working on factory - fix fixme in box while i'm at it.
[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
301 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
302 contact with the developers and maintainers.
303  */
304
305 #ifndef ELEMENTARY_H
306 #define ELEMENTARY_H
307
308 /**
309  * @file Elementary.h
310  * @brief Elementary's API
311  *
312  * Elementary API.
313  */
314
315 @ELM_UNIX_DEF@ ELM_UNIX
316 @ELM_WIN32_DEF@ ELM_WIN32
317 @ELM_WINCE_DEF@ ELM_WINCE
318 @ELM_EDBUS_DEF@ ELM_EDBUS
319 @ELM_EFREET_DEF@ ELM_EFREET
320 @ELM_ETHUMB_DEF@ ELM_ETHUMB
321 @ELM_EMAP_DEF@ ELM_EMAP
322 @ELM_DEBUG_DEF@ ELM_DEBUG
323 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
324 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
325
326 /* Standard headers for standard system calls etc. */
327 #include <stdio.h>
328 #include <stdlib.h>
329 #include <unistd.h>
330 #include <string.h>
331 #include <sys/types.h>
332 #include <sys/stat.h>
333 #include <sys/time.h>
334 #include <sys/param.h>
335 #include <dlfcn.h>
336 #include <math.h>
337 #include <fnmatch.h>
338 #include <limits.h>
339 #include <ctype.h>
340 #include <time.h>
341 #include <dirent.h>
342 #include <pwd.h>
343 #include <errno.h>
344
345 #ifdef ELM_UNIX
346 # include <locale.h>
347 # ifdef ELM_LIBINTL_H
348 #  include <libintl.h>
349 # endif
350 # include <signal.h>
351 # include <grp.h>
352 # include <glob.h>
353 #endif
354
355 #ifdef ELM_ALLOCA_H
356 # include <alloca.h>
357 #endif
358
359 #if defined (ELM_WIN32) || defined (ELM_WINCE)
360 # include <malloc.h>
361 # ifndef alloca
362 #  define alloca _alloca
363 # endif
364 #endif
365
366
367 /* EFL headers */
368 #include <Eina.h>
369 #include <Eet.h>
370 #include <Evas.h>
371 #include <Evas_GL.h>
372 #include <Ecore.h>
373 #include <Ecore_Evas.h>
374 #include <Ecore_File.h>
375 #include <Ecore_IMF.h>
376 #include <Ecore_Con.h>
377 #include <Edje.h>
378
379 #ifdef ELM_EDBUS
380 # include <E_DBus.h>
381 #endif
382
383 #ifdef ELM_EFREET
384 # include <Efreet.h>
385 # include <Efreet_Mime.h>
386 # include <Efreet_Trash.h>
387 #endif
388
389 #ifdef ELM_ETHUMB
390 # include <Ethumb_Client.h>
391 #endif
392
393 #ifdef ELM_EMAP
394 # include <EMap.h>
395 #endif
396
397 #ifdef EAPI
398 # undef EAPI
399 #endif
400
401 #ifdef _WIN32
402 # ifdef ELEMENTARY_BUILD
403 #  ifdef DLL_EXPORT
404 #   define EAPI __declspec(dllexport)
405 #  else
406 #   define EAPI
407 #  endif /* ! DLL_EXPORT */
408 # else
409 #  define EAPI __declspec(dllimport)
410 # endif /* ! EFL_EVAS_BUILD */
411 #else
412 # ifdef __GNUC__
413 #  if __GNUC__ >= 4
414 #   define EAPI __attribute__ ((visibility("default")))
415 #  else
416 #   define EAPI
417 #  endif
418 # else
419 #  define EAPI
420 # endif
421 #endif /* ! _WIN32 */
422
423 #ifdef _WIN32
424 # define EAPI_MAIN
425 #else
426 # define EAPI_MAIN EAPI
427 #endif
428
429 /* allow usage from c++ */
430 #ifdef __cplusplus
431 extern "C" {
432 #endif
433
434 #define ELM_VERSION_MAJOR @VMAJ@
435 #define ELM_VERSION_MINOR @VMIN@
436
437    typedef struct _Elm_Version
438      {
439         int major;
440         int minor;
441         int micro;
442         int revision;
443      } Elm_Version;
444
445    EAPI extern Elm_Version *elm_version;
446
447 /* handy macros */
448 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
449 #define ELM_PI 3.14159265358979323846
450
451    /**
452     * @defgroup General General
453     *
454     * @brief General Elementary API. Functions that don't relate to
455     * Elementary objects specifically.
456     *
457     * Here are documented functions which init/shutdown the library,
458     * that apply to generic Elementary objects, that deal with
459     * configuration, et cetera.
460     *
461     * @ref general_functions_example_page "This" example contemplates
462     * some of these functions.
463     */
464
465    /**
466     * @addtogroup General
467     * @{
468     */
469
470   /**
471    * Defines couple of standard Evas_Object layers to be used
472    * with evas_object_layer_set().
473    *
474    * @note whenever extending with new values, try to keep some padding
475    *       to siblings so there is room for further extensions.
476    */
477   typedef enum _Elm_Object_Layer
478     {
479        ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
480        ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
481        ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
482        ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
483        ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
484        ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
485     } Elm_Object_Layer;
486
487 /**************************************************************************/
488    EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
489
490    /**
491     * Emitted when any Elementary's policy value is changed.
492     */
493    EAPI extern int ELM_EVENT_POLICY_CHANGED;
494
495    /**
496     * @typedef Elm_Event_Policy_Changed
497     *
498     * Data on the event when an Elementary policy has changed
499     */
500     typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
501
502    /**
503     * @struct _Elm_Event_Policy_Changed
504     *
505     * Data on the event when an Elementary policy has changed
506     */
507     struct _Elm_Event_Policy_Changed
508      {
509         unsigned int policy; /**< the policy identifier */
510         int          new_value; /**< value the policy had before the change */
511         int          old_value; /**< new value the policy got */
512     };
513
514    /**
515     * Policy identifiers.
516     */
517     typedef enum _Elm_Policy
518     {
519         ELM_POLICY_QUIT, /**< under which circumstances the application
520                           * should quit automatically. @see
521                           * Elm_Policy_Quit.
522                           */
523         ELM_POLICY_LAST
524     } Elm_Policy; /**< Elementary policy identifiers/groups enumeration.  @see elm_policy_set()
525  */
526
527    typedef enum _Elm_Policy_Quit
528      {
529         ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
530                                    * automatically */
531         ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
532                                             * application's last
533                                             * window is closed */
534      } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
535
536    typedef enum _Elm_Focus_Direction
537      {
538         ELM_FOCUS_PREVIOUS,
539         ELM_FOCUS_NEXT
540      } Elm_Focus_Direction;
541
542    typedef enum _Elm_Text_Format
543      {
544         ELM_TEXT_FORMAT_PLAIN_UTF8,
545         ELM_TEXT_FORMAT_MARKUP_UTF8
546      } Elm_Text_Format;
547
548    /**
549     * Line wrapping types.
550     */
551    typedef enum _Elm_Wrap_Type
552      {
553         ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
554         ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
555         ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
556         ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
557         ELM_WRAP_LAST
558      } Elm_Wrap_Type;
559
560    typedef enum
561      {
562         ELM_INPUT_PANEL_LAYOUT_NORMAL,          /**< Default layout */
563         ELM_INPUT_PANEL_LAYOUT_NUMBER,          /**< Number layout */
564         ELM_INPUT_PANEL_LAYOUT_EMAIL,           /**< Email layout */
565         ELM_INPUT_PANEL_LAYOUT_URL,             /**< URL layout */
566         ELM_INPUT_PANEL_LAYOUT_PHONENUMBER,     /**< Phone Number layout */
567         ELM_INPUT_PANEL_LAYOUT_IP,              /**< IP layout */
568         ELM_INPUT_PANEL_LAYOUT_MONTH,           /**< Month layout */
569         ELM_INPUT_PANEL_LAYOUT_NUMBERONLY,      /**< Number Only layout */
570         ELM_INPUT_PANEL_LAYOUT_INVALID
571      } Elm_Input_Panel_Layout;
572
573    /**
574     * @typedef Elm_Object_Item
575     * An Elementary Object item handle.
576     * @ingroup General
577     */
578    typedef struct _Elm_Object_Item Elm_Object_Item;
579
580
581    /**
582     * Called back when a widget's tooltip is activated and needs content.
583     * @param data user-data given to elm_object_tooltip_content_cb_set()
584     * @param obj owner widget.
585     * @param tooltip The tooltip object (affix content to this!)
586     */
587    typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
588
589    /**
590     * Called back when a widget's item tooltip is activated and needs content.
591     * @param data user-data given to elm_object_tooltip_content_cb_set()
592     * @param obj owner widget.
593     * @param tooltip The tooltip object (affix content to this!)
594     * @param item context dependent item. As an example, if tooltip was
595     *        set on Elm_List_Item, then it is of this type.
596     */
597    typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
598
599    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. */
600
601 #ifndef ELM_LIB_QUICKLAUNCH
602 #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 */
603 #else
604 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
605 #endif
606
607 /**************************************************************************/
608    /* General calls */
609
610    /**
611     * Initialize Elementary
612     *
613     * @param[in] argc System's argument count value
614     * @param[in] argv System's pointer to array of argument strings
615     * @return The init counter value.
616     *
617     * This function initializes Elementary and increments a counter of
618     * the number of calls to it. It returns the new counter's value.
619     *
620     * @warning This call is exported only for use by the @c ELM_MAIN()
621     * macro. There is no need to use this if you use this macro (which
622     * is highly advisable). An elm_main() should contain the entry
623     * point code for your application, having the same prototype as
624     * elm_init(), and @b not being static (putting the @c EAPI symbol
625     * in front of its type declaration is advisable). The @c
626     * ELM_MAIN() call should be placed just after it.
627     *
628     * Example:
629     * @dontinclude bg_example_01.c
630     * @skip static void
631     * @until ELM_MAIN
632     *
633     * See the full @ref bg_example_01_c "example".
634     *
635     * @see elm_shutdown().
636     * @ingroup General
637     */
638    EAPI int          elm_init(int argc, char **argv);
639
640    /**
641     * Shut down Elementary
642     *
643     * @return The init counter value.
644     *
645     * This should be called at the end of your application, just
646     * before it ceases to do any more processing. This will clean up
647     * any permanent resources your application may have allocated via
648     * Elementary that would otherwise persist.
649     *
650     * @see elm_init() for an example
651     *
652     * @ingroup General
653     */
654    EAPI int          elm_shutdown(void);
655
656    /**
657     * Run Elementary's main loop
658     *
659     * This call should be issued just after all initialization is
660     * completed. This function will not return until elm_exit() is
661     * called. It will keep looping, running the main
662     * (event/processing) loop for Elementary.
663     *
664     * @see elm_init() for an example
665     *
666     * @ingroup General
667     */
668    EAPI void         elm_run(void);
669
670    /**
671     * Exit Elementary's main loop
672     *
673     * If this call is issued, it will flag the main loop to cease
674     * processing and return back to its parent function (usually your
675     * elm_main() function).
676     *
677     * @see elm_init() for an example. There, just after a request to
678     * close the window comes, the main loop will be left.
679     *
680     * @note By using the #ELM_POLICY_QUIT on your Elementary
681     * applications, you'll this function called automatically for you.
682     *
683     * @ingroup General
684     */
685    EAPI void         elm_exit(void);
686
687    /**
688     * Provide information in order to make Elementary determine the @b
689     * run time location of the software in question, so other data files
690     * such as images, sound files, executable utilities, libraries,
691     * modules and locale files can be found.
692     *
693     * @param mainfunc This is your application's main function name,
694     *        whose binary's location is to be found. Providing @c NULL
695     *        will make Elementary not to use it
696     * @param dom This will be used as the application's "domain", in the
697     *        form of a prefix to any environment variables that may
698     *        override prefix detection and the directory name, inside the
699     *        standard share or data directories, where the software's
700     *        data files will be looked for.
701     * @param checkfile This is an (optional) magic file's path to check
702     *        for existence (and it must be located in the data directory,
703     *        under the share directory provided above). Its presence will
704     *        help determine the prefix found was correct. Pass @c NULL if
705     *        the check is not to be done.
706     *
707     * This function allows one to re-locate the application somewhere
708     * else after compilation, if the developer wishes for easier
709     * distribution of pre-compiled binaries.
710     *
711     * The prefix system is designed to locate where the given software is
712     * installed (under a common path prefix) at run time and then report
713     * specific locations of this prefix and common directories inside
714     * this prefix like the binary, library, data and locale directories,
715     * through the @c elm_app_*_get() family of functions.
716     *
717     * Call elm_app_info_set() early on before you change working
718     * directory or anything about @c argv[0], so it gets accurate
719     * information.
720     *
721     * It will then try and trace back which file @p mainfunc comes from,
722     * if provided, to determine the application's prefix directory.
723     *
724     * The @p dom parameter provides a string prefix to prepend before
725     * environment variables, allowing a fallback to @b specific
726     * environment variables to locate the software. You would most
727     * probably provide a lowercase string there, because it will also
728     * serve as directory domain, explained next. For environment
729     * variables purposes, this string is made uppercase. For example if
730     * @c "myapp" is provided as the prefix, then the program would expect
731     * @c "MYAPP_PREFIX" as a master environment variable to specify the
732     * exact install prefix for the software, or more specific environment
733     * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
734     * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
735     * the user or scripts before launching. If not provided (@c NULL),
736     * environment variables will not be used to override compiled-in
737     * defaults or auto detections.
738     *
739     * The @p dom string also provides a subdirectory inside the system
740     * shared data directory for data files. For example, if the system
741     * directory is @c /usr/local/share, then this directory name is
742     * appended, creating @c /usr/local/share/myapp, if it @p was @c
743     * "myapp". It is expected the application installs data files in
744     * this directory.
745     *
746     * The @p checkfile is a file name or path of something inside the
747     * share or data directory to be used to test that the prefix
748     * detection worked. For example, your app will install a wallpaper
749     * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
750     * check that this worked, provide @c "images/wallpaper.jpg" as the @p
751     * checkfile string.
752     *
753     * @see elm_app_compile_bin_dir_set()
754     * @see elm_app_compile_lib_dir_set()
755     * @see elm_app_compile_data_dir_set()
756     * @see elm_app_compile_locale_set()
757     * @see elm_app_prefix_dir_get()
758     * @see elm_app_bin_dir_get()
759     * @see elm_app_lib_dir_get()
760     * @see elm_app_data_dir_get()
761     * @see elm_app_locale_dir_get()
762     */
763    EAPI void         elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
764
765    /**
766     * Provide information on the @b fallback application's binaries
767     * directory, on scenarios where they get overriden by
768     * elm_app_info_set().
769     *
770     * @param dir The path to the default binaries directory (compile time
771     * one)
772     *
773     * @note Elementary will as well use this path to determine actual
774     * names of binaries' directory paths, maybe changing it to be @c
775     * something/local/bin instead of @c something/bin, only, for
776     * example.
777     *
778     * @warning You should call this function @b before
779     * elm_app_info_set().
780     */
781    EAPI void         elm_app_compile_bin_dir_set(const char *dir);
782
783    /**
784     * Provide information on the @b fallback application's libraries
785     * directory, on scenarios where they get overriden by
786     * elm_app_info_set().
787     *
788     * @param dir The path to the default libraries directory (compile
789     * time one)
790     *
791     * @note Elementary will as well use this path to determine actual
792     * names of libraries' directory paths, maybe changing it to be @c
793     * something/lib32 or @c something/lib64 instead of @c something/lib,
794     * only, for example.
795     *
796     * @warning You should call this function @b before
797     * elm_app_info_set().
798     */
799    EAPI void         elm_app_compile_lib_dir_set(const char *dir);
800
801    /**
802     * Provide information on the @b fallback application's data
803     * directory, on scenarios where they get overriden by
804     * elm_app_info_set().
805     *
806     * @param dir The path to the default data directory (compile time
807     * one)
808     *
809     * @note Elementary will as well use this path to determine actual
810     * names of data directory paths, maybe changing it to be @c
811     * something/local/share instead of @c something/share, only, for
812     * example.
813     *
814     * @warning You should call this function @b before
815     * elm_app_info_set().
816     */
817    EAPI void         elm_app_compile_data_dir_set(const char *dir);
818
819    /**
820     * Provide information on the @b fallback application's locale
821     * directory, on scenarios where they get overriden by
822     * elm_app_info_set().
823     *
824     * @param dir The path to the default locale directory (compile time
825     * one)
826     *
827     * @warning You should call this function @b before
828     * elm_app_info_set().
829     */
830    EAPI void         elm_app_compile_locale_set(const char *dir);
831
832    /**
833     * Retrieve the application's run time prefix directory, as set by
834     * elm_app_info_set() and the way (environment) the application was
835     * run from.
836     *
837     * @return The directory prefix the application is actually using
838     */
839    EAPI const char  *elm_app_prefix_dir_get(void);
840
841    /**
842     * Retrieve the application's run time binaries prefix directory, as
843     * set by elm_app_info_set() and the way (environment) the application
844     * was run from.
845     *
846     * @return The binaries directory prefix the application is actually
847     * using
848     */
849    EAPI const char  *elm_app_bin_dir_get(void);
850
851    /**
852     * Retrieve the application's run time libraries prefix directory, as
853     * set by elm_app_info_set() and the way (environment) the application
854     * was run from.
855     *
856     * @return The libraries directory prefix the application is actually
857     * using
858     */
859    EAPI const char  *elm_app_lib_dir_get(void);
860
861    /**
862     * Retrieve the application's run time data prefix directory, as
863     * set by elm_app_info_set() and the way (environment) the application
864     * was run from.
865     *
866     * @return The data directory prefix the application is actually
867     * using
868     */
869    EAPI const char  *elm_app_data_dir_get(void);
870
871    /**
872     * Retrieve the application's run time locale prefix directory, as
873     * set by elm_app_info_set() and the way (environment) the application
874     * was run from.
875     *
876     * @return The locale directory prefix the application is actually
877     * using
878     */
879    EAPI const char  *elm_app_locale_dir_get(void);
880
881    EAPI void         elm_quicklaunch_mode_set(Eina_Bool ql_on);
882    EAPI Eina_Bool    elm_quicklaunch_mode_get(void);
883    EAPI int          elm_quicklaunch_init(int argc, char **argv);
884    EAPI int          elm_quicklaunch_sub_init(int argc, char **argv);
885    EAPI int          elm_quicklaunch_sub_shutdown(void);
886    EAPI int          elm_quicklaunch_shutdown(void);
887    EAPI void         elm_quicklaunch_seed(void);
888    EAPI Eina_Bool    elm_quicklaunch_prepare(int argc, char **argv);
889    EAPI Eina_Bool    elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
890    EAPI void         elm_quicklaunch_cleanup(void);
891    EAPI int          elm_quicklaunch_fallback(int argc, char **argv);
892    EAPI char        *elm_quicklaunch_exe_path_get(const char *exe);
893
894    EAPI Eina_Bool    elm_need_efreet(void);
895    EAPI Eina_Bool    elm_need_e_dbus(void);
896
897    /**
898     * This must be called before any other function that handle with
899     * elm_thumb objects or ethumb_client instances.
900     *
901     * @ingroup Thumb
902     */
903    EAPI Eina_Bool    elm_need_ethumb(void);
904
905    /**
906     * Set a new policy's value (for a given policy group/identifier).
907     *
908     * @param policy policy identifier, as in @ref Elm_Policy.
909     * @param value policy value, which depends on the identifier
910     *
911     * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
912     *
913     * Elementary policies define applications' behavior,
914     * somehow. These behaviors are divided in policy groups (see
915     * #Elm_Policy enumeration). This call will emit the Ecore event
916     * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
917     * handlers. An #Elm_Event_Policy_Changed struct will be passed,
918     * then.
919     *
920     * @note Currently, we have only one policy identifier/group
921     * (#ELM_POLICY_QUIT), which has two possible values.
922     *
923     * @ingroup General
924     */
925    EAPI Eina_Bool    elm_policy_set(unsigned int policy, int value);
926
927    /**
928     * Gets the policy value set for given policy identifier.
929     *
930     * @param policy policy identifier, as in #Elm_Policy.
931     * @return The currently set policy value, for that
932     * identifier. Will be @c 0 if @p policy passed is invalid.
933     *
934     * @ingroup General
935     */
936    EAPI int          elm_policy_get(unsigned int policy);
937
938    /**
939     * Set a label of an object
940     *
941     * @param obj The Elementary object
942     * @param part The text part name to set (NULL for the default label)
943     * @param label The new text of the label
944     *
945     * @note Elementary objects may have many labels (e.g. Action Slider)
946     *
947     * @ingroup General
948     */
949    EAPI void         elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
950
951 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
952
953    /**
954     * Get a label of an object
955     *
956     * @param obj The Elementary object
957     * @param part The text part name to get (NULL for the default label)
958     * @return text of the label or NULL for any error
959     *
960     * @note Elementary objects may have many labels (e.g. Action Slider)
961     *
962     * @ingroup General
963     */
964    EAPI const char  *elm_object_text_part_get(const Evas_Object *obj, const char *part);
965
966 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
967
968    /**
969     * Set a content of an object
970     *
971     * @param obj The Elementary object
972     * @param part The content part name to set (NULL for the default content)
973     * @param content The new content of the object
974     *
975     * @note Elementary objects may have many contents
976     *
977     * @ingroup General
978     */
979    EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
980
981 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
982
983    /**
984     * Get a content of an object
985     *
986     * @param obj The Elementary object
987     * @param item The content part name to get (NULL for the default content)
988     * @return content of the object or NULL for any error
989     *
990     * @note Elementary objects may have many contents
991     *
992     * @ingroup General
993     */
994    EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
995
996 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
997
998    /**
999     * Unset a content of an object
1000     *
1001     * @param obj The Elementary object
1002     * @param item The content part name to unset (NULL for the default content)
1003     *
1004     * @note Elementary objects may have many contents
1005     *
1006     * @ingroup General
1007     */
1008    EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1009
1010 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
1011
1012    /**
1013     * Set a content of an object item
1014     *
1015     * @param it The Elementary object item
1016     * @param part The content part name to unset (NULL for the default content)
1017     * @param content The new content of the object item
1018     *
1019     * @note Elementary object items may have many contents
1020     *
1021     * @ingroup General
1022     */
1023    EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1024
1025 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
1026
1027    /**
1028     * Get a content of an object item
1029     *
1030     * @param it The Elementary object item
1031     * @param part The content part name to unset (NULL for the default content)
1032     * @return content of the object item or NULL for any error
1033     *
1034     * @note Elementary object items may have many contents
1035     *
1036     * @ingroup General
1037     */
1038    EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *item);
1039
1040 #define elm_object_item_content_get(it, content) elm_object_item_content_part_get((it), NULL, (content))
1041
1042    /**
1043     * Unset a content of an object item
1044     *
1045     * @param it The Elementary object item
1046     * @param part The content part name to unset (NULL for the default content)
1047     *
1048     * @note Elementary object items may have many contents
1049     *
1050     * @ingroup General
1051     */
1052    EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1053
1054 #define elm_object_item_content_unset(it, content) elm_object_item_content_part_unset((it), (content))
1055
1056    /**
1057     * Set a label of an objec itemt
1058     *
1059     * @param it The Elementary object item
1060     * @param part The text part name to set (NULL for the default label)
1061     * @param label The new text of the label
1062     *
1063     * @note Elementary object items may have many labels
1064     *
1065     * @ingroup General
1066     */
1067    EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1068
1069 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1070
1071    /**
1072     * Get a label of an object
1073     *
1074     * @param it The Elementary object item
1075     * @param part The text part name to get (NULL for the default label)
1076     * @return text of the label or NULL for any error
1077     *
1078     * @note Elementary object items may have many labels
1079     *
1080     * @ingroup General
1081     */
1082    EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1083
1084    /**
1085     * Set the text to read out when in accessibility mode
1086     *
1087     * @param obj The object which is to be described
1088     * @param txt The text that describes the widget to people with poor or no vision
1089     *
1090     * @ingroup General
1091     */
1092    EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1093
1094    /**
1095     * Set the text to read out when in accessibility mode
1096     *
1097     * @param it The object item which is to be described
1098     * @param txt The text that describes the widget to people with poor or no vision
1099     *
1100     * @ingroup General
1101     */
1102    EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1103
1104
1105 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
1106
1107    /**
1108     * @}
1109     */
1110
1111    /**
1112     * @defgroup Caches Caches
1113     *
1114     * These are functions which let one fine-tune some cache values for
1115     * Elementary applications, thus allowing for performance adjustments.
1116     *
1117     * @{
1118     */
1119
1120    /**
1121     * @brief Flush all caches.
1122     *
1123     * Frees all data that was in cache and is not currently being used to reduce
1124     * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1125     * to calling all of the following functions:
1126     * @li edje_file_cache_flush()
1127     * @li edje_collection_cache_flush()
1128     * @li eet_clearcache()
1129     * @li evas_image_cache_flush()
1130     * @li evas_font_cache_flush()
1131     * @li evas_render_dump()
1132     * @note Evas caches are flushed for every canvas associated with a window.
1133     *
1134     * @ingroup Caches
1135     */
1136    EAPI void         elm_all_flush(void);
1137
1138    /**
1139     * Get the configured cache flush interval time
1140     *
1141     * This gets the globally configured cache flush interval time, in
1142     * ticks
1143     *
1144     * @return The cache flush interval time
1145     * @ingroup Caches
1146     *
1147     * @see elm_all_flush()
1148     */
1149    EAPI int          elm_cache_flush_interval_get(void);
1150
1151    /**
1152     * Set the configured cache flush interval time
1153     *
1154     * This sets the globally configured cache flush interval time, in ticks
1155     *
1156     * @param size The cache flush interval time
1157     * @ingroup Caches
1158     *
1159     * @see elm_all_flush()
1160     */
1161    EAPI void         elm_cache_flush_interval_set(int size);
1162
1163    /**
1164     * Set the configured cache flush interval time for all applications on the
1165     * display
1166     *
1167     * This sets the globally configured cache flush interval time -- in ticks
1168     * -- for all applications on the display.
1169     *
1170     * @param size The cache flush interval time
1171     * @ingroup Caches
1172     */
1173    EAPI void         elm_cache_flush_interval_all_set(int size);
1174
1175    /**
1176     * Get the configured cache flush enabled state
1177     *
1178     * This gets the globally configured cache flush state - if it is enabled
1179     * or not. When cache flushing is enabled, elementary will regularly
1180     * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1181     * memory and allow usage to re-seed caches and data in memory where it
1182     * can do so. An idle application will thus minimise its memory usage as
1183     * data will be freed from memory and not be re-loaded as it is idle and
1184     * not rendering or doing anything graphically right now.
1185     *
1186     * @return The cache flush state
1187     * @ingroup Caches
1188     *
1189     * @see elm_all_flush()
1190     */
1191    EAPI Eina_Bool    elm_cache_flush_enabled_get(void);
1192
1193    /**
1194     * Set the configured cache flush enabled state
1195     *
1196     * This sets the globally configured cache flush enabled state
1197     *
1198     * @param size The cache flush enabled state
1199     * @ingroup Caches
1200     *
1201     * @see elm_all_flush()
1202     */
1203    EAPI void         elm_cache_flush_enabled_set(Eina_Bool enabled);
1204
1205    /**
1206     * Set the configured cache flush enabled state for all applications on the
1207     * display
1208     *
1209     * This sets the globally configured cache flush enabled state for all
1210     * applications on the display.
1211     *
1212     * @param size The cache flush enabled state
1213     * @ingroup Caches
1214     */
1215    EAPI void         elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1216
1217    /**
1218     * Get the configured font cache size
1219     *
1220     * This gets the globally configured font cache size, in bytes
1221     *
1222     * @return The font cache size
1223     * @ingroup Caches
1224     */
1225    EAPI int          elm_font_cache_get(void);
1226
1227    /**
1228     * Set the configured font cache size
1229     *
1230     * This sets the globally configured font cache size, in bytes
1231     *
1232     * @param size The font cache size
1233     * @ingroup Caches
1234     */
1235    EAPI void         elm_font_cache_set(int size);
1236
1237    /**
1238     * Set the configured font cache size for all applications on the
1239     * display
1240     *
1241     * This sets the globally configured font cache size -- in bytes
1242     * -- for all applications on the display.
1243     *
1244     * @param size The font cache size
1245     * @ingroup Caches
1246     */
1247    EAPI void         elm_font_cache_all_set(int size);
1248
1249    /**
1250     * Get the configured image cache size
1251     *
1252     * This gets the globally configured image cache size, in bytes
1253     *
1254     * @return The image cache size
1255     * @ingroup Caches
1256     */
1257    EAPI int          elm_image_cache_get(void);
1258
1259    /**
1260     * Set the configured image cache size
1261     *
1262     * This sets the globally configured image cache size, in bytes
1263     *
1264     * @param size The image cache size
1265     * @ingroup Caches
1266     */
1267    EAPI void         elm_image_cache_set(int size);
1268
1269    /**
1270     * Set the configured image cache size for all applications on the
1271     * display
1272     *
1273     * This sets the globally configured image cache size -- in bytes
1274     * -- for all applications on the display.
1275     *
1276     * @param size The image cache size
1277     * @ingroup Caches
1278     */
1279    EAPI void         elm_image_cache_all_set(int size);
1280
1281    /**
1282     * Get the configured edje file cache size.
1283     *
1284     * This gets the globally configured edje file cache size, in number
1285     * of files.
1286     *
1287     * @return The edje file cache size
1288     * @ingroup Caches
1289     */
1290    EAPI int          elm_edje_file_cache_get(void);
1291
1292    /**
1293     * Set the configured edje file cache size
1294     *
1295     * This sets the globally configured edje file cache size, in number
1296     * of files.
1297     *
1298     * @param size The edje file cache size
1299     * @ingroup Caches
1300     */
1301    EAPI void         elm_edje_file_cache_set(int size);
1302
1303    /**
1304     * Set the configured edje file cache size for all applications on the
1305     * display
1306     *
1307     * This sets the globally configured edje file cache size -- in number
1308     * of files -- for all applications on the display.
1309     *
1310     * @param size The edje file cache size
1311     * @ingroup Caches
1312     */
1313    EAPI void         elm_edje_file_cache_all_set(int size);
1314
1315    /**
1316     * Get the configured edje collections (groups) cache size.
1317     *
1318     * This gets the globally configured edje collections cache size, in
1319     * number of collections.
1320     *
1321     * @return The edje collections cache size
1322     * @ingroup Caches
1323     */
1324    EAPI int          elm_edje_collection_cache_get(void);
1325
1326    /**
1327     * Set the configured edje collections (groups) cache size
1328     *
1329     * This sets the globally configured edje collections cache size, in
1330     * number of collections.
1331     *
1332     * @param size The edje collections cache size
1333     * @ingroup Caches
1334     */
1335    EAPI void         elm_edje_collection_cache_set(int size);
1336
1337    /**
1338     * Set the configured edje collections (groups) cache size for all
1339     * applications on the display
1340     *
1341     * This sets the globally configured edje collections cache size -- in
1342     * number of collections -- for all applications on the display.
1343     *
1344     * @param size The edje collections cache size
1345     * @ingroup Caches
1346     */
1347    EAPI void         elm_edje_collection_cache_all_set(int size);
1348
1349    /**
1350     * @}
1351     */
1352
1353    /**
1354     * @defgroup Scaling Widget Scaling
1355     *
1356     * Different widgets can be scaled independently. These functions
1357     * allow you to manipulate this scaling on a per-widget basis. The
1358     * object and all its children get their scaling factors multiplied
1359     * by the scale factor set. This is multiplicative, in that if a
1360     * child also has a scale size set it is in turn multiplied by its
1361     * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
1362     * double size, @c 0.5 is half, etc.
1363     *
1364     * @ref general_functions_example_page "This" example contemplates
1365     * some of these functions.
1366     */
1367
1368    /**
1369     * Get the global scaling factor
1370     *
1371     * This gets the globally configured scaling factor that is applied to all
1372     * objects.
1373     *
1374     * @return The scaling factor
1375     * @ingroup Scaling
1376     */
1377    EAPI double       elm_scale_get(void);
1378
1379    /**
1380     * Set the global scaling factor
1381     *
1382     * This sets the globally configured scaling factor that is applied to all
1383     * objects.
1384     *
1385     * @param scale The scaling factor to set
1386     * @ingroup Scaling
1387     */
1388    EAPI void         elm_scale_set(double scale);
1389
1390    /**
1391     * Set the global scaling factor for all applications on the display
1392     *
1393     * This sets the globally configured scaling factor that is applied to all
1394     * objects for all applications.
1395     * @param scale The scaling factor to set
1396     * @ingroup Scaling
1397     */
1398    EAPI void         elm_scale_all_set(double scale);
1399
1400    /**
1401     * Set the scaling factor for a given Elementary object
1402     *
1403     * @param obj The Elementary to operate on
1404     * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1405     * no scaling)
1406     *
1407     * @ingroup Scaling
1408     */
1409    EAPI void         elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1410
1411    /**
1412     * Get the scaling factor for a given Elementary object
1413     *
1414     * @param obj The object
1415     * @return The scaling factor set by elm_object_scale_set()
1416     *
1417     * @ingroup Scaling
1418     */
1419    EAPI double       elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1420
1421    /**
1422     * @defgroup Password_last_show Password last input show
1423     *
1424     * Last show feature of password mode enables user to view
1425     * the last input entered for few seconds before masking it.
1426     * These functions allow to set this feature in password mode
1427     * of entry widget and also allow to manipulate the duration 
1428     * for which the input has to be visible.
1429     *
1430     * @{
1431     */
1432
1433    /**
1434     * Get show last setting of password mode.
1435     *
1436     * This gets the show last input setting of password mode which might be 
1437     * enabled or disabled.
1438     *
1439     * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1440     *            if it's disabled.
1441     * @ingroup Password_last_show
1442     */
1443    EAPI Eina_Bool elm_password_show_last_get(void);
1444
1445    /**
1446     * Set show last setting in password mode.
1447     *
1448     * This enables or disables show last setting of password mode.
1449     *
1450     * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1451     * @see elm_password_show_last_timeout_set()
1452     * @ingroup Password_last_show
1453     */
1454    EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1455
1456    /**
1457     * Get's the timeout value in last show password mode.
1458     *
1459     * This gets the time out value for which the last input entered in password
1460     * mode will be visible.
1461     *
1462     * @return The timeout value of last show password mode.
1463     * @ingroup Password_last_show
1464     */
1465    EAPI double elm_password_show_last_timeout_get(void);
1466
1467    /**
1468     * Set's the timeout value in last show password mode.
1469     *
1470     * This sets the time out value for which the last input entered in password
1471     * mode will be visible.
1472     *
1473     * @param password_show_last_timeout The timeout value.
1474     * @see elm_password_show_last_set()
1475     * @ingroup Password_last_show
1476     */
1477    EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1478
1479    /**
1480     * @}
1481     */
1482
1483    /**
1484     * @defgroup UI-Mirroring Selective Widget mirroring
1485     *
1486     * These functions allow you to set ui-mirroring on specific
1487     * widgets or the whole interface. Widgets can be in one of two
1488     * modes, automatic and manual.  Automatic means they'll be changed
1489     * according to the system mirroring mode and manual means only
1490     * explicit changes will matter. You are not supposed to change
1491     * mirroring state of a widget set to automatic, will mostly work,
1492     * but the behavior is not really defined.
1493     *
1494     * @{
1495     */
1496
1497    EAPI Eina_Bool    elm_mirrored_get(void);
1498    EAPI void         elm_mirrored_set(Eina_Bool mirrored);
1499
1500    /**
1501     * Get the system mirrored mode. This determines the default mirrored mode
1502     * of widgets.
1503     *
1504     * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1505     */
1506    EAPI Eina_Bool    elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1507
1508    /**
1509     * Set the system mirrored mode. This determines the default mirrored mode
1510     * of widgets.
1511     *
1512     * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1513     */
1514    EAPI void         elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1515
1516    /**
1517     * Returns the widget's mirrored mode setting.
1518     *
1519     * @param obj The widget.
1520     * @return mirrored mode setting of the object.
1521     *
1522     **/
1523    EAPI Eina_Bool    elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1524
1525    /**
1526     * Sets the widget's mirrored mode setting.
1527     * When widget in automatic mode, it follows the system mirrored mode set by
1528     * elm_mirrored_set().
1529     * @param obj The widget.
1530     * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1531     */
1532    EAPI void         elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1533
1534    /**
1535     * @}
1536     */
1537
1538    /**
1539     * Set the style to use by a widget
1540     *
1541     * Sets the style name that will define the appearance of a widget. Styles
1542     * vary from widget to widget and may also be defined by other themes
1543     * by means of extensions and overlays.
1544     *
1545     * @param obj The Elementary widget to style
1546     * @param style The style name to use
1547     *
1548     * @see elm_theme_extension_add()
1549     * @see elm_theme_extension_del()
1550     * @see elm_theme_overlay_add()
1551     * @see elm_theme_overlay_del()
1552     *
1553     * @ingroup Styles
1554     */
1555    EAPI void         elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1556    /**
1557     * Get the style used by the widget
1558     *
1559     * This gets the style being used for that widget. Note that the string
1560     * pointer is only valid as longas the object is valid and the style doesn't
1561     * change.
1562     *
1563     * @param obj The Elementary widget to query for its style
1564     * @return The style name used
1565     *
1566     * @see elm_object_style_set()
1567     *
1568     * @ingroup Styles
1569     */
1570    EAPI const char  *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1571
1572    /**
1573     * @defgroup Styles Styles
1574     *
1575     * Widgets can have different styles of look. These generic API's
1576     * set styles of widgets, if they support them (and if the theme(s)
1577     * do).
1578     *
1579     * @ref general_functions_example_page "This" example contemplates
1580     * some of these functions.
1581     */
1582
1583    /**
1584     * Set the disabled state of an Elementary object.
1585     *
1586     * @param obj The Elementary object to operate on
1587     * @param disabled The state to put in in: @c EINA_TRUE for
1588     *        disabled, @c EINA_FALSE for enabled
1589     *
1590     * Elementary objects can be @b disabled, in which state they won't
1591     * receive input and, in general, will be themed differently from
1592     * their normal state, usually greyed out. Useful for contexts
1593     * where you don't want your users to interact with some of the
1594     * parts of you interface.
1595     *
1596     * This sets the state for the widget, either disabling it or
1597     * enabling it back.
1598     *
1599     * @ingroup Styles
1600     */
1601    EAPI void         elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1602
1603    /**
1604     * Get the disabled state of an Elementary object.
1605     *
1606     * @param obj The Elementary object to operate on
1607     * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1608     *            if it's enabled (or on errors)
1609     *
1610     * This gets the state of the widget, which might be enabled or disabled.
1611     *
1612     * @ingroup Styles
1613     */
1614    EAPI Eina_Bool    elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1615
1616    /**
1617     * @defgroup WidgetNavigation Widget Tree Navigation.
1618     *
1619     * How to check if an Evas Object is an Elementary widget? How to
1620     * get the first elementary widget that is parent of the given
1621     * object?  These are all covered in widget tree navigation.
1622     *
1623     * @ref general_functions_example_page "This" example contemplates
1624     * some of these functions.
1625     */
1626
1627    /**
1628     * Check if the given Evas Object is an Elementary widget.
1629     *
1630     * @param obj the object to query.
1631     * @return @c EINA_TRUE if it is an elementary widget variant,
1632     *         @c EINA_FALSE otherwise
1633     * @ingroup WidgetNavigation
1634     */
1635    EAPI Eina_Bool    elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1636
1637    /**
1638     * Get the first parent of the given object that is an Elementary
1639     * widget.
1640     *
1641     * @param obj the Elementary object to query parent from.
1642     * @return the parent object that is an Elementary widget, or @c
1643     *         NULL, if it was not found.
1644     *
1645     * Use this to query for an object's parent widget.
1646     *
1647     * @note Most of Elementary users wouldn't be mixing non-Elementary
1648     * smart objects in the objects tree of an application, as this is
1649     * an advanced usage of Elementary with Evas. So, except for the
1650     * application's window, which is the root of that tree, all other
1651     * objects would have valid Elementary widget parents.
1652     *
1653     * @ingroup WidgetNavigation
1654     */
1655    EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1656
1657    /**
1658     * Get the top level parent of an Elementary widget.
1659     *
1660     * @param obj The object to query.
1661     * @return The top level Elementary widget, or @c NULL if parent cannot be
1662     * found.
1663     * @ingroup WidgetNavigation
1664     */
1665    EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1666
1667    /**
1668     * Get the string that represents this Elementary widget.
1669     *
1670     * @note Elementary is weird and exposes itself as a single
1671     *       Evas_Object_Smart_Class of type "elm_widget", so
1672     *       evas_object_type_get() always return that, making debug and
1673     *       language bindings hard. This function tries to mitigate this
1674     *       problem, but the solution is to change Elementary to use
1675     *       proper inheritance.
1676     *
1677     * @param obj the object to query.
1678     * @return Elementary widget name, or @c NULL if not a valid widget.
1679     * @ingroup WidgetNavigation
1680     */
1681    EAPI const char  *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1682
1683    /**
1684     * @defgroup Config Elementary Config
1685     *
1686     * Elementary configuration is formed by a set options bounded to a
1687     * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1688     * "finger size", etc. These are functions with which one syncronizes
1689     * changes made to those values to the configuration storing files, de
1690     * facto. You most probably don't want to use the functions in this
1691     * group unlees you're writing an elementary configuration manager.
1692     *
1693     * @{
1694     */
1695
1696    /**
1697     * Save back Elementary's configuration, so that it will persist on
1698     * future sessions.
1699     *
1700     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1701     * @ingroup Config
1702     *
1703     * This function will take effect -- thus, do I/O -- immediately. Use
1704     * it when you want to apply all configuration changes at once. The
1705     * current configuration set will get saved onto the current profile
1706     * configuration file.
1707     *
1708     */
1709    EAPI Eina_Bool    elm_config_save(void);
1710
1711    /**
1712     * Reload Elementary's configuration, bounded to current selected
1713     * profile.
1714     *
1715     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1716     * @ingroup Config
1717     *
1718     * Useful when you want to force reloading of configuration values for
1719     * a profile. If one removes user custom configuration directories,
1720     * for example, it will force a reload with system values insted.
1721     *
1722     */
1723    EAPI void         elm_config_reload(void);
1724
1725    /**
1726     * @}
1727     */
1728
1729    /**
1730     * @defgroup Profile Elementary Profile
1731     *
1732     * Profiles are pre-set options that affect the whole look-and-feel of
1733     * Elementary-based applications. There are, for example, profiles
1734     * aimed at desktop computer applications and others aimed at mobile,
1735     * touchscreen-based ones. You most probably don't want to use the
1736     * functions in this group unlees you're writing an elementary
1737     * configuration manager.
1738     *
1739     * @{
1740     */
1741
1742    /**
1743     * Get Elementary's profile in use.
1744     *
1745     * This gets the global profile that is applied to all Elementary
1746     * applications.
1747     *
1748     * @return The profile's name
1749     * @ingroup Profile
1750     */
1751    EAPI const char  *elm_profile_current_get(void);
1752
1753    /**
1754     * Get an Elementary's profile directory path in the filesystem. One
1755     * may want to fetch a system profile's dir or an user one (fetched
1756     * inside $HOME).
1757     *
1758     * @param profile The profile's name
1759     * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1760     *                or a system one (@c EINA_FALSE)
1761     * @return The profile's directory path.
1762     * @ingroup Profile
1763     *
1764     * @note You must free it with elm_profile_dir_free().
1765     */
1766    EAPI const char  *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1767
1768    /**
1769     * Free an Elementary's profile directory path, as returned by
1770     * elm_profile_dir_get().
1771     *
1772     * @param p_dir The profile's path
1773     * @ingroup Profile
1774     *
1775     */
1776    EAPI void         elm_profile_dir_free(const char *p_dir);
1777
1778    /**
1779     * Get Elementary's list of available profiles.
1780     *
1781     * @return The profiles list. List node data are the profile name
1782     *         strings.
1783     * @ingroup Profile
1784     *
1785     * @note One must free this list, after usage, with the function
1786     *       elm_profile_list_free().
1787     */
1788    EAPI Eina_List   *elm_profile_list_get(void);
1789
1790    /**
1791     * Free Elementary's list of available profiles.
1792     *
1793     * @param l The profiles list, as returned by elm_profile_list_get().
1794     * @ingroup Profile
1795     *
1796     */
1797    EAPI void         elm_profile_list_free(Eina_List *l);
1798
1799    /**
1800     * Set Elementary's profile.
1801     *
1802     * This sets the global profile that is applied to Elementary
1803     * applications. Just the process the call comes from will be
1804     * affected.
1805     *
1806     * @param profile The profile's name
1807     * @ingroup Profile
1808     *
1809     */
1810    EAPI void         elm_profile_set(const char *profile);
1811
1812    /**
1813     * Set Elementary's profile.
1814     *
1815     * This sets the global profile that is applied to all Elementary
1816     * applications. All running Elementary windows will be affected.
1817     *
1818     * @param profile The profile's name
1819     * @ingroup Profile
1820     *
1821     */
1822    EAPI void         elm_profile_all_set(const char *profile);
1823
1824    /**
1825     * @}
1826     */
1827
1828    /**
1829     * @defgroup Engine Elementary Engine
1830     *
1831     * These are functions setting and querying which rendering engine
1832     * Elementary will use for drawing its windows' pixels.
1833     *
1834     * The following are the available engines:
1835     * @li "software_x11"
1836     * @li "fb"
1837     * @li "directfb"
1838     * @li "software_16_x11"
1839     * @li "software_8_x11"
1840     * @li "xrender_x11"
1841     * @li "opengl_x11"
1842     * @li "software_gdi"
1843     * @li "software_16_wince_gdi"
1844     * @li "sdl"
1845     * @li "software_16_sdl"
1846     * @li "opengl_sdl"
1847     * @li "buffer"
1848     *
1849     * @{
1850     */
1851
1852    /**
1853     * @brief Get Elementary's rendering engine in use.
1854     *
1855     * @return The rendering engine's name
1856     * @note there's no need to free the returned string, here.
1857     *
1858     * This gets the global rendering engine that is applied to all Elementary
1859     * applications.
1860     *
1861     * @see elm_engine_set()
1862     */
1863    EAPI const char  *elm_engine_current_get(void);
1864
1865    /**
1866     * @brief Set Elementary's rendering engine for use.
1867     *
1868     * @param engine The rendering engine's name
1869     *
1870     * This sets global rendering engine that is applied to all Elementary
1871     * applications. Note that it will take effect only to Elementary windows
1872     * created after this is called.
1873     *
1874     * @see elm_win_add()
1875     */
1876    EAPI void         elm_engine_set(const char *engine);
1877
1878    /**
1879     * @}
1880     */
1881
1882    /**
1883     * @defgroup Fonts Elementary Fonts
1884     *
1885     * These are functions dealing with font rendering, selection and the
1886     * like for Elementary applications. One might fetch which system
1887     * fonts are there to use and set custom fonts for individual classes
1888     * of UI items containing text (text classes).
1889     *
1890     * @{
1891     */
1892
1893   typedef struct _Elm_Text_Class
1894     {
1895        const char *name;
1896        const char *desc;
1897     } Elm_Text_Class;
1898
1899   typedef struct _Elm_Font_Overlay
1900     {
1901        const char     *text_class;
1902        const char     *font;
1903        Evas_Font_Size  size;
1904     } Elm_Font_Overlay;
1905
1906   typedef struct _Elm_Font_Properties
1907     {
1908        const char *name;
1909        Eina_List  *styles;
1910     } Elm_Font_Properties;
1911
1912    /**
1913     * Get Elementary's list of supported text classes.
1914     *
1915     * @return The text classes list, with @c Elm_Text_Class blobs as data.
1916     * @ingroup Fonts
1917     *
1918     * Release the list with elm_text_classes_list_free().
1919     */
1920    EAPI const Eina_List     *elm_text_classes_list_get(void);
1921
1922    /**
1923     * Free Elementary's list of supported text classes.
1924     *
1925     * @ingroup Fonts
1926     *
1927     * @see elm_text_classes_list_get().
1928     */
1929    EAPI void                 elm_text_classes_list_free(const Eina_List *list);
1930
1931    /**
1932     * Get Elementary's list of font overlays, set with
1933     * elm_font_overlay_set().
1934     *
1935     * @return The font overlays list, with @c Elm_Font_Overlay blobs as
1936     * data.
1937     *
1938     * @ingroup Fonts
1939     *
1940     * For each text class, one can set a <b>font overlay</b> for it,
1941     * overriding the default font properties for that class coming from
1942     * the theme in use. There is no need to free this list.
1943     *
1944     * @see elm_font_overlay_set() and elm_font_overlay_unset().
1945     */
1946    EAPI const Eina_List     *elm_font_overlay_list_get(void);
1947
1948    /**
1949     * Set a font overlay for a given Elementary text class.
1950     *
1951     * @param text_class Text class name
1952     * @param font Font name and style string
1953     * @param size Font size
1954     *
1955     * @ingroup Fonts
1956     *
1957     * @p font has to be in the format returned by
1958     * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
1959     * and elm_font_overlay_unset().
1960     */
1961    EAPI void                 elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
1962
1963    /**
1964     * Unset a font overlay for a given Elementary text class.
1965     *
1966     * @param text_class Text class name
1967     *
1968     * @ingroup Fonts
1969     *
1970     * This will bring back text elements belonging to text class
1971     * @p text_class back to their default font settings.
1972     */
1973    EAPI void                 elm_font_overlay_unset(const char *text_class);
1974
1975    /**
1976     * Apply the changes made with elm_font_overlay_set() and
1977     * elm_font_overlay_unset() on the current Elementary window.
1978     *
1979     * @ingroup Fonts
1980     *
1981     * This applies all font overlays set to all objects in the UI.
1982     */
1983    EAPI void                 elm_font_overlay_apply(void);
1984
1985    /**
1986     * Apply the changes made with elm_font_overlay_set() and
1987     * elm_font_overlay_unset() on all Elementary application windows.
1988     *
1989     * @ingroup Fonts
1990     *
1991     * This applies all font overlays set to all objects in the UI.
1992     */
1993    EAPI void                 elm_font_overlay_all_apply(void);
1994
1995    /**
1996     * Translate a font (family) name string in fontconfig's font names
1997     * syntax into an @c Elm_Font_Properties struct.
1998     *
1999     * @param font The font name and styles string
2000     * @return the font properties struct
2001     *
2002     * @ingroup Fonts
2003     *
2004     * @note The reverse translation can be achived with
2005     * elm_font_fontconfig_name_get(), for one style only (single font
2006     * instance, not family).
2007     */
2008    EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2009
2010    /**
2011     * Free font properties return by elm_font_properties_get().
2012     *
2013     * @param efp the font properties struct
2014     *
2015     * @ingroup Fonts
2016     */
2017    EAPI void                 elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2018
2019    /**
2020     * Translate a font name, bound to a style, into fontconfig's font names
2021     * syntax.
2022     *
2023     * @param name The font (family) name
2024     * @param style The given style (may be @c NULL)
2025     *
2026     * @return the font name and style string
2027     *
2028     * @ingroup Fonts
2029     *
2030     * @note The reverse translation can be achived with
2031     * elm_font_properties_get(), for one style only (single font
2032     * instance, not family).
2033     */
2034    EAPI const char          *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2035
2036    /**
2037     * Free the font string return by elm_font_fontconfig_name_get().
2038     *
2039     * @param efp the font properties struct
2040     *
2041     * @ingroup Fonts
2042     */
2043    EAPI void                 elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2044
2045    /**
2046     * Create a font hash table of available system fonts.
2047     *
2048     * One must call it with @p list being the return value of
2049     * evas_font_available_list(). The hash will be indexed by font
2050     * (family) names, being its values @c Elm_Font_Properties blobs.
2051     *
2052     * @param list The list of available system fonts, as returned by
2053     * evas_font_available_list().
2054     * @return the font hash.
2055     *
2056     * @ingroup Fonts
2057     *
2058     * @note The user is supposed to get it populated at least with 3
2059     * default font families (Sans, Serif, Monospace), which should be
2060     * present on most systems.
2061     */
2062    EAPI Eina_Hash           *elm_font_available_hash_add(Eina_List *list);
2063
2064    /**
2065     * Free the hash return by elm_font_available_hash_add().
2066     *
2067     * @param hash the hash to be freed.
2068     *
2069     * @ingroup Fonts
2070     */
2071    EAPI void                 elm_font_available_hash_del(Eina_Hash *hash);
2072
2073    /**
2074     * @}
2075     */
2076
2077    /**
2078     * @defgroup Fingers Fingers
2079     *
2080     * Elementary is designed to be finger-friendly for touchscreens,
2081     * and so in addition to scaling for display resolution, it can
2082     * also scale based on finger "resolution" (or size). You can then
2083     * customize the granularity of the areas meant to receive clicks
2084     * on touchscreens.
2085     *
2086     * Different profiles may have pre-set values for finger sizes.
2087     *
2088     * @ref general_functions_example_page "This" example contemplates
2089     * some of these functions.
2090     *
2091     * @{
2092     */
2093
2094    /**
2095     * Get the configured "finger size"
2096     *
2097     * @return The finger size
2098     *
2099     * This gets the globally configured finger size, <b>in pixels</b>
2100     *
2101     * @ingroup Fingers
2102     */
2103    EAPI Evas_Coord       elm_finger_size_get(void);
2104
2105    /**
2106     * Set the configured finger size
2107     *
2108     * This sets the globally configured finger size in pixels
2109     *
2110     * @param size The finger size
2111     * @ingroup Fingers
2112     */
2113    EAPI void             elm_finger_size_set(Evas_Coord size);
2114
2115    /**
2116     * Set the configured finger size for all applications on the display
2117     *
2118     * This sets the globally configured finger size in pixels for all
2119     * applications on the display
2120     *
2121     * @param size The finger size
2122     * @ingroup Fingers
2123     */
2124    EAPI void             elm_finger_size_all_set(Evas_Coord size);
2125
2126    /**
2127     * @}
2128     */
2129
2130    /**
2131     * @defgroup Focus Focus
2132     *
2133     * An Elementary application has, at all times, one (and only one)
2134     * @b focused object. This is what determines where the input
2135     * events go to within the application's window. Also, focused
2136     * objects can be decorated differently, in order to signal to the
2137     * user where the input is, at a given moment.
2138     *
2139     * Elementary applications also have the concept of <b>focus
2140     * chain</b>: one can cycle through all the windows' focusable
2141     * objects by input (tab key) or programmatically. The default
2142     * focus chain for an application is the one define by the order in
2143     * which the widgets where added in code. One will cycle through
2144     * top level widgets, and, for each one containg sub-objects, cycle
2145     * through them all, before returning to the level
2146     * above. Elementary also allows one to set @b custom focus chains
2147     * for their applications.
2148     *
2149     * Besides the focused decoration a widget may exhibit, when it
2150     * gets focus, Elementary has a @b global focus highlight object
2151     * that can be enabled for a window. If one chooses to do so, this
2152     * extra highlight effect will surround the current focused object,
2153     * too.
2154     *
2155     * @note Some Elementary widgets are @b unfocusable, after
2156     * creation, by their very nature: they are not meant to be
2157     * interacted with input events, but are there just for visual
2158     * purposes.
2159     *
2160     * @ref general_functions_example_page "This" example contemplates
2161     * some of these functions.
2162     */
2163
2164    /**
2165     * Get the enable status of the focus highlight
2166     *
2167     * This gets whether the highlight on focused objects is enabled or not
2168     * @ingroup Focus
2169     */
2170    EAPI Eina_Bool        elm_focus_highlight_enabled_get(void);
2171
2172    /**
2173     * Set the enable status of the focus highlight
2174     *
2175     * Set whether to show or not the highlight on focused objects
2176     * @param enable Enable highlight if EINA_TRUE, disable otherwise
2177     * @ingroup Focus
2178     */
2179    EAPI void             elm_focus_highlight_enabled_set(Eina_Bool enable);
2180
2181    /**
2182     * Get the enable status of the highlight animation
2183     *
2184     * Get whether the focus highlight, if enabled, will animate its switch from
2185     * one object to the next
2186     * @ingroup Focus
2187     */
2188    EAPI Eina_Bool        elm_focus_highlight_animate_get(void);
2189
2190    /**
2191     * Set the enable status of the highlight animation
2192     *
2193     * Set whether the focus highlight, if enabled, will animate its switch from
2194     * one object to the next
2195     * @param animate Enable animation if EINA_TRUE, disable otherwise
2196     * @ingroup Focus
2197     */
2198    EAPI void             elm_focus_highlight_animate_set(Eina_Bool animate);
2199
2200    /**
2201     * Get the whether an Elementary object has the focus or not.
2202     *
2203     * @param obj The Elementary object to get the information from
2204     * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2205     *            not (and on errors).
2206     *
2207     * @see elm_object_focus_set()
2208     *
2209     * @ingroup Focus
2210     */
2211    EAPI Eina_Bool        elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2212
2213    /**
2214     * Set/unset focus to a given Elementary object.
2215     *
2216     * @param obj The Elementary object to operate on.
2217     * @param enable @c EINA_TRUE Set focus to a given object,
2218     *               @c EINA_FALSE Unset focus to a given object.
2219     *
2220     * @note When you set focus to this object, if it can handle focus, will
2221     * take the focus away from the one who had it previously and will, for
2222     * now on, be the one receiving input events. Unsetting focus will remove
2223     * the focus from @p obj, passing it back to the previous element in the
2224     * focus chain list.
2225     *
2226     * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2227     *
2228     * @ingroup Focus
2229     */
2230    EAPI void             elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2231
2232    /**
2233     * Make a given Elementary object the focused one.
2234     *
2235     * @param obj The Elementary object to make focused.
2236     *
2237     * @note This object, if it can handle focus, will take the focus
2238     * away from the one who had it previously and will, for now on, be
2239     * the one receiving input events.
2240     *
2241     * @see elm_object_focus_get()
2242     * @deprecated use elm_object_focus_set() instead.
2243     *
2244     * @ingroup Focus
2245     */
2246    EINA_DEPRECATED EAPI void             elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2247
2248    /**
2249     * Remove the focus from an Elementary object
2250     *
2251     * @param obj The Elementary to take focus from
2252     *
2253     * This removes the focus from @p obj, passing it back to the
2254     * previous element in the focus chain list.
2255     *
2256     * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2257     * @deprecated use elm_object_focus_set() instead.
2258     *
2259     * @ingroup Focus
2260     */
2261    EINA_DEPRECATED EAPI void             elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2262
2263    /**
2264     * Set the ability for an Element object to be focused
2265     *
2266     * @param obj The Elementary object to operate on
2267     * @param enable @c EINA_TRUE if the object can be focused, @c
2268     *        EINA_FALSE if not (and on errors)
2269     *
2270     * This sets whether the object @p obj is able to take focus or
2271     * not. Unfocusable objects do nothing when programmatically
2272     * focused, being the nearest focusable parent object the one
2273     * really getting focus. Also, when they receive mouse input, they
2274     * will get the event, but not take away the focus from where it
2275     * was previously.
2276     *
2277     * @ingroup Focus
2278     */
2279    EAPI void             elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2280
2281    /**
2282     * Get whether an Elementary object is focusable or not
2283     *
2284     * @param obj The Elementary object to operate on
2285     * @return @c EINA_TRUE if the object is allowed to be focused, @c
2286     *             EINA_FALSE if not (and on errors)
2287     *
2288     * @note Objects which are meant to be interacted with by input
2289     * events are created able to be focused, by default. All the
2290     * others are not.
2291     *
2292     * @ingroup Focus
2293     */
2294    EAPI Eina_Bool        elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2295
2296    /**
2297     * Set custom focus chain.
2298     *
2299     * This function overwrites any previous custom focus chain within
2300     * the list of objects. The previous list will be deleted and this list
2301     * will be managed by elementary. After it is set, don't modify it.
2302     *
2303     * @note On focus cycle, only will be evaluated children of this container.
2304     *
2305     * @param obj The container object
2306     * @param objs Chain of objects to pass focus
2307     * @ingroup Focus
2308     */
2309    EAPI void             elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2310
2311    /**
2312     * Unset a custom focus chain on a given Elementary widget
2313     *
2314     * @param obj The container object to remove focus chain from
2315     *
2316     * Any focus chain previously set on @p obj (for its child objects)
2317     * is removed entirely after this call.
2318     *
2319     * @ingroup Focus
2320     */
2321    EAPI void             elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2322
2323    /**
2324     * Get custom focus chain
2325     *
2326     * @param obj The container object
2327     * @ingroup Focus
2328     */
2329    EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2330
2331    /**
2332     * Append object to custom focus chain.
2333     *
2334     * @note If relative_child equal to NULL or not in custom chain, the object
2335     * will be added in end.
2336     *
2337     * @note On focus cycle, only will be evaluated children of this container.
2338     *
2339     * @param obj The container object
2340     * @param child The child to be added in custom chain
2341     * @param relative_child The relative object to position the child
2342     * @ingroup Focus
2343     */
2344    EAPI void             elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2345
2346    /**
2347     * Prepend object to custom focus chain.
2348     *
2349     * @note If relative_child equal to NULL or not in custom chain, the object
2350     * will be added in begin.
2351     *
2352     * @note On focus cycle, only will be evaluated children of this container.
2353     *
2354     * @param obj The container object
2355     * @param child The child to be added in custom chain
2356     * @param relative_child The relative object to position the child
2357     * @ingroup Focus
2358     */
2359    EAPI void             elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2360
2361    /**
2362     * Give focus to next object in object tree.
2363     *
2364     * Give focus to next object in focus chain of one object sub-tree.
2365     * If the last object of chain already have focus, the focus will go to the
2366     * first object of chain.
2367     *
2368     * @param obj The object root of sub-tree
2369     * @param dir Direction to cycle the focus
2370     *
2371     * @ingroup Focus
2372     */
2373    EAPI void             elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2374
2375    /**
2376     * Give focus to near object in one direction.
2377     *
2378     * Give focus to near object in direction of one object.
2379     * If none focusable object in given direction, the focus will not change.
2380     *
2381     * @param obj The reference object
2382     * @param x Horizontal component of direction to focus
2383     * @param y Vertical component of direction to focus
2384     *
2385     * @ingroup Focus
2386     */
2387    EAPI void             elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2388
2389    /**
2390     * Make the elementary object and its children to be unfocusable
2391     * (or focusable).
2392     *
2393     * @param obj The Elementary object to operate on
2394     * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2395     *        @c EINA_FALSE for focusable.
2396     *
2397     * This sets whether the object @p obj and its children objects
2398     * are able to take focus or not. If the tree is set as unfocusable,
2399     * newest focused object which is not in this tree will get focus.
2400     * This API can be helpful for an object to be deleted.
2401     * When an object will be deleted soon, it and its children may not
2402     * want to get focus (by focus reverting or by other focus controls).
2403     * Then, just use this API before deleting.
2404     *
2405     * @see elm_object_tree_unfocusable_get()
2406     *
2407     * @ingroup Focus
2408     */
2409    EAPI void             elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2410
2411    /**
2412     * Get whether an Elementary object and its children are unfocusable or not.
2413     *
2414     * @param obj The Elementary object to get the information from
2415     * @return @c EINA_TRUE, if the tree is unfocussable,
2416     *         @c EINA_FALSE if not (and on errors).
2417     *
2418     * @see elm_object_tree_unfocusable_set()
2419     *
2420     * @ingroup Focus
2421     */
2422    EAPI Eina_Bool        elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2423
2424    /**
2425     * @defgroup Scrolling Scrolling
2426     *
2427     * These are functions setting how scrollable views in Elementary
2428     * widgets should behave on user interaction.
2429     *
2430     * @{
2431     */
2432
2433    /**
2434     * Get whether scrollers should bounce when they reach their
2435     * viewport's edge during a scroll.
2436     *
2437     * @return the thumb scroll bouncing state
2438     *
2439     * This is the default behavior for touch screens, in general.
2440     * @ingroup Scrolling
2441     */
2442    EAPI Eina_Bool        elm_scroll_bounce_enabled_get(void);
2443
2444    /**
2445     * Set whether scrollers should bounce when they reach their
2446     * viewport's edge during a scroll.
2447     *
2448     * @param enabled the thumb scroll bouncing state
2449     *
2450     * @see elm_thumbscroll_bounce_enabled_get()
2451     * @ingroup Scrolling
2452     */
2453    EAPI void             elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2454
2455    /**
2456     * Set whether scrollers should bounce when they reach their
2457     * viewport's edge during a scroll, for all Elementary application
2458     * windows.
2459     *
2460     * @param enabled the thumb scroll bouncing state
2461     *
2462     * @see elm_thumbscroll_bounce_enabled_get()
2463     * @ingroup Scrolling
2464     */
2465    EAPI void             elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2466
2467    /**
2468     * Get the amount of inertia a scroller will impose at bounce
2469     * animations.
2470     *
2471     * @return the thumb scroll bounce friction
2472     *
2473     * @ingroup Scrolling
2474     */
2475    EAPI double           elm_scroll_bounce_friction_get(void);
2476
2477    /**
2478     * Set the amount of inertia a scroller will impose at bounce
2479     * animations.
2480     *
2481     * @param friction the thumb scroll bounce friction
2482     *
2483     * @see elm_thumbscroll_bounce_friction_get()
2484     * @ingroup Scrolling
2485     */
2486    EAPI void             elm_scroll_bounce_friction_set(double friction);
2487
2488    /**
2489     * Set the amount of inertia a scroller will impose at bounce
2490     * animations, for all Elementary application windows.
2491     *
2492     * @param friction the thumb scroll bounce friction
2493     *
2494     * @see elm_thumbscroll_bounce_friction_get()
2495     * @ingroup Scrolling
2496     */
2497    EAPI void             elm_scroll_bounce_friction_all_set(double friction);
2498
2499    /**
2500     * Get the amount of inertia a <b>paged</b> scroller will impose at
2501     * page fitting animations.
2502     *
2503     * @return the page scroll friction
2504     *
2505     * @ingroup Scrolling
2506     */
2507    EAPI double           elm_scroll_page_scroll_friction_get(void);
2508
2509    /**
2510     * Set the amount of inertia a <b>paged</b> scroller will impose at
2511     * page fitting animations.
2512     *
2513     * @param friction the page scroll friction
2514     *
2515     * @see elm_thumbscroll_page_scroll_friction_get()
2516     * @ingroup Scrolling
2517     */
2518    EAPI void             elm_scroll_page_scroll_friction_set(double friction);
2519
2520    /**
2521     * Set the amount of inertia a <b>paged</b> scroller will impose at
2522     * page fitting animations, for all Elementary application windows.
2523     *
2524     * @param friction the page scroll friction
2525     *
2526     * @see elm_thumbscroll_page_scroll_friction_get()
2527     * @ingroup Scrolling
2528     */
2529    EAPI void             elm_scroll_page_scroll_friction_all_set(double friction);
2530
2531    /**
2532     * Get the amount of inertia a scroller will impose at region bring
2533     * animations.
2534     *
2535     * @return the bring in scroll friction
2536     *
2537     * @ingroup Scrolling
2538     */
2539    EAPI double           elm_scroll_bring_in_scroll_friction_get(void);
2540
2541    /**
2542     * Set the amount of inertia a scroller will impose at region bring
2543     * animations.
2544     *
2545     * @param friction the bring in scroll friction
2546     *
2547     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2548     * @ingroup Scrolling
2549     */
2550    EAPI void             elm_scroll_bring_in_scroll_friction_set(double friction);
2551
2552    /**
2553     * Set the amount of inertia a scroller will impose at region bring
2554     * animations, for all Elementary application windows.
2555     *
2556     * @param friction the bring in scroll friction
2557     *
2558     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2559     * @ingroup Scrolling
2560     */
2561    EAPI void             elm_scroll_bring_in_scroll_friction_all_set(double friction);
2562
2563    /**
2564     * Get the amount of inertia scrollers will impose at animations
2565     * triggered by Elementary widgets' zooming API.
2566     *
2567     * @return the zoom friction
2568     *
2569     * @ingroup Scrolling
2570     */
2571    EAPI double           elm_scroll_zoom_friction_get(void);
2572
2573    /**
2574     * Set the amount of inertia scrollers will impose at animations
2575     * triggered by Elementary widgets' zooming API.
2576     *
2577     * @param friction the zoom friction
2578     *
2579     * @see elm_thumbscroll_zoom_friction_get()
2580     * @ingroup Scrolling
2581     */
2582    EAPI void             elm_scroll_zoom_friction_set(double friction);
2583
2584    /**
2585     * Set the amount of inertia scrollers will impose at animations
2586     * triggered by Elementary widgets' zooming API, for all Elementary
2587     * application windows.
2588     *
2589     * @param friction the zoom friction
2590     *
2591     * @see elm_thumbscroll_zoom_friction_get()
2592     * @ingroup Scrolling
2593     */
2594    EAPI void             elm_scroll_zoom_friction_all_set(double friction);
2595
2596    /**
2597     * Get whether scrollers should be draggable from any point in their
2598     * views.
2599     *
2600     * @return the thumb scroll state
2601     *
2602     * @note This is the default behavior for touch screens, in general.
2603     * @note All other functions namespaced with "thumbscroll" will only
2604     *       have effect if this mode is enabled.
2605     *
2606     * @ingroup Scrolling
2607     */
2608    EAPI Eina_Bool        elm_scroll_thumbscroll_enabled_get(void);
2609
2610    /**
2611     * Set whether scrollers should be draggable from any point in their
2612     * views.
2613     *
2614     * @param enabled the thumb scroll state
2615     *
2616     * @see elm_thumbscroll_enabled_get()
2617     * @ingroup Scrolling
2618     */
2619    EAPI void             elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2620
2621    /**
2622     * Set whether scrollers should be draggable from any point in their
2623     * views, for all Elementary application windows.
2624     *
2625     * @param enabled the thumb scroll state
2626     *
2627     * @see elm_thumbscroll_enabled_get()
2628     * @ingroup Scrolling
2629     */
2630    EAPI void             elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2631
2632    /**
2633     * Get the number of pixels one should travel while dragging a
2634     * scroller's view to actually trigger scrolling.
2635     *
2636     * @return the thumb scroll threshould
2637     *
2638     * One would use higher values for touch screens, in general, because
2639     * of their inherent imprecision.
2640     * @ingroup Scrolling
2641     */
2642    EAPI unsigned int     elm_scroll_thumbscroll_threshold_get(void);
2643
2644    /**
2645     * Set the number of pixels one should travel while dragging a
2646     * scroller's view to actually trigger scrolling.
2647     *
2648     * @param threshold the thumb scroll threshould
2649     *
2650     * @see elm_thumbscroll_threshould_get()
2651     * @ingroup Scrolling
2652     */
2653    EAPI void             elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2654
2655    /**
2656     * Set the number of pixels one should travel while dragging a
2657     * scroller's view to actually trigger scrolling, for all Elementary
2658     * application windows.
2659     *
2660     * @param threshold the thumb scroll threshould
2661     *
2662     * @see elm_thumbscroll_threshould_get()
2663     * @ingroup Scrolling
2664     */
2665    EAPI void             elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2666
2667    /**
2668     * Get the minimum speed of mouse cursor movement which will trigger
2669     * list self scrolling animation after a mouse up event
2670     * (pixels/second).
2671     *
2672     * @return the thumb scroll momentum threshould
2673     *
2674     * @ingroup Scrolling
2675     */
2676    EAPI double           elm_scroll_thumbscroll_momentum_threshold_get(void);
2677
2678    /**
2679     * Set the minimum speed of mouse cursor movement which will trigger
2680     * list self scrolling animation after a mouse up event
2681     * (pixels/second).
2682     *
2683     * @param threshold the thumb scroll momentum threshould
2684     *
2685     * @see elm_thumbscroll_momentum_threshould_get()
2686     * @ingroup Scrolling
2687     */
2688    EAPI void             elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2689
2690    /**
2691     * Set the minimum speed of mouse cursor movement which will trigger
2692     * list self scrolling animation after a mouse up event
2693     * (pixels/second), for all Elementary application windows.
2694     *
2695     * @param threshold the thumb scroll momentum threshould
2696     *
2697     * @see elm_thumbscroll_momentum_threshould_get()
2698     * @ingroup Scrolling
2699     */
2700    EAPI void             elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2701
2702    /**
2703     * Get the amount of inertia a scroller will impose at self scrolling
2704     * animations.
2705     *
2706     * @return the thumb scroll friction
2707     *
2708     * @ingroup Scrolling
2709     */
2710    EAPI double           elm_scroll_thumbscroll_friction_get(void);
2711
2712    /**
2713     * Set the amount of inertia a scroller will impose at self scrolling
2714     * animations.
2715     *
2716     * @param friction the thumb scroll friction
2717     *
2718     * @see elm_thumbscroll_friction_get()
2719     * @ingroup Scrolling
2720     */
2721    EAPI void             elm_scroll_thumbscroll_friction_set(double friction);
2722
2723    /**
2724     * Set the amount of inertia a scroller will impose at self scrolling
2725     * animations, for all Elementary application windows.
2726     *
2727     * @param friction the thumb scroll friction
2728     *
2729     * @see elm_thumbscroll_friction_get()
2730     * @ingroup Scrolling
2731     */
2732    EAPI void             elm_scroll_thumbscroll_friction_all_set(double friction);
2733
2734    /**
2735     * Get the amount of lag between your actual mouse cursor dragging
2736     * movement and a scroller's view movement itself, while pushing it
2737     * into bounce state manually.
2738     *
2739     * @return the thumb scroll border friction
2740     *
2741     * @ingroup Scrolling
2742     */
2743    EAPI double           elm_scroll_thumbscroll_border_friction_get(void);
2744
2745    /**
2746     * Set the amount of lag between your actual mouse cursor dragging
2747     * movement and a scroller's view movement itself, while pushing it
2748     * into bounce state manually.
2749     *
2750     * @param friction the thumb scroll border friction. @c 0.0 for
2751     *        perfect synchrony between two movements, @c 1.0 for maximum
2752     *        lag.
2753     *
2754     * @see elm_thumbscroll_border_friction_get()
2755     * @note parameter value will get bound to 0.0 - 1.0 interval, always
2756     *
2757     * @ingroup Scrolling
2758     */
2759    EAPI void             elm_scroll_thumbscroll_border_friction_set(double friction);
2760
2761    /**
2762     * Set the amount of lag between your actual mouse cursor dragging
2763     * movement and a scroller's view movement itself, while pushing it
2764     * into bounce state manually, for all Elementary application windows.
2765     *
2766     * @param friction the thumb scroll border friction. @c 0.0 for
2767     *        perfect synchrony between two movements, @c 1.0 for maximum
2768     *        lag.
2769     *
2770     * @see elm_thumbscroll_border_friction_get()
2771     * @note parameter value will get bound to 0.0 - 1.0 interval, always
2772     *
2773     * @ingroup Scrolling
2774     */
2775    EAPI void             elm_scroll_thumbscroll_border_friction_all_set(double friction);
2776
2777    /**
2778     * @}
2779     */
2780
2781    /**
2782     * @defgroup Scrollhints Scrollhints
2783     *
2784     * Objects when inside a scroller can scroll, but this may not always be
2785     * desirable in certain situations. This allows an object to hint to itself
2786     * and parents to "not scroll" in one of 2 ways. If any child object of a
2787     * scroller has pushed a scroll freeze or hold then it affects all parent
2788     * scrollers until all children have released them.
2789     *
2790     * 1. To hold on scrolling. This means just flicking and dragging may no
2791     * longer scroll, but pressing/dragging near an edge of the scroller will
2792     * still scroll. This is automatically used by the entry object when
2793     * selecting text.
2794     *
2795     * 2. To totally freeze scrolling. This means it stops. until
2796     * popped/released.
2797     *
2798     * @{
2799     */
2800
2801    /**
2802     * Push the scroll hold by 1
2803     *
2804     * This increments the scroll hold count by one. If it is more than 0 it will
2805     * take effect on the parents of the indicated object.
2806     *
2807     * @param obj The object
2808     * @ingroup Scrollhints
2809     */
2810    EAPI void             elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2811
2812    /**
2813     * Pop the scroll hold by 1
2814     *
2815     * This decrements the scroll hold count by one. If it is more than 0 it will
2816     * take effect on the parents of the indicated object.
2817     *
2818     * @param obj The object
2819     * @ingroup Scrollhints
2820     */
2821    EAPI void             elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2822
2823    /**
2824     * Push the scroll freeze by 1
2825     *
2826     * This increments the scroll freeze count by one. If it is more
2827     * than 0 it will take effect on the parents of the indicated
2828     * object.
2829     *
2830     * @param obj The object
2831     * @ingroup Scrollhints
2832     */
2833    EAPI void             elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2834
2835    /**
2836     * Pop the scroll freeze by 1
2837     *
2838     * This decrements the scroll freeze count by one. If it is more
2839     * than 0 it will take effect on the parents of the indicated
2840     * object.
2841     *
2842     * @param obj The object
2843     * @ingroup Scrollhints
2844     */
2845    EAPI void             elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2846
2847    /**
2848     * Lock the scrolling of the given widget (and thus all parents)
2849     *
2850     * This locks the given object from scrolling in the X axis (and implicitly
2851     * also locks all parent scrollers too from doing the same).
2852     *
2853     * @param obj The object
2854     * @param lock The lock state (1 == locked, 0 == unlocked)
2855     * @ingroup Scrollhints
2856     */
2857    EAPI void             elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2858
2859    /**
2860     * Lock the scrolling of the given widget (and thus all parents)
2861     *
2862     * This locks the given object from scrolling in the Y axis (and implicitly
2863     * also locks all parent scrollers too from doing the same).
2864     *
2865     * @param obj The object
2866     * @param lock The lock state (1 == locked, 0 == unlocked)
2867     * @ingroup Scrollhints
2868     */
2869    EAPI void             elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2870
2871    /**
2872     * Get the scrolling lock of the given widget
2873     *
2874     * This gets the lock for X axis scrolling.
2875     *
2876     * @param obj The object
2877     * @ingroup Scrollhints
2878     */
2879    EAPI Eina_Bool        elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2880
2881    /**
2882     * Get the scrolling lock of the given widget
2883     *
2884     * This gets the lock for X axis scrolling.
2885     *
2886     * @param obj The object
2887     * @ingroup Scrollhints
2888     */
2889    EAPI Eina_Bool        elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2890
2891    /**
2892     * @}
2893     */
2894
2895    /**
2896     * Send a signal to the widget edje object.
2897     *
2898     * This function sends a signal to the edje object of the obj. An
2899     * edje program can respond to a signal by specifying matching
2900     * 'signal' and 'source' fields.
2901     *
2902     * @param obj The object
2903     * @param emission The signal's name.
2904     * @param source The signal's source.
2905     * @ingroup General
2906     */
2907    EAPI void             elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
2908
2909    /**
2910     * Add a callback for a signal emitted by widget edje object.
2911     *
2912     * This function connects a callback function to a signal emitted by the
2913     * edje object of the obj.
2914     * Globs can occur in either the emission or source name.
2915     *
2916     * @param obj The object
2917     * @param emission The signal's name.
2918     * @param source The signal's source.
2919     * @param func The callback function to be executed when the signal is
2920     * emitted.
2921     * @param data A pointer to data to pass in to the callback function.
2922     * @ingroup General
2923     */
2924    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);
2925
2926    /**
2927     * Remove a signal-triggered callback from a widget edje object.
2928     *
2929     * This function removes a callback, previoulsy attached to a
2930     * signal emitted by the edje object of the obj.  The parameters
2931     * emission, source and func must match exactly those passed to a
2932     * previous call to elm_object_signal_callback_add(). The data
2933     * pointer that was passed to this call will be returned.
2934     *
2935     * @param obj The object
2936     * @param emission The signal's name.
2937     * @param source The signal's source.
2938     * @param func The callback function to be executed when the signal is
2939     * emitted.
2940     * @return The data pointer
2941     * @ingroup General
2942     */
2943    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);
2944
2945    /**
2946     * Add a callback for input events (key up, key down, mouse wheel)
2947     * on a given Elementary widget
2948     *
2949     * @param obj The widget to add an event callback on
2950     * @param func The callback function to be executed when the event
2951     * happens
2952     * @param data Data to pass in to @p func
2953     *
2954     * Every widget in an Elementary interface set to receive focus,
2955     * with elm_object_focus_allow_set(), will propagate @b all of its
2956     * key up, key down and mouse wheel input events up to its parent
2957     * object, and so on. All of the focusable ones in this chain which
2958     * had an event callback set, with this call, will be able to treat
2959     * those events. There are two ways of making the propagation of
2960     * these event upwards in the tree of widgets to @b cease:
2961     * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
2962     *   the event was @b not processed, so the propagation will go on.
2963     * - The @c event_info pointer passed to @p func will contain the
2964     *   event's structure and, if you OR its @c event_flags inner
2965     *   value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
2966     *   one has already handled it, thus killing the event's
2967     *   propagation, too.
2968     *
2969     * @note Your event callback will be issued on those events taking
2970     * place only if no other child widget of @obj has consumed the
2971     * event already.
2972     *
2973     * @note Not to be confused with @c
2974     * evas_object_event_callback_add(), which will add event callbacks
2975     * per type on general Evas objects (no event propagation
2976     * infrastructure taken in account).
2977     *
2978     * @note Not to be confused with @c
2979     * elm_object_signal_callback_add(), which will add callbacks to @b
2980     * signals coming from a widget's theme, not input events.
2981     *
2982     * @note Not to be confused with @c
2983     * edje_object_signal_callback_add(), which does the same as
2984     * elm_object_signal_callback_add(), but directly on an Edje
2985     * object.
2986     *
2987     * @note Not to be confused with @c
2988     * evas_object_smart_callback_add(), which adds callbacks to smart
2989     * objects' <b>smart events</b>, and not input events.
2990     *
2991     * @see elm_object_event_callback_del()
2992     *
2993     * @ingroup General
2994     */
2995    EAPI void             elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
2996
2997    /**
2998     * Remove an event callback from a widget.
2999     *
3000     * This function removes a callback, previoulsy attached to event emission
3001     * by the @p obj.
3002     * The parameters func and data must match exactly those passed to
3003     * a previous call to elm_object_event_callback_add(). The data pointer that
3004     * was passed to this call will be returned.
3005     *
3006     * @param obj The object
3007     * @param func The callback function to be executed when the event is
3008     * emitted.
3009     * @param data Data to pass in to the callback function.
3010     * @return The data pointer
3011     * @ingroup General
3012     */
3013    EAPI void            *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3014
3015    /**
3016     * Adjust size of an element for finger usage.
3017     *
3018     * @param times_w How many fingers should fit horizontally
3019     * @param w Pointer to the width size to adjust
3020     * @param times_h How many fingers should fit vertically
3021     * @param h Pointer to the height size to adjust
3022     *
3023     * This takes width and height sizes (in pixels) as input and a
3024     * size multiple (which is how many fingers you want to place
3025     * within the area, being "finger" the size set by
3026     * elm_finger_size_set()), and adjusts the size to be large enough
3027     * to accommodate the resulting size -- if it doesn't already
3028     * accommodate it. On return the @p w and @p h sizes pointed to by
3029     * these parameters will be modified, on those conditions.
3030     *
3031     * @note This is kind of a low level Elementary call, most useful
3032     * on size evaluation times for widgets. An external user wouldn't
3033     * be calling, most of the time.
3034     *
3035     * @ingroup Fingers
3036     */
3037    EAPI void             elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3038
3039    /**
3040     * Get the duration for occuring long press event.
3041     *
3042     * @return Timeout for long press event
3043     * @ingroup Longpress
3044     */
3045    EAPI double           elm_longpress_timeout_get(void);
3046
3047    /**
3048     * Set the duration for occuring long press event.
3049     *
3050     * @param lonpress_timeout Timeout for long press event
3051     * @ingroup Longpress
3052     */
3053    EAPI void             elm_longpress_timeout_set(double longpress_timeout);
3054
3055    /**
3056     * @defgroup Debug Debug
3057     * don't use it unless you are sure
3058     *
3059     * @{
3060     */
3061
3062    /**
3063     * Print Tree object hierarchy in stdout
3064     *
3065     * @param obj The root object
3066     * @ingroup Debug
3067     */
3068    EAPI void             elm_object_tree_dump(const Evas_Object *top);
3069
3070    /**
3071     * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3072     *
3073     * @param obj The root object
3074     * @param file The path of output file
3075     * @ingroup Debug
3076     */
3077    EAPI void             elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3078
3079    /**
3080     * @}
3081     */
3082
3083    /**
3084     * @defgroup Theme Theme
3085     *
3086     * Elementary uses Edje to theme its widgets, naturally. But for the most
3087     * part this is hidden behind a simpler interface that lets the user set
3088     * extensions and choose the style of widgets in a much easier way.
3089     *
3090     * Instead of thinking in terms of paths to Edje files and their groups
3091     * each time you want to change the appearance of a widget, Elementary
3092     * works so you can add any theme file with extensions or replace the
3093     * main theme at one point in the application, and then just set the style
3094     * of widgets with elm_object_style_set() and related functions. Elementary
3095     * will then look in its list of themes for a matching group and apply it,
3096     * and when the theme changes midway through the application, all widgets
3097     * will be updated accordingly.
3098     *
3099     * There are three concepts you need to know to understand how Elementary
3100     * theming works: default theme, extensions and overlays.
3101     *
3102     * Default theme, obviously enough, is the one that provides the default
3103     * look of all widgets. End users can change the theme used by Elementary
3104     * by setting the @c ELM_THEME environment variable before running an
3105     * application, or globally for all programs using the @c elementary_config
3106     * utility. Applications can change the default theme using elm_theme_set(),
3107     * but this can go against the user wishes, so it's not an adviced practice.
3108     *
3109     * Ideally, applications should find everything they need in the already
3110     * provided theme, but there may be occasions when that's not enough and
3111     * custom styles are required to correctly express the idea. For this
3112     * cases, Elementary has extensions.
3113     *
3114     * Extensions allow the application developer to write styles of its own
3115     * to apply to some widgets. This requires knowledge of how each widget
3116     * is themed, as extensions will always replace the entire group used by
3117     * the widget, so important signals and parts need to be there for the
3118     * object to behave properly (see documentation of Edje for details).
3119     * Once the theme for the extension is done, the application needs to add
3120     * it to the list of themes Elementary will look into, using
3121     * elm_theme_extension_add(), and set the style of the desired widgets as
3122     * he would normally with elm_object_style_set().
3123     *
3124     * Overlays, on the other hand, can replace the look of all widgets by
3125     * overriding the default style. Like extensions, it's up to the application
3126     * developer to write the theme for the widgets it wants, the difference
3127     * being that when looking for the theme, Elementary will check first the
3128     * list of overlays, then the set theme and lastly the list of extensions,
3129     * so with overlays it's possible to replace the default view and every
3130     * widget will be affected. This is very much alike to setting the whole
3131     * theme for the application and will probably clash with the end user
3132     * options, not to mention the risk of ending up with not matching styles
3133     * across the program. Unless there's a very special reason to use them,
3134     * overlays should be avoided for the resons exposed before.
3135     *
3136     * All these theme lists are handled by ::Elm_Theme instances. Elementary
3137     * keeps one default internally and every function that receives one of
3138     * these can be called with NULL to refer to this default (except for
3139     * elm_theme_free()). It's possible to create a new instance of a
3140     * ::Elm_Theme to set other theme for a specific widget (and all of its
3141     * children), but this is as discouraged, if not even more so, than using
3142     * overlays. Don't use this unless you really know what you are doing.
3143     *
3144     * But to be less negative about things, you can look at the following
3145     * examples:
3146     * @li @ref theme_example_01 "Using extensions"
3147     * @li @ref theme_example_02 "Using overlays"
3148     *
3149     * @{
3150     */
3151    /**
3152     * @typedef Elm_Theme
3153     *
3154     * Opaque handler for the list of themes Elementary looks for when
3155     * rendering widgets.
3156     *
3157     * Stay out of this unless you really know what you are doing. For most
3158     * cases, sticking to the default is all a developer needs.
3159     */
3160    typedef struct _Elm_Theme Elm_Theme;
3161
3162    /**
3163     * Create a new specific theme
3164     *
3165     * This creates an empty specific theme that only uses the default theme. A
3166     * specific theme has its own private set of extensions and overlays too
3167     * (which are empty by default). Specific themes do not fall back to themes
3168     * of parent objects. They are not intended for this use. Use styles, overlays
3169     * and extensions when needed, but avoid specific themes unless there is no
3170     * other way (example: you want to have a preview of a new theme you are
3171     * selecting in a "theme selector" window. The preview is inside a scroller
3172     * and should display what the theme you selected will look like, but not
3173     * actually apply it yet. The child of the scroller will have a specific
3174     * theme set to show this preview before the user decides to apply it to all
3175     * applications).
3176     */
3177    EAPI Elm_Theme       *elm_theme_new(void);
3178    /**
3179     * Free a specific theme
3180     *
3181     * @param th The theme to free
3182     *
3183     * This frees a theme created with elm_theme_new().
3184     */
3185    EAPI void             elm_theme_free(Elm_Theme *th);
3186    /**
3187     * Copy the theme fom the source to the destination theme
3188     *
3189     * @param th The source theme to copy from
3190     * @param thdst The destination theme to copy data to
3191     *
3192     * This makes a one-time static copy of all the theme config, extensions
3193     * and overlays from @p th to @p thdst. If @p th references a theme, then
3194     * @p thdst is also set to reference it, with all the theme settings,
3195     * overlays and extensions that @p th had.
3196     */
3197    EAPI void             elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3198    /**
3199     * Tell the source theme to reference the ref theme
3200     *
3201     * @param th The theme that will do the referencing
3202     * @param thref The theme that is the reference source
3203     *
3204     * This clears @p th to be empty and then sets it to refer to @p thref
3205     * so @p th acts as an override to @p thref, but where its overrides
3206     * don't apply, it will fall through to @p thref for configuration.
3207     */
3208    EAPI void             elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3209    /**
3210     * Return the theme referred to
3211     *
3212     * @param th The theme to get the reference from
3213     * @return The referenced theme handle
3214     *
3215     * This gets the theme set as the reference theme by elm_theme_ref_set().
3216     * If no theme is set as a reference, NULL is returned.
3217     */
3218    EAPI Elm_Theme       *elm_theme_ref_get(Elm_Theme *th);
3219    /**
3220     * Return the default theme
3221     *
3222     * @return The default theme handle
3223     *
3224     * This returns the internal default theme setup handle that all widgets
3225     * use implicitly unless a specific theme is set. This is also often use
3226     * as a shorthand of NULL.
3227     */
3228    EAPI Elm_Theme       *elm_theme_default_get(void);
3229    /**
3230     * Prepends a theme overlay to the list of overlays
3231     *
3232     * @param th The theme to add to, or if NULL, the default theme
3233     * @param item The Edje file path to be used
3234     *
3235     * Use this if your application needs to provide some custom overlay theme
3236     * (An Edje file that replaces some default styles of widgets) where adding
3237     * new styles, or changing system theme configuration is not possible. Do
3238     * NOT use this instead of a proper system theme configuration. Use proper
3239     * configuration files, profiles, environment variables etc. to set a theme
3240     * so that the theme can be altered by simple confiugration by a user. Using
3241     * this call to achieve that effect is abusing the API and will create lots
3242     * of trouble.
3243     *
3244     * @see elm_theme_extension_add()
3245     */
3246    EAPI void             elm_theme_overlay_add(Elm_Theme *th, const char *item);
3247    /**
3248     * Delete a theme overlay from the list of overlays
3249     *
3250     * @param th The theme to delete from, or if NULL, the default theme
3251     * @param item The name of the theme overlay
3252     *
3253     * @see elm_theme_overlay_add()
3254     */
3255    EAPI void             elm_theme_overlay_del(Elm_Theme *th, const char *item);
3256    /**
3257     * Appends a theme extension to the list of extensions.
3258     *
3259     * @param th The theme to add to, or if NULL, the default theme
3260     * @param item The Edje file path to be used
3261     *
3262     * This is intended when an application needs more styles of widgets or new
3263     * widget themes that the default does not provide (or may not provide). The
3264     * application has "extended" usage by coming up with new custom style names
3265     * for widgets for specific uses, but as these are not "standard", they are
3266     * not guaranteed to be provided by a default theme. This means the
3267     * application is required to provide these extra elements itself in specific
3268     * Edje files. This call adds one of those Edje files to the theme search
3269     * path to be search after the default theme. The use of this call is
3270     * encouraged when default styles do not meet the needs of the application.
3271     * Use this call instead of elm_theme_overlay_add() for almost all cases.
3272     *
3273     * @see elm_object_style_set()
3274     */
3275    EAPI void             elm_theme_extension_add(Elm_Theme *th, const char *item);
3276    /**
3277     * Deletes a theme extension from the list of extensions.
3278     *
3279     * @param th The theme to delete from, or if NULL, the default theme
3280     * @param item The name of the theme extension
3281     *
3282     * @see elm_theme_extension_add()
3283     */
3284    EAPI void             elm_theme_extension_del(Elm_Theme *th, const char *item);
3285    /**
3286     * Set the theme search order for the given theme
3287     *
3288     * @param th The theme to set the search order, or if NULL, the default theme
3289     * @param theme Theme search string
3290     *
3291     * This sets the search string for the theme in path-notation from first
3292     * theme to search, to last, delimited by the : character. Example:
3293     *
3294     * "shiny:/path/to/file.edj:default"
3295     *
3296     * See the ELM_THEME environment variable for more information.
3297     *
3298     * @see elm_theme_get()
3299     * @see elm_theme_list_get()
3300     */
3301    EAPI void             elm_theme_set(Elm_Theme *th, const char *theme);
3302    /**
3303     * Return the theme search order
3304     *
3305     * @param th The theme to get the search order, or if NULL, the default theme
3306     * @return The internal search order path
3307     *
3308     * This function returns a colon separated string of theme elements as
3309     * returned by elm_theme_list_get().
3310     *
3311     * @see elm_theme_set()
3312     * @see elm_theme_list_get()
3313     */
3314    EAPI const char      *elm_theme_get(Elm_Theme *th);
3315    /**
3316     * Return a list of theme elements to be used in a theme.
3317     *
3318     * @param th Theme to get the list of theme elements from.
3319     * @return The internal list of theme elements
3320     *
3321     * This returns the internal list of theme elements (will only be valid as
3322     * long as the theme is not modified by elm_theme_set() or theme is not
3323     * freed by elm_theme_free(). This is a list of strings which must not be
3324     * altered as they are also internal. If @p th is NULL, then the default
3325     * theme element list is returned.
3326     *
3327     * A theme element can consist of a full or relative path to a .edj file,
3328     * or a name, without extension, for a theme to be searched in the known
3329     * theme paths for Elemementary.
3330     *
3331     * @see elm_theme_set()
3332     * @see elm_theme_get()
3333     */
3334    EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3335    /**
3336     * Return the full patrh for a theme element
3337     *
3338     * @param f The theme element name
3339     * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3340     * @return The full path to the file found.
3341     *
3342     * This returns a string you should free with free() on success, NULL on
3343     * failure. This will search for the given theme element, and if it is a
3344     * full or relative path element or a simple searchable name. The returned
3345     * path is the full path to the file, if searched, and the file exists, or it
3346     * is simply the full path given in the element or a resolved path if
3347     * relative to home. The @p in_search_path boolean pointed to is set to
3348     * EINA_TRUE if the file was a searchable file andis in the search path,
3349     * and EINA_FALSE otherwise.
3350     */
3351    EAPI char            *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3352    /**
3353     * Flush the current theme.
3354     *
3355     * @param th Theme to flush
3356     *
3357     * This flushes caches that let elementary know where to find theme elements
3358     * in the given theme. If @p th is NULL, then the default theme is flushed.
3359     * Call this function if source theme data has changed in such a way as to
3360     * make any caches Elementary kept invalid.
3361     */
3362    EAPI void             elm_theme_flush(Elm_Theme *th);
3363    /**
3364     * This flushes all themes (default and specific ones).
3365     *
3366     * This will flush all themes in the current application context, by calling
3367     * elm_theme_flush() on each of them.
3368     */
3369    EAPI void             elm_theme_full_flush(void);
3370    /**
3371     * Set the theme for all elementary using applications on the current display
3372     *
3373     * @param theme The name of the theme to use. Format same as the ELM_THEME
3374     * environment variable.
3375     */
3376    EAPI void             elm_theme_all_set(const char *theme);
3377    /**
3378     * Return a list of theme elements in the theme search path
3379     *
3380     * @return A list of strings that are the theme element names.
3381     *
3382     * This lists all available theme files in the standard Elementary search path
3383     * for theme elements, and returns them in alphabetical order as theme
3384     * element names in a list of strings. Free this with
3385     * elm_theme_name_available_list_free() when you are done with the list.
3386     */
3387    EAPI Eina_List       *elm_theme_name_available_list_new(void);
3388    /**
3389     * Free the list returned by elm_theme_name_available_list_new()
3390     *
3391     * This frees the list of themes returned by
3392     * elm_theme_name_available_list_new(). Once freed the list should no longer
3393     * be used. a new list mys be created.
3394     */
3395    EAPI void             elm_theme_name_available_list_free(Eina_List *list);
3396    /**
3397     * Set a specific theme to be used for this object and its children
3398     *
3399     * @param obj The object to set the theme on
3400     * @param th The theme to set
3401     *
3402     * This sets a specific theme that will be used for the given object and any
3403     * child objects it has. If @p th is NULL then the theme to be used is
3404     * cleared and the object will inherit its theme from its parent (which
3405     * ultimately will use the default theme if no specific themes are set).
3406     *
3407     * Use special themes with great care as this will annoy users and make
3408     * configuration difficult. Avoid any custom themes at all if it can be
3409     * helped.
3410     */
3411    EAPI void             elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3412    /**
3413     * Get the specific theme to be used
3414     *
3415     * @param obj The object to get the specific theme from
3416     * @return The specifc theme set.
3417     *
3418     * This will return a specific theme set, or NULL if no specific theme is
3419     * set on that object. It will not return inherited themes from parents, only
3420     * the specific theme set for that specific object. See elm_object_theme_set()
3421     * for more information.
3422     */
3423    EAPI Elm_Theme       *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3424    /**
3425     * @}
3426     */
3427
3428    /* win */
3429    /** @defgroup Win Win
3430     *
3431     * @image html img/widget/win/preview-00.png
3432     * @image latex img/widget/win/preview-00.eps
3433     *
3434     * The window class of Elementary.  Contains functions to manipulate
3435     * windows. The Evas engine used to render the window contents is specified
3436     * in the system or user elementary config files (whichever is found last),
3437     * and can be overridden with the ELM_ENGINE environment variable for
3438     * testing.  Engines that may be supported (depending on Evas and Ecore-Evas
3439     * compilation setup and modules actually installed at runtime) are (listed
3440     * in order of best supported and most likely to be complete and work to
3441     * lowest quality).
3442     *
3443     * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3444     * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3445     * rendering in X11)
3446     * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3447     * exits)
3448     * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3449     * rendering)
3450     * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3451     * buffer)
3452     * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3453     * rendering using SDL as the buffer)
3454     * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3455     * GDI with software)
3456     * @li "dfb", "directfb" (Rendering to a DirectFB window)
3457     * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3458     * grayscale using dedicated 8bit software engine in X11)
3459     * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3460     * X11 using 16bit software engine)
3461     * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3462     * (Windows CE rendering via GDI with 16bit software renderer)
3463     * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3464     * buffer with 16bit software renderer)
3465     *
3466     * All engines use a simple string to select the engine to render, EXCEPT
3467     * the "shot" engine. This actually encodes the output of the virtual
3468     * screenshot and how long to delay in the engine string. The engine string
3469     * is encoded in the following way:
3470     *
3471     *   "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3472     *
3473     * Where options are separated by a ":" char if more than one option is
3474     * given, with delay, if provided being the first option and file the last
3475     * (order is important). The delay specifies how long to wait after the
3476     * window is shown before doing the virtual "in memory" rendering and then
3477     * save the output to the file specified by the file option (and then exit).
3478     * If no delay is given, the default is 0.5 seconds. If no file is given the
3479     * default output file is "out.png". Repeat option is for continous
3480     * capturing screenshots. Repeat range is from 1 to 999 and filename is
3481     * fixed to "out001.png" Some examples of using the shot engine:
3482     *
3483     *   ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3484     *   ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3485     *   ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3486     *   ELM_ENGINE="shot:delay=2.0" elementary_test
3487     *   ELM_ENGINE="shot:" elementary_test
3488     *
3489     * Signals that you can add callbacks for are:
3490     *
3491     * @li "delete,request": the user requested to close the window. See
3492     * elm_win_autodel_set().
3493     * @li "focus,in": window got focus
3494     * @li "focus,out": window lost focus
3495     * @li "moved": window that holds the canvas was moved
3496     *
3497     * Examples:
3498     * @li @ref win_example_01
3499     *
3500     * @{
3501     */
3502    /**
3503     * Defines the types of window that can be created
3504     *
3505     * These are hints set on the window so that a running Window Manager knows
3506     * how the window should be handled and/or what kind of decorations it
3507     * should have.
3508     *
3509     * Currently, only the X11 backed engines use them.
3510     */
3511    typedef enum _Elm_Win_Type
3512      {
3513         ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3514                          window. Almost every window will be created with this
3515                          type. */
3516         ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3517         ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3518                            window holding desktop icons. */
3519         ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3520                         be kept on top of any other window by the Window
3521                         Manager. */
3522         ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3523                            similar. */
3524         ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3525         ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3526                            pallete. */
3527         ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3528         ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3529                                  entry in a menubar is clicked. Typically used
3530                                  with elm_win_override_set(). This hint exists
3531                                  for completion only, as the EFL way of
3532                                  implementing a menu would not normally use a
3533                                  separate window for its contents. */
3534         ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3535                               triggered by right-clicking an object. */
3536         ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3537                            explanatory text that typically appear after the
3538                            mouse cursor hovers over an object for a while.
3539                            Typically used with elm_win_override_set() and also
3540                            not very commonly used in the EFL. */
3541         ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3542                                 battery life or a new E-Mail received. */
3543         ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3544                          usually used in the EFL. */
3545         ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3546                        object being dragged across different windows, or even
3547                        applications. Typically used with
3548                        elm_win_override_set(). */
3549         ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3550                                  buffer. No actual window is created for this
3551                                  type, instead the window and all of its
3552                                  contents will be rendered to an image buffer.
3553                                  This allows to have children window inside a
3554                                  parent one just like any other object would
3555                                  be, and do other things like applying @c
3556                                  Evas_Map effects to it. This is the only type
3557                                  of window that requires the @c parent
3558                                  parameter of elm_win_add() to be a valid @c
3559                                  Evas_Object. */
3560      } Elm_Win_Type;
3561
3562    /**
3563     * The differents layouts that can be requested for the virtual keyboard.
3564     *
3565     * When the application window is being managed by Illume, it may request
3566     * any of the following layouts for the virtual keyboard.
3567     */
3568    typedef enum _Elm_Win_Keyboard_Mode
3569      {
3570         ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3571         ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3572         ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3573         ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3574         ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3575         ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3576         ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3577         ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3578         ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3579         ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3580         ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3581         ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3582         ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3583         ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3584         ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3585         ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3586      } Elm_Win_Keyboard_Mode;
3587
3588    /**
3589     * Available commands that can be sent to the Illume manager.
3590     *
3591     * When running under an Illume session, a window may send commands to the
3592     * Illume manager to perform different actions.
3593     */
3594    typedef enum _Elm_Illume_Command
3595      {
3596         ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3597                                          window */
3598         ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3599                                             in the list */
3600         ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3601                                          screen */
3602         ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3603      } Elm_Illume_Command;
3604
3605    /**
3606     * Adds a window object. If this is the first window created, pass NULL as
3607     * @p parent.
3608     *
3609     * @param parent Parent object to add the window to, or NULL
3610     * @param name The name of the window
3611     * @param type The window type, one of #Elm_Win_Type.
3612     *
3613     * The @p parent paramter can be @c NULL for every window @p type except
3614     * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3615     * which the image object will be created.
3616     *
3617     * @return The created object, or NULL on failure
3618     */
3619    EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3620    /**
3621     * Add @p subobj as a resize object of window @p obj.
3622     *
3623     *
3624     * Setting an object as a resize object of the window means that the
3625     * @p subobj child's size and position will be controlled by the window
3626     * directly. That is, the object will be resized to match the window size
3627     * and should never be moved or resized manually by the developer.
3628     *
3629     * In addition, resize objects of the window control what the minimum size
3630     * of it will be, as well as whether it can or not be resized by the user.
3631     *
3632     * For the end user to be able to resize a window by dragging the handles
3633     * or borders provided by the Window Manager, or using any other similar
3634     * mechanism, all of the resize objects in the window should have their
3635     * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3636     *
3637     * @param obj The window object
3638     * @param subobj The resize object to add
3639     */
3640    EAPI void         elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3641    /**
3642     * Delete @p subobj as a resize object of window @p obj.
3643     *
3644     * This function removes the object @p subobj from the resize objects of
3645     * the window @p obj. It will not delete the object itself, which will be
3646     * left unmanaged and should be deleted by the developer, manually handled
3647     * or set as child of some other container.
3648     *
3649     * @param obj The window object
3650     * @param subobj The resize object to add
3651     */
3652    EAPI void         elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3653    /**
3654     * Set the title of the window
3655     *
3656     * @param obj The window object
3657     * @param title The title to set
3658     */
3659    EAPI void         elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3660    /**
3661     * Get the title of the window
3662     *
3663     * The returned string is an internal one and should not be freed or
3664     * modified. It will also be rendered invalid if a new title is set or if
3665     * the window is destroyed.
3666     *
3667     * @param obj The window object
3668     * @return The title
3669     */
3670    EAPI const char  *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3671    /**
3672     * Set the window's autodel state.
3673     *
3674     * When closing the window in any way outside of the program control, like
3675     * pressing the X button in the titlebar or using a command from the
3676     * Window Manager, a "delete,request" signal is emitted to indicate that
3677     * this event occurred and the developer can take any action, which may
3678     * include, or not, destroying the window object.
3679     *
3680     * When the @p autodel parameter is set, the window will be automatically
3681     * destroyed when this event occurs, after the signal is emitted.
3682     * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3683     * and is up to the program to do so when it's required.
3684     *
3685     * @param obj The window object
3686     * @param autodel If true, the window will automatically delete itself when
3687     * closed
3688     */
3689    EAPI void         elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3690    /**
3691     * Get the window's autodel state.
3692     *
3693     * @param obj The window object
3694     * @return If the window will automatically delete itself when closed
3695     *
3696     * @see elm_win_autodel_set()
3697     */
3698    EAPI Eina_Bool    elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3699    /**
3700     * Activate a window object.
3701     *
3702     * This function sends a request to the Window Manager to activate the
3703     * window pointed by @p obj. If honored by the WM, the window will receive
3704     * the keyboard focus.
3705     *
3706     * @note This is just a request that a Window Manager may ignore, so calling
3707     * this function does not ensure in any way that the window will be the
3708     * active one after it.
3709     *
3710     * @param obj The window object
3711     */
3712    EAPI void         elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3713    /**
3714     * Lower a window object.
3715     *
3716     * Places the window pointed by @p obj at the bottom of the stack, so that
3717     * no other window is covered by it.
3718     *
3719     * If elm_win_override_set() is not set, the Window Manager may ignore this
3720     * request.
3721     *
3722     * @param obj The window object
3723     */
3724    EAPI void         elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3725    /**
3726     * Raise a window object.
3727     *
3728     * Places the window pointed by @p obj at the top of the stack, so that it's
3729     * not covered by any other window.
3730     *
3731     * If elm_win_override_set() is not set, the Window Manager may ignore this
3732     * request.
3733     *
3734     * @param obj The window object
3735     */
3736    EAPI void         elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3737    /**
3738     * Set the borderless state of a window.
3739     *
3740     * This function requests the Window Manager to not draw any decoration
3741     * around the window.
3742     *
3743     * @param obj The window object
3744     * @param borderless If true, the window is borderless
3745     */
3746    EAPI void         elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3747    /**
3748     * Get the borderless state of a window.
3749     *
3750     * @param obj The window object
3751     * @return If true, the window is borderless
3752     */
3753    EAPI Eina_Bool    elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3754    /**
3755     * Set the shaped state of a window.
3756     *
3757     * Shaped windows, when supported, will render the parts of the window that
3758     * has no content, transparent.
3759     *
3760     * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3761     * background object or cover the entire window in any other way, or the
3762     * parts of the canvas that have no data will show framebuffer artifacts.
3763     *
3764     * @param obj The window object
3765     * @param shaped If true, the window is shaped
3766     *
3767     * @see elm_win_alpha_set()
3768     */
3769    EAPI void         elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3770    /**
3771     * Get the shaped state of a window.
3772     *
3773     * @param obj The window object
3774     * @return If true, the window is shaped
3775     *
3776     * @see elm_win_shaped_set()
3777     */
3778    EAPI Eina_Bool    elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3779    /**
3780     * Set the alpha channel state of a window.
3781     *
3782     * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3783     * possibly making parts of the window completely or partially transparent.
3784     * This is also subject to the underlying system supporting it, like for
3785     * example, running under a compositing manager. If no compositing is
3786     * available, enabling this option will instead fallback to using shaped
3787     * windows, with elm_win_shaped_set().
3788     *
3789     * @param obj The window object
3790     * @param alpha If true, the window has an alpha channel
3791     *
3792     * @see elm_win_alpha_set()
3793     */
3794    EAPI void         elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
3795    /**
3796     * Get the transparency state of a window.
3797     *
3798     * @param obj The window object
3799     * @return If true, the window is transparent
3800     *
3801     * @see elm_win_transparent_set()
3802     */
3803    EAPI Eina_Bool    elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3804    /**
3805     * Set the transparency state of a window.
3806     *
3807     * Use elm_win_alpha_set() instead.
3808     *
3809     * @param obj The window object
3810     * @param transparent If true, the window is transparent
3811     *
3812     * @see elm_win_alpha_set()
3813     */
3814    EAPI void         elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
3815    /**
3816     * Get the alpha channel state of a window.
3817     *
3818     * @param obj The window object
3819     * @return If true, the window has an alpha channel
3820     */
3821    EAPI Eina_Bool    elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3822    /**
3823     * Set the override state of a window.
3824     *
3825     * A window with @p override set to EINA_TRUE will not be managed by the
3826     * Window Manager. This means that no decorations of any kind will be shown
3827     * for it, moving and resizing must be handled by the application, as well
3828     * as the window visibility.
3829     *
3830     * This should not be used for normal windows, and even for not so normal
3831     * ones, it should only be used when there's a good reason and with a lot
3832     * of care. Mishandling override windows may result situations that
3833     * disrupt the normal workflow of the end user.
3834     *
3835     * @param obj The window object
3836     * @param override If true, the window is overridden
3837     */
3838    EAPI void         elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
3839    /**
3840     * Get the override state of a window.
3841     *
3842     * @param obj The window object
3843     * @return If true, the window is overridden
3844     *
3845     * @see elm_win_override_set()
3846     */
3847    EAPI Eina_Bool    elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3848    /**
3849     * Set the fullscreen state of a window.
3850     *
3851     * @param obj The window object
3852     * @param fullscreen If true, the window is fullscreen
3853     */
3854    EAPI void         elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
3855    /**
3856     * Get the fullscreen state of a window.
3857     *
3858     * @param obj The window object
3859     * @return If true, the window is fullscreen
3860     */
3861    EAPI Eina_Bool    elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3862    /**
3863     * Set the maximized state of a window.
3864     *
3865     * @param obj The window object
3866     * @param maximized If true, the window is maximized
3867     */
3868    EAPI void         elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
3869    /**
3870     * Get the maximized state of a window.
3871     *
3872     * @param obj The window object
3873     * @return If true, the window is maximized
3874     */
3875    EAPI Eina_Bool    elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3876    /**
3877     * Set the iconified state of a window.
3878     *
3879     * @param obj The window object
3880     * @param iconified If true, the window is iconified
3881     */
3882    EAPI void         elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
3883    /**
3884     * Get the iconified state of a window.
3885     *
3886     * @param obj The window object
3887     * @return If true, the window is iconified
3888     */
3889    EAPI Eina_Bool    elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3890    /**
3891     * Set the layer of the window.
3892     *
3893     * What this means exactly will depend on the underlying engine used.
3894     *
3895     * In the case of X11 backed engines, the value in @p layer has the
3896     * following meanings:
3897     * @li < 3: The window will be placed below all others.
3898     * @li > 5: The window will be placed above all others.
3899     * @li other: The window will be placed in the default layer.
3900     *
3901     * @param obj The window object
3902     * @param layer The layer of the window
3903     */
3904    EAPI void         elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
3905    /**
3906     * Get the layer of the window.
3907     *
3908     * @param obj The window object
3909     * @return The layer of the window
3910     *
3911     * @see elm_win_layer_set()
3912     */
3913    EAPI int          elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3914    /**
3915     * Set the rotation of the window.
3916     *
3917     * Most engines only work with multiples of 90.
3918     *
3919     * This function is used to set the orientation of the window @p obj to
3920     * match that of the screen. The window itself will be resized to adjust
3921     * to the new geometry of its contents. If you want to keep the window size,
3922     * see elm_win_rotation_with_resize_set().
3923     *
3924     * @param obj The window object
3925     * @param rotation The rotation of the window, in degrees (0-360),
3926     * counter-clockwise.
3927     */
3928    EAPI void         elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3929    /**
3930     * Rotates the window and resizes it.
3931     *
3932     * Like elm_win_rotation_set(), but it also resizes the window's contents so
3933     * that they fit inside the current window geometry.
3934     *
3935     * @param obj The window object
3936     * @param layer The rotation of the window in degrees (0-360),
3937     * counter-clockwise.
3938     */
3939    EAPI void         elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3940    /**
3941     * Get the rotation of the window.
3942     *
3943     * @param obj The window object
3944     * @return The rotation of the window in degrees (0-360)
3945     *
3946     * @see elm_win_rotation_set()
3947     * @see elm_win_rotation_with_resize_set()
3948     */
3949    EAPI int          elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3950    /**
3951     * Set the sticky state of the window.
3952     *
3953     * Hints the Window Manager that the window in @p obj should be left fixed
3954     * at its position even when the virtual desktop it's on moves or changes.
3955     *
3956     * @param obj The window object
3957     * @param sticky If true, the window's sticky state is enabled
3958     */
3959    EAPI void         elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
3960    /**
3961     * Get the sticky state of the window.
3962     *
3963     * @param obj The window object
3964     * @return If true, the window's sticky state is enabled
3965     *
3966     * @see elm_win_sticky_set()
3967     */
3968    EAPI Eina_Bool    elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3969    /**
3970     * Set if this window is an illume conformant window
3971     *
3972     * @param obj The window object
3973     * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
3974     */
3975    EAPI void         elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
3976    /**
3977     * Get if this window is an illume conformant window
3978     *
3979     * @param obj The window object
3980     * @return A boolean if this window is illume conformant or not
3981     */
3982    EAPI Eina_Bool    elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3983    /**
3984     * Set a window to be an illume quickpanel window
3985     *
3986     * By default window objects are not quickpanel windows.
3987     *
3988     * @param obj The window object
3989     * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
3990     */
3991    EAPI void         elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
3992    /**
3993     * Get if this window is a quickpanel or not
3994     *
3995     * @param obj The window object
3996     * @return A boolean if this window is a quickpanel or not
3997     */
3998    EAPI Eina_Bool    elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3999    /**
4000     * Set the major priority of a quickpanel window
4001     *
4002     * @param obj The window object
4003     * @param priority The major priority for this quickpanel
4004     */
4005    EAPI void         elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4006    /**
4007     * Get the major priority of a quickpanel window
4008     *
4009     * @param obj The window object
4010     * @return The major priority of this quickpanel
4011     */
4012    EAPI int          elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4013    /**
4014     * Set the minor priority of a quickpanel window
4015     *
4016     * @param obj The window object
4017     * @param priority The minor priority for this quickpanel
4018     */
4019    EAPI void         elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4020    /**
4021     * Get the minor priority of a quickpanel window
4022     *
4023     * @param obj The window object
4024     * @return The minor priority of this quickpanel
4025     */
4026    EAPI int          elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4027    /**
4028     * Set which zone this quickpanel should appear in
4029     *
4030     * @param obj The window object
4031     * @param zone The requested zone for this quickpanel
4032     */
4033    EAPI void         elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4034    /**
4035     * Get which zone this quickpanel should appear in
4036     *
4037     * @param obj The window object
4038     * @return The requested zone for this quickpanel
4039     */
4040    EAPI int          elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4041    /**
4042     * Set the window to be skipped by keyboard focus
4043     *
4044     * This sets the window to be skipped by normal keyboard input. This means
4045     * a window manager will be asked to not focus this window as well as omit
4046     * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4047     *
4048     * Call this and enable it on a window BEFORE you show it for the first time,
4049     * otherwise it may have no effect.
4050     *
4051     * Use this for windows that have only output information or might only be
4052     * interacted with by the mouse or fingers, and never for typing input.
4053     * Be careful that this may have side-effects like making the window
4054     * non-accessible in some cases unless the window is specially handled. Use
4055     * this with care.
4056     *
4057     * @param obj The window object
4058     * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4059     */
4060    EAPI void         elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4061    /**
4062     * Send a command to the windowing environment
4063     *
4064     * This is intended to work in touchscreen or small screen device
4065     * environments where there is a more simplistic window management policy in
4066     * place. This uses the window object indicated to select which part of the
4067     * environment to control (the part that this window lives in), and provides
4068     * a command and an optional parameter structure (use NULL for this if not
4069     * needed).
4070     *
4071     * @param obj The window object that lives in the environment to control
4072     * @param command The command to send
4073     * @param params Optional parameters for the command
4074     */
4075    EAPI void         elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4076    /**
4077     * Get the inlined image object handle
4078     *
4079     * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4080     * then the window is in fact an evas image object inlined in the parent
4081     * canvas. You can get this object (be careful to not manipulate it as it
4082     * is under control of elementary), and use it to do things like get pixel
4083     * data, save the image to a file, etc.
4084     *
4085     * @param obj The window object to get the inlined image from
4086     * @return The inlined image object, or NULL if none exists
4087     */
4088    EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4089    /**
4090     * Set the enabled status for the focus highlight in a window
4091     *
4092     * This function will enable or disable the focus highlight only for the
4093     * given window, regardless of the global setting for it
4094     *
4095     * @param obj The window where to enable the highlight
4096     * @param enabled The enabled value for the highlight
4097     */
4098    EAPI void         elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4099    /**
4100     * Get the enabled value of the focus highlight for this window
4101     *
4102     * @param obj The window in which to check if the focus highlight is enabled
4103     *
4104     * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4105     */
4106    EAPI Eina_Bool    elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4107    /**
4108     * Set the style for the focus highlight on this window
4109     *
4110     * Sets the style to use for theming the highlight of focused objects on
4111     * the given window. If @p style is NULL, the default will be used.
4112     *
4113     * @param obj The window where to set the style
4114     * @param style The style to set
4115     */
4116    EAPI void         elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4117    /**
4118     * Get the style set for the focus highlight object
4119     *
4120     * Gets the style set for this windows highilght object, or NULL if none
4121     * is set.
4122     *
4123     * @param obj The window to retrieve the highlights style from
4124     *
4125     * @return The style set or NULL if none was. Default is used in that case.
4126     */
4127    EAPI const char  *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4128    /*...
4129     * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4130     * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4131     * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4132     * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4133     * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4134     * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4135     * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4136     *
4137     * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4138     * (blank mouse, private mouse obj, defaultmouse)
4139     *
4140     */
4141    /**
4142     * Sets the keyboard mode of the window.
4143     *
4144     * @param obj The window object
4145     * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4146     */
4147    EAPI void                  elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4148    /**
4149     * Gets the keyboard mode of the window.
4150     *
4151     * @param obj The window object
4152     * @return The mode, one of #Elm_Win_Keyboard_Mode
4153     */
4154    EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4155    /**
4156     * Sets whether the window is a keyboard.
4157     *
4158     * @param obj The window object
4159     * @param is_keyboard If true, the window is a virtual keyboard
4160     */
4161    EAPI void                  elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4162    /**
4163     * Gets whether the window is a keyboard.
4164     *
4165     * @param obj The window object
4166     * @return If the window is a virtual keyboard
4167     */
4168    EAPI Eina_Bool             elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4169
4170    /**
4171     * Get the screen position of a window.
4172     *
4173     * @param obj The window object
4174     * @param x The int to store the x coordinate to
4175     * @param y The int to store the y coordinate to
4176     */
4177    EAPI void                  elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4178    /**
4179     * @}
4180     */
4181
4182    /**
4183     * @defgroup Inwin Inwin
4184     *
4185     * @image html img/widget/inwin/preview-00.png
4186     * @image latex img/widget/inwin/preview-00.eps
4187     * @image html img/widget/inwin/preview-01.png
4188     * @image latex img/widget/inwin/preview-01.eps
4189     * @image html img/widget/inwin/preview-02.png
4190     * @image latex img/widget/inwin/preview-02.eps
4191     *
4192     * An inwin is a window inside a window that is useful for a quick popup.
4193     * It does not hover.
4194     *
4195     * It works by creating an object that will occupy the entire window, so it
4196     * must be created using an @ref Win "elm_win" as parent only. The inwin
4197     * object can be hidden or restacked below every other object if it's
4198     * needed to show what's behind it without destroying it. If this is done,
4199     * the elm_win_inwin_activate() function can be used to bring it back to
4200     * full visibility again.
4201     *
4202     * There are three styles available in the default theme. These are:
4203     * @li default: The inwin is sized to take over most of the window it's
4204     * placed in.
4205     * @li minimal: The size of the inwin will be the minimum necessary to show
4206     * its contents.
4207     * @li minimal_vertical: Horizontally, the inwin takes as much space as
4208     * possible, but it's sized vertically the most it needs to fit its\
4209     * contents.
4210     *
4211     * Some examples of Inwin can be found in the following:
4212     * @li @ref inwin_example_01
4213     *
4214     * @{
4215     */
4216    /**
4217     * Adds an inwin to the current window
4218     *
4219     * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4220     * Never call this function with anything other than the top-most window
4221     * as its parameter, unless you are fond of undefined behavior.
4222     *
4223     * After creating the object, the widget will set itself as resize object
4224     * for the window with elm_win_resize_object_add(), so when shown it will
4225     * appear to cover almost the entire window (how much of it depends on its
4226     * content and the style used). It must not be added into other container
4227     * objects and it needs not be moved or resized manually.
4228     *
4229     * @param parent The parent object
4230     * @return The new object or NULL if it cannot be created
4231     */
4232    EAPI Evas_Object          *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4233    /**
4234     * Activates an inwin object, ensuring its visibility
4235     *
4236     * This function will make sure that the inwin @p obj is completely visible
4237     * by calling evas_object_show() and evas_object_raise() on it, to bring it
4238     * to the front. It also sets the keyboard focus to it, which will be passed
4239     * onto its content.
4240     *
4241     * The object's theme will also receive the signal "elm,action,show" with
4242     * source "elm".
4243     *
4244     * @param obj The inwin to activate
4245     */
4246    EAPI void                  elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4247    /**
4248     * Set the content of an inwin object.
4249     *
4250     * Once the content object is set, a previously set one will be deleted.
4251     * If you want to keep that old content object, use the
4252     * elm_win_inwin_content_unset() function.
4253     *
4254     * @param obj The inwin object
4255     * @param content The object to set as content
4256     */
4257    EAPI void                  elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4258    /**
4259     * Get the content of an inwin object.
4260     *
4261     * Return the content object which is set for this widget.
4262     *
4263     * The returned object is valid as long as the inwin is still alive and no
4264     * other content is set on it. Deleting the object will notify the inwin
4265     * about it and this one will be left empty.
4266     *
4267     * If you need to remove an inwin's content to be reused somewhere else,
4268     * see elm_win_inwin_content_unset().
4269     *
4270     * @param obj The inwin object
4271     * @return The content that is being used
4272     */
4273    EAPI Evas_Object          *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4274    /**
4275     * Unset the content of an inwin object.
4276     *
4277     * Unparent and return the content object which was set for this widget.
4278     *
4279     * @param obj The inwin object
4280     * @return The content that was being used
4281     */
4282    EAPI Evas_Object          *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4283    /**
4284     * @}
4285     */
4286    /* X specific calls - won't work on non-x engines (return 0) */
4287
4288    /**
4289     * Get the Ecore_X_Window of an Evas_Object
4290     *
4291     * @param obj The object
4292     *
4293     * @return The Ecore_X_Window of @p obj
4294     *
4295     * @ingroup Win
4296     */
4297    EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4298
4299    /* smart callbacks called:
4300     * "delete,request" - the user requested to delete the window
4301     * "focus,in" - window got focus
4302     * "focus,out" - window lost focus
4303     * "moved" - window that holds the canvas was moved
4304     */
4305
4306    /**
4307     * @defgroup Bg Bg
4308     *
4309     * @image html img/widget/bg/preview-00.png
4310     * @image latex img/widget/bg/preview-00.eps
4311     *
4312     * @brief Background object, used for setting a solid color, image or Edje
4313     * group as background to a window or any container object.
4314     *
4315     * The bg object is used for setting a solid background to a window or
4316     * packing into any container object. It works just like an image, but has
4317     * some properties useful to a background, like setting it to tiled,
4318     * centered, scaled or stretched.
4319     *
4320     * Here is some sample code using it:
4321     * @li @ref bg_01_example_page
4322     * @li @ref bg_02_example_page
4323     * @li @ref bg_03_example_page
4324     */
4325
4326    /* bg */
4327    typedef enum _Elm_Bg_Option
4328      {
4329         ELM_BG_OPTION_CENTER,  /**< center the background */
4330         ELM_BG_OPTION_SCALE,   /**< scale the background retaining aspect ratio */
4331         ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4332         ELM_BG_OPTION_TILE     /**< tile background at its original size */
4333      } Elm_Bg_Option;
4334
4335    /**
4336     * Add a new background to the parent
4337     *
4338     * @param parent The parent object
4339     * @return The new object or NULL if it cannot be created
4340     *
4341     * @ingroup Bg
4342     */
4343    EAPI Evas_Object  *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4344
4345    /**
4346     * Set the file (image or edje) used for the background
4347     *
4348     * @param obj The bg object
4349     * @param file The file path
4350     * @param group Optional key (group in Edje) within the file
4351     *
4352     * This sets the image file used in the background object. The image (or edje)
4353     * will be stretched (retaining aspect if its an image file) to completely fill
4354     * the bg object. This may mean some parts are not visible.
4355     *
4356     * @note  Once the image of @p obj is set, a previously set one will be deleted,
4357     * even if @p file is NULL.
4358     *
4359     * @ingroup Bg
4360     */
4361    EAPI void          elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4362
4363    /**
4364     * Get the file (image or edje) used for the background
4365     *
4366     * @param obj The bg object
4367     * @param file The file path
4368     * @param group Optional key (group in Edje) within the file
4369     *
4370     * @ingroup Bg
4371     */
4372    EAPI void          elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4373
4374    /**
4375     * Set the option used for the background image
4376     *
4377     * @param obj The bg object
4378     * @param option The desired background option (TILE, SCALE)
4379     *
4380     * This sets the option used for manipulating the display of the background
4381     * image. The image can be tiled or scaled.
4382     *
4383     * @ingroup Bg
4384     */
4385    EAPI void          elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4386
4387    /**
4388     * Get the option used for the background image
4389     *
4390     * @param obj The bg object
4391     * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4392     *
4393     * @ingroup Bg
4394     */
4395    EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4396    /**
4397     * Set the option used for the background color
4398     *
4399     * @param obj The bg object
4400     * @param r
4401     * @param g
4402     * @param b
4403     *
4404     * This sets the color used for the background rectangle. Its range goes
4405     * from 0 to 255.
4406     *
4407     * @ingroup Bg
4408     */
4409    EAPI void          elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4410    /**
4411     * Get the option used for the background color
4412     *
4413     * @param obj The bg object
4414     * @param r
4415     * @param g
4416     * @param b
4417     *
4418     * @ingroup Bg
4419     */
4420    EAPI void          elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4421
4422    /**
4423     * Set the overlay object used for the background object.
4424     *
4425     * @param obj The bg object
4426     * @param overlay The overlay object
4427     *
4428     * This provides a way for elm_bg to have an 'overlay' that will be on top
4429     * of the bg. Once the over object is set, a previously set one will be
4430     * deleted, even if you set the new one to NULL. If you want to keep that
4431     * old content object, use the elm_bg_overlay_unset() function.
4432     *
4433     * @ingroup Bg
4434     */
4435
4436    EAPI void          elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4437
4438    /**
4439     * Get the overlay object used for the background object.
4440     *
4441     * @param obj The bg object
4442     * @return The content that is being used
4443     *
4444     * Return the content object which is set for this widget
4445     *
4446     * @ingroup Bg
4447     */
4448    EAPI Evas_Object  *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4449
4450    /**
4451     * Get the overlay object used for the background object.
4452     *
4453     * @param obj The bg object
4454     * @return The content that was being used
4455     *
4456     * Unparent and return the overlay object which was set for this widget
4457     *
4458     * @ingroup Bg
4459     */
4460    EAPI Evas_Object  *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4461
4462    /**
4463     * Set the size of the pixmap representation of the image.
4464     *
4465     * This option just makes sense if an image is going to be set in the bg.
4466     *
4467     * @param obj The bg object
4468     * @param w The new width of the image pixmap representation.
4469     * @param h The new height of the image pixmap representation.
4470     *
4471     * This function sets a new size for pixmap representation of the given bg
4472     * image. It allows the image to be loaded already in the specified size,
4473     * reducing the memory usage and load time when loading a big image with load
4474     * size set to a smaller size.
4475     *
4476     * NOTE: this is just a hint, the real size of the pixmap may differ
4477     * depending on the type of image being loaded, being bigger than requested.
4478     *
4479     * @ingroup Bg
4480     */
4481    EAPI void          elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4482    /* smart callbacks called:
4483     */
4484
4485    /**
4486     * @defgroup Icon Icon
4487     *
4488     * @image html img/widget/icon/preview-00.png
4489     * @image latex img/widget/icon/preview-00.eps
4490     *
4491     * An object that provides standard icon images (delete, edit, arrows, etc.)
4492     * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4493     *
4494     * The icon image requested can be in the elementary theme, or in the
4495     * freedesktop.org paths. It's possible to set the order of preference from
4496     * where the image will be used.
4497     *
4498     * This API is very similar to @ref Image, but with ready to use images.
4499     *
4500     * Default images provided by the theme are described below.
4501     *
4502     * The first list contains icons that were first intended to be used in
4503     * toolbars, but can be used in many other places too:
4504     * @li home
4505     * @li close
4506     * @li apps
4507     * @li arrow_up
4508     * @li arrow_down
4509     * @li arrow_left
4510     * @li arrow_right
4511     * @li chat
4512     * @li clock
4513     * @li delete
4514     * @li edit
4515     * @li refresh
4516     * @li folder
4517     * @li file
4518     *
4519     * Now some icons that were designed to be used in menus (but again, you can
4520     * use them anywhere else):
4521     * @li menu/home
4522     * @li menu/close
4523     * @li menu/apps
4524     * @li menu/arrow_up
4525     * @li menu/arrow_down
4526     * @li menu/arrow_left
4527     * @li menu/arrow_right
4528     * @li menu/chat
4529     * @li menu/clock
4530     * @li menu/delete
4531     * @li menu/edit
4532     * @li menu/refresh
4533     * @li menu/folder
4534     * @li menu/file
4535     *
4536     * And here we have some media player specific icons:
4537     * @li media_player/forward
4538     * @li media_player/info
4539     * @li media_player/next
4540     * @li media_player/pause
4541     * @li media_player/play
4542     * @li media_player/prev
4543     * @li media_player/rewind
4544     * @li media_player/stop
4545     *
4546     * Signals that you can add callbacks for are:
4547     *
4548     * "clicked" - This is called when a user has clicked the icon
4549     *
4550     * An example of usage for this API follows:
4551     * @li @ref tutorial_icon
4552     */
4553
4554    /**
4555     * @addtogroup Icon
4556     * @{
4557     */
4558
4559    typedef enum _Elm_Icon_Type
4560      {
4561         ELM_ICON_NONE,
4562         ELM_ICON_FILE,
4563         ELM_ICON_STANDARD
4564      } Elm_Icon_Type;
4565    /**
4566     * @enum _Elm_Icon_Lookup_Order
4567     * @typedef Elm_Icon_Lookup_Order
4568     *
4569     * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4570     * theme, FDO paths, or both?
4571     *
4572     * @ingroup Icon
4573     */
4574    typedef enum _Elm_Icon_Lookup_Order
4575      {
4576         ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4577         ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4578         ELM_ICON_LOOKUP_FDO,       /**< icon look up order: freedesktop */
4579         ELM_ICON_LOOKUP_THEME      /**< icon look up order: theme */
4580      } Elm_Icon_Lookup_Order;
4581
4582    /**
4583     * Add a new icon object to the parent.
4584     *
4585     * @param parent The parent object
4586     * @return The new object or NULL if it cannot be created
4587     *
4588     * @see elm_icon_file_set()
4589     *
4590     * @ingroup Icon
4591     */
4592    EAPI Evas_Object          *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4593    /**
4594     * Set the file that will be used as icon.
4595     *
4596     * @param obj The icon object
4597     * @param file The path to file that will be used as icon image
4598     * @param group The group that the icon belongs to in edje file
4599     *
4600     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4601     *
4602     * @note The icon image set by this function can be changed by
4603     * elm_icon_standard_set().
4604     *
4605     * @see elm_icon_file_get()
4606     *
4607     * @ingroup Icon
4608     */
4609    EAPI Eina_Bool             elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4610    /**
4611     * Set a location in memory to be used as an icon
4612     *
4613     * @param obj The icon object
4614     * @param img The binary data that will be used as an image
4615     * @param size The size of binary data @p img
4616     * @param format Optional format of @p img to pass to the image loader
4617     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4618     *
4619     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4620     *
4621     * @note The icon image set by this function can be changed by
4622     * elm_icon_standard_set().
4623     *
4624     * @ingroup Icon
4625     */
4626    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);
4627    /**
4628     * Get the file that will be used as icon.
4629     *
4630     * @param obj The icon object
4631     * @param file The path to file that will be used as icon icon image
4632     * @param group The group that the icon belongs to in edje file
4633     *
4634     * @see elm_icon_file_set()
4635     *
4636     * @ingroup Icon
4637     */
4638    EAPI void                  elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4639    EAPI void                  elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4640    /**
4641     * Set the icon by icon standards names.
4642     *
4643     * @param obj The icon object
4644     * @param name The icon name
4645     *
4646     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4647     *
4648     * For example, freedesktop.org defines standard icon names such as "home",
4649     * "network", etc. There can be different icon sets to match those icon
4650     * keys. The @p name given as parameter is one of these "keys", and will be
4651     * used to look in the freedesktop.org paths and elementary theme. One can
4652     * change the lookup order with elm_icon_order_lookup_set().
4653     *
4654     * If name is not found in any of the expected locations and it is the
4655     * absolute path of an image file, this image will be used.
4656     *
4657     * @note The icon image set by this function can be changed by
4658     * elm_icon_file_set().
4659     *
4660     * @see elm_icon_standard_get()
4661     * @see elm_icon_file_set()
4662     *
4663     * @ingroup Icon
4664     */
4665    EAPI Eina_Bool             elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4666    /**
4667     * Get the icon name set by icon standard names.
4668     *
4669     * @param obj The icon object
4670     * @return The icon name
4671     *
4672     * If the icon image was set using elm_icon_file_set() instead of
4673     * elm_icon_standard_set(), then this function will return @c NULL.
4674     *
4675     * @see elm_icon_standard_set()
4676     *
4677     * @ingroup Icon
4678     */
4679    EAPI const char           *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4680    /**
4681     * Set the smooth effect for an icon object.
4682     *
4683     * @param obj The icon object
4684     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4685     * otherwise. Default is @c EINA_TRUE.
4686     *
4687     * Set the scaling algorithm to be used when scaling the icon image. Smooth
4688     * scaling provides a better resulting image, but is slower.
4689     *
4690     * The smooth scaling should be disabled when making animations that change
4691     * the icon size, since they will be faster. Animations that don't require
4692     * resizing of the icon can keep the smooth scaling enabled (even if the icon
4693     * is already scaled, since the scaled icon image will be cached).
4694     *
4695     * @see elm_icon_smooth_get()
4696     *
4697     * @ingroup Icon
4698     */
4699    EAPI void                  elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4700    /**
4701     * Get the smooth effect for an icon object.
4702     *
4703     * @param obj The icon object
4704     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4705     *
4706     * @see elm_icon_smooth_set()
4707     *
4708     * @ingroup Icon
4709     */
4710    EAPI Eina_Bool             elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4711    /**
4712     * Disable scaling of this object.
4713     *
4714     * @param obj The icon object.
4715     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4716     * otherwise. Default is @c EINA_FALSE.
4717     *
4718     * This function disables scaling of the icon object through the function
4719     * elm_object_scale_set(). However, this does not affect the object
4720     * size/resize in any way. For that effect, take a look at
4721     * elm_icon_scale_set().
4722     *
4723     * @see elm_icon_no_scale_get()
4724     * @see elm_icon_scale_set()
4725     * @see elm_object_scale_set()
4726     *
4727     * @ingroup Icon
4728     */
4729    EAPI void                  elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4730    /**
4731     * Get whether scaling is disabled on the object.
4732     *
4733     * @param obj The icon object
4734     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4735     *
4736     * @see elm_icon_no_scale_set()
4737     *
4738     * @ingroup Icon
4739     */
4740    EAPI Eina_Bool             elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4741    /**
4742     * Set if the object is (up/down) resizable.
4743     *
4744     * @param obj The icon object
4745     * @param scale_up A bool to set if the object is resizable up. Default is
4746     * @c EINA_TRUE.
4747     * @param scale_down A bool to set if the object is resizable down. Default
4748     * is @c EINA_TRUE.
4749     *
4750     * This function limits the icon object resize ability. If @p scale_up is set to
4751     * @c EINA_FALSE, the object can't have its height or width resized to a value
4752     * higher than the original icon size. Same is valid for @p scale_down.
4753     *
4754     * @see elm_icon_scale_get()
4755     *
4756     * @ingroup Icon
4757     */
4758    EAPI void                  elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4759    /**
4760     * Get if the object is (up/down) resizable.
4761     *
4762     * @param obj The icon object
4763     * @param scale_up A bool to set if the object is resizable up
4764     * @param scale_down A bool to set if the object is resizable down
4765     *
4766     * @see elm_icon_scale_set()
4767     *
4768     * @ingroup Icon
4769     */
4770    EAPI void                  elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4771    /**
4772     * Get the object's image size
4773     *
4774     * @param obj The icon object
4775     * @param w A pointer to store the width in
4776     * @param h A pointer to store the height in
4777     *
4778     * @ingroup Icon
4779     */
4780    EAPI void                  elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4781    /**
4782     * Set if the icon fill the entire object area.
4783     *
4784     * @param obj The icon object
4785     * @param fill_outside @c EINA_TRUE if the object is filled outside,
4786     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4787     *
4788     * When the icon object is resized to a different aspect ratio from the
4789     * original icon image, the icon image will still keep its aspect. This flag
4790     * tells how the image should fill the object's area. They are: keep the
4791     * entire icon inside the limits of height and width of the object (@p
4792     * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
4793     * of the object, and the icon will fill the entire object (@p fill_outside
4794     * is @c EINA_TRUE).
4795     *
4796     * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
4797     * retain property to false. Thus, the icon image will always keep its
4798     * original aspect ratio.
4799     *
4800     * @see elm_icon_fill_outside_get()
4801     * @see elm_image_fill_outside_set()
4802     *
4803     * @ingroup Icon
4804     */
4805    EAPI void                  elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
4806    /**
4807     * Get if the object is filled outside.
4808     *
4809     * @param obj The icon object
4810     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
4811     *
4812     * @see elm_icon_fill_outside_set()
4813     *
4814     * @ingroup Icon
4815     */
4816    EAPI Eina_Bool             elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4817    /**
4818     * Set the prescale size for the icon.
4819     *
4820     * @param obj The icon object
4821     * @param size The prescale size. This value is used for both width and
4822     * height.
4823     *
4824     * This function sets a new size for pixmap representation of the given
4825     * icon. It allows the icon to be loaded already in the specified size,
4826     * reducing the memory usage and load time when loading a big icon with load
4827     * size set to a smaller size.
4828     *
4829     * It's equivalent to the elm_bg_load_size_set() function for bg.
4830     *
4831     * @note this is just a hint, the real size of the pixmap may differ
4832     * depending on the type of icon being loaded, being bigger than requested.
4833     *
4834     * @see elm_icon_prescale_get()
4835     * @see elm_bg_load_size_set()
4836     *
4837     * @ingroup Icon
4838     */
4839    EAPI void                  elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
4840    /**
4841     * Get the prescale size for the icon.
4842     *
4843     * @param obj The icon object
4844     * @return The prescale size
4845     *
4846     * @see elm_icon_prescale_set()
4847     *
4848     * @ingroup Icon
4849     */
4850    EAPI int                   elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4851    /**
4852     * Sets the icon lookup order used by elm_icon_standard_set().
4853     *
4854     * @param obj The icon object
4855     * @param order The icon lookup order (can be one of
4856     * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
4857     * or ELM_ICON_LOOKUP_THEME)
4858     *
4859     * @see elm_icon_order_lookup_get()
4860     * @see Elm_Icon_Lookup_Order
4861     *
4862     * @ingroup Icon
4863     */
4864    EAPI void                  elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
4865    /**
4866     * Gets the icon lookup order.
4867     *
4868     * @param obj The icon object
4869     * @return The icon lookup order
4870     *
4871     * @see elm_icon_order_lookup_set()
4872     * @see Elm_Icon_Lookup_Order
4873     *
4874     * @ingroup Icon
4875     */
4876    EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4877    /**
4878     * Get if the icon supports animation or not.
4879     *
4880     * @param obj The icon object
4881     * @return @c EINA_TRUE if the icon supports animation,
4882     *         @c EINA_FALSE otherwise.
4883     *
4884     * Return if this elm icon's image can be animated. Currently Evas only
4885     * supports gif animation. If the return value is EINA_FALSE, other
4886     * elm_icon_animated_XXX APIs won't work.
4887     * @ingroup Icon
4888     */
4889    EAPI Eina_Bool           elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4890    /**
4891     * Set animation mode of the icon.
4892     *
4893     * @param obj The icon object
4894     * @param anim @c EINA_TRUE if the object do animation job,
4895     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4896     *
4897     * Even though elm icon's file can be animated,
4898     * sometimes appication developer want to just first page of image.
4899     * In that time, don't call this function, because default value is EINA_FALSE
4900     * Only when you want icon support anition,
4901     * use this function and set animated to EINA_TURE
4902     * @ingroup Icon
4903     */
4904    EAPI void                elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
4905    /**
4906     * Get animation mode of the icon.
4907     *
4908     * @param obj The icon object
4909     * @return The animation mode of the icon object
4910     * @see elm_icon_animated_set
4911     * @ingroup Icon
4912     */
4913    EAPI Eina_Bool           elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4914    /**
4915     * Set animation play mode of the icon.
4916     *
4917     * @param obj The icon object
4918     * @param play @c EINA_TRUE the object play animation images,
4919     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4920     *
4921     * If you want to play elm icon's animation, you set play to EINA_TURE.
4922     * For example, you make gif player using this set/get API and click event.
4923     *
4924     * 1. Click event occurs
4925     * 2. Check play flag using elm_icon_animaged_play_get
4926     * 3. If elm icon was playing, set play to EINA_FALSE.
4927     *    Then animation will be stopped and vice versa
4928     * @ingroup Icon
4929     */
4930    EAPI void                elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
4931    /**
4932     * Get animation play mode of the icon.
4933     *
4934     * @param obj The icon object
4935     * @return The play mode of the icon object
4936     *
4937     * @see elm_icon_animated_lay_get
4938     * @ingroup Icon
4939     */
4940    EAPI Eina_Bool           elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4941
4942    /**
4943     * @}
4944     */
4945
4946    /**
4947     * @defgroup Image Image
4948     *
4949     * @image html img/widget/image/preview-00.png
4950     * @image latex img/widget/image/preview-00.eps
4951
4952     *
4953     * An object that allows one to load an image file to it. It can be used
4954     * anywhere like any other elementary widget.
4955     *
4956     * This widget provides most of the functionality provided from @ref Bg or @ref
4957     * Icon, but with a slightly different API (use the one that fits better your
4958     * needs).
4959     *
4960     * The features not provided by those two other image widgets are:
4961     * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
4962     * @li change the object orientation with elm_image_orient_set();
4963     * @li and turning the image editable with elm_image_editable_set().
4964     *
4965     * Signals that you can add callbacks for are:
4966     *
4967     * @li @c "clicked" - This is called when a user has clicked the image
4968     *
4969     * An example of usage for this API follows:
4970     * @li @ref tutorial_image
4971     */
4972
4973    /**
4974     * @addtogroup Image
4975     * @{
4976     */
4977
4978    /**
4979     * @enum _Elm_Image_Orient
4980     * @typedef Elm_Image_Orient
4981     *
4982     * Possible orientation options for elm_image_orient_set().
4983     *
4984     * @image html elm_image_orient_set.png
4985     * @image latex elm_image_orient_set.eps width=\textwidth
4986     *
4987     * @ingroup Image
4988     */
4989    typedef enum _Elm_Image_Orient
4990      {
4991         ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
4992         ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
4993         ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
4994         ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
4995         ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
4996         ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
4997         ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
4998         ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
4999      } Elm_Image_Orient;
5000
5001    /**
5002     * Add a new image to the parent.
5003     *
5004     * @param parent The parent object
5005     * @return The new object or NULL if it cannot be created
5006     *
5007     * @see elm_image_file_set()
5008     *
5009     * @ingroup Image
5010     */
5011    EAPI Evas_Object     *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5012    /**
5013     * Set the file that will be used as image.
5014     *
5015     * @param obj The image object
5016     * @param file The path to file that will be used as image
5017     * @param group The group that the image belongs in edje file (if it's an
5018     * edje image)
5019     *
5020     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5021     *
5022     * @see elm_image_file_get()
5023     *
5024     * @ingroup Image
5025     */
5026    EAPI Eina_Bool        elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5027    /**
5028     * Get the file that will be used as image.
5029     *
5030     * @param obj The image object
5031     * @param file The path to file
5032     * @param group The group that the image belongs in edje file
5033     *
5034     * @see elm_image_file_set()
5035     *
5036     * @ingroup Image
5037     */
5038    EAPI void             elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5039    /**
5040     * Set the smooth effect for an image.
5041     *
5042     * @param obj The image object
5043     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5044     * otherwise. Default is @c EINA_TRUE.
5045     *
5046     * Set the scaling algorithm to be used when scaling the image. Smooth
5047     * scaling provides a better resulting image, but is slower.
5048     *
5049     * The smooth scaling should be disabled when making animations that change
5050     * the image size, since it will be faster. Animations that don't require
5051     * resizing of the image can keep the smooth scaling enabled (even if the
5052     * image is already scaled, since the scaled image will be cached).
5053     *
5054     * @see elm_image_smooth_get()
5055     *
5056     * @ingroup Image
5057     */
5058    EAPI void             elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5059    /**
5060     * Get the smooth effect for an image.
5061     *
5062     * @param obj The image object
5063     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5064     *
5065     * @see elm_image_smooth_get()
5066     *
5067     * @ingroup Image
5068     */
5069    EAPI Eina_Bool        elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5070    /**
5071     * Gets the current size of the image.
5072     *
5073     * @param obj The image object.
5074     * @param w Pointer to store width, or NULL.
5075     * @param h Pointer to store height, or NULL.
5076     *
5077     * This is the real size of the image, not the size of the object.
5078     *
5079     * On error, neither w or h will be written.
5080     *
5081     * @ingroup Image
5082     */
5083    EAPI void             elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5084    /**
5085     * Disable scaling of this object.
5086     *
5087     * @param obj The image object.
5088     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5089     * otherwise. Default is @c EINA_FALSE.
5090     *
5091     * This function disables scaling of the elm_image widget through the
5092     * function elm_object_scale_set(). However, this does not affect the widget
5093     * size/resize in any way. For that effect, take a look at
5094     * elm_image_scale_set().
5095     *
5096     * @see elm_image_no_scale_get()
5097     * @see elm_image_scale_set()
5098     * @see elm_object_scale_set()
5099     *
5100     * @ingroup Image
5101     */
5102    EAPI void             elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5103    /**
5104     * Get whether scaling is disabled on the object.
5105     *
5106     * @param obj The image object
5107     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5108     *
5109     * @see elm_image_no_scale_set()
5110     *
5111     * @ingroup Image
5112     */
5113    EAPI Eina_Bool        elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5114    /**
5115     * Set if the object is (up/down) resizable.
5116     *
5117     * @param obj The image object
5118     * @param scale_up A bool to set if the object is resizable up. Default is
5119     * @c EINA_TRUE.
5120     * @param scale_down A bool to set if the object is resizable down. Default
5121     * is @c EINA_TRUE.
5122     *
5123     * This function limits the image resize ability. If @p scale_up is set to
5124     * @c EINA_FALSE, the object can't have its height or width resized to a value
5125     * higher than the original image size. Same is valid for @p scale_down.
5126     *
5127     * @see elm_image_scale_get()
5128     *
5129     * @ingroup Image
5130     */
5131    EAPI void             elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5132    /**
5133     * Get if the object is (up/down) resizable.
5134     *
5135     * @param obj The image object
5136     * @param scale_up A bool to set if the object is resizable up
5137     * @param scale_down A bool to set if the object is resizable down
5138     *
5139     * @see elm_image_scale_set()
5140     *
5141     * @ingroup Image
5142     */
5143    EAPI void             elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5144    /**
5145     * Set if the image fill the entire object area when keeping the aspect ratio.
5146     *
5147     * @param obj The image object
5148     * @param fill_outside @c EINA_TRUE if the object is filled outside,
5149     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5150     *
5151     * When the image should keep its aspect ratio even if resized to another
5152     * aspect ratio, there are two possibilities to resize it: keep the entire
5153     * image inside the limits of height and width of the object (@p fill_outside
5154     * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5155     * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5156     *
5157     * @note This option will have no effect if
5158     * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5159     *
5160     * @see elm_image_fill_outside_get()
5161     * @see elm_image_aspect_ratio_retained_set()
5162     *
5163     * @ingroup Image
5164     */
5165    EAPI void             elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5166    /**
5167     * Get if the object is filled outside
5168     *
5169     * @param obj The image object
5170     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5171     *
5172     * @see elm_image_fill_outside_set()
5173     *
5174     * @ingroup Image
5175     */
5176    EAPI Eina_Bool        elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5177    /**
5178     * Set the prescale size for the image
5179     *
5180     * @param obj The image object
5181     * @param size The prescale size. This value is used for both width and
5182     * height.
5183     *
5184     * This function sets a new size for pixmap representation of the given
5185     * image. It allows the image to be loaded already in the specified size,
5186     * reducing the memory usage and load time when loading a big image with load
5187     * size set to a smaller size.
5188     *
5189     * It's equivalent to the elm_bg_load_size_set() function for bg.
5190     *
5191     * @note this is just a hint, the real size of the pixmap may differ
5192     * depending on the type of image being loaded, being bigger than requested.
5193     *
5194     * @see elm_image_prescale_get()
5195     * @see elm_bg_load_size_set()
5196     *
5197     * @ingroup Image
5198     */
5199    EAPI void             elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5200    /**
5201     * Get the prescale size for the image
5202     *
5203     * @param obj The image object
5204     * @return The prescale size
5205     *
5206     * @see elm_image_prescale_set()
5207     *
5208     * @ingroup Image
5209     */
5210    EAPI int              elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5211    /**
5212     * Set the image orientation.
5213     *
5214     * @param obj The image object
5215     * @param orient The image orientation
5216     * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5217     *  #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5218     *  #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5219     *  #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
5220     *  Default is #ELM_IMAGE_ORIENT_NONE.
5221     *
5222     * This function allows to rotate or flip the given image.
5223     *
5224     * @see elm_image_orient_get()
5225     * @see @ref Elm_Image_Orient
5226     *
5227     * @ingroup Image
5228     */
5229    EAPI void             elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5230    /**
5231     * Get the image orientation.
5232     *
5233     * @param obj The image object
5234     * @return The image orientation
5235     * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5236     *  #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5237     *  #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5238     *  #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
5239     *
5240     * @see elm_image_orient_set()
5241     * @see @ref Elm_Image_Orient
5242     *
5243     * @ingroup Image
5244     */
5245    EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5246    /**
5247     * Make the image 'editable'.
5248     *
5249     * @param obj Image object.
5250     * @param set Turn on or off editability. Default is @c EINA_FALSE.
5251     *
5252     * This means the image is a valid drag target for drag and drop, and can be
5253     * cut or pasted too.
5254     *
5255     * @ingroup Image
5256     */
5257    EAPI void             elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5258    /**
5259     * Make the image 'editable'.
5260     *
5261     * @param obj Image object.
5262     * @return Editability.
5263     *
5264     * This means the image is a valid drag target for drag and drop, and can be
5265     * cut or pasted too.
5266     *
5267     * @ingroup Image
5268     */
5269    EAPI Eina_Bool        elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5270    /**
5271     * Get the basic Evas_Image object from this object (widget).
5272     *
5273     * @param obj The image object to get the inlined image from
5274     * @return The inlined image object, or NULL if none exists
5275     *
5276     * This function allows one to get the underlying @c Evas_Object of type
5277     * Image from this elementary widget. It can be useful to do things like get
5278     * the pixel data, save the image to a file, etc.
5279     *
5280     * @note Be careful to not manipulate it, as it is under control of
5281     * elementary.
5282     *
5283     * @ingroup Image
5284     */
5285    EAPI Evas_Object     *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5286    /**
5287     * Set whether the original aspect ratio of the image should be kept on resize.
5288     *
5289     * @param obj The image object.
5290     * @param retained @c EINA_TRUE if the image should retain the aspect,
5291     * @c EINA_FALSE otherwise.
5292     *
5293     * The original aspect ratio (width / height) of the image is usually
5294     * distorted to match the object's size. Enabling this option will retain
5295     * this original aspect, and the way that the image is fit into the object's
5296     * area depends on the option set by elm_image_fill_outside_set().
5297     *
5298     * @see elm_image_aspect_ratio_retained_get()
5299     * @see elm_image_fill_outside_set()
5300     *
5301     * @ingroup Image
5302     */
5303    EAPI void             elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5304    /**
5305     * Get if the object retains the original aspect ratio.
5306     *
5307     * @param obj The image object.
5308     * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5309     * otherwise.
5310     *
5311     * @ingroup Image
5312     */
5313    EAPI Eina_Bool        elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5314
5315    /* smart callbacks called:
5316     * "clicked" - the user clicked the image
5317     */
5318
5319    /**
5320     * @}
5321     */
5322
5323    /* glview */
5324    typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5325
5326    typedef enum _Elm_GLView_Mode
5327      {
5328         ELM_GLVIEW_ALPHA   = 1,
5329         ELM_GLVIEW_DEPTH   = 2,
5330         ELM_GLVIEW_STENCIL = 4
5331      } Elm_GLView_Mode;
5332
5333    /**
5334     * Defines a policy for the glview resizing.
5335     *
5336     * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5337     */
5338    typedef enum _Elm_GLView_Resize_Policy
5339      {
5340         ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1,      /**< Resize the internal surface along with the image */
5341         ELM_GLVIEW_RESIZE_POLICY_SCALE    = 2       /**< Only reize the internal image and not the surface */
5342      } Elm_GLView_Resize_Policy;
5343
5344    typedef enum _Elm_GLView_Render_Policy
5345      {
5346         ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1,     /**< Render only when there is a need for redrawing */
5347         ELM_GLVIEW_RENDER_POLICY_ALWAYS    = 2      /**< Render always even when it is not visible */
5348      } Elm_GLView_Render_Policy;
5349
5350    /**
5351     * @defgroup GLView
5352     *
5353     * A simple GLView widget that allows GL rendering.
5354     *
5355     * Signals that you can add callbacks for are:
5356     *
5357     * @{
5358     */
5359
5360    /**
5361     * Add a new glview to the parent
5362     *
5363     * @param parent The parent object
5364     * @return The new object or NULL if it cannot be created
5365     *
5366     * @ingroup GLView
5367     */
5368    EAPI Evas_Object     *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5369
5370    /**
5371     * Sets the size of the glview
5372     *
5373     * @param obj The glview object
5374     * @param width width of the glview object
5375     * @param height height of the glview object
5376     *
5377     * @ingroup GLView
5378     */
5379    EAPI void             elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5380
5381    /**
5382     * Gets the size of the glview.
5383     *
5384     * @param obj The glview object
5385     * @param width width of the glview object
5386     * @param height height of the glview object
5387     *
5388     * Note that this function returns the actual image size of the
5389     * glview.  This means that when the scale policy is set to
5390     * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5391     * size.
5392     *
5393     * @ingroup GLView
5394     */
5395    EAPI void             elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5396
5397    /**
5398     * Gets the gl api struct for gl rendering
5399     *
5400     * @param obj The glview object
5401     * @return The api object or NULL if it cannot be created
5402     *
5403     * @ingroup GLView
5404     */
5405    EAPI Evas_GL_API     *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5406
5407    /**
5408     * Set the mode of the GLView. Supports Three simple modes.
5409     *
5410     * @param obj The glview object
5411     * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5412     * @return True if set properly.
5413     *
5414     * @ingroup GLView
5415     */
5416    EAPI Eina_Bool        elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5417
5418    /**
5419     * Set the resize policy for the glview object.
5420     *
5421     * @param obj The glview object.
5422     * @param policy The scaling policy.
5423     *
5424     * By default, the resize policy is set to
5425     * ELM_GLVIEW_RESIZE_POLICY_RECREATE.  When resize is called it
5426     * destroys the previous surface and recreates the newly specified
5427     * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5428     * however, glview only scales the image object and not the underlying
5429     * GL Surface.
5430     *
5431     * @ingroup GLView
5432     */
5433    EAPI Eina_Bool        elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5434
5435    /**
5436     * Set the render policy for the glview object.
5437     *
5438     * @param obj The glview object.
5439     * @param policy The render policy.
5440     *
5441     * By default, the render policy is set to
5442     * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND.  This policy is set such
5443     * that during the render loop, glview is only redrawn if it needs
5444     * to be redrawn. (i.e. When it is visible) If the policy is set to
5445     * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5446     * whether it is visible/need redrawing or not.
5447     *
5448     * @ingroup GLView
5449     */
5450    EAPI Eina_Bool        elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5451
5452    /**
5453     * Set the init function that runs once in the main loop.
5454     *
5455     * @param obj The glview object.
5456     * @param func The init function to be registered.
5457     *
5458     * The registered init function gets called once during the render loop.
5459     *
5460     * @ingroup GLView
5461     */
5462    EAPI void             elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5463
5464    /**
5465     * Set the render function that runs in the main loop.
5466     *
5467     * @param obj The glview object.
5468     * @param func The delete function to be registered.
5469     *
5470     * The registered del function gets called when GLView object is deleted.
5471     *
5472     * @ingroup GLView
5473     */
5474    EAPI void             elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5475
5476    /**
5477     * Set the resize function that gets called when resize happens.
5478     *
5479     * @param obj The glview object.
5480     * @param func The resize function to be registered.
5481     *
5482     * @ingroup GLView
5483     */
5484    EAPI void             elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5485
5486    /**
5487     * Set the render function that runs in the main loop.
5488     *
5489     * @param obj The glview object.
5490     * @param func The render function to be registered.
5491     *
5492     * @ingroup GLView
5493     */
5494    EAPI void             elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5495
5496    /**
5497     * Notifies that there has been changes in the GLView.
5498     *
5499     * @param obj The glview object.
5500     *
5501     * @ingroup GLView
5502     */
5503    EAPI void             elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5504
5505    /**
5506     * @}
5507     */
5508
5509    /* box */
5510    /**
5511     * @defgroup Box Box
5512     *
5513     * @image html img/widget/box/preview-00.png
5514     * @image latex img/widget/box/preview-00.eps width=\textwidth
5515     *
5516     * @image html img/box.png
5517     * @image latex img/box.eps width=\textwidth
5518     *
5519     * A box arranges objects in a linear fashion, governed by a layout function
5520     * that defines the details of this arrangement.
5521     *
5522     * By default, the box will use an internal function to set the layout to
5523     * a single row, either vertical or horizontal. This layout is affected
5524     * by a number of parameters, such as the homogeneous flag set by
5525     * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5526     * elm_box_align_set() and the hints set to each object in the box.
5527     *
5528     * For this default layout, it's possible to change the orientation with
5529     * elm_box_horizontal_set(). The box will start in the vertical orientation,
5530     * placing its elements ordered from top to bottom. When horizontal is set,
5531     * the order will go from left to right. If the box is set to be
5532     * homogeneous, every object in it will be assigned the same space, that
5533     * of the largest object. Padding can be used to set some spacing between
5534     * the cell given to each object. The alignment of the box, set with
5535     * elm_box_align_set(), determines how the bounding box of all the elements
5536     * will be placed within the space given to the box widget itself.
5537     *
5538     * The size hints of each object also affect how they are placed and sized
5539     * within the box. evas_object_size_hint_min_set() will give the minimum
5540     * size the object can have, and the box will use it as the basis for all
5541     * latter calculations. Elementary widgets set their own minimum size as
5542     * needed, so there's rarely any need to use it manually.
5543     *
5544     * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5545     * used to tell whether the object will be allocated the minimum size it
5546     * needs or if the space given to it should be expanded. It's important
5547     * to realize that expanding the size given to the object is not the same
5548     * thing as resizing the object. It could very well end being a small
5549     * widget floating in a much larger empty space. If not set, the weight
5550     * for objects will normally be 0.0 for both axis, meaning the widget will
5551     * not be expanded. To take as much space possible, set the weight to
5552     * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5553     *
5554     * Besides how much space each object is allocated, it's possible to control
5555     * how the widget will be placed within that space using
5556     * evas_object_size_hint_align_set(). By default, this value will be 0.5
5557     * for both axis, meaning the object will be centered, but any value from
5558     * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5559     * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5560     * is -1.0, means the object will be resized to fill the entire space it
5561     * was allocated.
5562     *
5563     * In addition, customized functions to define the layout can be set, which
5564     * allow the application developer to organize the objects within the box
5565     * in any number of ways.
5566     *
5567     * The special elm_box_layout_transition() function can be used
5568     * to switch from one layout to another, animating the motion of the
5569     * children of the box.
5570     *
5571     * @note Objects should not be added to box objects using _add() calls.
5572     *
5573     * Some examples on how to use boxes follow:
5574     * @li @ref box_example_01
5575     * @li @ref box_example_02
5576     *
5577     * @{
5578     */
5579    /**
5580     * @typedef Elm_Box_Transition
5581     *
5582     * Opaque handler containing the parameters to perform an animated
5583     * transition of the layout the box uses.
5584     *
5585     * @see elm_box_transition_new()
5586     * @see elm_box_layout_set()
5587     * @see elm_box_layout_transition()
5588     */
5589    typedef struct _Elm_Box_Transition Elm_Box_Transition;
5590
5591    /**
5592     * Add a new box to the parent
5593     *
5594     * By default, the box will be in vertical mode and non-homogeneous.
5595     *
5596     * @param parent The parent object
5597     * @return The new object or NULL if it cannot be created
5598     */
5599    EAPI Evas_Object        *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5600    /**
5601     * Set the horizontal orientation
5602     *
5603     * By default, box object arranges their contents vertically from top to
5604     * bottom.
5605     * By calling this function with @p horizontal as EINA_TRUE, the box will
5606     * become horizontal, arranging contents from left to right.
5607     *
5608     * @note This flag is ignored if a custom layout function is set.
5609     *
5610     * @param obj The box object
5611     * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5612     * EINA_FALSE = vertical)
5613     */
5614    EAPI void                elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5615    /**
5616     * Get the horizontal orientation
5617     *
5618     * @param obj The box object
5619     * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5620     */
5621    EAPI Eina_Bool           elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5622    /**
5623     * Set the box to arrange its children homogeneously
5624     *
5625     * If enabled, homogeneous layout makes all items the same size, according
5626     * to the size of the largest of its children.
5627     *
5628     * @note This flag is ignored if a custom layout function is set.
5629     *
5630     * @param obj The box object
5631     * @param homogeneous The homogeneous flag
5632     */
5633    EAPI void                elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5634    /**
5635     * Get whether the box is using homogeneous mode or not
5636     *
5637     * @param obj The box object
5638     * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5639     */
5640    EAPI Eina_Bool           elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5641    EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5642    EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5643    /**
5644     * Add an object to the beginning of the pack list
5645     *
5646     * Pack @p subobj into the box @p obj, placing it first in the list of
5647     * children objects. The actual position the object will get on screen
5648     * depends on the layout used. If no custom layout is set, it will be at
5649     * the top or left, depending if the box is vertical or horizontal,
5650     * respectively.
5651     *
5652     * @param obj The box object
5653     * @param subobj The object to add to the box
5654     *
5655     * @see elm_box_pack_end()
5656     * @see elm_box_pack_before()
5657     * @see elm_box_pack_after()
5658     * @see elm_box_unpack()
5659     * @see elm_box_unpack_all()
5660     * @see elm_box_clear()
5661     */
5662    EAPI void                elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5663    /**
5664     * Add an object at the end of the pack list
5665     *
5666     * Pack @p subobj into the box @p obj, placing it last in the list of
5667     * children objects. The actual position the object will get on screen
5668     * depends on the layout used. If no custom layout is set, it will be at
5669     * the bottom or right, depending if the box is vertical or horizontal,
5670     * respectively.
5671     *
5672     * @param obj The box object
5673     * @param subobj The object to add to the box
5674     *
5675     * @see elm_box_pack_start()
5676     * @see elm_box_pack_before()
5677     * @see elm_box_pack_after()
5678     * @see elm_box_unpack()
5679     * @see elm_box_unpack_all()
5680     * @see elm_box_clear()
5681     */
5682    EAPI void                elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5683    /**
5684     * Adds an object to the box before the indicated object
5685     *
5686     * This will add the @p subobj to the box indicated before the object
5687     * indicated with @p before. If @p before is not already in the box, results
5688     * are undefined. Before means either to the left of the indicated object or
5689     * above it depending on orientation.
5690     *
5691     * @param obj The box object
5692     * @param subobj The object to add to the box
5693     * @param before The object before which to add it
5694     *
5695     * @see elm_box_pack_start()
5696     * @see elm_box_pack_end()
5697     * @see elm_box_pack_after()
5698     * @see elm_box_unpack()
5699     * @see elm_box_unpack_all()
5700     * @see elm_box_clear()
5701     */
5702    EAPI void                elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5703    /**
5704     * Adds an object to the box after the indicated object
5705     *
5706     * This will add the @p subobj to the box indicated after the object
5707     * indicated with @p after. If @p after is not already in the box, results
5708     * are undefined. After means either to the right of the indicated object or
5709     * below it depending on orientation.
5710     *
5711     * @param obj The box object
5712     * @param subobj The object to add to the box
5713     * @param after The object after which to add it
5714     *
5715     * @see elm_box_pack_start()
5716     * @see elm_box_pack_end()
5717     * @see elm_box_pack_before()
5718     * @see elm_box_unpack()
5719     * @see elm_box_unpack_all()
5720     * @see elm_box_clear()
5721     */
5722    EAPI void                elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5723    /**
5724     * Clear the box of all children
5725     *
5726     * Remove all the elements contained by the box, deleting the respective
5727     * objects.
5728     *
5729     * @param obj The box object
5730     *
5731     * @see elm_box_unpack()
5732     * @see elm_box_unpack_all()
5733     */
5734    EAPI void                elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5735    /**
5736     * Unpack a box item
5737     *
5738     * Remove the object given by @p subobj from the box @p obj without
5739     * deleting it.
5740     *
5741     * @param obj The box object
5742     *
5743     * @see elm_box_unpack_all()
5744     * @see elm_box_clear()
5745     */
5746    EAPI void                elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5747    /**
5748     * Remove all items from the box, without deleting them
5749     *
5750     * Clear the box from all children, but don't delete the respective objects.
5751     * If no other references of the box children exist, the objects will never
5752     * be deleted, and thus the application will leak the memory. Make sure
5753     * when using this function that you hold a reference to all the objects
5754     * in the box @p obj.
5755     *
5756     * @param obj The box object
5757     *
5758     * @see elm_box_clear()
5759     * @see elm_box_unpack()
5760     */
5761    EAPI void                elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5762    /**
5763     * Retrieve a list of the objects packed into the box
5764     *
5765     * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5766     * The order of the list corresponds to the packing order the box uses.
5767     *
5768     * You must free this list with eina_list_free() once you are done with it.
5769     *
5770     * @param obj The box object
5771     */
5772    EAPI const Eina_List    *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5773    /**
5774     * Set the space (padding) between the box's elements.
5775     *
5776     * Extra space in pixels that will be added between a box child and its
5777     * neighbors after its containing cell has been calculated. This padding
5778     * is set for all elements in the box, besides any possible padding that
5779     * individual elements may have through their size hints.
5780     *
5781     * @param obj The box object
5782     * @param horizontal The horizontal space between elements
5783     * @param vertical The vertical space between elements
5784     */
5785    EAPI void                elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5786    /**
5787     * Get the space (padding) between the box's elements.
5788     *
5789     * @param obj The box object
5790     * @param horizontal The horizontal space between elements
5791     * @param vertical The vertical space between elements
5792     *
5793     * @see elm_box_padding_set()
5794     */
5795    EAPI void                elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5796    /**
5797     * Set the alignment of the whole bouding box of contents.
5798     *
5799     * Sets how the bounding box containing all the elements of the box, after
5800     * their sizes and position has been calculated, will be aligned within
5801     * the space given for the whole box widget.
5802     *
5803     * @param obj The box object
5804     * @param horizontal The horizontal alignment of elements
5805     * @param vertical The vertical alignment of elements
5806     */
5807    EAPI void                elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
5808    /**
5809     * Get the alignment of the whole bouding box of contents.
5810     *
5811     * @param obj The box object
5812     * @param horizontal The horizontal alignment of elements
5813     * @param vertical The vertical alignment of elements
5814     *
5815     * @see elm_box_align_set()
5816     */
5817    EAPI void                elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
5818
5819    /**
5820     * Set the layout defining function to be used by the box
5821     *
5822     * Whenever anything changes that requires the box in @p obj to recalculate
5823     * the size and position of its elements, the function @p cb will be called
5824     * to determine what the layout of the children will be.
5825     *
5826     * Once a custom function is set, everything about the children layout
5827     * is defined by it. The flags set by elm_box_horizontal_set() and
5828     * elm_box_homogeneous_set() no longer have any meaning, and the values
5829     * given by elm_box_padding_set() and elm_box_align_set() are up to this
5830     * layout function to decide if they are used and how. These last two
5831     * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
5832     * passed to @p cb. The @c Evas_Object the function receives is not the
5833     * Elementary widget, but the internal Evas Box it uses, so none of the
5834     * functions described here can be used on it.
5835     *
5836     * Any of the layout functions in @c Evas can be used here, as well as the
5837     * special elm_box_layout_transition().
5838     *
5839     * The final @p data argument received by @p cb is the same @p data passed
5840     * here, and the @p free_data function will be called to free it
5841     * whenever the box is destroyed or another layout function is set.
5842     *
5843     * Setting @p cb to NULL will revert back to the default layout function.
5844     *
5845     * @param obj The box object
5846     * @param cb The callback function used for layout
5847     * @param data Data that will be passed to layout function
5848     * @param free_data Function called to free @p data
5849     *
5850     * @see elm_box_layout_transition()
5851     */
5852    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);
5853    /**
5854     * Special layout function that animates the transition from one layout to another
5855     *
5856     * Normally, when switching the layout function for a box, this will be
5857     * reflected immediately on screen on the next render, but it's also
5858     * possible to do this through an animated transition.
5859     *
5860     * This is done by creating an ::Elm_Box_Transition and setting the box
5861     * layout to this function.
5862     *
5863     * For example:
5864     * @code
5865     * Elm_Box_Transition *t = elm_box_transition_new(1.0,
5866     *                            evas_object_box_layout_vertical, // start
5867     *                            NULL, // data for initial layout
5868     *                            NULL, // free function for initial data
5869     *                            evas_object_box_layout_horizontal, // end
5870     *                            NULL, // data for final layout
5871     *                            NULL, // free function for final data
5872     *                            anim_end, // will be called when animation ends
5873     *                            NULL); // data for anim_end function\
5874     * elm_box_layout_set(box, elm_box_layout_transition, t,
5875     *                    elm_box_transition_free);
5876     * @endcode
5877     *
5878     * @note This function can only be used with elm_box_layout_set(). Calling
5879     * it directly will not have the expected results.
5880     *
5881     * @see elm_box_transition_new
5882     * @see elm_box_transition_free
5883     * @see elm_box_layout_set
5884     */
5885    EAPI void                elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
5886    /**
5887     * Create a new ::Elm_Box_Transition to animate the switch of layouts
5888     *
5889     * If you want to animate the change from one layout to another, you need
5890     * to set the layout function of the box to elm_box_layout_transition(),
5891     * passing as user data to it an instance of ::Elm_Box_Transition with the
5892     * necessary information to perform this animation. The free function to
5893     * set for the layout is elm_box_transition_free().
5894     *
5895     * The parameters to create an ::Elm_Box_Transition sum up to how long
5896     * will it be, in seconds, a layout function to describe the initial point,
5897     * another for the final position of the children and one function to be
5898     * called when the whole animation ends. This last function is useful to
5899     * set the definitive layout for the box, usually the same as the end
5900     * layout for the animation, but could be used to start another transition.
5901     *
5902     * @param start_layout The layout function that will be used to start the animation
5903     * @param start_layout_data The data to be passed the @p start_layout function
5904     * @param start_layout_free_data Function to free @p start_layout_data
5905     * @param end_layout The layout function that will be used to end the animation
5906     * @param end_layout_free_data The data to be passed the @p end_layout function
5907     * @param end_layout_free_data Function to free @p end_layout_data
5908     * @param transition_end_cb Callback function called when animation ends
5909     * @param transition_end_data Data to be passed to @p transition_end_cb
5910     * @return An instance of ::Elm_Box_Transition
5911     *
5912     * @see elm_box_transition_new
5913     * @see elm_box_layout_transition
5914     */
5915    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);
5916    /**
5917     * Free a Elm_Box_Transition instance created with elm_box_transition_new().
5918     *
5919     * This function is mostly useful as the @c free_data parameter in
5920     * elm_box_layout_set() when elm_box_layout_transition().
5921     *
5922     * @param data The Elm_Box_Transition instance to be freed.
5923     *
5924     * @see elm_box_transition_new
5925     * @see elm_box_layout_transition
5926     */
5927    EAPI void                elm_box_transition_free(void *data);
5928    /**
5929     * @}
5930     */
5931
5932    /* button */
5933    /**
5934     * @defgroup Button Button
5935     *
5936     * @image html img/widget/button/preview-00.png
5937     * @image latex img/widget/button/preview-00.eps
5938     * @image html img/widget/button/preview-01.png
5939     * @image latex img/widget/button/preview-01.eps
5940     * @image html img/widget/button/preview-02.png
5941     * @image latex img/widget/button/preview-02.eps
5942     *
5943     * This is a push-button. Press it and run some function. It can contain
5944     * a simple label and icon object and it also has an autorepeat feature.
5945     *
5946     * This widgets emits the following signals:
5947     * @li "clicked": the user clicked the button (press/release).
5948     * @li "repeated": the user pressed the button without releasing it.
5949     * @li "pressed": button was pressed.
5950     * @li "unpressed": button was released after being pressed.
5951     * In all three cases, the @c event parameter of the callback will be
5952     * @c NULL.
5953     *
5954     * Also, defined in the default theme, the button has the following styles
5955     * available:
5956     * @li default: a normal button.
5957     * @li anchor: Like default, but the button fades away when the mouse is not
5958     * over it, leaving only the text or icon.
5959     * @li hoversel_vertical: Internally used by @ref Hoversel to give a
5960     * continuous look across its options.
5961     * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
5962     *
5963     * Follow through a complete example @ref button_example_01 "here".
5964     * @{
5965     */
5966    /**
5967     * Add a new button to the parent's canvas
5968     *
5969     * @param parent The parent object
5970     * @return The new object or NULL if it cannot be created
5971     */
5972    EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5973    /**
5974     * Set the label used in the button
5975     *
5976     * The passed @p label can be NULL to clean any existing text in it and
5977     * leave the button as an icon only object.
5978     *
5979     * @param obj The button object
5980     * @param label The text will be written on the button
5981     * @deprecated use elm_object_text_set() instead.
5982     */
5983    EINA_DEPRECATED EAPI void         elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5984    /**
5985     * Get the label set for the button
5986     *
5987     * The string returned is an internal pointer and should not be freed or
5988     * altered. It will also become invalid when the button is destroyed.
5989     * The string returned, if not NULL, is a stringshare, so if you need to
5990     * keep it around even after the button is destroyed, you can use
5991     * eina_stringshare_ref().
5992     *
5993     * @param obj The button object
5994     * @return The text set to the label, or NULL if nothing is set
5995     * @deprecated use elm_object_text_set() instead.
5996     */
5997    EINA_DEPRECATED EAPI const char  *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5998    /**
5999     * Set the icon used for the button
6000     *
6001     * Setting a new icon will delete any other that was previously set, making
6002     * any reference to them invalid. If you need to maintain the previous
6003     * object alive, unset it first with elm_button_icon_unset().
6004     *
6005     * @param obj The button object
6006     * @param icon The icon object for the button
6007     */
6008    EAPI void         elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6009    /**
6010     * Get the icon used for the button
6011     *
6012     * Return the icon object which is set for this widget. If the button is
6013     * destroyed or another icon is set, the returned object will be deleted
6014     * and any reference to it will be invalid.
6015     *
6016     * @param obj The button object
6017     * @return The icon object that is being used
6018     *
6019     * @see elm_button_icon_unset()
6020     */
6021    EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6022    /**
6023     * Remove the icon set without deleting it and return the object
6024     *
6025     * This function drops the reference the button holds of the icon object
6026     * and returns this last object. It is used in case you want to remove any
6027     * icon, or set another one, without deleting the actual object. The button
6028     * will be left without an icon set.
6029     *
6030     * @param obj The button object
6031     * @return The icon object that was being used
6032     */
6033    EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6034    /**
6035     * Turn on/off the autorepeat event generated when the button is kept pressed
6036     *
6037     * When off, no autorepeat is performed and buttons emit a normal @c clicked
6038     * signal when they are clicked.
6039     *
6040     * When on, keeping a button pressed will continuously emit a @c repeated
6041     * signal until the button is released. The time it takes until it starts
6042     * emitting the signal is given by
6043     * elm_button_autorepeat_initial_timeout_set(), and the time between each
6044     * new emission by elm_button_autorepeat_gap_timeout_set().
6045     *
6046     * @param obj The button object
6047     * @param on  A bool to turn on/off the event
6048     */
6049    EAPI void         elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6050    /**
6051     * Get whether the autorepeat feature is enabled
6052     *
6053     * @param obj The button object
6054     * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6055     *
6056     * @see elm_button_autorepeat_set()
6057     */
6058    EAPI Eina_Bool    elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6059    /**
6060     * Set the initial timeout before the autorepeat event is generated
6061     *
6062     * Sets the timeout, in seconds, since the button is pressed until the
6063     * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6064     * won't be any delay and the even will be fired the moment the button is
6065     * pressed.
6066     *
6067     * @param obj The button object
6068     * @param t   Timeout in seconds
6069     *
6070     * @see elm_button_autorepeat_set()
6071     * @see elm_button_autorepeat_gap_timeout_set()
6072     */
6073    EAPI void         elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6074    /**
6075     * Get the initial timeout before the autorepeat event is generated
6076     *
6077     * @param obj The button object
6078     * @return Timeout in seconds
6079     *
6080     * @see elm_button_autorepeat_initial_timeout_set()
6081     */
6082    EAPI double       elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6083    /**
6084     * Set the interval between each generated autorepeat event
6085     *
6086     * After the first @c repeated event is fired, all subsequent ones will
6087     * follow after a delay of @p t seconds for each.
6088     *
6089     * @param obj The button object
6090     * @param t   Interval in seconds
6091     *
6092     * @see elm_button_autorepeat_initial_timeout_set()
6093     */
6094    EAPI void         elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6095    /**
6096     * Get the interval between each generated autorepeat event
6097     *
6098     * @param obj The button object
6099     * @return Interval in seconds
6100     */
6101    EAPI double       elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6102    /**
6103     * @}
6104     */
6105
6106    /**
6107     * @defgroup File_Selector_Button File Selector Button
6108     *
6109     * @image html img/widget/fileselector_button/preview-00.png
6110     * @image latex img/widget/fileselector_button/preview-00.eps
6111     * @image html img/widget/fileselector_button/preview-01.png
6112     * @image latex img/widget/fileselector_button/preview-01.eps
6113     * @image html img/widget/fileselector_button/preview-02.png
6114     * @image latex img/widget/fileselector_button/preview-02.eps
6115     *
6116     * This is a button that, when clicked, creates an Elementary
6117     * window (or inner window) <b> with a @ref Fileselector "file
6118     * selector widget" within</b>. When a file is chosen, the (inner)
6119     * window is closed and the button emits a signal having the
6120     * selected file as it's @c event_info.
6121     *
6122     * This widget encapsulates operations on its internal file
6123     * selector on its own API. There is less control over its file
6124     * selector than that one would have instatiating one directly.
6125     *
6126     * The following styles are available for this button:
6127     * @li @c "default"
6128     * @li @c "anchor"
6129     * @li @c "hoversel_vertical"
6130     * @li @c "hoversel_vertical_entry"
6131     *
6132     * Smart callbacks one can register to:
6133     * - @c "file,chosen" - the user has selected a path, whose string
6134     *   pointer comes as the @c event_info data (a stringshared
6135     *   string)
6136     *
6137     * Here is an example on its usage:
6138     * @li @ref fileselector_button_example
6139     *
6140     * @see @ref File_Selector_Entry for a similar widget.
6141     * @{
6142     */
6143
6144    /**
6145     * Add a new file selector button widget to the given parent
6146     * Elementary (container) object
6147     *
6148     * @param parent The parent object
6149     * @return a new file selector button widget handle or @c NULL, on
6150     * errors
6151     */
6152    EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6153
6154    /**
6155     * Set the label for a given file selector button widget
6156     *
6157     * @param obj The file selector button widget
6158     * @param label The text label to be displayed on @p obj
6159     *
6160     * @deprecated use elm_object_text_set() instead.
6161     */
6162    EINA_DEPRECATED EAPI void         elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6163
6164    /**
6165     * Get the label set for a given file selector button widget
6166     *
6167     * @param obj The file selector button widget
6168     * @return The button label
6169     *
6170     * @deprecated use elm_object_text_set() instead.
6171     */
6172    EINA_DEPRECATED EAPI const char  *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6173
6174    /**
6175     * Set the icon on a given file selector button widget
6176     *
6177     * @param obj The file selector button widget
6178     * @param icon The icon object for the button
6179     *
6180     * Once the icon object is set, a previously set one will be
6181     * deleted. If you want to keep the latter, use the
6182     * elm_fileselector_button_icon_unset() function.
6183     *
6184     * @see elm_fileselector_button_icon_get()
6185     */
6186    EAPI void         elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6187
6188    /**
6189     * Get the icon set for a given file selector button widget
6190     *
6191     * @param obj The file selector button widget
6192     * @return The icon object currently set on @p obj or @c NULL, if
6193     * none is
6194     *
6195     * @see elm_fileselector_button_icon_set()
6196     */
6197    EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6198
6199    /**
6200     * Unset the icon used in a given file selector button widget
6201     *
6202     * @param obj The file selector button widget
6203     * @return The icon object that was being used on @p obj or @c
6204     * NULL, on errors
6205     *
6206     * Unparent and return the icon object which was set for this
6207     * widget.
6208     *
6209     * @see elm_fileselector_button_icon_set()
6210     */
6211    EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6212
6213    /**
6214     * Set the title for a given file selector button widget's window
6215     *
6216     * @param obj The file selector button widget
6217     * @param title The title string
6218     *
6219     * This will change the window's title, when the file selector pops
6220     * out after a click on the button. Those windows have the default
6221     * (unlocalized) value of @c "Select a file" as titles.
6222     *
6223     * @note It will only take any effect if the file selector
6224     * button widget is @b not under "inwin mode".
6225     *
6226     * @see elm_fileselector_button_window_title_get()
6227     */
6228    EAPI void         elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6229
6230    /**
6231     * Get the title set for a given file selector button widget's
6232     * window
6233     *
6234     * @param obj The file selector button widget
6235     * @return Title of the file selector button's window
6236     *
6237     * @see elm_fileselector_button_window_title_get() for more details
6238     */
6239    EAPI const char  *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6240
6241    /**
6242     * Set the size of a given file selector button widget's window,
6243     * holding the file selector itself.
6244     *
6245     * @param obj The file selector button widget
6246     * @param width The window's width
6247     * @param height The window's height
6248     *
6249     * @note it will only take any effect if the file selector button
6250     * widget is @b not under "inwin mode". The default size for the
6251     * window (when applicable) is 400x400 pixels.
6252     *
6253     * @see elm_fileselector_button_window_size_get()
6254     */
6255    EAPI void         elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6256
6257    /**
6258     * Get the size of a given file selector button widget's window,
6259     * holding the file selector itself.
6260     *
6261     * @param obj The file selector button widget
6262     * @param width Pointer into which to store the width value
6263     * @param height Pointer into which to store the height value
6264     *
6265     * @note Use @c NULL pointers on the size values you're not
6266     * interested in: they'll be ignored by the function.
6267     *
6268     * @see elm_fileselector_button_window_size_set(), for more details
6269     */
6270    EAPI void         elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6271
6272    /**
6273     * Set the initial file system path for a given file selector
6274     * button widget
6275     *
6276     * @param obj The file selector button widget
6277     * @param path The path string
6278     *
6279     * It must be a <b>directory</b> path, which will have the contents
6280     * displayed initially in the file selector's view, when invoked
6281     * from @p obj. The default initial path is the @c "HOME"
6282     * environment variable's value.
6283     *
6284     * @see elm_fileselector_button_path_get()
6285     */
6286    EAPI void         elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6287
6288    /**
6289     * Get the initial file system path set for a given file selector
6290     * button widget
6291     *
6292     * @param obj The file selector button widget
6293     * @return path The path string
6294     *
6295     * @see elm_fileselector_button_path_set() for more details
6296     */
6297    EAPI const char  *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6298
6299    /**
6300     * Enable/disable a tree view in the given file selector button
6301     * widget's internal file selector
6302     *
6303     * @param obj The file selector button widget
6304     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6305     * disable
6306     *
6307     * This has the same effect as elm_fileselector_expandable_set(),
6308     * but now applied to a file selector button's internal file
6309     * selector.
6310     *
6311     * @note There's no way to put a file selector button's internal
6312     * file selector in "grid mode", as one may do with "pure" file
6313     * selectors.
6314     *
6315     * @see elm_fileselector_expandable_get()
6316     */
6317    EAPI void         elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6318
6319    /**
6320     * Get whether tree view is enabled for the given file selector
6321     * button widget's internal file selector
6322     *
6323     * @param obj The file selector button widget
6324     * @return @c EINA_TRUE if @p obj widget's internal file selector
6325     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6326     *
6327     * @see elm_fileselector_expandable_set() for more details
6328     */
6329    EAPI Eina_Bool    elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6330
6331    /**
6332     * Set whether a given file selector button widget's internal file
6333     * selector is to display folders only or the directory contents,
6334     * as well.
6335     *
6336     * @param obj The file selector button widget
6337     * @param only @c EINA_TRUE to make @p obj widget's internal file
6338     * selector only display directories, @c EINA_FALSE to make files
6339     * to be displayed in it too
6340     *
6341     * This has the same effect as elm_fileselector_folder_only_set(),
6342     * but now applied to a file selector button's internal file
6343     * selector.
6344     *
6345     * @see elm_fileselector_folder_only_get()
6346     */
6347    EAPI void         elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6348
6349    /**
6350     * Get whether a given file selector button widget's internal file
6351     * selector is displaying folders only or the directory contents,
6352     * as well.
6353     *
6354     * @param obj The file selector button widget
6355     * @return @c EINA_TRUE if @p obj widget's internal file
6356     * selector is only displaying directories, @c EINA_FALSE if files
6357     * are being displayed in it too (and on errors)
6358     *
6359     * @see elm_fileselector_button_folder_only_set() for more details
6360     */
6361    EAPI Eina_Bool    elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6362
6363    /**
6364     * Enable/disable the file name entry box where the user can type
6365     * in a name for a file, in a given file selector button widget's
6366     * internal file selector.
6367     *
6368     * @param obj The file selector button widget
6369     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6370     * file selector a "saving dialog", @c EINA_FALSE otherwise
6371     *
6372     * This has the same effect as elm_fileselector_is_save_set(),
6373     * but now applied to a file selector button's internal file
6374     * selector.
6375     *
6376     * @see elm_fileselector_is_save_get()
6377     */
6378    EAPI void         elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6379
6380    /**
6381     * Get whether the given file selector button widget's internal
6382     * file selector is in "saving dialog" mode
6383     *
6384     * @param obj The file selector button widget
6385     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6386     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6387     * errors)
6388     *
6389     * @see elm_fileselector_button_is_save_set() for more details
6390     */
6391    EAPI Eina_Bool    elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6392
6393    /**
6394     * Set whether a given file selector button widget's internal file
6395     * selector will raise an Elementary "inner window", instead of a
6396     * dedicated Elementary window. By default, it won't.
6397     *
6398     * @param obj The file selector button widget
6399     * @param value @c EINA_TRUE to make it use an inner window, @c
6400     * EINA_TRUE to make it use a dedicated window
6401     *
6402     * @see elm_win_inwin_add() for more information on inner windows
6403     * @see elm_fileselector_button_inwin_mode_get()
6404     */
6405    EAPI void         elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6406
6407    /**
6408     * Get whether a given file selector button widget's internal file
6409     * selector will raise an Elementary "inner window", instead of a
6410     * dedicated Elementary window.
6411     *
6412     * @param obj The file selector button widget
6413     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6414     * if it will use a dedicated window
6415     *
6416     * @see elm_fileselector_button_inwin_mode_set() for more details
6417     */
6418    EAPI Eina_Bool    elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6419
6420    /**
6421     * @}
6422     */
6423
6424     /**
6425     * @defgroup File_Selector_Entry File Selector Entry
6426     *
6427     * @image html img/widget/fileselector_entry/preview-00.png
6428     * @image latex img/widget/fileselector_entry/preview-00.eps
6429     *
6430     * This is an entry made to be filled with or display a <b>file
6431     * system path string</b>. Besides the entry itself, the widget has
6432     * a @ref File_Selector_Button "file selector button" on its side,
6433     * which will raise an internal @ref Fileselector "file selector widget",
6434     * when clicked, for path selection aided by file system
6435     * navigation.
6436     *
6437     * This file selector may appear in an Elementary window or in an
6438     * inner window. When a file is chosen from it, the (inner) window
6439     * is closed and the selected file's path string is exposed both as
6440     * an smart event and as the new text on the entry.
6441     *
6442     * This widget encapsulates operations on its internal file
6443     * selector on its own API. There is less control over its file
6444     * selector than that one would have instatiating one directly.
6445     *
6446     * Smart callbacks one can register to:
6447     * - @c "changed" - The text within the entry was changed
6448     * - @c "activated" - The entry has had editing finished and
6449     *   changes are to be "committed"
6450     * - @c "press" - The entry has been clicked
6451     * - @c "longpressed" - The entry has been clicked (and held) for a
6452     *   couple seconds
6453     * - @c "clicked" - The entry has been clicked
6454     * - @c "clicked,double" - The entry has been double clicked
6455     * - @c "focused" - The entry has received focus
6456     * - @c "unfocused" - The entry has lost focus
6457     * - @c "selection,paste" - A paste action has occurred on the
6458     *   entry
6459     * - @c "selection,copy" - A copy action has occurred on the entry
6460     * - @c "selection,cut" - A cut action has occurred on the entry
6461     * - @c "unpressed" - The file selector entry's button was released
6462     *   after being pressed.
6463     * - @c "file,chosen" - The user has selected a path via the file
6464     *   selector entry's internal file selector, whose string pointer
6465     *   comes as the @c event_info data (a stringshared string)
6466     *
6467     * Here is an example on its usage:
6468     * @li @ref fileselector_entry_example
6469     *
6470     * @see @ref File_Selector_Button for a similar widget.
6471     * @{
6472     */
6473
6474    /**
6475     * Add a new file selector entry widget to the given parent
6476     * Elementary (container) object
6477     *
6478     * @param parent The parent object
6479     * @return a new file selector entry widget handle or @c NULL, on
6480     * errors
6481     */
6482    EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6483
6484    /**
6485     * Set the label for a given file selector entry widget's button
6486     *
6487     * @param obj The file selector entry widget
6488     * @param label The text label to be displayed on @p obj widget's
6489     * button
6490     *
6491     * @deprecated use elm_object_text_set() instead.
6492     */
6493    EINA_DEPRECATED EAPI void         elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6494
6495    /**
6496     * Get the label set for a given file selector entry widget's button
6497     *
6498     * @param obj The file selector entry widget
6499     * @return The widget button's label
6500     *
6501     * @deprecated use elm_object_text_set() instead.
6502     */
6503    EINA_DEPRECATED EAPI const char  *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6504
6505    /**
6506     * Set the icon on a given file selector entry widget's button
6507     *
6508     * @param obj The file selector entry widget
6509     * @param icon The icon object for the entry's button
6510     *
6511     * Once the icon object is set, a previously set one will be
6512     * deleted. If you want to keep the latter, use the
6513     * elm_fileselector_entry_button_icon_unset() function.
6514     *
6515     * @see elm_fileselector_entry_button_icon_get()
6516     */
6517    EAPI void         elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6518
6519    /**
6520     * Get the icon set for a given file selector entry widget's button
6521     *
6522     * @param obj The file selector entry widget
6523     * @return The icon object currently set on @p obj widget's button
6524     * or @c NULL, if none is
6525     *
6526     * @see elm_fileselector_entry_button_icon_set()
6527     */
6528    EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6529
6530    /**
6531     * Unset the icon used in a given file selector entry widget's
6532     * button
6533     *
6534     * @param obj The file selector entry widget
6535     * @return The icon object that was being used on @p obj widget's
6536     * button or @c NULL, on errors
6537     *
6538     * Unparent and return the icon object which was set for this
6539     * widget's button.
6540     *
6541     * @see elm_fileselector_entry_button_icon_set()
6542     */
6543    EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6544
6545    /**
6546     * Set the title for a given file selector entry widget's window
6547     *
6548     * @param obj The file selector entry widget
6549     * @param title The title string
6550     *
6551     * This will change the window's title, when the file selector pops
6552     * out after a click on the entry's button. Those windows have the
6553     * default (unlocalized) value of @c "Select a file" as titles.
6554     *
6555     * @note It will only take any effect if the file selector
6556     * entry widget is @b not under "inwin mode".
6557     *
6558     * @see elm_fileselector_entry_window_title_get()
6559     */
6560    EAPI void         elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6561
6562    /**
6563     * Get the title set for a given file selector entry widget's
6564     * window
6565     *
6566     * @param obj The file selector entry widget
6567     * @return Title of the file selector entry's window
6568     *
6569     * @see elm_fileselector_entry_window_title_get() for more details
6570     */
6571    EAPI const char  *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6572
6573    /**
6574     * Set the size of a given file selector entry widget's window,
6575     * holding the file selector itself.
6576     *
6577     * @param obj The file selector entry widget
6578     * @param width The window's width
6579     * @param height The window's height
6580     *
6581     * @note it will only take any effect if the file selector entry
6582     * widget is @b not under "inwin mode". The default size for the
6583     * window (when applicable) is 400x400 pixels.
6584     *
6585     * @see elm_fileselector_entry_window_size_get()
6586     */
6587    EAPI void         elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6588
6589    /**
6590     * Get the size of a given file selector entry widget's window,
6591     * holding the file selector itself.
6592     *
6593     * @param obj The file selector entry widget
6594     * @param width Pointer into which to store the width value
6595     * @param height Pointer into which to store the height value
6596     *
6597     * @note Use @c NULL pointers on the size values you're not
6598     * interested in: they'll be ignored by the function.
6599     *
6600     * @see elm_fileselector_entry_window_size_set(), for more details
6601     */
6602    EAPI void         elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6603
6604    /**
6605     * Set the initial file system path and the entry's path string for
6606     * a given file selector entry widget
6607     *
6608     * @param obj The file selector entry widget
6609     * @param path The path string
6610     *
6611     * It must be a <b>directory</b> path, which will have the contents
6612     * displayed initially in the file selector's view, when invoked
6613     * from @p obj. The default initial path is the @c "HOME"
6614     * environment variable's value.
6615     *
6616     * @see elm_fileselector_entry_path_get()
6617     */
6618    EAPI void         elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6619
6620    /**
6621     * Get the entry's path string for a given file selector entry
6622     * widget
6623     *
6624     * @param obj The file selector entry widget
6625     * @return path The path string
6626     *
6627     * @see elm_fileselector_entry_path_set() for more details
6628     */
6629    EAPI const char  *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6630
6631    /**
6632     * Enable/disable a tree view in the given file selector entry
6633     * widget's internal file selector
6634     *
6635     * @param obj The file selector entry widget
6636     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6637     * disable
6638     *
6639     * This has the same effect as elm_fileselector_expandable_set(),
6640     * but now applied to a file selector entry's internal file
6641     * selector.
6642     *
6643     * @note There's no way to put a file selector entry's internal
6644     * file selector in "grid mode", as one may do with "pure" file
6645     * selectors.
6646     *
6647     * @see elm_fileselector_expandable_get()
6648     */
6649    EAPI void         elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6650
6651    /**
6652     * Get whether tree view is enabled for the given file selector
6653     * entry widget's internal file selector
6654     *
6655     * @param obj The file selector entry widget
6656     * @return @c EINA_TRUE if @p obj widget's internal file selector
6657     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6658     *
6659     * @see elm_fileselector_expandable_set() for more details
6660     */
6661    EAPI Eina_Bool    elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6662
6663    /**
6664     * Set whether a given file selector entry widget's internal file
6665     * selector is to display folders only or the directory contents,
6666     * as well.
6667     *
6668     * @param obj The file selector entry widget
6669     * @param only @c EINA_TRUE to make @p obj widget's internal file
6670     * selector only display directories, @c EINA_FALSE to make files
6671     * to be displayed in it too
6672     *
6673     * This has the same effect as elm_fileselector_folder_only_set(),
6674     * but now applied to a file selector entry's internal file
6675     * selector.
6676     *
6677     * @see elm_fileselector_folder_only_get()
6678     */
6679    EAPI void         elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6680
6681    /**
6682     * Get whether a given file selector entry widget's internal file
6683     * selector is displaying folders only or the directory contents,
6684     * as well.
6685     *
6686     * @param obj The file selector entry widget
6687     * @return @c EINA_TRUE if @p obj widget's internal file
6688     * selector is only displaying directories, @c EINA_FALSE if files
6689     * are being displayed in it too (and on errors)
6690     *
6691     * @see elm_fileselector_entry_folder_only_set() for more details
6692     */
6693    EAPI Eina_Bool    elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6694
6695    /**
6696     * Enable/disable the file name entry box where the user can type
6697     * in a name for a file, in a given file selector entry widget's
6698     * internal file selector.
6699     *
6700     * @param obj The file selector entry widget
6701     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6702     * file selector a "saving dialog", @c EINA_FALSE otherwise
6703     *
6704     * This has the same effect as elm_fileselector_is_save_set(),
6705     * but now applied to a file selector entry's internal file
6706     * selector.
6707     *
6708     * @see elm_fileselector_is_save_get()
6709     */
6710    EAPI void         elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6711
6712    /**
6713     * Get whether the given file selector entry widget's internal
6714     * file selector is in "saving dialog" mode
6715     *
6716     * @param obj The file selector entry widget
6717     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6718     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6719     * errors)
6720     *
6721     * @see elm_fileselector_entry_is_save_set() for more details
6722     */
6723    EAPI Eina_Bool    elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6724
6725    /**
6726     * Set whether a given file selector entry widget's internal file
6727     * selector will raise an Elementary "inner window", instead of a
6728     * dedicated Elementary window. By default, it won't.
6729     *
6730     * @param obj The file selector entry widget
6731     * @param value @c EINA_TRUE to make it use an inner window, @c
6732     * EINA_TRUE to make it use a dedicated window
6733     *
6734     * @see elm_win_inwin_add() for more information on inner windows
6735     * @see elm_fileselector_entry_inwin_mode_get()
6736     */
6737    EAPI void         elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6738
6739    /**
6740     * Get whether a given file selector entry widget's internal file
6741     * selector will raise an Elementary "inner window", instead of a
6742     * dedicated Elementary window.
6743     *
6744     * @param obj The file selector entry widget
6745     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6746     * if it will use a dedicated window
6747     *
6748     * @see elm_fileselector_entry_inwin_mode_set() for more details
6749     */
6750    EAPI Eina_Bool    elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6751
6752    /**
6753     * Set the initial file system path for a given file selector entry
6754     * widget
6755     *
6756     * @param obj The file selector entry widget
6757     * @param path The path string
6758     *
6759     * It must be a <b>directory</b> path, which will have the contents
6760     * displayed initially in the file selector's view, when invoked
6761     * from @p obj. The default initial path is the @c "HOME"
6762     * environment variable's value.
6763     *
6764     * @see elm_fileselector_entry_path_get()
6765     */
6766    EAPI void         elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6767
6768    /**
6769     * Get the parent directory's path to the latest file selection on
6770     * a given filer selector entry widget
6771     *
6772     * @param obj The file selector object
6773     * @return The (full) path of the directory of the last selection
6774     * on @p obj widget, a @b stringshared string
6775     *
6776     * @see elm_fileselector_entry_path_set()
6777     */
6778    EAPI const char  *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6779
6780    /**
6781     * @}
6782     */
6783
6784    /**
6785     * @defgroup Scroller Scroller
6786     *
6787     * A scroller holds a single object and "scrolls it around". This means that
6788     * it allows the user to use a scrollbar (or a finger) to drag the viewable
6789     * region around, allowing to move through a much larger object that is
6790     * contained in the scroller. The scroiller will always have a small minimum
6791     * size by default as it won't be limited by the contents of the scroller.
6792     *
6793     * Signals that you can add callbacks for are:
6794     * @li "edge,left" - the left edge of the content has been reached
6795     * @li "edge,right" - the right edge of the content has been reached
6796     * @li "edge,top" - the top edge of the content has been reached
6797     * @li "edge,bottom" - the bottom edge of the content has been reached
6798     * @li "scroll" - the content has been scrolled (moved)
6799     * @li "scroll,anim,start" - scrolling animation has started
6800     * @li "scroll,anim,stop" - scrolling animation has stopped
6801     * @li "scroll,drag,start" - dragging the contents around has started
6802     * @li "scroll,drag,stop" - dragging the contents around has stopped
6803     * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
6804     * user intervetion.
6805     *
6806     * @note When Elemementary is in embedded mode the scrollbars will not be
6807     * dragable, they appear merely as indicators of how much has been scrolled.
6808     * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
6809     * fingerscroll) won't work.
6810     *
6811     * In @ref tutorial_scroller you'll find an example of how to use most of
6812     * this API.
6813     * @{
6814     */
6815    /**
6816     * @brief Type that controls when scrollbars should appear.
6817     *
6818     * @see elm_scroller_policy_set()
6819     */
6820    typedef enum _Elm_Scroller_Policy
6821      {
6822         ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
6823         ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
6824         ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
6825         ELM_SCROLLER_POLICY_LAST
6826      } Elm_Scroller_Policy;
6827    /**
6828     * @brief Add a new scroller to the parent
6829     *
6830     * @param parent The parent object
6831     * @return The new object or NULL if it cannot be created
6832     */
6833    EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6834    /**
6835     * @brief Set the content of the scroller widget (the object to be scrolled around).
6836     *
6837     * @param obj The scroller object
6838     * @param content The new content object
6839     *
6840     * Once the content object is set, a previously set one will be deleted.
6841     * If you want to keep that old content object, use the
6842     * elm_scroller_content_unset() function.
6843     */
6844    EAPI void         elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
6845    /**
6846     * @brief Get the content of the scroller widget
6847     *
6848     * @param obj The slider object
6849     * @return The content that is being used
6850     *
6851     * Return the content object which is set for this widget
6852     *
6853     * @see elm_scroller_content_set()
6854     */
6855    EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6856    /**
6857     * @brief Unset the content of the scroller widget
6858     *
6859     * @param obj The slider object
6860     * @return The content that was being used
6861     *
6862     * Unparent and return the content object which was set for this widget
6863     *
6864     * @see elm_scroller_content_set()
6865     */
6866    EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6867    /**
6868     * @brief Set custom theme elements for the scroller
6869     *
6870     * @param obj The scroller object
6871     * @param widget The widget name to use (default is "scroller")
6872     * @param base The base name to use (default is "base")
6873     */
6874    EAPI void         elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
6875    /**
6876     * @brief Make the scroller minimum size limited to the minimum size of the content
6877     *
6878     * @param obj The scroller object
6879     * @param w Enable limiting minimum size horizontally
6880     * @param h Enable limiting minimum size vertically
6881     *
6882     * By default the scroller will be as small as its design allows,
6883     * irrespective of its content. This will make the scroller minimum size the
6884     * right size horizontally and/or vertically to perfectly fit its content in
6885     * that direction.
6886     */
6887    EAPI void         elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
6888    /**
6889     * @brief Show a specific virtual region within the scroller content object
6890     *
6891     * @param obj The scroller object
6892     * @param x X coordinate of the region
6893     * @param y Y coordinate of the region
6894     * @param w Width of the region
6895     * @param h Height of the region
6896     *
6897     * This will ensure all (or part if it does not fit) of the designated
6898     * region in the virtual content object (0, 0 starting at the top-left of the
6899     * virtual content object) is shown within the scroller.
6900     */
6901    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);
6902    /**
6903     * @brief Set the scrollbar visibility policy
6904     *
6905     * @param obj The scroller object
6906     * @param policy_h Horizontal scrollbar policy
6907     * @param policy_v Vertical scrollbar policy
6908     *
6909     * This sets the scrollbar visibility policy for the given scroller.
6910     * ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it is
6911     * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
6912     * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
6913     * respectively for the horizontal and vertical scrollbars.
6914     */
6915    EAPI void         elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
6916    /**
6917     * @brief Gets scrollbar visibility policy
6918     *
6919     * @param obj The scroller object
6920     * @param policy_h Horizontal scrollbar policy
6921     * @param policy_v Vertical scrollbar policy
6922     *
6923     * @see elm_scroller_policy_set()
6924     */
6925    EAPI void         elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
6926    /**
6927     * @brief Get the currently visible content region
6928     *
6929     * @param obj The scroller object
6930     * @param x X coordinate of the region
6931     * @param y Y coordinate of the region
6932     * @param w Width of the region
6933     * @param h Height of the region
6934     *
6935     * This gets the current region in the content object that is visible through
6936     * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
6937     * w, @p h values pointed to.
6938     *
6939     * @note All coordinates are relative to the content.
6940     *
6941     * @see elm_scroller_region_show()
6942     */
6943    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);
6944    /**
6945     * @brief Get the size of the content object
6946     *
6947     * @param obj The scroller object
6948     * @param w Width return
6949     * @param h Height return
6950     *
6951     * This gets the size of the content object of the scroller.
6952     */
6953    EAPI void         elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
6954    /**
6955     * @brief Set bouncing behavior
6956     *
6957     * @param obj The scroller object
6958     * @param h_bounce Will the scroller bounce horizontally or not
6959     * @param v_bounce Will the scroller bounce vertically or not
6960     *
6961     * When scrolling, the scroller may "bounce" when reaching an edge of the
6962     * content object. This is a visual way to indicate the end has been reached.
6963     * This is enabled by default for both axis. This will set if it is enabled
6964     * for that axis with the boolean parameters for each axis.
6965     */
6966    EAPI void         elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6967    /**
6968     * @brief Get the bounce mode
6969     *
6970     * @param obj The Scroller object
6971     * @param h_bounce Allow bounce horizontally
6972     * @param v_bounce Allow bounce vertically
6973     *
6974     * @see elm_scroller_bounce_set()
6975     */
6976    EAPI void         elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
6977    /**
6978     * @brief Set scroll page size relative to viewport size.
6979     *
6980     * @param obj The scroller object
6981     * @param h_pagerel The horizontal page relative size
6982     * @param v_pagerel The vertical page relative size
6983     *
6984     * The scroller is capable of limiting scrolling by the user to "pages". That
6985     * is to jump by and only show a "whole page" at a time as if the continuous
6986     * area of the scroller content is split into page sized pieces. This sets
6987     * the size of a page relative to the viewport of the scroller. 1.0 is "1
6988     * viewport" is size (horizontally or vertically). 0.0 turns it off in that
6989     * axis. This is mutually exclusive with page size
6990     * (see elm_scroller_page_size_set()  for more information). Likewise 0.5
6991     * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
6992     * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
6993     * the other axis.
6994     */
6995    EAPI void         elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
6996    /**
6997     * @brief Set scroll page size.
6998     *
6999     * @param obj The scroller object
7000     * @param h_pagesize The horizontal page size
7001     * @param v_pagesize The vertical page size
7002     *
7003     * This sets the page size to an absolute fixed value, with 0 turning it off
7004     * for that axis.
7005     *
7006     * @see elm_scroller_page_relative_set()
7007     */
7008    EAPI void         elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7009    /**
7010     * @brief Get scroll current page number.
7011     *
7012     * @param obj The scroller object
7013     * @param h_pagenumber The horizoptal page number
7014     * @param v_pagenumber The vertical page number
7015     *
7016     * The page number starts from 0. 0 is the first page.
7017     * Current page means the page which meet the top-left of the viewport.
7018     * If there are two or more pages in the viewport, it returns the number of page
7019     * which meet the top-left of the viewport.
7020     *
7021     * @see elm_scroller_last_page_get()
7022     * @see elm_scroller_page_show()
7023     * @see elm_scroller_page_brint_in()
7024     */
7025    EAPI void         elm_scroller_current_page_get(Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7026    /**
7027     * @brief Get scroll last page number.
7028     *
7029     * @param obj The scroller object
7030     * @param h_pagenumber The horizoptal page number
7031     * @param v_pagenumber The vertical page number
7032     *
7033     * The page number starts from 0. 0 is the first page.
7034     * This returns the last page number among the pages.
7035     *
7036     * @see elm_scroller_current_page_get()
7037     * @see elm_scroller_page_show()
7038     * @see elm_scroller_page_brint_in()
7039     */
7040    EAPI void         elm_scroller_last_page_get(Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7041    /**
7042     * Show a specific virtual region within the scroller content object by page number.
7043     *
7044     * @param obj The scroller object
7045     * @param h_pagenumber The horizoptal page number
7046     * @param v_pagenumber The vertical page number
7047     *
7048     * 0, 0 of the indicated page is located at the top-left of the viewport.
7049     * This will jump to the page directly without animation.
7050     *
7051     * Example of usage:
7052     *
7053     * @code
7054     * sc = elm_scroller_add(win);
7055     * elm_scroller_content_set(sc, content);
7056     * elm_scroller_page_relative_set(sc, 1, 0);
7057     * elm_scroller_current_page_get(sc, &h_page, &v_page);
7058     * elm_scroller_page_show(sc, h_page + 1, v_page);
7059     * @endcode
7060     *
7061     * @see elm_scroller_page_bring_in()
7062     */
7063    EAPI void         elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7064    /**
7065     * Show a specific virtual region within the scroller content object by page number.
7066     *
7067     * @param obj The scroller object
7068     * @param h_pagenumber The horizoptal page number
7069     * @param v_pagenumber The vertical page number
7070     *
7071     * 0, 0 of the indicated page is located at the top-left of the viewport.
7072     * This will slide to the page with animation.
7073     *
7074     * Example of usage:
7075     *
7076     * @code
7077     * sc = elm_scroller_add(win);
7078     * elm_scroller_content_set(sc, content);
7079     * elm_scroller_page_relative_set(sc, 1, 0);
7080     * elm_scroller_last_page_get(sc, &h_page, &v_page);
7081     * elm_scroller_page_bring_in(sc, h_page, v_page);
7082     * @endcode
7083     *
7084     * @see elm_scroller_page_show()
7085     */
7086    EAPI void         elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7087    /**
7088     * @brief Show a specific virtual region within the scroller content object.
7089     *
7090     * @param obj The scroller object
7091     * @param x X coordinate of the region
7092     * @param y Y coordinate of the region
7093     * @param w Width of the region
7094     * @param h Height of the region
7095     *
7096     * This will ensure all (or part if it does not fit) of the designated
7097     * region in the virtual content object (0, 0 starting at the top-left of the
7098     * virtual content object) is shown within the scroller. Unlike
7099     * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7100     * to this location (if configuration in general calls for transitions). It
7101     * may not jump immediately to the new location and make take a while and
7102     * show other content along the way.
7103     *
7104     * @see elm_scroller_region_show()
7105     */
7106    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);
7107    /**
7108     * @brief Set event propagation on a scroller
7109     *
7110     * @param obj The scroller object
7111     * @param propagation If propagation is enabled or not
7112     *
7113     * This enables or disabled event propagation from the scroller content to
7114     * the scroller and its parent. By default event propagation is disabled.
7115     */
7116    EAPI void         elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
7117    /**
7118     * @brief Get event propagation for a scroller
7119     *
7120     * @param obj The scroller object
7121     * @return The propagation state
7122     *
7123     * This gets the event propagation for a scroller.
7124     *
7125     * @see elm_scroller_propagate_events_set()
7126     */
7127    EAPI Eina_Bool    elm_scroller_propagate_events_get(const Evas_Object *obj);
7128    /**
7129     * @}
7130     */
7131
7132    /**
7133     * @defgroup Label Label
7134     *
7135     * @image html img/widget/label/preview-00.png
7136     * @image latex img/widget/label/preview-00.eps
7137     *
7138     * @brief Widget to display text, with simple html-like markup.
7139     *
7140     * The Label widget @b doesn't allow text to overflow its boundaries, if the
7141     * text doesn't fit the geometry of the label it will be ellipsized or be
7142     * cut. Elementary provides several themes for this widget:
7143     * @li default - No animation
7144     * @li marker - Centers the text in the label and make it bold by default
7145     * @li slide_long - The entire text appears from the right of the screen and
7146     * slides until it disappears in the left of the screen(reappering on the
7147     * right again).
7148     * @li slide_short - The text appears in the left of the label and slides to
7149     * the right to show the overflow. When all of the text has been shown the
7150     * position is reset.
7151     * @li slide_bounce - The text appears in the left of the label and slides to
7152     * the right to show the overflow. When all of the text has been shown the
7153     * animation reverses, moving the text to the left.
7154     *
7155     * Custom themes can of course invent new markup tags and style them any way
7156     * they like.
7157     *
7158     * See @ref tutorial_label for a demonstration of how to use a label widget.
7159     * @{
7160     */
7161    /**
7162     * @brief Add a new label to the parent
7163     *
7164     * @param parent The parent object
7165     * @return The new object or NULL if it cannot be created
7166     */
7167    EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7168    /**
7169     * @brief Set the label on the label object
7170     *
7171     * @param obj The label object
7172     * @param label The label will be used on the label object
7173     * @deprecated See elm_object_text_set()
7174     */
7175    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 */
7176    /**
7177     * @brief Get the label used on the label object
7178     *
7179     * @param obj The label object
7180     * @return The string inside the label
7181     * @deprecated See elm_object_text_get()
7182     */
7183    EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7184    /**
7185     * @brief Set the wrapping behavior of the label
7186     *
7187     * @param obj The label object
7188     * @param wrap To wrap text or not
7189     *
7190     * By default no wrapping is done. Possible values for @p wrap are:
7191     * @li ELM_WRAP_NONE - No wrapping
7192     * @li ELM_WRAP_CHAR - wrap between characters
7193     * @li ELM_WRAP_WORD - wrap between words
7194     * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7195     */
7196    EAPI void         elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7197    /**
7198     * @brief Get the wrapping behavior of the label
7199     *
7200     * @param obj The label object
7201     * @return Wrap type
7202     *
7203     * @see elm_label_line_wrap_set()
7204     */
7205    EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7206    /**
7207     * @brief Set wrap width of the label
7208     *
7209     * @param obj The label object
7210     * @param w The wrap width in pixels at a minimum where words need to wrap
7211     *
7212     * This function sets the maximum width size hint of the label.
7213     *
7214     * @warning This is only relevant if the label is inside a container.
7215     */
7216    EAPI void         elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7217    /**
7218     * @brief Get wrap width of the label
7219     *
7220     * @param obj The label object
7221     * @return The wrap width in pixels at a minimum where words need to wrap
7222     *
7223     * @see elm_label_wrap_width_set()
7224     */
7225    EAPI Evas_Coord   elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7226    /**
7227     * @brief Set wrap height of the label
7228     *
7229     * @param obj The label object
7230     * @param h The wrap height in pixels at a minimum where words need to wrap
7231     *
7232     * This function sets the maximum height size hint of the label.
7233     *
7234     * @warning This is only relevant if the label is inside a container.
7235     */
7236    EAPI void         elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7237    /**
7238     * @brief get wrap width of the label
7239     *
7240     * @param obj The label object
7241     * @return The wrap height in pixels at a minimum where words need to wrap
7242     */
7243    EAPI Evas_Coord   elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7244    /**
7245     * @brief Set the font size on the label object.
7246     *
7247     * @param obj The label object
7248     * @param size font size
7249     *
7250     * @warning NEVER use this. It is for hyper-special cases only. use styles
7251     * instead. e.g. "big", "medium", "small" - or better name them by use:
7252     * "title", "footnote", "quote" etc.
7253     */
7254    EAPI void         elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7255    /**
7256     * @brief Set the text color on the label object
7257     *
7258     * @param obj The label object
7259     * @param r Red property background color of The label object
7260     * @param g Green property background color of The label object
7261     * @param b Blue property background color of The label object
7262     * @param a Alpha property background color of The label object
7263     *
7264     * @warning NEVER use this. It is for hyper-special cases only. use styles
7265     * instead. e.g. "big", "medium", "small" - or better name them by use:
7266     * "title", "footnote", "quote" etc.
7267     */
7268    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);
7269    /**
7270     * @brief Set the text align on the label object
7271     *
7272     * @param obj The label object
7273     * @param align align mode ("left", "center", "right")
7274     *
7275     * @warning NEVER use this. It is for hyper-special cases only. use styles
7276     * instead. e.g. "big", "medium", "small" - or better name them by use:
7277     * "title", "footnote", "quote" etc.
7278     */
7279    EAPI void         elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7280    /**
7281     * @brief Set background color of the label
7282     *
7283     * @param obj The label object
7284     * @param r Red property background color of The label object
7285     * @param g Green property background color of The label object
7286     * @param b Blue property background color of The label object
7287     * @param a Alpha property background alpha of The label object
7288     *
7289     * @warning NEVER use this. It is for hyper-special cases only. use styles
7290     * instead. e.g. "big", "medium", "small" - or better name them by use:
7291     * "title", "footnote", "quote" etc.
7292     */
7293    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);
7294    /**
7295     * @brief Set the ellipsis behavior of the label
7296     *
7297     * @param obj The label object
7298     * @param ellipsis To ellipsis text or not
7299     *
7300     * If set to true and the text doesn't fit in the label an ellipsis("...")
7301     * will be shown at the end of the widget.
7302     *
7303     * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7304     * choosen wrap method was ELM_WRAP_WORD.
7305     */
7306    EAPI void         elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7307    /**
7308     * @brief Set the text slide of the label
7309     *
7310     * @param obj The label object
7311     * @param slide To start slide or stop
7312     *
7313     * If set to true the text of the label will slide throught the length of
7314     * label.
7315     *
7316     * @warning This only work with the themes "slide_short", "slide_long" and
7317     * "slide_bounce".
7318     */
7319    EAPI void         elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7320    /**
7321     * @brief Get the text slide mode of the label
7322     *
7323     * @param obj The label object
7324     * @return slide slide mode value
7325     *
7326     * @see elm_label_slide_set()
7327     */
7328    EAPI Eina_Bool    elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7329    /**
7330     * @brief Set the slide duration(speed) of the label
7331     *
7332     * @param obj The label object
7333     * @return The duration in seconds in moving text from slide begin position
7334     * to slide end position
7335     */
7336    EAPI void         elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7337    /**
7338     * @brief Get the slide duration(speed) of the label
7339     *
7340     * @param obj The label object
7341     * @return The duration time in moving text from slide begin position to slide end position
7342     *
7343     * @see elm_label_slide_duration_set()
7344     */
7345    EAPI double       elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7346    /**
7347     * @}
7348     */
7349
7350    /**
7351     * @defgroup Toggle Toggle
7352     *
7353     * @image html img/widget/toggle/preview-00.png
7354     * @image latex img/widget/toggle/preview-00.eps
7355     *
7356     * @brief A toggle is a slider which can be used to toggle between
7357     * two values.  It has two states: on and off.
7358     *
7359     * Signals that you can add callbacks for are:
7360     * @li "changed" - Whenever the toggle value has been changed.  Is not called
7361     *                 until the toggle is released by the cursor (assuming it
7362     *                 has been triggered by the cursor in the first place).
7363     *
7364     * @ref tutorial_toggle show how to use a toggle.
7365     * @{
7366     */
7367    /**
7368     * @brief Add a toggle to @p parent.
7369     *
7370     * @param parent The parent object
7371     *
7372     * @return The toggle object
7373     */
7374    EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7375    /**
7376     * @brief Sets the label to be displayed with the toggle.
7377     *
7378     * @param obj The toggle object
7379     * @param label The label to be displayed
7380     *
7381     * @deprecated use elm_object_text_set() instead.
7382     */
7383    EINA_DEPRECATED EAPI void         elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7384    /**
7385     * @brief Gets the label of the toggle
7386     *
7387     * @param obj  toggle object
7388     * @return The label of the toggle
7389     *
7390     * @deprecated use elm_object_text_get() instead.
7391     */
7392    EINA_DEPRECATED EAPI const char  *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7393    /**
7394     * @brief Set the icon used for the toggle
7395     *
7396     * @param obj The toggle object
7397     * @param icon The icon object for the button
7398     *
7399     * Once the icon object is set, a previously set one will be deleted
7400     * If you want to keep that old content object, use the
7401     * elm_toggle_icon_unset() function.
7402     */
7403    EAPI void         elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7404    /**
7405     * @brief Get the icon used for the toggle
7406     *
7407     * @param obj The toggle object
7408     * @return The icon object that is being used
7409     *
7410     * Return the icon object which is set for this widget.
7411     *
7412     * @see elm_toggle_icon_set()
7413     */
7414    EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7415    /**
7416     * @brief Unset the icon used for the toggle
7417     *
7418     * @param obj The toggle object
7419     * @return The icon object that was being used
7420     *
7421     * Unparent and return the icon object which was set for this widget.
7422     *
7423     * @see elm_toggle_icon_set()
7424     */
7425    EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7426    /**
7427     * @brief Sets the labels to be associated with the on and off states of the toggle.
7428     *
7429     * @param obj The toggle object
7430     * @param onlabel The label displayed when the toggle is in the "on" state
7431     * @param offlabel The label displayed when the toggle is in the "off" state
7432     */
7433    EAPI void         elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7434    /**
7435     * @brief Gets the labels associated with the on and off states of the toggle.
7436     *
7437     * @param obj The toggle object
7438     * @param onlabel A char** to place the onlabel of @p obj into
7439     * @param offlabel A char** to place the offlabel of @p obj into
7440     */
7441    EAPI void         elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7442    /**
7443     * @brief Sets the state of the toggle to @p state.
7444     *
7445     * @param obj The toggle object
7446     * @param state The state of @p obj
7447     */
7448    EAPI void         elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7449    /**
7450     * @brief Gets the state of the toggle to @p state.
7451     *
7452     * @param obj The toggle object
7453     * @return The state of @p obj
7454     */
7455    EAPI Eina_Bool    elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7456    /**
7457     * @brief Sets the state pointer of the toggle to @p statep.
7458     *
7459     * @param obj The toggle object
7460     * @param statep The state pointer of @p obj
7461     */
7462    EAPI void         elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7463    /**
7464     * @}
7465     */
7466
7467    /**
7468     * @defgroup Frame Frame
7469     *
7470     * @image html img/widget/frame/preview-00.png
7471     * @image latex img/widget/frame/preview-00.eps
7472     *
7473     * @brief Frame is a widget that holds some content and has a title.
7474     *
7475     * The default look is a frame with a title, but Frame supports multple
7476     * styles:
7477     * @li default
7478     * @li pad_small
7479     * @li pad_medium
7480     * @li pad_large
7481     * @li pad_huge
7482     * @li outdent_top
7483     * @li outdent_bottom
7484     *
7485     * Of all this styles only default shows the title. Frame emits no signals.
7486     *
7487     * For a detailed example see the @ref tutorial_frame.
7488     *
7489     * @{
7490     */
7491    /**
7492     * @brief Add a new frame to the parent
7493     *
7494     * @param parent The parent object
7495     * @return The new object or NULL if it cannot be created
7496     */
7497    EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7498    /**
7499     * @brief Set the frame label
7500     *
7501     * @param obj The frame object
7502     * @param label The label of this frame object
7503     *
7504     * @deprecated use elm_object_text_set() instead.
7505     */
7506    EINA_DEPRECATED EAPI void         elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7507    /**
7508     * @brief Get the frame label
7509     *
7510     * @param obj The frame object
7511     *
7512     * @return The label of this frame objet or NULL if unable to get frame
7513     *
7514     * @deprecated use elm_object_text_get() instead.
7515     */
7516    EINA_DEPRECATED EAPI const char  *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7517    /**
7518     * @brief Set the content of the frame widget
7519     *
7520     * Once the content object is set, a previously set one will be deleted.
7521     * If you want to keep that old content object, use the
7522     * elm_frame_content_unset() function.
7523     *
7524     * @param obj The frame object
7525     * @param content The content will be filled in this frame object
7526     */
7527    EAPI void         elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7528    /**
7529     * @brief Get the content of the frame widget
7530     *
7531     * Return the content object which is set for this widget
7532     *
7533     * @param obj The frame object
7534     * @return The content that is being used
7535     */
7536    EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7537    /**
7538     * @brief Unset the content of the frame widget
7539     *
7540     * Unparent and return the content object which was set for this widget
7541     *
7542     * @param obj The frame object
7543     * @return The content that was being used
7544     */
7545    EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7546    /**
7547     * @}
7548     */
7549
7550    /**
7551     * @defgroup Table Table
7552     *
7553     * A container widget to arrange other widgets in a table where items can
7554     * also span multiple columns or rows - even overlap (and then be raised or
7555     * lowered accordingly to adjust stacking if they do overlap).
7556     *
7557     * The followin are examples of how to use a table:
7558     * @li @ref tutorial_table_01
7559     * @li @ref tutorial_table_02
7560     *
7561     * @{
7562     */
7563    /**
7564     * @brief Add a new table to the parent
7565     *
7566     * @param parent The parent object
7567     * @return The new object or NULL if it cannot be created
7568     */
7569    EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7570    /**
7571     * @brief Set the homogeneous layout in the table
7572     *
7573     * @param obj The layout object
7574     * @param homogeneous A boolean to set if the layout is homogeneous in the
7575     * table (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7576     */
7577    EAPI void         elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7578    /**
7579     * @brief Get the current table homogeneous mode.
7580     *
7581     * @param obj The table object
7582     * @return A boolean to indicating if the layout is homogeneous in the table
7583     * (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7584     */
7585    EAPI Eina_Bool    elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7586    /**
7587     * @warning <b>Use elm_table_homogeneous_set() instead</b>
7588     */
7589    EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7590    /**
7591     * @warning <b>Use elm_table_homogeneous_get() instead</b>
7592     */
7593    EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7594    /**
7595     * @brief Set padding between cells.
7596     *
7597     * @param obj The layout object.
7598     * @param horizontal set the horizontal padding.
7599     * @param vertical set the vertical padding.
7600     *
7601     * Default value is 0.
7602     */
7603    EAPI void         elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7604    /**
7605     * @brief Get padding between cells.
7606     *
7607     * @param obj The layout object.
7608     * @param horizontal set the horizontal padding.
7609     * @param vertical set the vertical padding.
7610     */
7611    EAPI void         elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7612    /**
7613     * @brief Add a subobject on the table with the coordinates passed
7614     *
7615     * @param obj The table object
7616     * @param subobj The subobject to be added to the table
7617     * @param x Row number
7618     * @param y Column number
7619     * @param w rowspan
7620     * @param h colspan
7621     *
7622     * @note All positioning inside the table is relative to rows and columns, so
7623     * a value of 0 for x and y, means the top left cell of the table, and a
7624     * value of 1 for w and h means @p subobj only takes that 1 cell.
7625     */
7626    EAPI void         elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7627    /**
7628     * @brief Remove child from table.
7629     *
7630     * @param obj The table object
7631     * @param subobj The subobject
7632     */
7633    EAPI void         elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7634    /**
7635     * @brief Faster way to remove all child objects from a table object.
7636     *
7637     * @param obj The table object
7638     * @param clear If true, will delete children, else just remove from table.
7639     */
7640    EAPI void         elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7641    /**
7642     * @brief Set the packing location of an existing child of the table
7643     *
7644     * @param subobj The subobject to be modified in the table
7645     * @param x Row number
7646     * @param y Column number
7647     * @param w rowspan
7648     * @param h colspan
7649     *
7650     * Modifies the position of an object already in the table.
7651     *
7652     * @note All positioning inside the table is relative to rows and columns, so
7653     * a value of 0 for x and y, means the top left cell of the table, and a
7654     * value of 1 for w and h means @p subobj only takes that 1 cell.
7655     */
7656    EAPI void         elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7657    /**
7658     * @brief Get the packing location of an existing child of the table
7659     *
7660     * @param subobj The subobject to be modified in the table
7661     * @param x Row number
7662     * @param y Column number
7663     * @param w rowspan
7664     * @param h colspan
7665     *
7666     * @see elm_table_pack_set()
7667     */
7668    EAPI void         elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7669    /**
7670     * @}
7671     */
7672
7673    /**
7674     * @defgroup Gengrid Gengrid (Generic grid)
7675     *
7676     * This widget aims to position objects in a grid layout while
7677     * actually creating and rendering only the visible ones, using the
7678     * same idea as the @ref Genlist "genlist": the user defines a @b
7679     * class for each item, specifying functions that will be called at
7680     * object creation, deletion, etc. When those items are selected by
7681     * the user, a callback function is issued. Users may interact with
7682     * a gengrid via the mouse (by clicking on items to select them and
7683     * clicking on the grid's viewport and swiping to pan the whole
7684     * view) or via the keyboard, navigating through item with the
7685     * arrow keys.
7686     *
7687     * @section Gengrid_Layouts Gengrid layouts
7688     *
7689     * Gengrids may layout its items in one of two possible layouts:
7690     * - horizontal or
7691     * - vertical.
7692     *
7693     * When in "horizontal mode", items will be placed in @b columns,
7694     * from top to bottom and, when the space for a column is filled,
7695     * another one is started on the right, thus expanding the grid
7696     * horizontally, making for horizontal scrolling. When in "vertical
7697     * mode" , though, items will be placed in @b rows, from left to
7698     * right and, when the space for a row is filled, another one is
7699     * started below, thus expanding the grid vertically (and making
7700     * for vertical scrolling).
7701     *
7702     * @section Gengrid_Items Gengrid items
7703     *
7704     * An item in a gengrid can have 0 or more text labels (they can be
7705     * regular text or textblock Evas objects - that's up to the style
7706     * to determine), 0 or more icons (which are simply objects
7707     * swallowed into the gengrid item's theming Edje object) and 0 or
7708     * more <b>boolean states</b>, which have the behavior left to the
7709     * user to define. The Edje part names for each of these properties
7710     * will be looked up, in the theme file for the gengrid, under the
7711     * Edje (string) data items named @c "labels", @c "icons" and @c
7712     * "states", respectively. For each of those properties, if more
7713     * than one part is provided, they must have names listed separated
7714     * by spaces in the data fields. For the default gengrid item
7715     * theme, we have @b one label part (@c "elm.text"), @b two icon
7716     * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
7717     * no state parts.
7718     *
7719     * A gengrid item may be at one of several styles. Elementary
7720     * provides one by default - "default", but this can be extended by
7721     * system or application custom themes/overlays/extensions (see
7722     * @ref Theme "themes" for more details).
7723     *
7724     * @section Gengrid_Item_Class Gengrid item classes
7725     *
7726     * In order to have the ability to add and delete items on the fly,
7727     * gengrid implements a class (callback) system where the
7728     * application provides a structure with information about that
7729     * type of item (gengrid may contain multiple different items with
7730     * different classes, states and styles). Gengrid will call the
7731     * functions in this struct (methods) when an item is "realized"
7732     * (i.e., created dynamically, while the user is scrolling the
7733     * grid). All objects will simply be deleted when no longer needed
7734     * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
7735     * contains the following members:
7736     * - @c item_style - This is a constant string and simply defines
7737     * the name of the item style. It @b must be specified and the
7738     * default should be @c "default".
7739     * - @c func.label_get - This function is called when an item
7740     * object is actually created. The @c data parameter will point to
7741     * the same data passed to elm_gengrid_item_append() and related
7742     * item creation functions. The @c obj parameter is the gengrid
7743     * object itself, while the @c part one is the name string of one
7744     * of the existing text parts in the Edje group implementing the
7745     * item's theme. This function @b must return a strdup'()ed string,
7746     * as the caller will free() it when done. See
7747     * #Elm_Gengrid_Item_Label_Get_Cb.
7748     * - @c func.icon_get - This function is called when an item object
7749     * is actually created. The @c data parameter will point to the
7750     * same data passed to elm_gengrid_item_append() and related item
7751     * creation functions. The @c obj parameter is the gengrid object
7752     * itself, while the @c part one is the name string of one of the
7753     * existing (icon) swallow parts in the Edje group implementing the
7754     * item's theme. It must return @c NULL, when no icon is desired,
7755     * or a valid object handle, otherwise. The object will be deleted
7756     * by the gengrid on its deletion or when the item is "unrealized".
7757     * See #Elm_Gengrid_Item_Icon_Get_Cb.
7758     * - @c func.state_get - This function is called when an item
7759     * object is actually created. The @c data parameter will point to
7760     * the same data passed to elm_gengrid_item_append() and related
7761     * item creation functions. The @c obj parameter is the gengrid
7762     * object itself, while the @c part one is the name string of one
7763     * of the state parts in the Edje group implementing the item's
7764     * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
7765     * true/on. Gengrids will emit a signal to its theming Edje object
7766     * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
7767     * "source" arguments, respectively, when the state is true (the
7768     * default is false), where @c XXX is the name of the (state) part.
7769     * See #Elm_Gengrid_Item_State_Get_Cb.
7770     * - @c func.del - This is called when elm_gengrid_item_del() is
7771     * called on an item or elm_gengrid_clear() is called on the
7772     * gengrid. This is intended for use when gengrid items are
7773     * deleted, so any data attached to the item (e.g. its data
7774     * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
7775     *
7776     * @section Gengrid_Usage_Hints Usage hints
7777     *
7778     * If the user wants to have multiple items selected at the same
7779     * time, elm_gengrid_multi_select_set() will permit it. If the
7780     * gengrid is single-selection only (the default), then
7781     * elm_gengrid_select_item_get() will return the selected item or
7782     * @c NULL, if none is selected. If the gengrid is under
7783     * multi-selection, then elm_gengrid_selected_items_get() will
7784     * return a list (that is only valid as long as no items are
7785     * modified (added, deleted, selected or unselected) of child items
7786     * on a gengrid.
7787     *
7788     * If an item changes (internal (boolean) state, label or icon
7789     * changes), then use elm_gengrid_item_update() to have gengrid
7790     * update the item with the new state. A gengrid will re-"realize"
7791     * the item, thus calling the functions in the
7792     * #Elm_Gengrid_Item_Class set for that item.
7793     *
7794     * To programmatically (un)select an item, use
7795     * elm_gengrid_item_selected_set(). To get its selected state use
7796     * elm_gengrid_item_selected_get(). To make an item disabled
7797     * (unable to be selected and appear differently) use
7798     * elm_gengrid_item_disabled_set() to set this and
7799     * elm_gengrid_item_disabled_get() to get the disabled state.
7800     *
7801     * Grid cells will only have their selection smart callbacks called
7802     * when firstly getting selected. Any further clicks will do
7803     * nothing, unless you enable the "always select mode", with
7804     * elm_gengrid_always_select_mode_set(), thus making every click to
7805     * issue selection callbacks. elm_gengrid_no_select_mode_set() will
7806     * turn off the ability to select items entirely in the widget and
7807     * they will neither appear selected nor call the selection smart
7808     * callbacks.
7809     *
7810     * Remember that you can create new styles and add your own theme
7811     * augmentation per application with elm_theme_extension_add(). If
7812     * you absolutely must have a specific style that overrides any
7813     * theme the user or system sets up you can use
7814     * elm_theme_overlay_add() to add such a file.
7815     *
7816     * @section Gengrid_Smart_Events Gengrid smart events
7817     *
7818     * Smart events that you can add callbacks for are:
7819     * - @c "activated" - The user has double-clicked or pressed
7820     *   (enter|return|spacebar) on an item. The @c event_info parameter
7821     *   is the gengrid item that was activated.
7822     * - @c "clicked,double" - The user has double-clicked an item.
7823     *   The @c event_info parameter is the gengrid item that was double-clicked.
7824     * - @c "selected" - The user has made an item selected. The
7825     *   @c event_info parameter is the gengrid item that was selected.
7826     * - @c "unselected" - The user has made an item unselected. The
7827     *   @c event_info parameter is the gengrid item that was unselected.
7828     * - @c "realized" - This is called when the item in the gengrid
7829     *   has its implementing Evas object instantiated, de facto. @c
7830     *   event_info is the gengrid item that was created. The object
7831     *   may be deleted at any time, so it is highly advised to the
7832     *   caller @b not to use the object pointer returned from
7833     *   elm_gengrid_item_object_get(), because it may point to freed
7834     *   objects.
7835     * - @c "unrealized" - This is called when the implementing Evas
7836     *   object for this item is deleted. @c event_info is the gengrid
7837     *   item that was deleted.
7838     * - @c "changed" - Called when an item is added, removed, resized
7839     *   or moved and when the gengrid is resized or gets "horizontal"
7840     *   property changes.
7841     * - @c "scroll,anim,start" - This is called when scrolling animation has
7842     *   started.
7843     * - @c "scroll,anim,stop" - This is called when scrolling animation has
7844     *   stopped.
7845     * - @c "drag,start,up" - Called when the item in the gengrid has
7846     *   been dragged (not scrolled) up.
7847     * - @c "drag,start,down" - Called when the item in the gengrid has
7848     *   been dragged (not scrolled) down.
7849     * - @c "drag,start,left" - Called when the item in the gengrid has
7850     *   been dragged (not scrolled) left.
7851     * - @c "drag,start,right" - Called when the item in the gengrid has
7852     *   been dragged (not scrolled) right.
7853     * - @c "drag,stop" - Called when the item in the gengrid has
7854     *   stopped being dragged.
7855     * - @c "drag" - Called when the item in the gengrid is being
7856     *   dragged.
7857     * - @c "scroll" - called when the content has been scrolled
7858     *   (moved).
7859     * - @c "scroll,drag,start" - called when dragging the content has
7860     *   started.
7861     * - @c "scroll,drag,stop" - called when dragging the content has
7862     *   stopped.
7863     *
7864     * List of gendrid examples:
7865     * @li @ref gengrid_example
7866     */
7867
7868    /**
7869     * @addtogroup Gengrid
7870     * @{
7871     */
7872
7873    typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
7874    typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
7875    typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
7876    typedef char        *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
7877    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. */
7878    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. */
7879    typedef void         (*Elm_Gengrid_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
7880
7881    typedef char        *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Label_Get_Cb. */
7882    typedef Evas_Object *(*GridItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Icon_Get_Cb. */
7883    typedef Eina_Bool    (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_State_Get_Cb. */
7884    typedef void         (*GridItemDelFunc)      (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Del_Cb. */
7885
7886    /**
7887     * @struct _Elm_Gengrid_Item_Class
7888     *
7889     * Gengrid item class definition. See @ref Gengrid_Item_Class for
7890     * field details.
7891     */
7892    struct _Elm_Gengrid_Item_Class
7893      {
7894         const char             *item_style;
7895         struct _Elm_Gengrid_Item_Class_Func
7896           {
7897              Elm_Gengrid_Item_Label_Get_Cb label_get;
7898              Elm_Gengrid_Item_Icon_Get_Cb  icon_get;
7899              Elm_Gengrid_Item_State_Get_Cb state_get;
7900              Elm_Gengrid_Item_Del_Cb       del;
7901           } func;
7902      }; /**< #Elm_Gengrid_Item_Class member definitions */
7903
7904    /**
7905     * Add a new gengrid widget to the given parent Elementary
7906     * (container) object
7907     *
7908     * @param parent The parent object
7909     * @return a new gengrid widget handle or @c NULL, on errors
7910     *
7911     * This function inserts a new gengrid widget on the canvas.
7912     *
7913     * @see elm_gengrid_item_size_set()
7914     * @see elm_gengrid_horizontal_set()
7915     * @see elm_gengrid_item_append()
7916     * @see elm_gengrid_item_del()
7917     * @see elm_gengrid_clear()
7918     *
7919     * @ingroup Gengrid
7920     */
7921    EAPI Evas_Object       *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7922
7923    /**
7924     * Set the size for the items of a given gengrid widget
7925     *
7926     * @param obj The gengrid object.
7927     * @param w The items' width.
7928     * @param h The items' height;
7929     *
7930     * A gengrid, after creation, has still no information on the size
7931     * to give to each of its cells. So, you most probably will end up
7932     * with squares one @ref Fingers "finger" wide, the default
7933     * size. Use this function to force a custom size for you items,
7934     * making them as big as you wish.
7935     *
7936     * @see elm_gengrid_item_size_get()
7937     *
7938     * @ingroup Gengrid
7939     */
7940    EAPI void               elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
7941
7942    /**
7943     * Get the size set for the items of a given gengrid widget
7944     *
7945     * @param obj The gengrid object.
7946     * @param w Pointer to a variable where to store the items' width.
7947     * @param h Pointer to a variable where to store the items' height.
7948     *
7949     * @note Use @c NULL pointers on the size values you're not
7950     * interested in: they'll be ignored by the function.
7951     *
7952     * @see elm_gengrid_item_size_get() for more details
7953     *
7954     * @ingroup Gengrid
7955     */
7956    EAPI void               elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7957
7958    /**
7959     * Set the items grid's alignment within a given gengrid widget
7960     *
7961     * @param obj The gengrid object.
7962     * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
7963     * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
7964     *
7965     * This sets the alignment of the whole grid of items of a gengrid
7966     * within its given viewport. By default, those values are both
7967     * 0.5, meaning that the gengrid will have its items grid placed
7968     * exactly in the middle of its viewport.
7969     *
7970     * @note If given alignment values are out of the cited ranges,
7971     * they'll be changed to the nearest boundary values on the valid
7972     * ranges.
7973     *
7974     * @see elm_gengrid_align_get()
7975     *
7976     * @ingroup Gengrid
7977     */
7978    EAPI void               elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
7979
7980    /**
7981     * Get the items grid's alignment values within a given gengrid
7982     * widget
7983     *
7984     * @param obj The gengrid object.
7985     * @param align_x Pointer to a variable where to store the
7986     * horizontal alignment.
7987     * @param align_y Pointer to a variable where to store the vertical
7988     * alignment.
7989     *
7990     * @note Use @c NULL pointers on the alignment values you're not
7991     * interested in: they'll be ignored by the function.
7992     *
7993     * @see elm_gengrid_align_set() for more details
7994     *
7995     * @ingroup Gengrid
7996     */
7997    EAPI void               elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
7998
7999    /**
8000     * Set whether a given gengrid widget is or not able have items
8001     * @b reordered
8002     *
8003     * @param obj The gengrid object
8004     * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8005     * @c EINA_FALSE to turn it off
8006     *
8007     * If a gengrid is set to allow reordering, a click held for more
8008     * than 0.5 over a given item will highlight it specially,
8009     * signalling the gengrid has entered the reordering state. From
8010     * that time on, the user will be able to, while still holding the
8011     * mouse button down, move the item freely in the gengrid's
8012     * viewport, replacing to said item to the locations it goes to.
8013     * The replacements will be animated and, whenever the user
8014     * releases the mouse button, the item being replaced gets a new
8015     * definitive place in the grid.
8016     *
8017     * @see elm_gengrid_reorder_mode_get()
8018     *
8019     * @ingroup Gengrid
8020     */
8021    EAPI void               elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8022
8023    /**
8024     * Get whether a given gengrid widget is or not able have items
8025     * @b reordered
8026     *
8027     * @param obj The gengrid object
8028     * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8029     * off
8030     *
8031     * @see elm_gengrid_reorder_mode_set() for more details
8032     *
8033     * @ingroup Gengrid
8034     */
8035    EAPI Eina_Bool          elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8036
8037    /**
8038     * Append a new item in a given gengrid widget.
8039     *
8040     * @param obj The gengrid object.
8041     * @param gic The item class for the item.
8042     * @param data The item data.
8043     * @param func Convenience function called when the item is
8044     * selected.
8045     * @param func_data Data to be passed to @p func.
8046     * @return A handle to the item added or @c NULL, on errors.
8047     *
8048     * This adds an item to the beginning of the gengrid.
8049     *
8050     * @see elm_gengrid_item_prepend()
8051     * @see elm_gengrid_item_insert_before()
8052     * @see elm_gengrid_item_insert_after()
8053     * @see elm_gengrid_item_del()
8054     *
8055     * @ingroup Gengrid
8056     */
8057    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);
8058
8059    /**
8060     * Prepend a new item in a given gengrid widget.
8061     *
8062     * @param obj The gengrid object.
8063     * @param gic The item class for the item.
8064     * @param data The item data.
8065     * @param func Convenience function called when the item is
8066     * selected.
8067     * @param func_data Data to be passed to @p func.
8068     * @return A handle to the item added or @c NULL, on errors.
8069     *
8070     * This adds an item to the end of the gengrid.
8071     *
8072     * @see elm_gengrid_item_append()
8073     * @see elm_gengrid_item_insert_before()
8074     * @see elm_gengrid_item_insert_after()
8075     * @see elm_gengrid_item_del()
8076     *
8077     * @ingroup Gengrid
8078     */
8079    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);
8080
8081    /**
8082     * Insert an item before another in a gengrid widget
8083     *
8084     * @param obj The gengrid object.
8085     * @param gic The item class for the item.
8086     * @param data The item data.
8087     * @param relative The item to place this new one before.
8088     * @param func Convenience function called when the item is
8089     * selected.
8090     * @param func_data Data to be passed to @p func.
8091     * @return A handle to the item added or @c NULL, on errors.
8092     *
8093     * This inserts an item before another in the gengrid.
8094     *
8095     * @see elm_gengrid_item_append()
8096     * @see elm_gengrid_item_prepend()
8097     * @see elm_gengrid_item_insert_after()
8098     * @see elm_gengrid_item_del()
8099     *
8100     * @ingroup Gengrid
8101     */
8102    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);
8103
8104    /**
8105     * Insert an item after another in a gengrid widget
8106     *
8107     * @param obj The gengrid object.
8108     * @param gic The item class for the item.
8109     * @param data The item data.
8110     * @param relative The item to place this new one after.
8111     * @param func Convenience function called when the item is
8112     * selected.
8113     * @param func_data Data to be passed to @p func.
8114     * @return A handle to the item added or @c NULL, on errors.
8115     *
8116     * This inserts an item after another in the gengrid.
8117     *
8118     * @see elm_gengrid_item_append()
8119     * @see elm_gengrid_item_prepend()
8120     * @see elm_gengrid_item_insert_after()
8121     * @see elm_gengrid_item_del()
8122     *
8123     * @ingroup Gengrid
8124     */
8125    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);
8126
8127    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);
8128
8129    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);
8130
8131    /**
8132     * Set whether items on a given gengrid widget are to get their
8133     * selection callbacks issued for @b every subsequent selection
8134     * click on them or just for the first click.
8135     *
8136     * @param obj The gengrid object
8137     * @param always_select @c EINA_TRUE to make items "always
8138     * selected", @c EINA_FALSE, otherwise
8139     *
8140     * By default, grid items will only call their selection callback
8141     * function when firstly getting selected, any subsequent further
8142     * clicks will do nothing. With this call, you make those
8143     * subsequent clicks also to issue the selection callbacks.
8144     *
8145     * @note <b>Double clicks</b> will @b always be reported on items.
8146     *
8147     * @see elm_gengrid_always_select_mode_get()
8148     *
8149     * @ingroup Gengrid
8150     */
8151    EAPI void               elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8152
8153    /**
8154     * Get whether items on a given gengrid widget have their selection
8155     * callbacks issued for @b every subsequent selection click on them
8156     * or just for the first click.
8157     *
8158     * @param obj The gengrid object.
8159     * @return @c EINA_TRUE if the gengrid items are "always selected",
8160     * @c EINA_FALSE, otherwise
8161     *
8162     * @see elm_gengrid_always_select_mode_set() for more details
8163     *
8164     * @ingroup Gengrid
8165     */
8166    EAPI Eina_Bool          elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8167
8168    /**
8169     * Set whether items on a given gengrid widget can be selected or not.
8170     *
8171     * @param obj The gengrid object
8172     * @param no_select @c EINA_TRUE to make items selectable,
8173     * @c EINA_FALSE otherwise
8174     *
8175     * This will make items in @p obj selectable or not. In the latter
8176     * case, any user interacion on the gendrid items will neither make
8177     * them appear selected nor them call their selection callback
8178     * functions.
8179     *
8180     * @see elm_gengrid_no_select_mode_get()
8181     *
8182     * @ingroup Gengrid
8183     */
8184    EAPI void               elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8185
8186    /**
8187     * Get whether items on a given gengrid widget can be selected or
8188     * not.
8189     *
8190     * @param obj The gengrid object
8191     * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8192     * otherwise
8193     *
8194     * @see elm_gengrid_no_select_mode_set() for more details
8195     *
8196     * @ingroup Gengrid
8197     */
8198    EAPI Eina_Bool          elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8199
8200    /**
8201     * Enable or disable multi-selection in a given gengrid widget
8202     *
8203     * @param obj The gengrid object.
8204     * @param multi @c EINA_TRUE, to enable multi-selection,
8205     * @c EINA_FALSE to disable it.
8206     *
8207     * Multi-selection is the ability for one to have @b more than one
8208     * item selected, on a given gengrid, simultaneously. When it is
8209     * enabled, a sequence of clicks on different items will make them
8210     * all selected, progressively. A click on an already selected item
8211     * will unselect it. If interecting via the keyboard,
8212     * multi-selection is enabled while holding the "Shift" key.
8213     *
8214     * @note By default, multi-selection is @b disabled on gengrids
8215     *
8216     * @see elm_gengrid_multi_select_get()
8217     *
8218     * @ingroup Gengrid
8219     */
8220    EAPI void               elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8221
8222    /**
8223     * Get whether multi-selection is enabled or disabled for a given
8224     * gengrid widget
8225     *
8226     * @param obj The gengrid object.
8227     * @return @c EINA_TRUE, if multi-selection is enabled, @c
8228     * EINA_FALSE otherwise
8229     *
8230     * @see elm_gengrid_multi_select_set() for more details
8231     *
8232     * @ingroup Gengrid
8233     */
8234    EAPI Eina_Bool          elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8235
8236    /**
8237     * Enable or disable bouncing effect for a given gengrid widget
8238     *
8239     * @param obj The gengrid object
8240     * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8241     * @c EINA_FALSE to disable it
8242     * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8243     * @c EINA_FALSE to disable it
8244     *
8245     * The bouncing effect occurs whenever one reaches the gengrid's
8246     * edge's while panning it -- it will scroll past its limits a
8247     * little bit and return to the edge again, in a animated for,
8248     * automatically.
8249     *
8250     * @note By default, gengrids have bouncing enabled on both axis
8251     *
8252     * @see elm_gengrid_bounce_get()
8253     *
8254     * @ingroup Gengrid
8255     */
8256    EAPI void               elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8257
8258    /**
8259     * Get whether bouncing effects are enabled or disabled, for a
8260     * given gengrid widget, on each axis
8261     *
8262     * @param obj The gengrid object
8263     * @param h_bounce Pointer to a variable where to store the
8264     * horizontal bouncing flag.
8265     * @param v_bounce Pointer to a variable where to store the
8266     * vertical bouncing flag.
8267     *
8268     * @see elm_gengrid_bounce_set() for more details
8269     *
8270     * @ingroup Gengrid
8271     */
8272    EAPI void               elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8273
8274    /**
8275     * Set a given gengrid widget's scrolling page size, relative to
8276     * its viewport size.
8277     *
8278     * @param obj The gengrid object
8279     * @param h_pagerel The horizontal page (relative) size
8280     * @param v_pagerel The vertical page (relative) size
8281     *
8282     * The gengrid's scroller is capable of binding scrolling by the
8283     * user to "pages". It means that, while scrolling and, specially
8284     * after releasing the mouse button, the grid will @b snap to the
8285     * nearest displaying page's area. When page sizes are set, the
8286     * grid's continuous content area is split into (equal) page sized
8287     * pieces.
8288     *
8289     * This function sets the size of a page <b>relatively to the
8290     * viewport dimensions</b> of the gengrid, for each axis. A value
8291     * @c 1.0 means "the exact viewport's size", in that axis, while @c
8292     * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8293     * a viewport". Sane usable values are, than, between @c 0.0 and @c
8294     * 1.0. Values beyond those will make it behave behave
8295     * inconsistently. If you only want one axis to snap to pages, use
8296     * the value @c 0.0 for the other one.
8297     *
8298     * There is a function setting page size values in @b absolute
8299     * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8300     * is mutually exclusive to this one.
8301     *
8302     * @see elm_gengrid_page_relative_get()
8303     *
8304     * @ingroup Gengrid
8305     */
8306    EAPI void               elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8307
8308    /**
8309     * Get a given gengrid widget's scrolling page size, relative to
8310     * its viewport size.
8311     *
8312     * @param obj The gengrid object
8313     * @param h_pagerel Pointer to a variable where to store the
8314     * horizontal page (relative) size
8315     * @param v_pagerel Pointer to a variable where to store the
8316     * vertical page (relative) size
8317     *
8318     * @see elm_gengrid_page_relative_set() for more details
8319     *
8320     * @ingroup Gengrid
8321     */
8322    EAPI void               elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8323
8324    /**
8325     * Set a given gengrid widget's scrolling page size
8326     *
8327     * @param obj The gengrid object
8328     * @param h_pagerel The horizontal page size, in pixels
8329     * @param v_pagerel The vertical page size, in pixels
8330     *
8331     * The gengrid's scroller is capable of binding scrolling by the
8332     * user to "pages". It means that, while scrolling and, specially
8333     * after releasing the mouse button, the grid will @b snap to the
8334     * nearest displaying page's area. When page sizes are set, the
8335     * grid's continuous content area is split into (equal) page sized
8336     * pieces.
8337     *
8338     * This function sets the size of a page of the gengrid, in pixels,
8339     * for each axis. Sane usable values are, between @c 0 and the
8340     * dimensions of @p obj, for each axis. Values beyond those will
8341     * make it behave behave inconsistently. If you only want one axis
8342     * to snap to pages, use the value @c 0 for the other one.
8343     *
8344     * There is a function setting page size values in @b relative
8345     * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8346     * use is mutually exclusive to this one.
8347     *
8348     * @ingroup Gengrid
8349     */
8350    EAPI void               elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8351
8352    /**
8353     * Set for what direction a given gengrid widget will expand while
8354     * placing its items.
8355     *
8356     * @param obj The gengrid object.
8357     * @param setting @c EINA_TRUE to make the gengrid expand
8358     * horizontally, @c EINA_FALSE to expand vertically.
8359     *
8360     * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8361     * in @b columns, from top to bottom and, when the space for a
8362     * column is filled, another one is started on the right, thus
8363     * expanding the grid horizontally. When in "vertical mode"
8364     * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8365     * to right and, when the space for a row is filled, another one is
8366     * started below, thus expanding the grid vertically.
8367     *
8368     * @see elm_gengrid_horizontal_get()
8369     *
8370     * @ingroup Gengrid
8371     */
8372    EAPI void               elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8373
8374    /**
8375     * Get for what direction a given gengrid widget will expand while
8376     * placing its items.
8377     *
8378     * @param obj The gengrid object.
8379     * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8380     * @c EINA_FALSE if it's set to expand vertically.
8381     *
8382     * @see elm_gengrid_horizontal_set() for more detais
8383     *
8384     * @ingroup Gengrid
8385     */
8386    EAPI Eina_Bool          elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8387
8388    /**
8389     * Get the first item in a given gengrid widget
8390     *
8391     * @param obj The gengrid object
8392     * @return The first item's handle or @c NULL, if there are no
8393     * items in @p obj (and on errors)
8394     *
8395     * This returns the first item in the @p obj's internal list of
8396     * items.
8397     *
8398     * @see elm_gengrid_last_item_get()
8399     *
8400     * @ingroup Gengrid
8401     */
8402    EAPI Elm_Gengrid_Item  *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8403
8404    /**
8405     * Get the last item in a given gengrid widget
8406     *
8407     * @param obj The gengrid object
8408     * @return The last item's handle or @c NULL, if there are no
8409     * items in @p obj (and on errors)
8410     *
8411     * This returns the last item in the @p obj's internal list of
8412     * items.
8413     *
8414     * @see elm_gengrid_first_item_get()
8415     *
8416     * @ingroup Gengrid
8417     */
8418    EAPI Elm_Gengrid_Item  *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8419
8420    /**
8421     * Get the @b next item in a gengrid widget's internal list of items,
8422     * given a handle to one of those items.
8423     *
8424     * @param item The gengrid item to fetch next from
8425     * @return The item after @p item, or @c NULL if there's none (and
8426     * on errors)
8427     *
8428     * This returns the item placed after the @p item, on the container
8429     * gengrid.
8430     *
8431     * @see elm_gengrid_item_prev_get()
8432     *
8433     * @ingroup Gengrid
8434     */
8435    EAPI Elm_Gengrid_Item  *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8436
8437    /**
8438     * Get the @b previous item in a gengrid widget's internal list of items,
8439     * given a handle to one of those items.
8440     *
8441     * @param item The gengrid item to fetch previous from
8442     * @return The item before @p item, or @c NULL if there's none (and
8443     * on errors)
8444     *
8445     * This returns the item placed before the @p item, on the container
8446     * gengrid.
8447     *
8448     * @see elm_gengrid_item_next_get()
8449     *
8450     * @ingroup Gengrid
8451     */
8452    EAPI Elm_Gengrid_Item  *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8453
8454    /**
8455     * Get the gengrid object's handle which contains a given gengrid
8456     * item
8457     *
8458     * @param item The item to fetch the container from
8459     * @return The gengrid (parent) object
8460     *
8461     * This returns the gengrid object itself that an item belongs to.
8462     *
8463     * @ingroup Gengrid
8464     */
8465    EAPI Evas_Object       *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8466
8467    /**
8468     * Remove a gengrid item from the its parent, deleting it.
8469     *
8470     * @param item The item to be removed.
8471     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8472     *
8473     * @see elm_gengrid_clear(), to remove all items in a gengrid at
8474     * once.
8475     *
8476     * @ingroup Gengrid
8477     */
8478    EAPI void               elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8479
8480    /**
8481     * Update the contents of a given gengrid item
8482     *
8483     * @param item The gengrid item
8484     *
8485     * This updates an item by calling all the item class functions
8486     * again to get the icons, labels and states. Use this when the
8487     * original item data has changed and you want thta changes to be
8488     * reflected.
8489     *
8490     * @ingroup Gengrid
8491     */
8492    EAPI void               elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8493    EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8494    EAPI void               elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8495
8496    /**
8497     * Return the data associated to a given gengrid item
8498     *
8499     * @param item The gengrid item.
8500     * @return the data associated to this item.
8501     *
8502     * This returns the @c data value passed on the
8503     * elm_gengrid_item_append() and related item addition calls.
8504     *
8505     * @see elm_gengrid_item_append()
8506     * @see elm_gengrid_item_data_set()
8507     *
8508     * @ingroup Gengrid
8509     */
8510    EAPI void              *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8511
8512    /**
8513     * Set the data associated to a given gengrid item
8514     *
8515     * @param item The gengrid item
8516     * @param data The new data pointer to set on it
8517     *
8518     * This @b overrides the @c data value passed on the
8519     * elm_gengrid_item_append() and related item addition calls. This
8520     * function @b won't call elm_gengrid_item_update() automatically,
8521     * so you'd issue it afterwards if you want to hove the item
8522     * updated to reflect the that new data.
8523     *
8524     * @see elm_gengrid_item_data_get()
8525     *
8526     * @ingroup Gengrid
8527     */
8528    EAPI void               elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8529
8530    /**
8531     * Get a given gengrid item's position, relative to the whole
8532     * gengrid's grid area.
8533     *
8534     * @param item The Gengrid item.
8535     * @param x Pointer to variable where to store the item's <b>row
8536     * number</b>.
8537     * @param y Pointer to variable where to store the item's <b>column
8538     * number</b>.
8539     *
8540     * This returns the "logical" position of the item whithin the
8541     * gengrid. For example, @c (0, 1) would stand for first row,
8542     * second column.
8543     *
8544     * @ingroup Gengrid
8545     */
8546    EAPI void               elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
8547
8548    /**
8549     * Set whether a given gengrid item is selected or not
8550     *
8551     * @param item The gengrid item
8552     * @param selected Use @c EINA_TRUE, to make it selected, @c
8553     * EINA_FALSE to make it unselected
8554     *
8555     * This sets the selected state of an item. If multi selection is
8556     * not enabled on the containing gengrid and @p selected is @c
8557     * EINA_TRUE, any other previously selected items will get
8558     * unselected in favor of this new one.
8559     *
8560     * @see elm_gengrid_item_selected_get()
8561     *
8562     * @ingroup Gengrid
8563     */
8564    EAPI void               elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
8565
8566    /**
8567     * Get whether a given gengrid item is selected or not
8568     *
8569     * @param item The gengrid item
8570     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
8571     *
8572     * @see elm_gengrid_item_selected_set() for more details
8573     *
8574     * @ingroup Gengrid
8575     */
8576    EAPI Eina_Bool          elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8577
8578    /**
8579     * Get the real Evas object created to implement the view of a
8580     * given gengrid item
8581     *
8582     * @param item The gengrid item.
8583     * @return the Evas object implementing this item's view.
8584     *
8585     * This returns the actual Evas object used to implement the
8586     * specified gengrid item's view. This may be @c NULL, as it may
8587     * not have been created or may have been deleted, at any time, by
8588     * the gengrid. <b>Do not modify this object</b> (move, resize,
8589     * show, hide, etc.), as the gengrid is controlling it. This
8590     * function is for querying, emitting custom signals or hooking
8591     * lower level callbacks for events on that object. Do not delete
8592     * this object under any circumstances.
8593     *
8594     * @see elm_gengrid_item_data_get()
8595     *
8596     * @ingroup Gengrid
8597     */
8598    EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8599
8600    /**
8601     * Show the portion of a gengrid's internal grid containing a given
8602     * item, @b immediately.
8603     *
8604     * @param item The item to display
8605     *
8606     * This causes gengrid to @b redraw its viewport's contents to the
8607     * region contining the given @p item item, if it is not fully
8608     * visible.
8609     *
8610     * @see elm_gengrid_item_bring_in()
8611     *
8612     * @ingroup Gengrid
8613     */
8614    EAPI void               elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8615
8616    /**
8617     * Animatedly bring in, to the visible are of a gengrid, a given
8618     * item on it.
8619     *
8620     * @param item The gengrid item to display
8621     *
8622     * This causes gengrig to jump to the given @p item item and show
8623     * it (by scrolling), if it is not fully visible. This will use
8624     * animation to do so and take a period of time to complete.
8625     *
8626     * @see elm_gengrid_item_show()
8627     *
8628     * @ingroup Gengrid
8629     */
8630    EAPI void               elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8631
8632    /**
8633     * Set whether a given gengrid item is disabled or not.
8634     *
8635     * @param item The gengrid item
8636     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
8637     * to enable it back.
8638     *
8639     * A disabled item cannot be selected or unselected. It will also
8640     * change its appearance, to signal the user it's disabled.
8641     *
8642     * @see elm_gengrid_item_disabled_get()
8643     *
8644     * @ingroup Gengrid
8645     */
8646    EAPI void               elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8647
8648    /**
8649     * Get whether a given gengrid item is disabled or not.
8650     *
8651     * @param item The gengrid item
8652     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
8653     * (and on errors).
8654     *
8655     * @see elm_gengrid_item_disabled_set() for more details
8656     *
8657     * @ingroup Gengrid
8658     */
8659    EAPI Eina_Bool          elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8660
8661    /**
8662     * Set the text to be shown in a given gengrid item's tooltips.
8663     *
8664     * @param item The gengrid item
8665     * @param text The text to set in the content
8666     *
8667     * This call will setup the text to be used as tooltip to that item
8668     * (analogous to elm_object_tooltip_text_set(), but being item
8669     * tooltips with higher precedence than object tooltips). It can
8670     * have only one tooltip at a time, so any previous tooltip data
8671     * will get removed.
8672     *
8673     * @ingroup Gengrid
8674     */
8675    EAPI void               elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
8676
8677    /**
8678     * Set the content to be shown in a given gengrid item's tooltips
8679     *
8680     * @param item The gengrid item.
8681     * @param func The function returning the tooltip contents.
8682     * @param data What to provide to @a func as callback data/context.
8683     * @param del_cb Called when data is not needed anymore, either when
8684     *        another callback replaces @p func, the tooltip is unset with
8685     *        elm_gengrid_item_tooltip_unset() or the owner @p item
8686     *        dies. This callback receives as its first parameter the
8687     *        given @p data, being @c event_info the item handle.
8688     *
8689     * This call will setup the tooltip's contents to @p item
8690     * (analogous to elm_object_tooltip_content_cb_set(), but being
8691     * item tooltips with higher precedence than object tooltips). It
8692     * can have only one tooltip at a time, so any previous tooltip
8693     * content will get removed. @p func (with @p data) will be called
8694     * every time Elementary needs to show the tooltip and it should
8695     * return a valid Evas object, which will be fully managed by the
8696     * tooltip system, getting deleted when the tooltip is gone.
8697     *
8698     * @ingroup Gengrid
8699     */
8700    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);
8701
8702    /**
8703     * Unset a tooltip from a given gengrid item
8704     *
8705     * @param item gengrid item to remove a previously set tooltip from.
8706     *
8707     * This call removes any tooltip set on @p item. The callback
8708     * provided as @c del_cb to
8709     * elm_gengrid_item_tooltip_content_cb_set() will be called to
8710     * notify it is not used anymore (and have resources cleaned, if
8711     * need be).
8712     *
8713     * @see elm_gengrid_item_tooltip_content_cb_set()
8714     *
8715     * @ingroup Gengrid
8716     */
8717    EAPI void               elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8718
8719    /**
8720     * Set a different @b style for a given gengrid item's tooltip.
8721     *
8722     * @param item gengrid item with tooltip set
8723     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
8724     * "default", @c "transparent", etc)
8725     *
8726     * Tooltips can have <b>alternate styles</b> to be displayed on,
8727     * which are defined by the theme set on Elementary. This function
8728     * works analogously as elm_object_tooltip_style_set(), but here
8729     * applied only to gengrid item objects. The default style for
8730     * tooltips is @c "default".
8731     *
8732     * @note before you set a style you should define a tooltip with
8733     *       elm_gengrid_item_tooltip_content_cb_set() or
8734     *       elm_gengrid_item_tooltip_text_set()
8735     *
8736     * @see elm_gengrid_item_tooltip_style_get()
8737     *
8738     * @ingroup Gengrid
8739     */
8740    EAPI void               elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8741
8742    /**
8743     * Get the style set a given gengrid item's tooltip.
8744     *
8745     * @param item gengrid item with tooltip already set on.
8746     * @return style the theme style in use, which defaults to
8747     *         "default". If the object does not have a tooltip set,
8748     *         then @c NULL is returned.
8749     *
8750     * @see elm_gengrid_item_tooltip_style_set() for more details
8751     *
8752     * @ingroup Gengrid
8753     */
8754    EAPI const char        *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8755    /**
8756     * @brief Disable size restrictions on an object's tooltip
8757     * @param item The tooltip's anchor object
8758     * @param disable If EINA_TRUE, size restrictions are disabled
8759     * @return EINA_FALSE on failure, EINA_TRUE on success
8760     *
8761     * This function allows a tooltip to expand beyond its parant window's canvas.
8762     * It will instead be limited only by the size of the display.
8763     */
8764    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
8765    /**
8766     * @brief Retrieve size restriction state of an object's tooltip
8767     * @param item The tooltip's anchor object
8768     * @return If EINA_TRUE, size restrictions are disabled
8769     *
8770     * This function returns whether a tooltip is allowed to expand beyond
8771     * its parant window's canvas.
8772     * It will instead be limited only by the size of the display.
8773     */
8774    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
8775    /**
8776     * Set the type of mouse pointer/cursor decoration to be shown,
8777     * when the mouse pointer is over the given gengrid widget item
8778     *
8779     * @param item gengrid item to customize cursor on
8780     * @param cursor the cursor type's name
8781     *
8782     * This function works analogously as elm_object_cursor_set(), but
8783     * here the cursor's changing area is restricted to the item's
8784     * area, and not the whole widget's. Note that that item cursors
8785     * have precedence over widget cursors, so that a mouse over @p
8786     * item will always show cursor @p type.
8787     *
8788     * If this function is called twice for an object, a previously set
8789     * cursor will be unset on the second call.
8790     *
8791     * @see elm_object_cursor_set()
8792     * @see elm_gengrid_item_cursor_get()
8793     * @see elm_gengrid_item_cursor_unset()
8794     *
8795     * @ingroup Gengrid
8796     */
8797    EAPI void               elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
8798
8799    /**
8800     * Get the type of mouse pointer/cursor decoration set to be shown,
8801     * when the mouse pointer is over the given gengrid widget item
8802     *
8803     * @param item gengrid item with custom cursor set
8804     * @return the cursor type's name or @c NULL, if no custom cursors
8805     * were set to @p item (and on errors)
8806     *
8807     * @see elm_object_cursor_get()
8808     * @see elm_gengrid_item_cursor_set() for more details
8809     * @see elm_gengrid_item_cursor_unset()
8810     *
8811     * @ingroup Gengrid
8812     */
8813    EAPI const char        *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8814
8815    /**
8816     * Unset any custom mouse pointer/cursor decoration set to be
8817     * shown, when the mouse pointer is over the given gengrid widget
8818     * item, thus making it show the @b default cursor again.
8819     *
8820     * @param item a gengrid item
8821     *
8822     * Use this call to undo any custom settings on this item's cursor
8823     * decoration, bringing it back to defaults (no custom style set).
8824     *
8825     * @see elm_object_cursor_unset()
8826     * @see elm_gengrid_item_cursor_set() for more details
8827     *
8828     * @ingroup Gengrid
8829     */
8830    EAPI void               elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8831
8832    /**
8833     * Set a different @b style for a given custom cursor set for a
8834     * gengrid item.
8835     *
8836     * @param item gengrid item with custom cursor set
8837     * @param style the <b>theme style</b> to use (e.g. @c "default",
8838     * @c "transparent", etc)
8839     *
8840     * This function only makes sense when one is using custom mouse
8841     * cursor decorations <b>defined in a theme file</b> , which can
8842     * have, given a cursor name/type, <b>alternate styles</b> on
8843     * it. It works analogously as elm_object_cursor_style_set(), but
8844     * here applied only to gengrid item objects.
8845     *
8846     * @warning Before you set a cursor style you should have defined a
8847     *       custom cursor previously on the item, with
8848     *       elm_gengrid_item_cursor_set()
8849     *
8850     * @see elm_gengrid_item_cursor_engine_only_set()
8851     * @see elm_gengrid_item_cursor_style_get()
8852     *
8853     * @ingroup Gengrid
8854     */
8855    EAPI void               elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8856
8857    /**
8858     * Get the current @b style set for a given gengrid item's custom
8859     * cursor
8860     *
8861     * @param item gengrid item with custom cursor set.
8862     * @return style the cursor style in use. If the object does not
8863     *         have a cursor set, then @c NULL is returned.
8864     *
8865     * @see elm_gengrid_item_cursor_style_set() for more details
8866     *
8867     * @ingroup Gengrid
8868     */
8869    EAPI const char        *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8870
8871    /**
8872     * Set if the (custom) cursor for a given gengrid item should be
8873     * searched in its theme, also, or should only rely on the
8874     * rendering engine.
8875     *
8876     * @param item item with custom (custom) cursor already set on
8877     * @param engine_only Use @c EINA_TRUE to have cursors looked for
8878     * only on those provided by the rendering engine, @c EINA_FALSE to
8879     * have them searched on the widget's theme, as well.
8880     *
8881     * @note This call is of use only if you've set a custom cursor
8882     * for gengrid items, with elm_gengrid_item_cursor_set().
8883     *
8884     * @note By default, cursors will only be looked for between those
8885     * provided by the rendering engine.
8886     *
8887     * @ingroup Gengrid
8888     */
8889    EAPI void               elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
8890
8891    /**
8892     * Get if the (custom) cursor for a given gengrid item is being
8893     * searched in its theme, also, or is only relying on the rendering
8894     * engine.
8895     *
8896     * @param item a gengrid item
8897     * @return @c EINA_TRUE, if cursors are being looked for only on
8898     * those provided by the rendering engine, @c EINA_FALSE if they
8899     * are being searched on the widget's theme, as well.
8900     *
8901     * @see elm_gengrid_item_cursor_engine_only_set(), for more details
8902     *
8903     * @ingroup Gengrid
8904     */
8905    EAPI Eina_Bool          elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8906
8907    /**
8908     * Remove all items from a given gengrid widget
8909     *
8910     * @param obj The gengrid object.
8911     *
8912     * This removes (and deletes) all items in @p obj, leaving it
8913     * empty.
8914     *
8915     * @see elm_gengrid_item_del(), to remove just one item.
8916     *
8917     * @ingroup Gengrid
8918     */
8919    EAPI void               elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
8920
8921    /**
8922     * Get the selected item in a given gengrid widget
8923     *
8924     * @param obj The gengrid object.
8925     * @return The selected item's handleor @c NULL, if none is
8926     * selected at the moment (and on errors)
8927     *
8928     * This returns the selected item in @p obj. If multi selection is
8929     * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
8930     * the first item in the list is selected, which might not be very
8931     * useful. For that case, see elm_gengrid_selected_items_get().
8932     *
8933     * @ingroup Gengrid
8934     */
8935    EAPI Elm_Gengrid_Item  *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8936
8937    /**
8938     * Get <b>a list</b> of selected items in a given gengrid
8939     *
8940     * @param obj The gengrid object.
8941     * @return The list of selected items or @c NULL, if none is
8942     * selected at the moment (and on errors)
8943     *
8944     * This returns a list of the selected items, in the order that
8945     * they appear in the grid. This list is only valid as long as no
8946     * more items are selected or unselected (or unselected implictly
8947     * by deletion). The list contains #Elm_Gengrid_Item pointers as
8948     * data, naturally.
8949     *
8950     * @see elm_gengrid_selected_item_get()
8951     *
8952     * @ingroup Gengrid
8953     */
8954    EAPI const Eina_List   *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8955
8956    /**
8957     * @}
8958     */
8959
8960    /**
8961     * @defgroup Clock Clock
8962     *
8963     * @image html img/widget/clock/preview-00.png
8964     * @image latex img/widget/clock/preview-00.eps
8965     *
8966     * This is a @b digital clock widget. In its default theme, it has a
8967     * vintage "flipping numbers clock" appearance, which will animate
8968     * sheets of individual algarisms individually as time goes by.
8969     *
8970     * A newly created clock will fetch system's time (already
8971     * considering local time adjustments) to start with, and will tick
8972     * accondingly. It may or may not show seconds.
8973     *
8974     * Clocks have an @b edition mode. When in it, the sheets will
8975     * display extra arrow indications on the top and bottom and the
8976     * user may click on them to raise or lower the time values. After
8977     * it's told to exit edition mode, it will keep ticking with that
8978     * new time set (it keeps the difference from local time).
8979     *
8980     * Also, when under edition mode, user clicks on the cited arrows
8981     * which are @b held for some time will make the clock to flip the
8982     * sheet, thus editing the time, continuosly and automatically for
8983     * the user. The interval between sheet flips will keep growing in
8984     * time, so that it helps the user to reach a time which is distant
8985     * from the one set.
8986     *
8987     * The time display is, by default, in military mode (24h), but an
8988     * am/pm indicator may be optionally shown, too, when it will
8989     * switch to 12h.
8990     *
8991     * Smart callbacks one can register to:
8992     * - "changed" - the clock's user changed the time
8993     *
8994     * Here is an example on its usage:
8995     * @li @ref clock_example
8996     */
8997
8998    /**
8999     * @addtogroup Clock
9000     * @{
9001     */
9002
9003    /**
9004     * Identifiers for which clock digits should be editable, when a
9005     * clock widget is in edition mode. Values may be ORed together to
9006     * make a mask, naturally.
9007     *
9008     * @see elm_clock_edit_set()
9009     * @see elm_clock_digit_edit_set()
9010     */
9011    typedef enum _Elm_Clock_Digedit
9012      {
9013         ELM_CLOCK_NONE         = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9014         ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9015         ELM_CLOCK_HOUR_UNIT    = 1 << 1, /**< Unit algarism of hours value should be editable */
9016         ELM_CLOCK_MIN_DECIMAL  = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9017         ELM_CLOCK_MIN_UNIT     = 1 << 3, /**< Unit algarism of minutes value should be editable */
9018         ELM_CLOCK_SEC_DECIMAL  = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9019         ELM_CLOCK_SEC_UNIT     = 1 << 5, /**< Unit algarism of seconds value should be editable */
9020         ELM_CLOCK_ALL          = (1 << 6) - 1 /**< All digits should be editable */
9021      } Elm_Clock_Digedit;
9022
9023    /**
9024     * Add a new clock widget to the given parent Elementary
9025     * (container) object
9026     *
9027     * @param parent The parent object
9028     * @return a new clock widget handle or @c NULL, on errors
9029     *
9030     * This function inserts a new clock widget on the canvas.
9031     *
9032     * @ingroup Clock
9033     */
9034    EAPI Evas_Object      *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9035
9036    /**
9037     * Set a clock widget's time, programmatically
9038     *
9039     * @param obj The clock widget object
9040     * @param hrs The hours to set
9041     * @param min The minutes to set
9042     * @param sec The secondes to set
9043     *
9044     * This function updates the time that is showed by the clock
9045     * widget.
9046     *
9047     *  Values @b must be set within the following ranges:
9048     * - 0 - 23, for hours
9049     * - 0 - 59, for minutes
9050     * - 0 - 59, for seconds,
9051     *
9052     * even if the clock is not in "military" mode.
9053     *
9054     * @warning The behavior for values set out of those ranges is @b
9055     * indefined.
9056     *
9057     * @ingroup Clock
9058     */
9059    EAPI void              elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9060
9061    /**
9062     * Get a clock widget's time values
9063     *
9064     * @param obj The clock object
9065     * @param[out] hrs Pointer to the variable to get the hours value
9066     * @param[out] min Pointer to the variable to get the minutes value
9067     * @param[out] sec Pointer to the variable to get the seconds value
9068     *
9069     * This function gets the time set for @p obj, returning
9070     * it on the variables passed as the arguments to function
9071     *
9072     * @note Use @c NULL pointers on the time values you're not
9073     * interested in: they'll be ignored by the function.
9074     *
9075     * @ingroup Clock
9076     */
9077    EAPI void              elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9078
9079    /**
9080     * Set whether a given clock widget is under <b>edition mode</b> or
9081     * under (default) displaying-only mode.
9082     *
9083     * @param obj The clock object
9084     * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9085     * put it back to "displaying only" mode
9086     *
9087     * This function makes a clock's time to be editable or not <b>by
9088     * user interaction</b>. When in edition mode, clocks @b stop
9089     * ticking, until one brings them back to canonical mode. The
9090     * elm_clock_digit_edit_set() function will influence which digits
9091     * of the clock will be editable. By default, all of them will be
9092     * (#ELM_CLOCK_NONE).
9093     *
9094     * @note am/pm sheets, if being shown, will @b always be editable
9095     * under edition mode.
9096     *
9097     * @see elm_clock_edit_get()
9098     *
9099     * @ingroup Clock
9100     */
9101    EAPI void              elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9102
9103    /**
9104     * Retrieve whether a given clock widget is under <b>edition
9105     * mode</b> or under (default) displaying-only mode.
9106     *
9107     * @param obj The clock object
9108     * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9109     * otherwise
9110     *
9111     * This function retrieves whether the clock's time can be edited
9112     * or not by user interaction.
9113     *
9114     * @see elm_clock_edit_set() for more details
9115     *
9116     * @ingroup Clock
9117     */
9118    EAPI Eina_Bool         elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9119
9120    /**
9121     * Set what digits of the given clock widget should be editable
9122     * when in edition mode.
9123     *
9124     * @param obj The clock object
9125     * @param digedit Bit mask indicating the digits to be editable
9126     * (values in #Elm_Clock_Digedit).
9127     *
9128     * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9129     * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9130     * EINA_FALSE).
9131     *
9132     * @see elm_clock_digit_edit_get()
9133     *
9134     * @ingroup Clock
9135     */
9136    EAPI void              elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9137
9138    /**
9139     * Retrieve what digits of the given clock widget should be
9140     * editable when in edition mode.
9141     *
9142     * @param obj The clock object
9143     * @return Bit mask indicating the digits to be editable
9144     * (values in #Elm_Clock_Digedit).
9145     *
9146     * @see elm_clock_digit_edit_set() for more details
9147     *
9148     * @ingroup Clock
9149     */
9150    EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9151
9152    /**
9153     * Set if the given clock widget must show hours in military or
9154     * am/pm mode
9155     *
9156     * @param obj The clock object
9157     * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9158     * to military mode
9159     *
9160     * This function sets if the clock must show hours in military or
9161     * am/pm mode. In some countries like Brazil the military mode
9162     * (00-24h-format) is used, in opposition to the USA, where the
9163     * am/pm mode is more commonly used.
9164     *
9165     * @see elm_clock_show_am_pm_get()
9166     *
9167     * @ingroup Clock
9168     */
9169    EAPI void              elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9170
9171    /**
9172     * Get if the given clock widget shows hours in military or am/pm
9173     * mode
9174     *
9175     * @param obj The clock object
9176     * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9177     * military
9178     *
9179     * This function gets if the clock shows hours in military or am/pm
9180     * mode.
9181     *
9182     * @see elm_clock_show_am_pm_set() for more details
9183     *
9184     * @ingroup Clock
9185     */
9186    EAPI Eina_Bool         elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9187
9188    /**
9189     * Set if the given clock widget must show time with seconds or not
9190     *
9191     * @param obj The clock object
9192     * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9193     *
9194     * This function sets if the given clock must show or not elapsed
9195     * seconds. By default, they are @b not shown.
9196     *
9197     * @see elm_clock_show_seconds_get()
9198     *
9199     * @ingroup Clock
9200     */
9201    EAPI void              elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9202
9203    /**
9204     * Get whether the given clock widget is showing time with seconds
9205     * or not
9206     *
9207     * @param obj The clock object
9208     * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9209     *
9210     * This function gets whether @p obj is showing or not the elapsed
9211     * seconds.
9212     *
9213     * @see elm_clock_show_seconds_set()
9214     *
9215     * @ingroup Clock
9216     */
9217    EAPI Eina_Bool         elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9218
9219    /**
9220     * Set the interval on time updates for an user mouse button hold
9221     * on clock widgets' time edition.
9222     *
9223     * @param obj The clock object
9224     * @param interval The (first) interval value in seconds
9225     *
9226     * This interval value is @b decreased while the user holds the
9227     * mouse pointer either incrementing or decrementing a given the
9228     * clock digit's value.
9229     *
9230     * This helps the user to get to a given time distant from the
9231     * current one easier/faster, as it will start to flip quicker and
9232     * quicker on mouse button holds.
9233     *
9234     * The calculation for the next flip interval value, starting from
9235     * the one set with this call, is the previous interval divided by
9236     * 1.05, so it decreases a little bit.
9237     *
9238     * The default starting interval value for automatic flips is
9239     * @b 0.85 seconds.
9240     *
9241     * @see elm_clock_interval_get()
9242     *
9243     * @ingroup Clock
9244     */
9245    EAPI void              elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9246
9247    /**
9248     * Get the interval on time updates for an user mouse button hold
9249     * on clock widgets' time edition.
9250     *
9251     * @param obj The clock object
9252     * @return The (first) interval value, in seconds, set on it
9253     *
9254     * @see elm_clock_interval_set() for more details
9255     *
9256     * @ingroup Clock
9257     */
9258    EAPI double            elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9259
9260    /**
9261     * @}
9262     */
9263
9264    /**
9265     * @defgroup Layout Layout
9266     *
9267     * @image html img/widget/layout/preview-00.png
9268     * @image latex img/widget/layout/preview-00.eps width=\textwidth
9269     *
9270     * @image html img/layout-predefined.png
9271     * @image latex img/layout-predefined.eps width=\textwidth
9272     *
9273     * This is a container widget that takes a standard Edje design file and
9274     * wraps it very thinly in a widget.
9275     *
9276     * An Edje design (theme) file has a very wide range of possibilities to
9277     * describe the behavior of elements added to the Layout. Check out the Edje
9278     * documentation and the EDC reference to get more information about what can
9279     * be done with Edje.
9280     *
9281     * Just like @ref List, @ref Box, and other container widgets, any
9282     * object added to the Layout will become its child, meaning that it will be
9283     * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9284     *
9285     * The Layout widget can contain as many Contents, Boxes or Tables as
9286     * described in its theme file. For instance, objects can be added to
9287     * different Tables by specifying the respective Table part names. The same
9288     * is valid for Content and Box.
9289     *
9290     * The objects added as child of the Layout will behave as described in the
9291     * part description where they were added. There are 3 possible types of
9292     * parts where a child can be added:
9293     *
9294     * @section secContent Content (SWALLOW part)
9295     *
9296     * Only one object can be added to the @c SWALLOW part (but you still can
9297     * have many @c SWALLOW parts and one object on each of them). Use the @c
9298     * elm_layout_content_* set of functions to set, retrieve and unset objects
9299     * as content of the @c SWALLOW. After being set to this part, the object
9300     * size, position, visibility, clipping and other description properties
9301     * will be totally controled by the description of the given part (inside
9302     * the Edje theme file).
9303     *
9304     * One can use @c evas_object_size_hint_* functions on the child to have some
9305     * kind of control over its behavior, but the resulting behavior will still
9306     * depend heavily on the @c SWALLOW part description.
9307     *
9308     * The Edje theme also can change the part description, based on signals or
9309     * scripts running inside the theme. This change can also be animated. All of
9310     * this will affect the child object set as content accordingly. The object
9311     * size will be changed if the part size is changed, it will animate move if
9312     * the part is moving, and so on.
9313     *
9314     * The following picture demonstrates a Layout widget with a child object
9315     * added to its @c SWALLOW:
9316     *
9317     * @image html layout_swallow.png
9318     * @image latex layout_swallow.eps width=\textwidth
9319     *
9320     * @section secBox Box (BOX part)
9321     *
9322     * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9323     * allows one to add objects to the box and have them distributed along its
9324     * area, accordingly to the specified @a layout property (now by @a layout we
9325     * mean the chosen layouting design of the Box, not the Layout widget
9326     * itself).
9327     *
9328     * A similar effect for having a box with its position, size and other things
9329     * controled by the Layout theme would be to create an Elementary @ref Box
9330     * widget and add it as a Content in the @c SWALLOW part.
9331     *
9332     * The main difference of using the Layout Box is that its behavior, the box
9333     * properties like layouting format, padding, align, etc. will be all
9334     * controled by the theme. This means, for example, that a signal could be
9335     * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9336     * handled the signal by changing the box padding, or align, or both. Using
9337     * the Elementary @ref Box widget is not necessarily harder or easier, it
9338     * just depends on the circunstances and requirements.
9339     *
9340     * The Layout Box can be used through the @c elm_layout_box_* set of
9341     * functions.
9342     *
9343     * The following picture demonstrates a Layout widget with many child objects
9344     * added to its @c BOX part:
9345     *
9346     * @image html layout_box.png
9347     * @image latex layout_box.eps width=\textwidth
9348     *
9349     * @section secTable Table (TABLE part)
9350     *
9351     * Just like the @ref secBox, the Layout Table is very similar to the
9352     * Elementary @ref Table widget. It allows one to add objects to the Table
9353     * specifying the row and column where the object should be added, and any
9354     * column or row span if necessary.
9355     *
9356     * Again, we could have this design by adding a @ref Table widget to the @c
9357     * SWALLOW part using elm_layout_content_set(). The same difference happens
9358     * here when choosing to use the Layout Table (a @c TABLE part) instead of
9359     * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9360     *
9361     * The Layout Table can be used through the @c elm_layout_table_* set of
9362     * functions.
9363     *
9364     * The following picture demonstrates a Layout widget with many child objects
9365     * added to its @c TABLE part:
9366     *
9367     * @image html layout_table.png
9368     * @image latex layout_table.eps width=\textwidth
9369     *
9370     * @section secPredef Predefined Layouts
9371     *
9372     * Another interesting thing about the Layout widget is that it offers some
9373     * predefined themes that come with the default Elementary theme. These
9374     * themes can be set by the call elm_layout_theme_set(), and provide some
9375     * basic functionality depending on the theme used.
9376     *
9377     * Most of them already send some signals, some already provide a toolbar or
9378     * back and next buttons.
9379     *
9380     * These are available predefined theme layouts. All of them have class = @c
9381     * layout, group = @c application, and style = one of the following options:
9382     *
9383     * @li @c toolbar-content - application with toolbar and main content area
9384     * @li @c toolbar-content-back - application with toolbar and main content
9385     * area with a back button and title area
9386     * @li @c toolbar-content-back-next - application with toolbar and main
9387     * content area with a back and next buttons and title area
9388     * @li @c content-back - application with a main content area with a back
9389     * button and title area
9390     * @li @c content-back-next - application with a main content area with a
9391     * back and next buttons and title area
9392     * @li @c toolbar-vbox - application with toolbar and main content area as a
9393     * vertical box
9394     * @li @c toolbar-table - application with toolbar and main content area as a
9395     * table
9396     *
9397     * @section secExamples Examples
9398     *
9399     * Some examples of the Layout widget can be found here:
9400     * @li @ref layout_example_01
9401     * @li @ref layout_example_02
9402     * @li @ref layout_example_03
9403     * @li @ref layout_example_edc
9404     *
9405     */
9406
9407    /**
9408     * Add a new layout to the parent
9409     *
9410     * @param parent The parent object
9411     * @return The new object or NULL if it cannot be created
9412     *
9413     * @see elm_layout_file_set()
9414     * @see elm_layout_theme_set()
9415     *
9416     * @ingroup Layout
9417     */
9418    EAPI Evas_Object       *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9419    /**
9420     * Set the file that will be used as layout
9421     *
9422     * @param obj The layout object
9423     * @param file The path to file (edj) that will be used as layout
9424     * @param group The group that the layout belongs in edje file
9425     *
9426     * @return (1 = success, 0 = error)
9427     *
9428     * @ingroup Layout
9429     */
9430    EAPI Eina_Bool          elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9431    /**
9432     * Set the edje group from the elementary theme that will be used as layout
9433     *
9434     * @param obj The layout object
9435     * @param clas the clas of the group
9436     * @param group the group
9437     * @param style the style to used
9438     *
9439     * @return (1 = success, 0 = error)
9440     *
9441     * @ingroup Layout
9442     */
9443    EAPI Eina_Bool          elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9444    /**
9445     * Set the layout content.
9446     *
9447     * @param obj The layout object
9448     * @param swallow The swallow part name in the edje file
9449     * @param content The child that will be added in this layout object
9450     *
9451     * Once the content object is set, a previously set one will be deleted.
9452     * If you want to keep that old content object, use the
9453     * elm_layout_content_unset() function.
9454     *
9455     * @note In an Edje theme, the part used as a content container is called @c
9456     * SWALLOW. This is why the parameter name is called @p swallow, but it is
9457     * expected to be a part name just like the second parameter of
9458     * elm_layout_box_append().
9459     *
9460     * @see elm_layout_box_append()
9461     * @see elm_layout_content_get()
9462     * @see elm_layout_content_unset()
9463     * @see @ref secBox
9464     *
9465     * @ingroup Layout
9466     */
9467    EAPI void               elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9468    /**
9469     * Get the child object in the given content part.
9470     *
9471     * @param obj The layout object
9472     * @param swallow The SWALLOW part to get its content
9473     *
9474     * @return The swallowed object or NULL if none or an error occurred
9475     *
9476     * @see elm_layout_content_set()
9477     *
9478     * @ingroup Layout
9479     */
9480    EAPI Evas_Object       *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9481    /**
9482     * Unset the layout content.
9483     *
9484     * @param obj The layout object
9485     * @param swallow The swallow part name in the edje file
9486     * @return The content that was being used
9487     *
9488     * Unparent and return the content object which was set for this part.
9489     *
9490     * @see elm_layout_content_set()
9491     *
9492     * @ingroup Layout
9493     */
9494     EAPI Evas_Object       *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9495    /**
9496     * Set the text of the given part
9497     *
9498     * @param obj The layout object
9499     * @param part The TEXT part where to set the text
9500     * @param text The text to set
9501     *
9502     * @ingroup Layout
9503     * @deprecated use elm_object_text_* instead.
9504     */
9505    EINA_DEPRECATED EAPI void               elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9506    /**
9507     * Get the text set in the given part
9508     *
9509     * @param obj The layout object
9510     * @param part The TEXT part to retrieve the text off
9511     *
9512     * @return The text set in @p part
9513     *
9514     * @ingroup Layout
9515     * @deprecated use elm_object_text_* instead.
9516     */
9517    EINA_DEPRECATED EAPI const char        *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9518    /**
9519     * Append child to layout box part.
9520     *
9521     * @param obj the layout object
9522     * @param part the box part to which the object will be appended.
9523     * @param child the child object to append to box.
9524     *
9525     * Once the object is appended, it will become child of the layout. Its
9526     * lifetime will be bound to the layout, whenever the layout dies the child
9527     * will be deleted automatically. One should use elm_layout_box_remove() to
9528     * make this layout forget about the object.
9529     *
9530     * @see elm_layout_box_prepend()
9531     * @see elm_layout_box_insert_before()
9532     * @see elm_layout_box_insert_at()
9533     * @see elm_layout_box_remove()
9534     *
9535     * @ingroup Layout
9536     */
9537    EAPI void               elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9538    /**
9539     * Prepend child to layout box part.
9540     *
9541     * @param obj the layout object
9542     * @param part the box part to prepend.
9543     * @param child the child object to prepend to box.
9544     *
9545     * Once the object is prepended, it will become child of the layout. Its
9546     * lifetime will be bound to the layout, whenever the layout dies the child
9547     * will be deleted automatically. One should use elm_layout_box_remove() to
9548     * make this layout forget about the object.
9549     *
9550     * @see elm_layout_box_append()
9551     * @see elm_layout_box_insert_before()
9552     * @see elm_layout_box_insert_at()
9553     * @see elm_layout_box_remove()
9554     *
9555     * @ingroup Layout
9556     */
9557    EAPI void               elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9558    /**
9559     * Insert child to layout box part before a reference object.
9560     *
9561     * @param obj the layout object
9562     * @param part the box part to insert.
9563     * @param child the child object to insert into box.
9564     * @param reference another reference object to insert before in box.
9565     *
9566     * Once the object is inserted, it will become child of the layout. Its
9567     * lifetime will be bound to the layout, whenever the layout dies the child
9568     * will be deleted automatically. One should use elm_layout_box_remove() to
9569     * make this layout forget about the object.
9570     *
9571     * @see elm_layout_box_append()
9572     * @see elm_layout_box_prepend()
9573     * @see elm_layout_box_insert_before()
9574     * @see elm_layout_box_remove()
9575     *
9576     * @ingroup Layout
9577     */
9578    EAPI void               elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
9579    /**
9580     * Insert child to layout box part at a given position.
9581     *
9582     * @param obj the layout object
9583     * @param part the box part to insert.
9584     * @param child the child object to insert into box.
9585     * @param pos the numeric position >=0 to insert the child.
9586     *
9587     * Once the object is inserted, it will become child of the layout. Its
9588     * lifetime will be bound to the layout, whenever the layout dies the child
9589     * will be deleted automatically. One should use elm_layout_box_remove() to
9590     * make this layout forget about the object.
9591     *
9592     * @see elm_layout_box_append()
9593     * @see elm_layout_box_prepend()
9594     * @see elm_layout_box_insert_before()
9595     * @see elm_layout_box_remove()
9596     *
9597     * @ingroup Layout
9598     */
9599    EAPI void               elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
9600    /**
9601     * Remove a child of the given part box.
9602     *
9603     * @param obj The layout object
9604     * @param part The box part name to remove child.
9605     * @param child The object to remove from box.
9606     * @return The object that was being used, or NULL if not found.
9607     *
9608     * The object will be removed from the box part and its lifetime will
9609     * not be handled by the layout anymore. This is equivalent to
9610     * elm_layout_content_unset() for box.
9611     *
9612     * @see elm_layout_box_append()
9613     * @see elm_layout_box_remove_all()
9614     *
9615     * @ingroup Layout
9616     */
9617    EAPI Evas_Object       *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
9618    /**
9619     * Remove all child of the given part box.
9620     *
9621     * @param obj The layout object
9622     * @param part The box part name to remove child.
9623     * @param clear If EINA_TRUE, then all objects will be deleted as
9624     *        well, otherwise they will just be removed and will be
9625     *        dangling on the canvas.
9626     *
9627     * The objects will be removed from the box part and their lifetime will
9628     * not be handled by the layout anymore. This is equivalent to
9629     * elm_layout_box_remove() for all box children.
9630     *
9631     * @see elm_layout_box_append()
9632     * @see elm_layout_box_remove()
9633     *
9634     * @ingroup Layout
9635     */
9636    EAPI void               elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9637    /**
9638     * Insert child to layout table part.
9639     *
9640     * @param obj the layout object
9641     * @param part the box part to pack child.
9642     * @param child_obj the child object to pack into table.
9643     * @param col the column to which the child should be added. (>= 0)
9644     * @param row the row to which the child should be added. (>= 0)
9645     * @param colspan how many columns should be used to store this object. (>=
9646     *        1)
9647     * @param rowspan how many rows should be used to store this object. (>= 1)
9648     *
9649     * Once the object is inserted, it will become child of the table. Its
9650     * lifetime will be bound to the layout, and whenever the layout dies the
9651     * child will be deleted automatically. One should use
9652     * elm_layout_table_remove() to make this layout forget about the object.
9653     *
9654     * If @p colspan or @p rowspan are bigger than 1, that object will occupy
9655     * more space than a single cell. For instance, the following code:
9656     * @code
9657     * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
9658     * @endcode
9659     *
9660     * Would result in an object being added like the following picture:
9661     *
9662     * @image html layout_colspan.png
9663     * @image latex layout_colspan.eps width=\textwidth
9664     *
9665     * @see elm_layout_table_unpack()
9666     * @see elm_layout_table_clear()
9667     *
9668     * @ingroup Layout
9669     */
9670    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);
9671    /**
9672     * Unpack (remove) a child of the given part table.
9673     *
9674     * @param obj The layout object
9675     * @param part The table part name to remove child.
9676     * @param child_obj The object to remove from table.
9677     * @return The object that was being used, or NULL if not found.
9678     *
9679     * The object will be unpacked from the table part and its lifetime
9680     * will not be handled by the layout anymore. This is equivalent to
9681     * elm_layout_content_unset() for table.
9682     *
9683     * @see elm_layout_table_pack()
9684     * @see elm_layout_table_clear()
9685     *
9686     * @ingroup Layout
9687     */
9688    EAPI Evas_Object       *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
9689    /**
9690     * Remove all child of the given part table.
9691     *
9692     * @param obj The layout object
9693     * @param part The table part name to remove child.
9694     * @param clear If EINA_TRUE, then all objects will be deleted as
9695     *        well, otherwise they will just be removed and will be
9696     *        dangling on the canvas.
9697     *
9698     * The objects will be removed from the table part and their lifetime will
9699     * not be handled by the layout anymore. This is equivalent to
9700     * elm_layout_table_unpack() for all table children.
9701     *
9702     * @see elm_layout_table_pack()
9703     * @see elm_layout_table_unpack()
9704     *
9705     * @ingroup Layout
9706     */
9707    EAPI void               elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9708    /**
9709     * Get the edje layout
9710     *
9711     * @param obj The layout object
9712     *
9713     * @return A Evas_Object with the edje layout settings loaded
9714     * with function elm_layout_file_set
9715     *
9716     * This returns the edje object. It is not expected to be used to then
9717     * swallow objects via edje_object_part_swallow() for example. Use
9718     * elm_layout_content_set() instead so child object handling and sizing is
9719     * done properly.
9720     *
9721     * @note This function should only be used if you really need to call some
9722     * low level Edje function on this edje object. All the common stuff (setting
9723     * text, emitting signals, hooking callbacks to signals, etc.) can be done
9724     * with proper elementary functions.
9725     *
9726     * @see elm_object_signal_callback_add()
9727     * @see elm_object_signal_emit()
9728     * @see elm_object_text_part_set()
9729     * @see elm_layout_content_set()
9730     * @see elm_layout_box_append()
9731     * @see elm_layout_table_pack()
9732     * @see elm_layout_data_get()
9733     *
9734     * @ingroup Layout
9735     */
9736    EAPI Evas_Object       *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9737    /**
9738     * Get the edje data from the given layout
9739     *
9740     * @param obj The layout object
9741     * @param key The data key
9742     *
9743     * @return The edje data string
9744     *
9745     * This function fetches data specified inside the edje theme of this layout.
9746     * This function return NULL if data is not found.
9747     *
9748     * In EDC this comes from a data block within the group block that @p
9749     * obj was loaded from. E.g.
9750     *
9751     * @code
9752     * collections {
9753     *   group {
9754     *     name: "a_group";
9755     *     data {
9756     *       item: "key1" "value1";
9757     *       item: "key2" "value2";
9758     *     }
9759     *   }
9760     * }
9761     * @endcode
9762     *
9763     * @ingroup Layout
9764     */
9765    EAPI const char        *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
9766    /**
9767     * Eval sizing
9768     *
9769     * @param obj The layout object
9770     *
9771     * Manually forces a sizing re-evaluation. This is useful when the minimum
9772     * size required by the edje theme of this layout has changed. The change on
9773     * the minimum size required by the edje theme is not immediately reported to
9774     * the elementary layout, so one needs to call this function in order to tell
9775     * the widget (layout) that it needs to reevaluate its own size.
9776     *
9777     * The minimum size of the theme is calculated based on minimum size of
9778     * parts, the size of elements inside containers like box and table, etc. All
9779     * of this can change due to state changes, and that's when this function
9780     * should be called.
9781     *
9782     * Also note that a standard signal of "size,eval" "elm" emitted from the
9783     * edje object will cause this to happen too.
9784     *
9785     * @ingroup Layout
9786     */
9787    EAPI void               elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
9788
9789    /**
9790     * Sets a specific cursor for an edje part.
9791     *
9792     * @param obj The layout object.
9793     * @param part_name a part from loaded edje group.
9794     * @param cursor cursor name to use, see Elementary_Cursor.h
9795     *
9796     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9797     *         part not exists or it has "mouse_events: 0".
9798     *
9799     * @ingroup Layout
9800     */
9801    EAPI Eina_Bool          elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
9802
9803    /**
9804     * Get the cursor to be shown when mouse is over an edje part
9805     *
9806     * @param obj The layout object.
9807     * @param part_name a part from loaded edje group.
9808     * @return the cursor name.
9809     *
9810     * @ingroup Layout
9811     */
9812    EAPI const char        *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9813
9814    /**
9815     * Unsets a cursor previously set with elm_layout_part_cursor_set().
9816     *
9817     * @param obj The layout object.
9818     * @param part_name a part from loaded edje group, that had a cursor set
9819     *        with elm_layout_part_cursor_set().
9820     *
9821     * @ingroup Layout
9822     */
9823    EAPI void               elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9824
9825    /**
9826     * Sets a specific cursor style for an edje part.
9827     *
9828     * @param obj The layout object.
9829     * @param part_name a part from loaded edje group.
9830     * @param style the theme style to use (default, transparent, ...)
9831     *
9832     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9833     *         part not exists or it did not had a cursor set.
9834     *
9835     * @ingroup Layout
9836     */
9837    EAPI Eina_Bool          elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
9838
9839    /**
9840     * Gets a specific cursor style for an edje part.
9841     *
9842     * @param obj The layout object.
9843     * @param part_name a part from loaded edje group.
9844     *
9845     * @return the theme style in use, defaults to "default". If the
9846     *         object does not have a cursor set, then NULL is returned.
9847     *
9848     * @ingroup Layout
9849     */
9850    EAPI const char        *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9851
9852    /**
9853     * Sets if the cursor set should be searched on the theme or should use
9854     * the provided by the engine, only.
9855     *
9856     * @note before you set if should look on theme you should define a
9857     * cursor with elm_layout_part_cursor_set(). By default it will only
9858     * look for cursors provided by the engine.
9859     *
9860     * @param obj The layout object.
9861     * @param part_name a part from loaded edje group.
9862     * @param engine_only if cursors should be just provided by the engine
9863     *        or should also search on widget's theme as well
9864     *
9865     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9866     *         part not exists or it did not had a cursor set.
9867     *
9868     * @ingroup Layout
9869     */
9870    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);
9871
9872    /**
9873     * Gets a specific cursor engine_only for an edje part.
9874     *
9875     * @param obj The layout object.
9876     * @param part_name a part from loaded edje group.
9877     *
9878     * @return whenever the cursor is just provided by engine or also from theme.
9879     *
9880     * @ingroup Layout
9881     */
9882    EAPI Eina_Bool          elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9883
9884 /**
9885  * @def elm_layout_icon_set
9886  * Convienience macro to set the icon object in a layout that follows the
9887  * Elementary naming convention for its parts.
9888  *
9889  * @ingroup Layout
9890  */
9891 #define elm_layout_icon_set(_ly, _obj) \
9892   do { \
9893     const char *sig; \
9894     elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
9895     if ((_obj)) sig = "elm,state,icon,visible"; \
9896     else sig = "elm,state,icon,hidden"; \
9897     elm_object_signal_emit((_ly), sig, "elm"); \
9898   } while (0)
9899
9900 /**
9901  * @def elm_layout_icon_get
9902  * Convienience macro to get the icon object from a layout that follows the
9903  * Elementary naming convention for its parts.
9904  *
9905  * @ingroup Layout
9906  */
9907 #define elm_layout_icon_get(_ly) \
9908   elm_layout_content_get((_ly), "elm.swallow.icon")
9909
9910 /**
9911  * @def elm_layout_end_set
9912  * Convienience macro to set the end object in a layout that follows the
9913  * Elementary naming convention for its parts.
9914  *
9915  * @ingroup Layout
9916  */
9917 #define elm_layout_end_set(_ly, _obj) \
9918   do { \
9919     const char *sig; \
9920     elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
9921     if ((_obj)) sig = "elm,state,end,visible"; \
9922     else sig = "elm,state,end,hidden"; \
9923     elm_object_signal_emit((_ly), sig, "elm"); \
9924   } while (0)
9925
9926 /**
9927  * @def elm_layout_end_get
9928  * Convienience macro to get the end object in a layout that follows the
9929  * Elementary naming convention for its parts.
9930  *
9931  * @ingroup Layout
9932  */
9933 #define elm_layout_end_get(_ly) \
9934   elm_layout_content_get((_ly), "elm.swallow.end")
9935
9936 /**
9937  * @def elm_layout_label_set
9938  * Convienience macro to set the label in a layout that follows the
9939  * Elementary naming convention for its parts.
9940  *
9941  * @ingroup Layout
9942  * @deprecated use elm_object_text_* instead.
9943  */
9944 #define elm_layout_label_set(_ly, _txt) \
9945   elm_layout_text_set((_ly), "elm.text", (_txt))
9946
9947 /**
9948  * @def elm_layout_label_get
9949  * Convienience macro to get the label in a layout that follows the
9950  * Elementary naming convention for its parts.
9951  *
9952  * @ingroup Layout
9953  * @deprecated use elm_object_text_* instead.
9954  */
9955 #define elm_layout_label_get(_ly) \
9956   elm_layout_text_get((_ly), "elm.text")
9957
9958    /* smart callbacks called:
9959     * "theme,changed" - when elm theme is changed.
9960     */
9961
9962    /**
9963     * @defgroup Notify Notify
9964     *
9965     * @image html img/widget/notify/preview-00.png
9966     * @image latex img/widget/notify/preview-00.eps
9967     *
9968     * Display a container in a particular region of the parent(top, bottom,
9969     * etc.  A timeout can be set to automatically hide the notify. This is so
9970     * that, after an evas_object_show() on a notify object, if a timeout was set
9971     * on it, it will @b automatically get hidden after that time.
9972     *
9973     * Signals that you can add callbacks for are:
9974     * @li "timeout" - when timeout happens on notify and it's hidden
9975     * @li "block,clicked" - when a click outside of the notify happens
9976     *
9977     * @ref tutorial_notify show usage of the API.
9978     *
9979     * @{
9980     */
9981    /**
9982     * @brief Possible orient values for notify.
9983     *
9984     * This values should be used in conjunction to elm_notify_orient_set() to
9985     * set the position in which the notify should appear(relative to its parent)
9986     * and in conjunction with elm_notify_orient_get() to know where the notify
9987     * is appearing.
9988     */
9989    typedef enum _Elm_Notify_Orient
9990      {
9991         ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
9992         ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
9993         ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
9994         ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
9995         ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
9996         ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
9997         ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
9998         ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
9999         ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10000         ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10001      } Elm_Notify_Orient;
10002    /**
10003     * @brief Add a new notify to the parent
10004     *
10005     * @param parent The parent object
10006     * @return The new object or NULL if it cannot be created
10007     */
10008    EAPI Evas_Object      *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10009    /**
10010     * @brief Set the content of the notify widget
10011     *
10012     * @param obj The notify object
10013     * @param content The content will be filled in this notify object
10014     *
10015     * Once the content object is set, a previously set one will be deleted. If
10016     * you want to keep that old content object, use the
10017     * elm_notify_content_unset() function.
10018     */
10019    EAPI void              elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10020    /**
10021     * @brief Unset the content of the notify widget
10022     *
10023     * @param obj The notify object
10024     * @return The content that was being used
10025     *
10026     * Unparent and return the content object which was set for this widget
10027     *
10028     * @see elm_notify_content_set()
10029     */
10030    EAPI Evas_Object      *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10031    /**
10032     * @brief Return the content of the notify widget
10033     *
10034     * @param obj The notify object
10035     * @return The content that is being used
10036     *
10037     * @see elm_notify_content_set()
10038     */
10039    EAPI Evas_Object      *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10040    /**
10041     * @brief Set the notify parent
10042     *
10043     * @param obj The notify object
10044     * @param content The new parent
10045     *
10046     * Once the parent object is set, a previously set one will be disconnected
10047     * and replaced.
10048     */
10049    EAPI void              elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10050    /**
10051     * @brief Get the notify parent
10052     *
10053     * @param obj The notify object
10054     * @return The parent
10055     *
10056     * @see elm_notify_parent_set()
10057     */
10058    EAPI Evas_Object      *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10059    /**
10060     * @brief Set the orientation
10061     *
10062     * @param obj The notify object
10063     * @param orient The new orientation
10064     *
10065     * Sets the position in which the notify will appear in its parent.
10066     *
10067     * @see @ref Elm_Notify_Orient for possible values.
10068     */
10069    EAPI void              elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10070    /**
10071     * @brief Return the orientation
10072     * @param obj The notify object
10073     * @return The orientation of the notification
10074     *
10075     * @see elm_notify_orient_set()
10076     * @see Elm_Notify_Orient
10077     */
10078    EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10079    /**
10080     * @brief Set the time interval after which the notify window is going to be
10081     * hidden.
10082     *
10083     * @param obj The notify object
10084     * @param time The timeout in seconds
10085     *
10086     * This function sets a timeout and starts the timer controlling when the
10087     * notify is hidden. Since calling evas_object_show() on a notify restarts
10088     * the timer controlling when the notify is hidden, setting this before the
10089     * notify is shown will in effect mean starting the timer when the notify is
10090     * shown.
10091     *
10092     * @note Set a value <= 0.0 to disable a running timer.
10093     *
10094     * @note If the value > 0.0 and the notify is previously visible, the
10095     * timer will be started with this value, canceling any running timer.
10096     */
10097    EAPI void              elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10098    /**
10099     * @brief Return the timeout value (in seconds)
10100     * @param obj the notify object
10101     *
10102     * @see elm_notify_timeout_set()
10103     */
10104    EAPI double            elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10105    /**
10106     * @brief Sets whether events should be passed to by a click outside
10107     * its area.
10108     *
10109     * @param obj The notify object
10110     * @param repeats EINA_TRUE Events are repeats, else no
10111     *
10112     * When true if the user clicks outside the window the events will be caught
10113     * by the others widgets, else the events are blocked.
10114     *
10115     * @note The default value is EINA_TRUE.
10116     */
10117    EAPI void              elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10118    /**
10119     * @brief Return true if events are repeat below the notify object
10120     * @param obj the notify object
10121     *
10122     * @see elm_notify_repeat_events_set()
10123     */
10124    EAPI Eina_Bool         elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10125    /**
10126     * @}
10127     */
10128
10129    /**
10130     * @defgroup Hover Hover
10131     *
10132     * @image html img/widget/hover/preview-00.png
10133     * @image latex img/widget/hover/preview-00.eps
10134     *
10135     * A Hover object will hover over its @p parent object at the @p target
10136     * location. Anything in the background will be given a darker coloring to
10137     * indicate that the hover object is on top (at the default theme). When the
10138     * hover is clicked it is dismissed(hidden), if the contents of the hover are
10139     * clicked that @b doesn't cause the hover to be dismissed.
10140     *
10141     * @note The hover object will take up the entire space of @p target
10142     * object.
10143     *
10144     * Elementary has the following styles for the hover widget:
10145     * @li default
10146     * @li popout
10147     * @li menu
10148     * @li hoversel_vertical
10149     *
10150     * The following are the available position for content:
10151     * @li left
10152     * @li top-left
10153     * @li top
10154     * @li top-right
10155     * @li right
10156     * @li bottom-right
10157     * @li bottom
10158     * @li bottom-left
10159     * @li middle
10160     * @li smart
10161     *
10162     * Signals that you can add callbacks for are:
10163     * @li "clicked" - the user clicked the empty space in the hover to dismiss
10164     * @li "smart,changed" - a content object placed under the "smart"
10165     *                   policy was replaced to a new slot direction.
10166     *
10167     * See @ref tutorial_hover for more information.
10168     *
10169     * @{
10170     */
10171    typedef enum _Elm_Hover_Axis
10172      {
10173         ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10174         ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10175         ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10176         ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10177      } Elm_Hover_Axis;
10178    /**
10179     * @brief Adds a hover object to @p parent
10180     *
10181     * @param parent The parent object
10182     * @return The hover object or NULL if one could not be created
10183     */
10184    EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10185    /**
10186     * @brief Sets the target object for the hover.
10187     *
10188     * @param obj The hover object
10189     * @param target The object to center the hover onto. The hover
10190     *
10191     * This function will cause the hover to be centered on the target object.
10192     */
10193    EAPI void         elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10194    /**
10195     * @brief Gets the target object for the hover.
10196     *
10197     * @param obj The hover object
10198     * @param parent The object to locate the hover over.
10199     *
10200     * @see elm_hover_target_set()
10201     */
10202    EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10203    /**
10204     * @brief Sets the parent object for the hover.
10205     *
10206     * @param obj The hover object
10207     * @param parent The object to locate the hover over.
10208     *
10209     * This function will cause the hover to take up the entire space that the
10210     * parent object fills.
10211     */
10212    EAPI void         elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10213    /**
10214     * @brief Gets the parent object for the hover.
10215     *
10216     * @param obj The hover object
10217     * @return The parent object to locate the hover over.
10218     *
10219     * @see elm_hover_parent_set()
10220     */
10221    EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10222    /**
10223     * @brief Sets the content of the hover object and the direction in which it
10224     * will pop out.
10225     *
10226     * @param obj The hover object
10227     * @param swallow The direction that the object will be displayed
10228     * at. Accepted values are "left", "top-left", "top", "top-right",
10229     * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10230     * "smart".
10231     * @param content The content to place at @p swallow
10232     *
10233     * Once the content object is set for a given direction, a previously
10234     * set one (on the same direction) will be deleted. If you want to
10235     * keep that old content object, use the elm_hover_content_unset()
10236     * function.
10237     *
10238     * All directions may have contents at the same time, except for
10239     * "smart". This is a special placement hint and its use case
10240     * independs of the calculations coming from
10241     * elm_hover_best_content_location_get(). Its use is for cases when
10242     * one desires only one hover content, but with a dinamic special
10243     * placement within the hover area. The content's geometry, whenever
10244     * it changes, will be used to decide on a best location not
10245     * extrapolating the hover's parent object view to show it in (still
10246     * being the hover's target determinant of its medium part -- move and
10247     * resize it to simulate finger sizes, for example). If one of the
10248     * directions other than "smart" are used, a previously content set
10249     * using it will be deleted, and vice-versa.
10250     */
10251    EAPI void         elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10252    /**
10253     * @brief Get the content of the hover object, in a given direction.
10254     *
10255     * Return the content object which was set for this widget in the
10256     * @p swallow direction.
10257     *
10258     * @param obj The hover object
10259     * @param swallow The direction that the object was display at.
10260     * @return The content that was being used
10261     *
10262     * @see elm_hover_content_set()
10263     */
10264    EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10265    /**
10266     * @brief Unset the content of the hover object, in a given direction.
10267     *
10268     * Unparent and return the content object set at @p swallow direction.
10269     *
10270     * @param obj The hover object
10271     * @param swallow The direction that the object was display at.
10272     * @return The content that was being used.
10273     *
10274     * @see elm_hover_content_set()
10275     */
10276    EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10277    /**
10278     * @brief Returns the best swallow location for content in the hover.
10279     *
10280     * @param obj The hover object
10281     * @param pref_axis The preferred orientation axis for the hover object to use
10282     * @return The edje location to place content into the hover or @c
10283     *         NULL, on errors.
10284     *
10285     * Best is defined here as the location at which there is the most available
10286     * space.
10287     *
10288     * @p pref_axis may be one of
10289     * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10290     * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10291     * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10292     * - @c ELM_HOVER_AXIS_BOTH -- both
10293     *
10294     * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10295     * nescessarily be along the horizontal axis("left" or "right"). If
10296     * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10297     * be along the vertical axis("top" or "bottom"). Chossing
10298     * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10299     * returned position may be in either axis.
10300     *
10301     * @see elm_hover_content_set()
10302     */
10303    EAPI const char  *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10304    /**
10305     * @}
10306     */
10307
10308    /* entry */
10309    /**
10310     * @defgroup Entry Entry
10311     *
10312     * @image html img/widget/entry/preview-00.png
10313     * @image latex img/widget/entry/preview-00.eps width=\textwidth
10314     * @image html img/widget/entry/preview-01.png
10315     * @image latex img/widget/entry/preview-01.eps width=\textwidth
10316     * @image html img/widget/entry/preview-02.png
10317     * @image latex img/widget/entry/preview-02.eps width=\textwidth
10318     * @image html img/widget/entry/preview-03.png
10319     * @image latex img/widget/entry/preview-03.eps width=\textwidth
10320     *
10321     * An entry is a convenience widget which shows a box that the user can
10322     * enter text into. Entries by default don't scroll, so they grow to
10323     * accomodate the entire text, resizing the parent window as needed. This
10324     * can be changed with the elm_entry_scrollable_set() function.
10325     *
10326     * They can also be single line or multi line (the default) and when set
10327     * to multi line mode they support text wrapping in any of the modes
10328     * indicated by #Elm_Wrap_Type.
10329     *
10330     * Other features include password mode, filtering of inserted text with
10331     * elm_entry_text_filter_append() and related functions, inline "items" and
10332     * formatted markup text.
10333     *
10334     * @section entry-markup Formatted text
10335     *
10336     * The markup tags supported by the Entry are defined by the theme, but
10337     * even when writing new themes or extensions it's a good idea to stick to
10338     * a sane default, to maintain coherency and avoid application breakages.
10339     * Currently defined by the default theme are the following tags:
10340     * @li \<br\>: Inserts a line break.
10341     * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10342     * breaks.
10343     * @li \<tab\>: Inserts a tab.
10344     * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10345     * enclosed text.
10346     * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10347     * @li \<link\>...\</link\>: Underlines the enclosed text.
10348     * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10349     *
10350     * @section entry-special Special markups
10351     *
10352     * Besides those used to format text, entries support two special markup
10353     * tags used to insert clickable portions of text or items inlined within
10354     * the text.
10355     *
10356     * @subsection entry-anchors Anchors
10357     *
10358     * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10359     * \</a\> tags and an event will be generated when this text is clicked,
10360     * like this:
10361     *
10362     * @code
10363     * This text is outside <a href=anc-01>but this one is an anchor</a>
10364     * @endcode
10365     *
10366     * The @c href attribute in the opening tag gives the name that will be
10367     * used to identify the anchor and it can be any valid utf8 string.
10368     *
10369     * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10370     * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10371     * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10372     * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10373     * an anchor.
10374     *
10375     * @subsection entry-items Items
10376     *
10377     * Inlined in the text, any other @c Evas_Object can be inserted by using
10378     * \<item\> tags this way:
10379     *
10380     * @code
10381     * <item size=16x16 vsize=full href=emoticon/haha></item>
10382     * @endcode
10383     *
10384     * Just like with anchors, the @c href identifies each item, but these need,
10385     * in addition, to indicate their size, which is done using any one of
10386     * @c size, @c absize or @c relsize attributes. These attributes take their
10387     * value in the WxH format, where W is the width and H the height of the
10388     * item.
10389     *
10390     * @li absize: Absolute pixel size for the item. Whatever value is set will
10391     * be the item's size regardless of any scale value the object may have
10392     * been set to. The final line height will be adjusted to fit larger items.
10393     * @li size: Similar to @c absize, but it's adjusted to the scale value set
10394     * for the object.
10395     * @li relsize: Size is adjusted for the item to fit within the current
10396     * line height.
10397     *
10398     * Besides their size, items are specificed a @c vsize value that affects
10399     * how their final size and position are calculated. The possible values
10400     * are:
10401     * @li ascent: Item will be placed within the line's baseline and its
10402     * ascent. That is, the height between the line where all characters are
10403     * positioned and the highest point in the line. For @c size and @c absize
10404     * items, the descent value will be added to the total line height to make
10405     * them fit. @c relsize items will be adjusted to fit within this space.
10406     * @li full: Items will be placed between the descent and ascent, or the
10407     * lowest point in the line and its highest.
10408     *
10409     * The next image shows different configurations of items and how they
10410     * are the previously mentioned options affect their sizes. In all cases,
10411     * the green line indicates the ascent, blue for the baseline and red for
10412     * the descent.
10413     *
10414     * @image html entry_item.png
10415     * @image latex entry_item.eps width=\textwidth
10416     *
10417     * And another one to show how size differs from absize. In the first one,
10418     * the scale value is set to 1.0, while the second one is using one of 2.0.
10419     *
10420     * @image html entry_item_scale.png
10421     * @image latex entry_item_scale.eps width=\textwidth
10422     *
10423     * After the size for an item is calculated, the entry will request an
10424     * object to place in its space. For this, the functions set with
10425     * elm_entry_item_provider_append() and related functions will be called
10426     * in order until one of them returns a @c non-NULL value. If no providers
10427     * are available, or all of them return @c NULL, then the entry falls back
10428     * to one of the internal defaults, provided the name matches with one of
10429     * them.
10430     *
10431     * All of the following are currently supported:
10432     *
10433     * - emoticon/angry
10434     * - emoticon/angry-shout
10435     * - emoticon/crazy-laugh
10436     * - emoticon/evil-laugh
10437     * - emoticon/evil
10438     * - emoticon/goggle-smile
10439     * - emoticon/grumpy
10440     * - emoticon/grumpy-smile
10441     * - emoticon/guilty
10442     * - emoticon/guilty-smile
10443     * - emoticon/haha
10444     * - emoticon/half-smile
10445     * - emoticon/happy-panting
10446     * - emoticon/happy
10447     * - emoticon/indifferent
10448     * - emoticon/kiss
10449     * - emoticon/knowing-grin
10450     * - emoticon/laugh
10451     * - emoticon/little-bit-sorry
10452     * - emoticon/love-lots
10453     * - emoticon/love
10454     * - emoticon/minimal-smile
10455     * - emoticon/not-happy
10456     * - emoticon/not-impressed
10457     * - emoticon/omg
10458     * - emoticon/opensmile
10459     * - emoticon/smile
10460     * - emoticon/sorry
10461     * - emoticon/squint-laugh
10462     * - emoticon/surprised
10463     * - emoticon/suspicious
10464     * - emoticon/tongue-dangling
10465     * - emoticon/tongue-poke
10466     * - emoticon/uh
10467     * - emoticon/unhappy
10468     * - emoticon/very-sorry
10469     * - emoticon/what
10470     * - emoticon/wink
10471     * - emoticon/worried
10472     * - emoticon/wtf
10473     *
10474     * Alternatively, an item may reference an image by its path, using
10475     * the URI form @c file:///path/to/an/image.png and the entry will then
10476     * use that image for the item.
10477     *
10478     * @section entry-files Loading and saving files
10479     *
10480     * Entries have convinience functions to load text from a file and save
10481     * changes back to it after a short delay. The automatic saving is enabled
10482     * by default, but can be disabled with elm_entry_autosave_set() and files
10483     * can be loaded directly as plain text or have any markup in them
10484     * recognized. See elm_entry_file_set() for more details.
10485     *
10486     * @section entry-signals Emitted signals
10487     *
10488     * This widget emits the following signals:
10489     *
10490     * @li "changed": The text within the entry was changed.
10491     * @li "changed,user": The text within the entry was changed because of user interaction.
10492     * @li "activated": The enter key was pressed on a single line entry.
10493     * @li "press": A mouse button has been pressed on the entry.
10494     * @li "longpressed": A mouse button has been pressed and held for a couple
10495     * seconds.
10496     * @li "clicked": The entry has been clicked (mouse press and release).
10497     * @li "clicked,double": The entry has been double clicked.
10498     * @li "clicked,triple": The entry has been triple clicked.
10499     * @li "focused": The entry has received focus.
10500     * @li "unfocused": The entry has lost focus.
10501     * @li "selection,paste": A paste of the clipboard contents was requested.
10502     * @li "selection,copy": A copy of the selected text into the clipboard was
10503     * requested.
10504     * @li "selection,cut": A cut of the selected text into the clipboard was
10505     * requested.
10506     * @li "selection,start": A selection has begun and no previous selection
10507     * existed.
10508     * @li "selection,changed": The current selection has changed.
10509     * @li "selection,cleared": The current selection has been cleared.
10510     * @li "cursor,changed": The cursor has changed position.
10511     * @li "anchor,clicked": An anchor has been clicked. The event_info
10512     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10513     * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10514     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10515     * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10516     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10517     * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10518     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10519     * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10520     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10521     * @li "preedit,changed": The preedit string has changed.
10522     *
10523     * @section entry-examples
10524     *
10525     * An overview of the Entry API can be seen in @ref entry_example_01
10526     *
10527     * @{
10528     */
10529    /**
10530     * @typedef Elm_Entry_Anchor_Info
10531     *
10532     * The info sent in the callback for the "anchor,clicked" signals emitted
10533     * by entries.
10534     */
10535    typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10536    /**
10537     * @struct _Elm_Entry_Anchor_Info
10538     *
10539     * The info sent in the callback for the "anchor,clicked" signals emitted
10540     * by entries.
10541     */
10542    struct _Elm_Entry_Anchor_Info
10543      {
10544         const char *name; /**< The name of the anchor, as stated in its href */
10545         int         button; /**< The mouse button used to click on it */
10546         Evas_Coord  x, /**< Anchor geometry, relative to canvas */
10547                     y, /**< Anchor geometry, relative to canvas */
10548                     w, /**< Anchor geometry, relative to canvas */
10549                     h; /**< Anchor geometry, relative to canvas */
10550      };
10551    /**
10552     * @typedef Elm_Entry_Filter_Cb
10553     * This callback type is used by entry filters to modify text.
10554     * @param data The data specified as the last param when adding the filter
10555     * @param entry The entry object
10556     * @param text A pointer to the location of the text being filtered. This data can be modified,
10557     * but any additional allocations must be managed by the user.
10558     * @see elm_entry_text_filter_append
10559     * @see elm_entry_text_filter_prepend
10560     */
10561    typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
10562
10563    /**
10564     * This adds an entry to @p parent object.
10565     *
10566     * By default, entries are:
10567     * @li not scrolled
10568     * @li multi-line
10569     * @li word wrapped
10570     * @li autosave is enabled
10571     *
10572     * @param parent The parent object
10573     * @return The new object or NULL if it cannot be created
10574     */
10575    EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10576    /**
10577     * Sets the entry to single line mode.
10578     *
10579     * In single line mode, entries don't ever wrap when the text reaches the
10580     * edge, and instead they keep growing horizontally. Pressing the @c Enter
10581     * key will generate an @c "activate" event instead of adding a new line.
10582     *
10583     * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
10584     * and pressing enter will break the text into a different line
10585     * without generating any events.
10586     *
10587     * @param obj The entry object
10588     * @param single_line If true, the text in the entry
10589     * will be on a single line.
10590     */
10591    EAPI void         elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
10592    /**
10593     * Gets whether the entry is set to be single line.
10594     *
10595     * @param obj The entry object
10596     * @return single_line If true, the text in the entry is set to display
10597     * on a single line.
10598     *
10599     * @see elm_entry_single_line_set()
10600     */
10601    EAPI Eina_Bool    elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10602    /**
10603     * Sets the entry to password mode.
10604     *
10605     * In password mode, entries are implicitly single line and the display of
10606     * any text in them is replaced with asterisks (*).
10607     *
10608     * @param obj The entry object
10609     * @param password If true, password mode is enabled.
10610     */
10611    EAPI void         elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
10612    /**
10613     * Gets whether the entry is set to password mode.
10614     *
10615     * @param obj The entry object
10616     * @return If true, the entry is set to display all characters
10617     * as asterisks (*).
10618     *
10619     * @see elm_entry_password_set()
10620     */
10621    EAPI Eina_Bool    elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10622    /**
10623     * This sets the text displayed within the entry to @p entry.
10624     *
10625     * @param obj The entry object
10626     * @param entry The text to be displayed
10627     *
10628     * @deprecated Use elm_object_text_set() instead.
10629     */
10630    EAPI void         elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10631    /**
10632     * This returns the text currently shown in object @p entry.
10633     * See also elm_entry_entry_set().
10634     *
10635     * @param obj The entry object
10636     * @return The currently displayed text or NULL on failure
10637     *
10638     * @deprecated Use elm_object_text_get() instead.
10639     */
10640    EAPI const char  *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10641    /**
10642     * Appends @p entry to the text of the entry.
10643     *
10644     * Adds the text in @p entry to the end of any text already present in the
10645     * widget.
10646     *
10647     * The appended text is subject to any filters set for the widget.
10648     *
10649     * @param obj The entry object
10650     * @param entry The text to be displayed
10651     *
10652     * @see elm_entry_text_filter_append()
10653     */
10654    EAPI void         elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10655    /**
10656     * Gets whether the entry is empty.
10657     *
10658     * Empty means no text at all. If there are any markup tags, like an item
10659     * tag for which no provider finds anything, and no text is displayed, this
10660     * function still returns EINA_FALSE.
10661     *
10662     * @param obj The entry object
10663     * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
10664     */
10665    EAPI Eina_Bool    elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10666    /**
10667     * Gets any selected text within the entry.
10668     *
10669     * If there's any selected text in the entry, this function returns it as
10670     * a string in markup format. NULL is returned if no selection exists or
10671     * if an error occurred.
10672     *
10673     * The returned value points to an internal string and should not be freed
10674     * or modified in any way. If the @p entry object is deleted or its
10675     * contents are changed, the returned pointer should be considered invalid.
10676     *
10677     * @param obj The entry object
10678     * @return The selected text within the entry or NULL on failure
10679     */
10680    EAPI const char  *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10681    /**
10682     * Inserts the given text into the entry at the current cursor position.
10683     *
10684     * This inserts text at the cursor position as if it was typed
10685     * by the user (note that this also allows markup which a user
10686     * can't just "type" as it would be converted to escaped text, so this
10687     * call can be used to insert things like emoticon items or bold push/pop
10688     * tags, other font and color change tags etc.)
10689     *
10690     * If any selection exists, it will be replaced by the inserted text.
10691     *
10692     * The inserted text is subject to any filters set for the widget.
10693     *
10694     * @param obj The entry object
10695     * @param entry The text to insert
10696     *
10697     * @see elm_entry_text_filter_append()
10698     */
10699    EAPI void         elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10700    /**
10701     * Set the line wrap type to use on multi-line entries.
10702     *
10703     * Sets the wrap type used by the entry to any of the specified in
10704     * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
10705     * line (without inserting a line break or paragraph separator) when it
10706     * reaches the far edge of the widget.
10707     *
10708     * Note that this only makes sense for multi-line entries. A widget set
10709     * to be single line will never wrap.
10710     *
10711     * @param obj The entry object
10712     * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
10713     */
10714    EAPI void         elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
10715    /**
10716     * Gets the wrap mode the entry was set to use.
10717     *
10718     * @param obj The entry object
10719     * @return Wrap type
10720     *
10721     * @see also elm_entry_line_wrap_set()
10722     */
10723    EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10724    /**
10725     * Sets if the entry is to be editable or not.
10726     *
10727     * By default, entries are editable and when focused, any text input by the
10728     * user will be inserted at the current cursor position. But calling this
10729     * function with @p editable as EINA_FALSE will prevent the user from
10730     * inputting text into the entry.
10731     *
10732     * The only way to change the text of a non-editable entry is to use
10733     * elm_object_text_set(), elm_entry_entry_insert() and other related
10734     * functions.
10735     *
10736     * @param obj The entry object
10737     * @param editable If EINA_TRUE, user input will be inserted in the entry,
10738     * if not, the entry is read-only and no user input is allowed.
10739     */
10740    EAPI void         elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
10741    /**
10742     * Gets whether the entry is editable or not.
10743     *
10744     * @param obj The entry object
10745     * @return If true, the entry is editable by the user.
10746     * If false, it is not editable by the user
10747     *
10748     * @see elm_entry_editable_set()
10749     */
10750    EAPI Eina_Bool    elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10751    /**
10752     * This drops any existing text selection within the entry.
10753     *
10754     * @param obj The entry object
10755     */
10756    EAPI void         elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
10757    /**
10758     * This selects all text within the entry.
10759     *
10760     * @param obj The entry object
10761     */
10762    EAPI void         elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
10763    /**
10764     * This moves the cursor one place to the right within the entry.
10765     *
10766     * @param obj The entry object
10767     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10768     */
10769    EAPI Eina_Bool    elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
10770    /**
10771     * This moves the cursor one place to the left within the entry.
10772     *
10773     * @param obj The entry object
10774     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10775     */
10776    EAPI Eina_Bool    elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
10777    /**
10778     * This moves the cursor one line up within the entry.
10779     *
10780     * @param obj The entry object
10781     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10782     */
10783    EAPI Eina_Bool    elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
10784    /**
10785     * This moves the cursor one line down within the entry.
10786     *
10787     * @param obj The entry object
10788     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10789     */
10790    EAPI Eina_Bool    elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
10791    /**
10792     * This moves the cursor to the beginning of the entry.
10793     *
10794     * @param obj The entry object
10795     */
10796    EAPI void         elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10797    /**
10798     * This moves the cursor to the end of the entry.
10799     *
10800     * @param obj The entry object
10801     */
10802    EAPI void         elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10803    /**
10804     * This moves the cursor to the beginning of the current line.
10805     *
10806     * @param obj The entry object
10807     */
10808    EAPI void         elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10809    /**
10810     * This moves the cursor to the end of the current line.
10811     *
10812     * @param obj The entry object
10813     */
10814    EAPI void         elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10815    /**
10816     * This begins a selection within the entry as though
10817     * the user were holding down the mouse button to make a selection.
10818     *
10819     * @param obj The entry object
10820     */
10821    EAPI void         elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
10822    /**
10823     * This ends a selection within the entry as though
10824     * the user had just released the mouse button while making a selection.
10825     *
10826     * @param obj The entry object
10827     */
10828    EAPI void         elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
10829    /**
10830     * Gets whether a format node exists at the current cursor position.
10831     *
10832     * A format node is anything that defines how the text is rendered. It can
10833     * be a visible format node, such as a line break or a paragraph separator,
10834     * or an invisible one, such as bold begin or end tag.
10835     * This function returns whether any format node exists at the current
10836     * cursor position.
10837     *
10838     * @param obj The entry object
10839     * @return EINA_TRUE if the current cursor position contains a format node,
10840     * EINA_FALSE otherwise.
10841     *
10842     * @see elm_entry_cursor_is_visible_format_get()
10843     */
10844    EAPI Eina_Bool    elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10845    /**
10846     * Gets if the current cursor position holds a visible format node.
10847     *
10848     * @param obj The entry object
10849     * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
10850     * if it's an invisible one or no format exists.
10851     *
10852     * @see elm_entry_cursor_is_format_get()
10853     */
10854    EAPI Eina_Bool    elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10855    /**
10856     * Gets the character pointed by the cursor at its current position.
10857     *
10858     * This function returns a string with the utf8 character stored at the
10859     * current cursor position.
10860     * Only the text is returned, any format that may exist will not be part
10861     * of the return value.
10862     *
10863     * @param obj The entry object
10864     * @return The text pointed by the cursors.
10865     */
10866    EAPI const char  *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10867    /**
10868     * This function returns the geometry of the cursor.
10869     *
10870     * It's useful if you want to draw something on the cursor (or where it is),
10871     * or for example in the case of scrolled entry where you want to show the
10872     * cursor.
10873     *
10874     * @param obj The entry object
10875     * @param x returned geometry
10876     * @param y returned geometry
10877     * @param w returned geometry
10878     * @param h returned geometry
10879     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10880     */
10881    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);
10882    /**
10883     * Sets the cursor position in the entry to the given value
10884     *
10885     * The value in @p pos is the index of the character position within the
10886     * contents of the string as returned by elm_entry_cursor_pos_get().
10887     *
10888     * @param obj The entry object
10889     * @param pos The position of the cursor
10890     */
10891    EAPI void         elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
10892    /**
10893     * Retrieves the current position of the cursor in the entry
10894     *
10895     * @param obj The entry object
10896     * @return The cursor position
10897     */
10898    EAPI int          elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10899    /**
10900     * This executes a "cut" action on the selected text in the entry.
10901     *
10902     * @param obj The entry object
10903     */
10904    EAPI void         elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
10905    /**
10906     * This executes a "copy" action on the selected text in the entry.
10907     *
10908     * @param obj The entry object
10909     */
10910    EAPI void         elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
10911    /**
10912     * This executes a "paste" action in the entry.
10913     *
10914     * @param obj The entry object
10915     */
10916    EAPI void         elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
10917    /**
10918     * This clears and frees the items in a entry's contextual (longpress)
10919     * menu.
10920     *
10921     * @param obj The entry object
10922     *
10923     * @see elm_entry_context_menu_item_add()
10924     */
10925    EAPI void         elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
10926    /**
10927     * This adds an item to the entry's contextual menu.
10928     *
10929     * A longpress on an entry will make the contextual menu show up, if this
10930     * hasn't been disabled with elm_entry_context_menu_disabled_set().
10931     * By default, this menu provides a few options like enabling selection mode,
10932     * which is useful on embedded devices that need to be explicit about it,
10933     * and when a selection exists it also shows the copy and cut actions.
10934     *
10935     * With this function, developers can add other options to this menu to
10936     * perform any action they deem necessary.
10937     *
10938     * @param obj The entry object
10939     * @param label The item's text label
10940     * @param icon_file The item's icon file
10941     * @param icon_type The item's icon type
10942     * @param func The callback to execute when the item is clicked
10943     * @param data The data to associate with the item for related functions
10944     */
10945    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);
10946    /**
10947     * This disables the entry's contextual (longpress) menu.
10948     *
10949     * @param obj The entry object
10950     * @param disabled If true, the menu is disabled
10951     */
10952    EAPI void         elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
10953    /**
10954     * This returns whether the entry's contextual (longpress) menu is
10955     * disabled.
10956     *
10957     * @param obj The entry object
10958     * @return If true, the menu is disabled
10959     */
10960    EAPI Eina_Bool    elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10961    /**
10962     * This appends a custom item provider to the list for that entry
10963     *
10964     * This appends the given callback. The list is walked from beginning to end
10965     * with each function called given the item href string in the text. If the
10966     * function returns an object handle other than NULL (it should create an
10967     * object to do this), then this object is used to replace that item. If
10968     * not the next provider is called until one provides an item object, or the
10969     * default provider in entry does.
10970     *
10971     * @param obj The entry object
10972     * @param func The function called to provide the item object
10973     * @param data The data passed to @p func
10974     *
10975     * @see @ref entry-items
10976     */
10977    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);
10978    /**
10979     * This prepends a custom item provider to the list for that entry
10980     *
10981     * This prepends the given callback. See elm_entry_item_provider_append() for
10982     * more information
10983     *
10984     * @param obj The entry object
10985     * @param func The function called to provide the item object
10986     * @param data The data passed to @p func
10987     */
10988    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);
10989    /**
10990     * This removes a custom item provider to the list for that entry
10991     *
10992     * This removes the given callback. See elm_entry_item_provider_append() for
10993     * more information
10994     *
10995     * @param obj The entry object
10996     * @param func The function called to provide the item object
10997     * @param data The data passed to @p func
10998     */
10999    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);
11000    /**
11001     * Append a filter function for text inserted in the entry
11002     *
11003     * Append the given callback to the list. This functions will be called
11004     * whenever any text is inserted into the entry, with the text to be inserted
11005     * as a parameter. The callback function is free to alter the text in any way
11006     * it wants, but it must remember to free the given pointer and update it.
11007     * If the new text is to be discarded, the function can free it and set its
11008     * text parameter to NULL. This will also prevent any following filters from
11009     * being called.
11010     *
11011     * @param obj The entry object
11012     * @param func The function to use as text filter
11013     * @param data User data to pass to @p func
11014     */
11015    EAPI void         elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11016    /**
11017     * Prepend a filter function for text insdrted in the entry
11018     *
11019     * Prepend the given callback to the list. See elm_entry_text_filter_append()
11020     * for more information
11021     *
11022     * @param obj The entry object
11023     * @param func The function to use as text filter
11024     * @param data User data to pass to @p func
11025     */
11026    EAPI void         elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11027    /**
11028     * Remove a filter from the list
11029     *
11030     * Removes the given callback from the filter list. See
11031     * elm_entry_text_filter_append() for more information.
11032     *
11033     * @param obj The entry object
11034     * @param func The filter function to remove
11035     * @param data The user data passed when adding the function
11036     */
11037    EAPI void         elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11038    /**
11039     * This converts a markup (HTML-like) string into UTF-8.
11040     *
11041     * The returned string is a malloc'ed buffer and it should be freed when
11042     * not needed anymore.
11043     *
11044     * @param s The string (in markup) to be converted
11045     * @return The converted string (in UTF-8). It should be freed.
11046     */
11047    EAPI char        *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11048    /**
11049     * This converts a UTF-8 string into markup (HTML-like).
11050     *
11051     * The returned string is a malloc'ed buffer and it should be freed when
11052     * not needed anymore.
11053     *
11054     * @param s The string (in UTF-8) to be converted
11055     * @return The converted string (in markup). It should be freed.
11056     */
11057    EAPI char        *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11058    /**
11059     * This sets the file (and implicitly loads it) for the text to display and
11060     * then edit. All changes are written back to the file after a short delay if
11061     * the entry object is set to autosave (which is the default).
11062     *
11063     * If the entry had any other file set previously, any changes made to it
11064     * will be saved if the autosave feature is enabled, otherwise, the file
11065     * will be silently discarded and any non-saved changes will be lost.
11066     *
11067     * @param obj The entry object
11068     * @param file The path to the file to load and save
11069     * @param format The file format
11070     */
11071    EAPI void         elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11072    /**
11073     * Gets the file being edited by the entry.
11074     *
11075     * This function can be used to retrieve any file set on the entry for
11076     * edition, along with the format used to load and save it.
11077     *
11078     * @param obj The entry object
11079     * @param file The path to the file to load and save
11080     * @param format The file format
11081     */
11082    EAPI void         elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11083    /**
11084     * This function writes any changes made to the file set with
11085     * elm_entry_file_set()
11086     *
11087     * @param obj The entry object
11088     */
11089    EAPI void         elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11090    /**
11091     * This sets the entry object to 'autosave' the loaded text file or not.
11092     *
11093     * @param obj The entry object
11094     * @param autosave Autosave the loaded file or not
11095     *
11096     * @see elm_entry_file_set()
11097     */
11098    EAPI void         elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11099    /**
11100     * This gets the entry object's 'autosave' status.
11101     *
11102     * @param obj The entry object
11103     * @return Autosave the loaded file or not
11104     *
11105     * @see elm_entry_file_set()
11106     */
11107    EAPI Eina_Bool    elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11108    /**
11109     * Control pasting of text and images for the widget.
11110     *
11111     * Normally the entry allows both text and images to be pasted.  By setting
11112     * textonly to be true, this prevents images from being pasted.
11113     *
11114     * Note this only changes the behaviour of text.
11115     *
11116     * @param obj The entry object
11117     * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11118     * text+image+other.
11119     */
11120    EAPI void         elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11121    /**
11122     * Getting elm_entry text paste/drop mode.
11123     *
11124     * In textonly mode, only text may be pasted or dropped into the widget.
11125     *
11126     * @param obj The entry object
11127     * @return If the widget only accepts text from pastes.
11128     */
11129    EAPI Eina_Bool    elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11130    /**
11131     * Enable or disable scrolling in entry
11132     *
11133     * Normally the entry is not scrollable unless you enable it with this call.
11134     *
11135     * @param obj The entry object
11136     * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11137     */
11138    EAPI void         elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11139    /**
11140     * Get the scrollable state of the entry
11141     *
11142     * Normally the entry is not scrollable. This gets the scrollable state
11143     * of the entry. See elm_entry_scrollable_set() for more information.
11144     *
11145     * @param obj The entry object
11146     * @return The scrollable state
11147     */
11148    EAPI Eina_Bool    elm_entry_scrollable_get(const Evas_Object *obj);
11149    /**
11150     * This sets a widget to be displayed to the left of a scrolled entry.
11151     *
11152     * @param obj The scrolled entry object
11153     * @param icon The widget to display on the left side of the scrolled
11154     * entry.
11155     *
11156     * @note A previously set widget will be destroyed.
11157     * @note If the object being set does not have minimum size hints set,
11158     * it won't get properly displayed.
11159     *
11160     * @see elm_entry_end_set()
11161     */
11162    EAPI void         elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11163    /**
11164     * Gets the leftmost widget of the scrolled entry. This object is
11165     * owned by the scrolled entry and should not be modified.
11166     *
11167     * @param obj The scrolled entry object
11168     * @return the left widget inside the scroller
11169     */
11170    EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11171    /**
11172     * Unset the leftmost widget of the scrolled entry, unparenting and
11173     * returning it.
11174     *
11175     * @param obj The scrolled entry object
11176     * @return the previously set icon sub-object of this entry, on
11177     * success.
11178     *
11179     * @see elm_entry_icon_set()
11180     */
11181    EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11182    /**
11183     * Sets the visibility of the left-side widget of the scrolled entry,
11184     * set by elm_entry_icon_set().
11185     *
11186     * @param obj The scrolled entry object
11187     * @param setting EINA_TRUE if the object should be displayed,
11188     * EINA_FALSE if not.
11189     */
11190    EAPI void         elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11191    /**
11192     * This sets a widget to be displayed to the end of a scrolled entry.
11193     *
11194     * @param obj The scrolled entry object
11195     * @param end The widget to display on the right side of the scrolled
11196     * entry.
11197     *
11198     * @note A previously set widget will be destroyed.
11199     * @note If the object being set does not have minimum size hints set,
11200     * it won't get properly displayed.
11201     *
11202     * @see elm_entry_icon_set
11203     */
11204    EAPI void         elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11205    /**
11206     * Gets the endmost widget of the scrolled entry. This object is owned
11207     * by the scrolled entry and should not be modified.
11208     *
11209     * @param obj The scrolled entry object
11210     * @return the right widget inside the scroller
11211     */
11212    EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11213    /**
11214     * Unset the endmost widget of the scrolled entry, unparenting and
11215     * returning it.
11216     *
11217     * @param obj The scrolled entry object
11218     * @return the previously set icon sub-object of this entry, on
11219     * success.
11220     *
11221     * @see elm_entry_icon_set()
11222     */
11223    EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11224    /**
11225     * Sets the visibility of the end widget of the scrolled entry, set by
11226     * elm_entry_end_set().
11227     *
11228     * @param obj The scrolled entry object
11229     * @param setting EINA_TRUE if the object should be displayed,
11230     * EINA_FALSE if not.
11231     */
11232    EAPI void         elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11233    /**
11234     * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11235     * them).
11236     *
11237     * Setting an entry to single-line mode with elm_entry_single_line_set()
11238     * will automatically disable the display of scrollbars when the entry
11239     * moves inside its scroller.
11240     *
11241     * @param obj The scrolled entry object
11242     * @param h The horizontal scrollbar policy to apply
11243     * @param v The vertical scrollbar policy to apply
11244     */
11245    EAPI void         elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11246    /**
11247     * This enables/disables bouncing within the entry.
11248     *
11249     * This function sets whether the entry will bounce when scrolling reaches
11250     * the end of the contained entry.
11251     *
11252     * @param obj The scrolled entry object
11253     * @param h The horizontal bounce state
11254     * @param v The vertical bounce state
11255     */
11256    EAPI void         elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11257    /**
11258     * Get the bounce mode
11259     *
11260     * @param obj The Entry object
11261     * @param h_bounce Allow bounce horizontally
11262     * @param v_bounce Allow bounce vertically
11263     */
11264    EAPI void         elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11265
11266    /* pre-made filters for entries */
11267    /**
11268     * @typedef Elm_Entry_Filter_Limit_Size
11269     *
11270     * Data for the elm_entry_filter_limit_size() entry filter.
11271     */
11272    typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11273    /**
11274     * @struct _Elm_Entry_Filter_Limit_Size
11275     *
11276     * Data for the elm_entry_filter_limit_size() entry filter.
11277     */
11278    struct _Elm_Entry_Filter_Limit_Size
11279      {
11280         int max_char_count; /**< The maximum number of characters allowed. */
11281         int max_byte_count; /**< The maximum number of bytes allowed*/
11282      };
11283    /**
11284     * Filter inserted text based on user defined character and byte limits
11285     *
11286     * Add this filter to an entry to limit the characters that it will accept
11287     * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11288     * The funtion works on the UTF-8 representation of the string, converting
11289     * it from the set markup, thus not accounting for any format in it.
11290     *
11291     * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11292     * it as data when setting the filter. In it, it's possible to set limits
11293     * by character count or bytes (any of them is disabled if 0), and both can
11294     * be set at the same time. In that case, it first checks for characters,
11295     * then bytes.
11296     *
11297     * The function will cut the inserted text in order to allow only the first
11298     * number of characters that are still allowed. The cut is made in
11299     * characters, even when limiting by bytes, in order to always contain
11300     * valid ones and avoid half unicode characters making it in.
11301     *
11302     * This filter, like any others, does not apply when setting the entry text
11303     * directly with elm_object_text_set() (or the deprecated
11304     * elm_entry_entry_set()).
11305     */
11306    EAPI void         elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11307    /**
11308     * @typedef Elm_Entry_Filter_Accept_Set
11309     *
11310     * Data for the elm_entry_filter_accept_set() entry filter.
11311     */
11312    typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11313    /**
11314     * @struct _Elm_Entry_Filter_Accept_Set
11315     *
11316     * Data for the elm_entry_filter_accept_set() entry filter.
11317     */
11318    struct _Elm_Entry_Filter_Accept_Set
11319      {
11320         const char *accepted; /**< Set of characters accepted in the entry. */
11321         const char *rejected; /**< Set of characters rejected from the entry. */
11322      };
11323    /**
11324     * Filter inserted text based on accepted or rejected sets of characters
11325     *
11326     * Add this filter to an entry to restrict the set of accepted characters
11327     * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11328     * This structure contains both accepted and rejected sets, but they are
11329     * mutually exclusive.
11330     *
11331     * The @c accepted set takes preference, so if it is set, the filter will
11332     * only work based on the accepted characters, ignoring anything in the
11333     * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11334     *
11335     * In both cases, the function filters by matching utf8 characters to the
11336     * raw markup text, so it can be used to remove formatting tags.
11337     *
11338     * This filter, like any others, does not apply when setting the entry text
11339     * directly with elm_object_text_set() (or the deprecated
11340     * elm_entry_entry_set()).
11341     */
11342    EAPI void         elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11343    /**
11344     * Set the input panel layout of the entry
11345     *
11346     * @param obj The entry object
11347     * @param layout layout type
11348     */
11349    EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11350    /**
11351     * Get the input panel layout of the entry
11352     *
11353     * @param obj The entry object
11354     * @return layout type
11355     *
11356     * @see elm_entry_input_panel_layout_set
11357     */
11358    EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11359    /**
11360     * @}
11361     */
11362
11363    /* composite widgets - these basically put together basic widgets above
11364     * in convenient packages that do more than basic stuff */
11365
11366    /* anchorview */
11367    /**
11368     * @defgroup Anchorview Anchorview
11369     *
11370     * @image html img/widget/anchorview/preview-00.png
11371     * @image latex img/widget/anchorview/preview-00.eps
11372     *
11373     * Anchorview is for displaying text that contains markup with anchors
11374     * like <c>\<a href=1234\>something\</\></c> in it.
11375     *
11376     * Besides being styled differently, the anchorview widget provides the
11377     * necessary functionality so that clicking on these anchors brings up a
11378     * popup with user defined content such as "call", "add to contacts" or
11379     * "open web page". This popup is provided using the @ref Hover widget.
11380     *
11381     * This widget is very similar to @ref Anchorblock, so refer to that
11382     * widget for an example. The only difference Anchorview has is that the
11383     * widget is already provided with scrolling functionality, so if the
11384     * text set to it is too large to fit in the given space, it will scroll,
11385     * whereas the @ref Anchorblock widget will keep growing to ensure all the
11386     * text can be displayed.
11387     *
11388     * This widget emits the following signals:
11389     * @li "anchor,clicked": will be called when an anchor is clicked. The
11390     * @p event_info parameter on the callback will be a pointer of type
11391     * ::Elm_Entry_Anchorview_Info.
11392     *
11393     * See @ref Anchorblock for an example on how to use both of them.
11394     *
11395     * @see Anchorblock
11396     * @see Entry
11397     * @see Hover
11398     *
11399     * @{
11400     */
11401    /**
11402     * @typedef Elm_Entry_Anchorview_Info
11403     *
11404     * The info sent in the callback for "anchor,clicked" signals emitted by
11405     * the Anchorview widget.
11406     */
11407    typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11408    /**
11409     * @struct _Elm_Entry_Anchorview_Info
11410     *
11411     * The info sent in the callback for "anchor,clicked" signals emitted by
11412     * the Anchorview widget.
11413     */
11414    struct _Elm_Entry_Anchorview_Info
11415      {
11416         const char     *name; /**< Name of the anchor, as indicated in its href
11417                                    attribute */
11418         int             button; /**< The mouse button used to click on it */
11419         Evas_Object    *hover; /**< The hover object to use for the popup */
11420         struct {
11421              Evas_Coord    x, y, w, h;
11422         } anchor, /**< Geometry selection of text used as anchor */
11423           hover_parent; /**< Geometry of the object used as parent by the
11424                              hover */
11425         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
11426                                              for content on the left side of
11427                                              the hover. Before calling the
11428                                              callback, the widget will make the
11429                                              necessary calculations to check
11430                                              which sides are fit to be set with
11431                                              content, based on the position the
11432                                              hover is activated and its distance
11433                                              to the edges of its parent object
11434                                              */
11435         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
11436                                               the right side of the hover.
11437                                               See @ref hover_left */
11438         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
11439                                             of the hover. See @ref hover_left */
11440         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
11441                                                below the hover. See @ref
11442                                                hover_left */
11443      };
11444    /**
11445     * Add a new Anchorview object
11446     *
11447     * @param parent The parent object
11448     * @return The new object or NULL if it cannot be created
11449     */
11450    EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11451    /**
11452     * Set the text to show in the anchorview
11453     *
11454     * Sets the text of the anchorview to @p text. This text can include markup
11455     * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11456     * text that will be specially styled and react to click events, ended with
11457     * either of \</a\> or \</\>. When clicked, the anchor will emit an
11458     * "anchor,clicked" signal that you can attach a callback to with
11459     * evas_object_smart_callback_add(). The name of the anchor given in the
11460     * event info struct will be the one set in the href attribute, in this
11461     * case, anchorname.
11462     *
11463     * Other markup can be used to style the text in different ways, but it's
11464     * up to the style defined in the theme which tags do what.
11465     * @deprecated use elm_object_text_set() instead.
11466     */
11467    EINA_DEPRECATED EAPI void         elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11468    /**
11469     * Get the markup text set for the anchorview
11470     *
11471     * Retrieves the text set on the anchorview, with markup tags included.
11472     *
11473     * @param obj The anchorview object
11474     * @return The markup text set or @c NULL if nothing was set or an error
11475     * occurred
11476     * @deprecated use elm_object_text_set() instead.
11477     */
11478    EINA_DEPRECATED EAPI const char  *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11479    /**
11480     * Set the parent of the hover popup
11481     *
11482     * Sets the parent object to use by the hover created by the anchorview
11483     * when an anchor is clicked. See @ref Hover for more details on this.
11484     * If no parent is set, the same anchorview object will be used.
11485     *
11486     * @param obj The anchorview object
11487     * @param parent The object to use as parent for the hover
11488     */
11489    EAPI void         elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11490    /**
11491     * Get the parent of the hover popup
11492     *
11493     * Get the object used as parent for the hover created by the anchorview
11494     * widget. See @ref Hover for more details on this.
11495     *
11496     * @param obj The anchorview object
11497     * @return The object used as parent for the hover, NULL if none is set.
11498     */
11499    EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11500    /**
11501     * Set the style that the hover should use
11502     *
11503     * When creating the popup hover, anchorview will request that it's
11504     * themed according to @p style.
11505     *
11506     * @param obj The anchorview object
11507     * @param style The style to use for the underlying hover
11508     *
11509     * @see elm_object_style_set()
11510     */
11511    EAPI void         elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11512    /**
11513     * Get the style that the hover should use
11514     *
11515     * Get the style the hover created by anchorview will use.
11516     *
11517     * @param obj The anchorview object
11518     * @return The style to use by the hover. NULL means the default is used.
11519     *
11520     * @see elm_object_style_set()
11521     */
11522    EAPI const char  *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11523    /**
11524     * Ends the hover popup in the anchorview
11525     *
11526     * When an anchor is clicked, the anchorview widget will create a hover
11527     * object to use as a popup with user provided content. This function
11528     * terminates this popup, returning the anchorview to its normal state.
11529     *
11530     * @param obj The anchorview object
11531     */
11532    EAPI void         elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11533    /**
11534     * Set bouncing behaviour when the scrolled content reaches an edge
11535     *
11536     * Tell the internal scroller object whether it should bounce or not
11537     * when it reaches the respective edges for each axis.
11538     *
11539     * @param obj The anchorview object
11540     * @param h_bounce Whether to bounce or not in the horizontal axis
11541     * @param v_bounce Whether to bounce or not in the vertical axis
11542     *
11543     * @see elm_scroller_bounce_set()
11544     */
11545    EAPI void         elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
11546    /**
11547     * Get the set bouncing behaviour of the internal scroller
11548     *
11549     * Get whether the internal scroller should bounce when the edge of each
11550     * axis is reached scrolling.
11551     *
11552     * @param obj The anchorview object
11553     * @param h_bounce Pointer where to store the bounce state of the horizontal
11554     *                 axis
11555     * @param v_bounce Pointer where to store the bounce state of the vertical
11556     *                 axis
11557     *
11558     * @see elm_scroller_bounce_get()
11559     */
11560    EAPI void         elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
11561    /**
11562     * Appends a custom item provider to the given anchorview
11563     *
11564     * Appends the given function to the list of items providers. This list is
11565     * called, one function at a time, with the given @p data pointer, the
11566     * anchorview object and, in the @p item parameter, the item name as
11567     * referenced in its href string. Following functions in the list will be
11568     * called in order until one of them returns something different to NULL,
11569     * which should be an Evas_Object which will be used in place of the item
11570     * element.
11571     *
11572     * Items in the markup text take the form \<item relsize=16x16 vsize=full
11573     * href=item/name\>\</item\>
11574     *
11575     * @param obj The anchorview object
11576     * @param func The function to add to the list of providers
11577     * @param data User data that will be passed to the callback function
11578     *
11579     * @see elm_entry_item_provider_append()
11580     */
11581    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);
11582    /**
11583     * Prepend a custom item provider to the given anchorview
11584     *
11585     * Like elm_anchorview_item_provider_append(), but it adds the function
11586     * @p func to the beginning of the list, instead of the end.
11587     *
11588     * @param obj The anchorview object
11589     * @param func The function to add to the list of providers
11590     * @param data User data that will be passed to the callback function
11591     */
11592    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);
11593    /**
11594     * Remove a custom item provider from the list of the given anchorview
11595     *
11596     * Removes the function and data pairing that matches @p func and @p data.
11597     * That is, unless the same function and same user data are given, the
11598     * function will not be removed from the list. This allows us to add the
11599     * same callback several times, with different @p data pointers and be
11600     * able to remove them later without conflicts.
11601     *
11602     * @param obj The anchorview object
11603     * @param func The function to remove from the list
11604     * @param data The data matching the function to remove from the list
11605     */
11606    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);
11607    /**
11608     * @}
11609     */
11610
11611    /* anchorblock */
11612    /**
11613     * @defgroup Anchorblock Anchorblock
11614     *
11615     * @image html img/widget/anchorblock/preview-00.png
11616     * @image latex img/widget/anchorblock/preview-00.eps
11617     *
11618     * Anchorblock is for displaying text that contains markup with anchors
11619     * like <c>\<a href=1234\>something\</\></c> in it.
11620     *
11621     * Besides being styled differently, the anchorblock widget provides the
11622     * necessary functionality so that clicking on these anchors brings up a
11623     * popup with user defined content such as "call", "add to contacts" or
11624     * "open web page". This popup is provided using the @ref Hover widget.
11625     *
11626     * This widget emits the following signals:
11627     * @li "anchor,clicked": will be called when an anchor is clicked. The
11628     * @p event_info parameter on the callback will be a pointer of type
11629     * ::Elm_Entry_Anchorblock_Info.
11630     *
11631     * @see Anchorview
11632     * @see Entry
11633     * @see Hover
11634     *
11635     * Since examples are usually better than plain words, we might as well
11636     * try @ref tutorial_anchorblock_example "one".
11637     */
11638    /**
11639     * @addtogroup Anchorblock
11640     * @{
11641     */
11642    /**
11643     * @typedef Elm_Entry_Anchorblock_Info
11644     *
11645     * The info sent in the callback for "anchor,clicked" signals emitted by
11646     * the Anchorblock widget.
11647     */
11648    typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
11649    /**
11650     * @struct _Elm_Entry_Anchorblock_Info
11651     *
11652     * The info sent in the callback for "anchor,clicked" signals emitted by
11653     * the Anchorblock widget.
11654     */
11655    struct _Elm_Entry_Anchorblock_Info
11656      {
11657         const char     *name; /**< Name of the anchor, as indicated in its href
11658                                    attribute */
11659         int             button; /**< The mouse button used to click on it */
11660         Evas_Object    *hover; /**< The hover object to use for the popup */
11661         struct {
11662              Evas_Coord    x, y, w, h;
11663         } anchor, /**< Geometry selection of text used as anchor */
11664           hover_parent; /**< Geometry of the object used as parent by the
11665                              hover */
11666         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
11667                                              for content on the left side of
11668                                              the hover. Before calling the
11669                                              callback, the widget will make the
11670                                              necessary calculations to check
11671                                              which sides are fit to be set with
11672                                              content, based on the position the
11673                                              hover is activated and its distance
11674                                              to the edges of its parent object
11675                                              */
11676         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
11677                                               the right side of the hover.
11678                                               See @ref hover_left */
11679         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
11680                                             of the hover. See @ref hover_left */
11681         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
11682                                                below the hover. See @ref
11683                                                hover_left */
11684      };
11685    /**
11686     * Add a new Anchorblock object
11687     *
11688     * @param parent The parent object
11689     * @return The new object or NULL if it cannot be created
11690     */
11691    EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11692    /**
11693     * Set the text to show in the anchorblock
11694     *
11695     * Sets the text of the anchorblock to @p text. This text can include markup
11696     * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
11697     * of text that will be specially styled and react to click events, ended
11698     * with either of \</a\> or \</\>. When clicked, the anchor will emit an
11699     * "anchor,clicked" signal that you can attach a callback to with
11700     * evas_object_smart_callback_add(). The name of the anchor given in the
11701     * event info struct will be the one set in the href attribute, in this
11702     * case, anchorname.
11703     *
11704     * Other markup can be used to style the text in different ways, but it's
11705     * up to the style defined in the theme which tags do what.
11706     * @deprecated use elm_object_text_set() instead.
11707     */
11708    EINA_DEPRECATED EAPI void         elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11709    /**
11710     * Get the markup text set for the anchorblock
11711     *
11712     * Retrieves the text set on the anchorblock, with markup tags included.
11713     *
11714     * @param obj The anchorblock object
11715     * @return The markup text set or @c NULL if nothing was set or an error
11716     * occurred
11717     * @deprecated use elm_object_text_set() instead.
11718     */
11719    EINA_DEPRECATED EAPI const char  *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11720    /**
11721     * Set the parent of the hover popup
11722     *
11723     * Sets the parent object to use by the hover created by the anchorblock
11724     * when an anchor is clicked. See @ref Hover for more details on this.
11725     *
11726     * @param obj The anchorblock object
11727     * @param parent The object to use as parent for the hover
11728     */
11729    EAPI void         elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11730    /**
11731     * Get the parent of the hover popup
11732     *
11733     * Get the object used as parent for the hover created by the anchorblock
11734     * widget. See @ref Hover for more details on this.
11735     * If no parent is set, the same anchorblock object will be used.
11736     *
11737     * @param obj The anchorblock object
11738     * @return The object used as parent for the hover, NULL if none is set.
11739     */
11740    EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11741    /**
11742     * Set the style that the hover should use
11743     *
11744     * When creating the popup hover, anchorblock will request that it's
11745     * themed according to @p style.
11746     *
11747     * @param obj The anchorblock object
11748     * @param style The style to use for the underlying hover
11749     *
11750     * @see elm_object_style_set()
11751     */
11752    EAPI void         elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11753    /**
11754     * Get the style that the hover should use
11755     *
11756     * Get the style the hover created by anchorblock will use.
11757     *
11758     * @param obj The anchorblock object
11759     * @return The style to use by the hover. NULL means the default is used.
11760     *
11761     * @see elm_object_style_set()
11762     */
11763    EAPI const char  *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11764    /**
11765     * Ends the hover popup in the anchorblock
11766     *
11767     * When an anchor is clicked, the anchorblock widget will create a hover
11768     * object to use as a popup with user provided content. This function
11769     * terminates this popup, returning the anchorblock to its normal state.
11770     *
11771     * @param obj The anchorblock object
11772     */
11773    EAPI void         elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11774    /**
11775     * Appends a custom item provider to the given anchorblock
11776     *
11777     * Appends the given function to the list of items providers. This list is
11778     * called, one function at a time, with the given @p data pointer, the
11779     * anchorblock object and, in the @p item parameter, the item name as
11780     * referenced in its href string. Following functions in the list will be
11781     * called in order until one of them returns something different to NULL,
11782     * which should be an Evas_Object which will be used in place of the item
11783     * element.
11784     *
11785     * Items in the markup text take the form \<item relsize=16x16 vsize=full
11786     * href=item/name\>\</item\>
11787     *
11788     * @param obj The anchorblock object
11789     * @param func The function to add to the list of providers
11790     * @param data User data that will be passed to the callback function
11791     *
11792     * @see elm_entry_item_provider_append()
11793     */
11794    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);
11795    /**
11796     * Prepend a custom item provider to the given anchorblock
11797     *
11798     * Like elm_anchorblock_item_provider_append(), but it adds the function
11799     * @p func to the beginning of the list, instead of the end.
11800     *
11801     * @param obj The anchorblock object
11802     * @param func The function to add to the list of providers
11803     * @param data User data that will be passed to the callback function
11804     */
11805    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);
11806    /**
11807     * Remove a custom item provider from the list of the given anchorblock
11808     *
11809     * Removes the function and data pairing that matches @p func and @p data.
11810     * That is, unless the same function and same user data are given, the
11811     * function will not be removed from the list. This allows us to add the
11812     * same callback several times, with different @p data pointers and be
11813     * able to remove them later without conflicts.
11814     *
11815     * @param obj The anchorblock object
11816     * @param func The function to remove from the list
11817     * @param data The data matching the function to remove from the list
11818     */
11819    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);
11820    /**
11821     * @}
11822     */
11823
11824    /**
11825     * @defgroup Bubble Bubble
11826     *
11827     * @image html img/widget/bubble/preview-00.png
11828     * @image latex img/widget/bubble/preview-00.eps
11829     * @image html img/widget/bubble/preview-01.png
11830     * @image latex img/widget/bubble/preview-01.eps
11831     * @image html img/widget/bubble/preview-02.png
11832     * @image latex img/widget/bubble/preview-02.eps
11833     *
11834     * @brief The Bubble is a widget to show text similarly to how speech is
11835     * represented in comics.
11836     *
11837     * The bubble widget contains 5 important visual elements:
11838     * @li The frame is a rectangle with rounded rectangles and an "arrow".
11839     * @li The @p icon is an image to which the frame's arrow points to.
11840     * @li The @p label is a text which appears to the right of the icon if the
11841     * corner is "top_left" or "bottom_left" and is right aligned to the frame
11842     * otherwise.
11843     * @li The @p info is a text which appears to the right of the label. Info's
11844     * font is of a ligther color than label.
11845     * @li The @p content is an evas object that is shown inside the frame.
11846     *
11847     * The position of the arrow, icon, label and info depends on which corner is
11848     * selected. The four available corners are:
11849     * @li "top_left" - Default
11850     * @li "top_right"
11851     * @li "bottom_left"
11852     * @li "bottom_right"
11853     *
11854     * Signals that you can add callbacks for are:
11855     * @li "clicked" - This is called when a user has clicked the bubble.
11856     *
11857     * For an example of using a buble see @ref bubble_01_example_page "this".
11858     *
11859     * @{
11860     */
11861    /**
11862     * Add a new bubble to the parent
11863     *
11864     * @param parent The parent object
11865     * @return The new object or NULL if it cannot be created
11866     *
11867     * This function adds a text bubble to the given parent evas object.
11868     */
11869    EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11870    /**
11871     * Set the label of the bubble
11872     *
11873     * @param obj The bubble object
11874     * @param label The string to set in the label
11875     *
11876     * This function sets the title of the bubble. Where this appears depends on
11877     * the selected corner.
11878     * @deprecated use elm_object_text_set() instead.
11879     */
11880    EINA_DEPRECATED EAPI void         elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
11881    /**
11882     * Get the label of the bubble
11883     *
11884     * @param obj The bubble object
11885     * @return The string of set in the label
11886     *
11887     * This function gets the title of the bubble.
11888     * @deprecated use elm_object_text_get() instead.
11889     */
11890    EINA_DEPRECATED EAPI const char  *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11891    /**
11892     * Set the info of the bubble
11893     *
11894     * @param obj The bubble object
11895     * @param info The given info about the bubble
11896     *
11897     * This function sets the info of the bubble. Where this appears depends on
11898     * the selected corner.
11899     * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
11900     */
11901    EINA_DEPRECATED EAPI void         elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
11902    /**
11903     * Get the info of the bubble
11904     *
11905     * @param obj The bubble object
11906     *
11907     * @return The "info" string of the bubble
11908     *
11909     * This function gets the info text.
11910     * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
11911     */
11912    EINA_DEPRECATED EAPI const char  *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11913    /**
11914     * Set the content to be shown in the bubble
11915     *
11916     * Once the content object is set, a previously set one will be deleted.
11917     * If you want to keep the old content object, use the
11918     * elm_bubble_content_unset() function.
11919     *
11920     * @param obj The bubble object
11921     * @param content The given content of the bubble
11922     *
11923     * This function sets the content shown on the middle of the bubble.
11924     */
11925    EAPI void         elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
11926    /**
11927     * Get the content shown in the bubble
11928     *
11929     * Return the content object which is set for this widget.
11930     *
11931     * @param obj The bubble object
11932     * @return The content that is being used
11933     */
11934    EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11935    /**
11936     * Unset the content shown in the bubble
11937     *
11938     * Unparent and return the content object which was set for this widget.
11939     *
11940     * @param obj The bubble object
11941     * @return The content that was being used
11942     */
11943    EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11944    /**
11945     * Set the icon of the bubble
11946     *
11947     * Once the icon object is set, a previously set one will be deleted.
11948     * If you want to keep the old content object, use the
11949     * elm_icon_content_unset() function.
11950     *
11951     * @param obj The bubble object
11952     * @param icon The given icon for the bubble
11953     */
11954    EAPI void         elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
11955    /**
11956     * Get the icon of the bubble
11957     *
11958     * @param obj The bubble object
11959     * @return The icon for the bubble
11960     *
11961     * This function gets the icon shown on the top left of bubble.
11962     */
11963    EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11964    /**
11965     * Unset the icon of the bubble
11966     *
11967     * Unparent and return the icon object which was set for this widget.
11968     *
11969     * @param obj The bubble object
11970     * @return The icon that was being used
11971     */
11972    EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11973    /**
11974     * Set the corner of the bubble
11975     *
11976     * @param obj The bubble object.
11977     * @param corner The given corner for the bubble.
11978     *
11979     * This function sets the corner of the bubble. The corner will be used to
11980     * determine where the arrow in the frame points to and where label, icon and
11981     * info arre shown.
11982     *
11983     * Possible values for corner are:
11984     * @li "top_left" - Default
11985     * @li "top_right"
11986     * @li "bottom_left"
11987     * @li "bottom_right"
11988     */
11989    EAPI void         elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
11990    /**
11991     * Get the corner of the bubble
11992     *
11993     * @param obj The bubble object.
11994     * @return The given corner for the bubble.
11995     *
11996     * This function gets the selected corner of the bubble.
11997     */
11998    EAPI const char  *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11999    /**
12000     * @}
12001     */
12002
12003    /**
12004     * @defgroup Photo Photo
12005     *
12006     * For displaying the photo of a person (contact). Simple yet
12007     * with a very specific purpose.
12008     *
12009     * Signals that you can add callbacks for are:
12010     *
12011     * "clicked" - This is called when a user has clicked the photo
12012     * "drag,start" - Someone started dragging the image out of the object
12013     * "drag,end" - Dragged item was dropped (somewhere)
12014     *
12015     * @{
12016     */
12017
12018    /**
12019     * Add a new photo to the parent
12020     *
12021     * @param parent The parent object
12022     * @return The new object or NULL if it cannot be created
12023     *
12024     * @ingroup Photo
12025     */
12026    EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12027
12028    /**
12029     * Set the file that will be used as photo
12030     *
12031     * @param obj The photo object
12032     * @param file The path to file that will be used as photo
12033     *
12034     * @return (1 = success, 0 = error)
12035     *
12036     * @ingroup Photo
12037     */
12038    EAPI Eina_Bool    elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12039
12040    /**
12041     * Set the size that will be used on the photo
12042     *
12043     * @param obj The photo object
12044     * @param size The size that the photo will be
12045     *
12046     * @ingroup Photo
12047     */
12048    EAPI void         elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12049
12050    /**
12051     * Set if the photo should be completely visible or not.
12052     *
12053     * @param obj The photo object
12054     * @param fill if true the photo will be completely visible
12055     *
12056     * @ingroup Photo
12057     */
12058    EAPI void         elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12059
12060    /**
12061     * Set editability of the photo.
12062     *
12063     * An editable photo can be dragged to or from, and can be cut or
12064     * pasted too.  Note that pasting an image or dropping an item on
12065     * the image will delete the existing content.
12066     *
12067     * @param obj The photo object.
12068     * @param set To set of clear editablity.
12069     */
12070    EAPI void         elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12071
12072    /**
12073     * @}
12074     */
12075
12076    /* gesture layer */
12077    /**
12078     * @defgroup Elm_Gesture_Layer Gesture Layer
12079     * Gesture Layer Usage:
12080     *
12081     * Use Gesture Layer to detect gestures.
12082     * The advantage is that you don't have to implement
12083     * gesture detection, just set callbacks of gesture state.
12084     * By using gesture layer we make standard interface.
12085     *
12086     * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12087     * with a parent object parameter.
12088     * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12089     * call. Usually with same object as target (2nd parameter).
12090     *
12091     * Now you need to tell gesture layer what gestures you follow.
12092     * This is done with @ref elm_gesture_layer_cb_set call.
12093     * By setting the callback you actually saying to gesture layer:
12094     * I would like to know when the gesture @ref Elm_Gesture_Types
12095     * switches to state @ref Elm_Gesture_State.
12096     *
12097     * Next, you need to implement the actual action that follows the input
12098     * in your callback.
12099     *
12100     * Note that if you like to stop being reported about a gesture, just set
12101     * all callbacks referring this gesture to NULL.
12102     * (again with @ref elm_gesture_layer_cb_set)
12103     *
12104     * The information reported by gesture layer to your callback is depending
12105     * on @ref Elm_Gesture_Types:
12106     * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12107     * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12108     * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12109     *
12110     * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12111     * @ref ELM_GESTURE_MOMENTUM.
12112     *
12113     * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12114     * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12115     * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12116     * Note that we consider a flick as a line-gesture that should be completed
12117     * in flick-time-limit as defined in @ref Config.
12118     *
12119     * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12120     *
12121     * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12122     * */
12123
12124    /**
12125     * @enum _Elm_Gesture_Types
12126     * Enum of supported gesture types.
12127     * @ingroup Elm_Gesture_Layer
12128     */
12129    enum _Elm_Gesture_Types
12130      {
12131         ELM_GESTURE_FIRST = 0,
12132
12133         ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12134         ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12135         ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12136         ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12137
12138         ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12139
12140         ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12141         ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12142
12143         ELM_GESTURE_ZOOM, /**< Zoom */
12144         ELM_GESTURE_ROTATE, /**< Rotate */
12145
12146         ELM_GESTURE_LAST
12147      };
12148
12149    /**
12150     * @typedef Elm_Gesture_Types
12151     * gesture types enum
12152     * @ingroup Elm_Gesture_Layer
12153     */
12154    typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12155
12156    /**
12157     * @enum _Elm_Gesture_State
12158     * Enum of gesture states.
12159     * @ingroup Elm_Gesture_Layer
12160     */
12161    enum _Elm_Gesture_State
12162      {
12163         ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12164         ELM_GESTURE_STATE_START,          /**< Gesture STARTed     */
12165         ELM_GESTURE_STATE_MOVE,           /**< Gesture is ongoing  */
12166         ELM_GESTURE_STATE_END,            /**< Gesture completed   */
12167         ELM_GESTURE_STATE_ABORT    /**< Onging gesture was ABORTed */
12168      };
12169
12170    /**
12171     * @typedef Elm_Gesture_State
12172     * gesture states enum
12173     * @ingroup Elm_Gesture_Layer
12174     */
12175    typedef enum _Elm_Gesture_State Elm_Gesture_State;
12176
12177    /**
12178     * @struct _Elm_Gesture_Taps_Info
12179     * Struct holds taps info for user
12180     * @ingroup Elm_Gesture_Layer
12181     */
12182    struct _Elm_Gesture_Taps_Info
12183      {
12184         Evas_Coord x, y;         /**< Holds center point between fingers */
12185         unsigned int n;          /**< Number of fingers tapped           */
12186         unsigned int timestamp;  /**< event timestamp       */
12187      };
12188
12189    /**
12190     * @typedef Elm_Gesture_Taps_Info
12191     * holds taps info for user
12192     * @ingroup Elm_Gesture_Layer
12193     */
12194    typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12195
12196    /**
12197     * @struct _Elm_Gesture_Momentum_Info
12198     * Struct holds momentum info for user
12199     * x1 and y1 are not necessarily in sync
12200     * x1 holds x value of x direction starting point
12201     * and same holds for y1.
12202     * This is noticeable when doing V-shape movement
12203     * @ingroup Elm_Gesture_Layer
12204     */
12205    struct _Elm_Gesture_Momentum_Info
12206      {  /* Report line ends, timestamps, and momentum computed        */
12207         Evas_Coord x1; /**< Final-swipe direction starting point on X */
12208         Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12209         Evas_Coord x2; /**< Final-swipe direction ending point on X   */
12210         Evas_Coord y2; /**< Final-swipe direction ending point on Y   */
12211
12212         unsigned int tx; /**< Timestamp of start of final x-swipe */
12213         unsigned int ty; /**< Timestamp of start of final y-swipe */
12214
12215         Evas_Coord mx; /**< Momentum on X */
12216         Evas_Coord my; /**< Momentum on Y */
12217      };
12218
12219    /**
12220     * @typedef Elm_Gesture_Momentum_Info
12221     * holds momentum info for user
12222     * @ingroup Elm_Gesture_Layer
12223     */
12224     typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12225
12226    /**
12227     * @struct _Elm_Gesture_Line_Info
12228     * Struct holds line info for user
12229     * @ingroup Elm_Gesture_Layer
12230     */
12231    struct _Elm_Gesture_Line_Info
12232      {  /* Report line ends, timestamps, and momentum computed      */
12233         Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12234         unsigned int n;            /**< Number of fingers (lines)   */
12235         /* FIXME should be radians, bot degrees */
12236         double angle;              /**< Angle (direction) of lines  */
12237      };
12238
12239    /**
12240     * @typedef Elm_Gesture_Line_Info
12241     * Holds line info for user
12242     * @ingroup Elm_Gesture_Layer
12243     */
12244     typedef struct  _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12245
12246    /**
12247     * @struct _Elm_Gesture_Zoom_Info
12248     * Struct holds zoom info for user
12249     * @ingroup Elm_Gesture_Layer
12250     */
12251    struct _Elm_Gesture_Zoom_Info
12252      {
12253         Evas_Coord x, y;       /**< Holds zoom center point reported to user  */
12254         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12255         double zoom;            /**< Zoom value: 1.0 means no zoom             */
12256         double momentum;        /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12257      };
12258
12259    /**
12260     * @typedef Elm_Gesture_Zoom_Info
12261     * Holds zoom info for user
12262     * @ingroup Elm_Gesture_Layer
12263     */
12264    typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12265
12266    /**
12267     * @struct _Elm_Gesture_Rotate_Info
12268     * Struct holds rotation info for user
12269     * @ingroup Elm_Gesture_Layer
12270     */
12271    struct _Elm_Gesture_Rotate_Info
12272      {
12273         Evas_Coord x, y;   /**< Holds zoom center point reported to user      */
12274         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12275         double base_angle; /**< Holds start-angle */
12276         double angle;      /**< Rotation value: 0.0 means no rotation         */
12277         double momentum;   /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12278      };
12279
12280    /**
12281     * @typedef Elm_Gesture_Rotate_Info
12282     * Holds rotation info for user
12283     * @ingroup Elm_Gesture_Layer
12284     */
12285    typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12286
12287    /**
12288     * @typedef Elm_Gesture_Event_Cb
12289     * User callback used to stream gesture info from gesture layer
12290     * @param data user data
12291     * @param event_info gesture report info
12292     * Returns a flag field to be applied on the causing event.
12293     * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12294     * upon the event, in an irreversible way.
12295     *
12296     * @ingroup Elm_Gesture_Layer
12297     */
12298    typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12299
12300    /**
12301     * Use function to set callbacks to be notified about
12302     * change of state of gesture.
12303     * When a user registers a callback with this function
12304     * this means this gesture has to be tested.
12305     *
12306     * When ALL callbacks for a gesture are set to NULL
12307     * it means user isn't interested in gesture-state
12308     * and it will not be tested.
12309     *
12310     * @param obj Pointer to gesture-layer.
12311     * @param idx The gesture you would like to track its state.
12312     * @param cb callback function pointer.
12313     * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12314     * @param data user info to be sent to callback (usually, Smart Data)
12315     *
12316     * @ingroup Elm_Gesture_Layer
12317     */
12318    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);
12319
12320    /**
12321     * Call this function to get repeat-events settings.
12322     *
12323     * @param obj Pointer to gesture-layer.
12324     *
12325     * @return repeat events settings.
12326     * @see elm_gesture_layer_hold_events_set()
12327     * @ingroup Elm_Gesture_Layer
12328     */
12329    EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12330
12331    /**
12332     * This function called in order to make gesture-layer repeat events.
12333     * Set this of you like to get the raw events only if gestures were not detected.
12334     * Clear this if you like gesture layer to fwd events as testing gestures.
12335     *
12336     * @param obj Pointer to gesture-layer.
12337     * @param r Repeat: TRUE/FALSE
12338     *
12339     * @ingroup Elm_Gesture_Layer
12340     */
12341    EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12342
12343    /**
12344     * This function sets step-value for zoom action.
12345     * Set step to any positive value.
12346     * Cancel step setting by setting to 0.0
12347     *
12348     * @param obj Pointer to gesture-layer.
12349     * @param s new zoom step value.
12350     *
12351     * @ingroup Elm_Gesture_Layer
12352     */
12353    EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12354
12355    /**
12356     * This function sets step-value for rotate action.
12357     * Set step to any positive value.
12358     * Cancel step setting by setting to 0.0
12359     *
12360     * @param obj Pointer to gesture-layer.
12361     * @param s new roatate step value.
12362     *
12363     * @ingroup Elm_Gesture_Layer
12364     */
12365    EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12366
12367    /**
12368     * This function called to attach gesture-layer to an Evas_Object.
12369     * @param obj Pointer to gesture-layer.
12370     * @param t Pointer to underlying object (AKA Target)
12371     *
12372     * @return TRUE, FALSE on success, failure.
12373     *
12374     * @ingroup Elm_Gesture_Layer
12375     */
12376    EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12377
12378    /**
12379     * Call this function to construct a new gesture-layer object.
12380     * This does not activate the gesture layer. You have to
12381     * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12382     *
12383     * @param parent the parent object.
12384     *
12385     * @return Pointer to new gesture-layer object.
12386     *
12387     * @ingroup Elm_Gesture_Layer
12388     */
12389    EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12390
12391    /**
12392     * @defgroup Thumb Thumb
12393     *
12394     * @image html img/widget/thumb/preview-00.png
12395     * @image latex img/widget/thumb/preview-00.eps
12396     *
12397     * A thumb object is used for displaying the thumbnail of an image or video.
12398     * You must have compiled Elementary with Ethumb_Client support and the DBus
12399     * service must be present and auto-activated in order to have thumbnails to
12400     * be generated.
12401     *
12402     * Once the thumbnail object becomes visible, it will check if there is a
12403     * previously generated thumbnail image for the file set on it. If not, it
12404     * will start generating this thumbnail.
12405     *
12406     * Different config settings will cause different thumbnails to be generated
12407     * even on the same file.
12408     *
12409     * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12410     * Ethumb documentation to change this path, and to see other configuration
12411     * options.
12412     *
12413     * Signals that you can add callbacks for are:
12414     *
12415     * - "clicked" - This is called when a user has clicked the thumb without dragging
12416     *             around.
12417     * - "clicked,double" - This is called when a user has double-clicked the thumb.
12418     * - "press" - This is called when a user has pressed down the thumb.
12419     * - "generate,start" - The thumbnail generation started.
12420     * - "generate,stop" - The generation process stopped.
12421     * - "generate,error" - The generation failed.
12422     * - "load,error" - The thumbnail image loading failed.
12423     *
12424     * available styles:
12425     * - default
12426     * - noframe
12427     *
12428     * An example of use of thumbnail:
12429     *
12430     * - @ref thumb_example_01
12431     */
12432
12433    /**
12434     * @addtogroup Thumb
12435     * @{
12436     */
12437
12438    /**
12439     * @enum _Elm_Thumb_Animation_Setting
12440     * @typedef Elm_Thumb_Animation_Setting
12441     *
12442     * Used to set if a video thumbnail is animating or not.
12443     *
12444     * @ingroup Thumb
12445     */
12446    typedef enum _Elm_Thumb_Animation_Setting
12447      {
12448         ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12449         ELM_THUMB_ANIMATION_LOOP,      /**< Keep playing animation until stop is requested */
12450         ELM_THUMB_ANIMATION_STOP,      /**< Stop playing the animation */
12451         ELM_THUMB_ANIMATION_LAST
12452      } Elm_Thumb_Animation_Setting;
12453
12454    /**
12455     * Add a new thumb object to the parent.
12456     *
12457     * @param parent The parent object.
12458     * @return The new object or NULL if it cannot be created.
12459     *
12460     * @see elm_thumb_file_set()
12461     * @see elm_thumb_ethumb_client_get()
12462     *
12463     * @ingroup Thumb
12464     */
12465    EAPI Evas_Object                 *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12466    /**
12467     * Reload thumbnail if it was generated before.
12468     *
12469     * @param obj The thumb object to reload
12470     *
12471     * This is useful if the ethumb client configuration changed, like its
12472     * size, aspect or any other property one set in the handle returned
12473     * by elm_thumb_ethumb_client_get().
12474     *
12475     * If the options didn't change, the thumbnail won't be generated again, but
12476     * the old one will still be used.
12477     *
12478     * @see elm_thumb_file_set()
12479     *
12480     * @ingroup Thumb
12481     */
12482    EAPI void                         elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
12483    /**
12484     * Set the file that will be used as thumbnail.
12485     *
12486     * @param obj The thumb object.
12487     * @param file The path to file that will be used as thumb.
12488     * @param key The key used in case of an EET file.
12489     *
12490     * The file can be an image or a video (in that case, acceptable extensions are:
12491     * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
12492     * function elm_thumb_animate().
12493     *
12494     * @see elm_thumb_file_get()
12495     * @see elm_thumb_reload()
12496     * @see elm_thumb_animate()
12497     *
12498     * @ingroup Thumb
12499     */
12500    EAPI void                         elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
12501    /**
12502     * Get the image or video path and key used to generate the thumbnail.
12503     *
12504     * @param obj The thumb object.
12505     * @param file Pointer to filename.
12506     * @param key Pointer to key.
12507     *
12508     * @see elm_thumb_file_set()
12509     * @see elm_thumb_path_get()
12510     *
12511     * @ingroup Thumb
12512     */
12513    EAPI void                         elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12514    /**
12515     * Get the path and key to the image or video generated by ethumb.
12516     *
12517     * One just need to make sure that the thumbnail was generated before getting
12518     * its path; otherwise, the path will be NULL. One way to do that is by asking
12519     * for the path when/after the "generate,stop" smart callback is called.
12520     *
12521     * @param obj The thumb object.
12522     * @param file Pointer to thumb path.
12523     * @param key Pointer to thumb key.
12524     *
12525     * @see elm_thumb_file_get()
12526     *
12527     * @ingroup Thumb
12528     */
12529    EAPI void                         elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12530    /**
12531     * Set the animation state for the thumb object. If its content is an animated
12532     * video, you may start/stop the animation or tell it to play continuously and
12533     * looping.
12534     *
12535     * @param obj The thumb object.
12536     * @param setting The animation setting.
12537     *
12538     * @see elm_thumb_file_set()
12539     *
12540     * @ingroup Thumb
12541     */
12542    EAPI void                         elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
12543    /**
12544     * Get the animation state for the thumb object.
12545     *
12546     * @param obj The thumb object.
12547     * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
12548     * on errors.
12549     *
12550     * @see elm_thumb_animate_set()
12551     *
12552     * @ingroup Thumb
12553     */
12554    EAPI Elm_Thumb_Animation_Setting  elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12555    /**
12556     * Get the ethumb_client handle so custom configuration can be made.
12557     *
12558     * @return Ethumb_Client instance or NULL.
12559     *
12560     * This must be called before the objects are created to be sure no object is
12561     * visible and no generation started.
12562     *
12563     * Example of usage:
12564     *
12565     * @code
12566     * #include <Elementary.h>
12567     * #ifndef ELM_LIB_QUICKLAUNCH
12568     * EAPI_MAIN int
12569     * elm_main(int argc, char **argv)
12570     * {
12571     *    Ethumb_Client *client;
12572     *
12573     *    elm_need_ethumb();
12574     *
12575     *    // ... your code
12576     *
12577     *    client = elm_thumb_ethumb_client_get();
12578     *    if (!client)
12579     *      {
12580     *         ERR("could not get ethumb_client");
12581     *         return 1;
12582     *      }
12583     *    ethumb_client_size_set(client, 100, 100);
12584     *    ethumb_client_crop_align_set(client, 0.5, 0.5);
12585     *    // ... your code
12586     *
12587     *    // Create elm_thumb objects here
12588     *
12589     *    elm_run();
12590     *    elm_shutdown();
12591     *    return 0;
12592     * }
12593     * #endif
12594     * ELM_MAIN()
12595     * @endcode
12596     *
12597     * @note There's only one client handle for Ethumb, so once a configuration
12598     * change is done to it, any other request for thumbnails (for any thumbnail
12599     * object) will use that configuration. Thus, this configuration is global.
12600     *
12601     * @ingroup Thumb
12602     */
12603    EAPI void                        *elm_thumb_ethumb_client_get(void);
12604    /**
12605     * Get the ethumb_client connection state.
12606     *
12607     * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
12608     * otherwise.
12609     */
12610    EAPI Eina_Bool                    elm_thumb_ethumb_client_connected(void);
12611    /**
12612     * Make the thumbnail 'editable'.
12613     *
12614     * @param obj Thumb object.
12615     * @param set Turn on or off editability. Default is @c EINA_FALSE.
12616     *
12617     * This means the thumbnail is a valid drag target for drag and drop, and can be
12618     * cut or pasted too.
12619     *
12620     * @see elm_thumb_editable_get()
12621     *
12622     * @ingroup Thumb
12623     */
12624    EAPI Eina_Bool                    elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
12625    /**
12626     * Make the thumbnail 'editable'.
12627     *
12628     * @param obj Thumb object.
12629     * @return Editability.
12630     *
12631     * This means the thumbnail is a valid drag target for drag and drop, and can be
12632     * cut or pasted too.
12633     *
12634     * @see elm_thumb_editable_set()
12635     *
12636     * @ingroup Thumb
12637     */
12638    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12639
12640    /**
12641     * @}
12642     */
12643
12644    /**
12645     * @defgroup Hoversel Hoversel
12646     *
12647     * @image html img/widget/hoversel/preview-00.png
12648     * @image latex img/widget/hoversel/preview-00.eps
12649     *
12650     * A hoversel is a button that pops up a list of items (automatically
12651     * choosing the direction to display) that have a label and, optionally, an
12652     * icon to select from. It is a convenience widget to avoid the need to do
12653     * all the piecing together yourself. It is intended for a small number of
12654     * items in the hoversel menu (no more than 8), though is capable of many
12655     * more.
12656     *
12657     * Signals that you can add callbacks for are:
12658     * "clicked" - the user clicked the hoversel button and popped up the sel
12659     * "selected" - an item in the hoversel list is selected. event_info is the item
12660     * "dismissed" - the hover is dismissed
12661     *
12662     * See @ref tutorial_hoversel for an example.
12663     * @{
12664     */
12665    typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
12666    /**
12667     * @brief Add a new Hoversel object
12668     *
12669     * @param parent The parent object
12670     * @return The new object or NULL if it cannot be created
12671     */
12672    EAPI Evas_Object       *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12673    /**
12674     * @brief This sets the hoversel to expand horizontally.
12675     *
12676     * @param obj The hoversel object
12677     * @param horizontal If true, the hover will expand horizontally to the
12678     * right.
12679     *
12680     * @note The initial button will display horizontally regardless of this
12681     * setting.
12682     */
12683    EAPI void               elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
12684    /**
12685     * @brief This returns whether the hoversel is set to expand horizontally.
12686     *
12687     * @param obj The hoversel object
12688     * @return If true, the hover will expand horizontally to the right.
12689     *
12690     * @see elm_hoversel_horizontal_set()
12691     */
12692    EAPI Eina_Bool          elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12693    /**
12694     * @brief Set the Hover parent
12695     *
12696     * @param obj The hoversel object
12697     * @param parent The parent to use
12698     *
12699     * Sets the hover parent object, the area that will be darkened when the
12700     * hoversel is clicked. Should probably be the window that the hoversel is
12701     * in. See @ref Hover objects for more information.
12702     */
12703    EAPI void               elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12704    /**
12705     * @brief Get the Hover parent
12706     *
12707     * @param obj The hoversel object
12708     * @return The used parent
12709     *
12710     * Gets the hover parent object.
12711     *
12712     * @see elm_hoversel_hover_parent_set()
12713     */
12714    EAPI Evas_Object       *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12715    /**
12716     * @brief Set the hoversel button label
12717     *
12718     * @param obj The hoversel object
12719     * @param label The label text.
12720     *
12721     * This sets the label of the button that is always visible (before it is
12722     * clicked and expanded).
12723     *
12724     * @deprecated elm_object_text_set()
12725     */
12726    EINA_DEPRECATED EAPI void               elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12727    /**
12728     * @brief Get the hoversel button label
12729     *
12730     * @param obj The hoversel object
12731     * @return The label text.
12732     *
12733     * @deprecated elm_object_text_get()
12734     */
12735    EINA_DEPRECATED EAPI const char        *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12736    /**
12737     * @brief Set the icon of the hoversel button
12738     *
12739     * @param obj The hoversel object
12740     * @param icon The icon object
12741     *
12742     * Sets the icon of the button that is always visible (before it is clicked
12743     * and expanded).  Once the icon object is set, a previously set one will be
12744     * deleted, if you want to keep that old content object, use the
12745     * elm_hoversel_icon_unset() function.
12746     *
12747     * @see elm_button_icon_set()
12748     */
12749    EAPI void               elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12750    /**
12751     * @brief Get the icon of the hoversel button
12752     *
12753     * @param obj The hoversel object
12754     * @return The icon object
12755     *
12756     * Get the icon of the button that is always visible (before it is clicked
12757     * and expanded). Also see elm_button_icon_get().
12758     *
12759     * @see elm_hoversel_icon_set()
12760     */
12761    EAPI Evas_Object       *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12762    /**
12763     * @brief Get and unparent the icon of the hoversel button
12764     *
12765     * @param obj The hoversel object
12766     * @return The icon object that was being used
12767     *
12768     * Unparent and return the icon of the button that is always visible
12769     * (before it is clicked and expanded).
12770     *
12771     * @see elm_hoversel_icon_set()
12772     * @see elm_button_icon_unset()
12773     */
12774    EAPI Evas_Object       *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12775    /**
12776     * @brief This triggers the hoversel popup from code, the same as if the user
12777     * had clicked the button.
12778     *
12779     * @param obj The hoversel object
12780     */
12781    EAPI void               elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
12782    /**
12783     * @brief This dismisses the hoversel popup as if the user had clicked
12784     * outside the hover.
12785     *
12786     * @param obj The hoversel object
12787     */
12788    EAPI void               elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12789    /**
12790     * @brief Returns whether the hoversel is expanded.
12791     *
12792     * @param obj The hoversel object
12793     * @return  This will return EINA_TRUE if the hoversel is expanded or
12794     * EINA_FALSE if it is not expanded.
12795     */
12796    EAPI Eina_Bool          elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12797    /**
12798     * @brief This will remove all the children items from the hoversel.
12799     *
12800     * @param obj The hoversel object
12801     *
12802     * @warning Should @b not be called while the hoversel is active; use
12803     * elm_hoversel_expanded_get() to check first.
12804     *
12805     * @see elm_hoversel_item_del_cb_set()
12806     * @see elm_hoversel_item_del()
12807     */
12808    EAPI void               elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
12809    /**
12810     * @brief Get the list of items within the given hoversel.
12811     *
12812     * @param obj The hoversel object
12813     * @return Returns a list of Elm_Hoversel_Item*
12814     *
12815     * @see elm_hoversel_item_add()
12816     */
12817    EAPI const Eina_List   *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12818    /**
12819     * @brief Add an item to the hoversel button
12820     *
12821     * @param obj The hoversel object
12822     * @param label The text label to use for the item (NULL if not desired)
12823     * @param icon_file An image file path on disk to use for the icon or standard
12824     * icon name (NULL if not desired)
12825     * @param icon_type The icon type if relevant
12826     * @param func Convenience function to call when this item is selected
12827     * @param data Data to pass to item-related functions
12828     * @return A handle to the item added.
12829     *
12830     * This adds an item to the hoversel to show when it is clicked. Note: if you
12831     * need to use an icon from an edje file then use
12832     * elm_hoversel_item_icon_set() right after the this function, and set
12833     * icon_file to NULL here.
12834     *
12835     * For more information on what @p icon_file and @p icon_type are see the
12836     * @ref Icon "icon documentation".
12837     */
12838    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);
12839    /**
12840     * @brief Delete an item from the hoversel
12841     *
12842     * @param item The item to delete
12843     *
12844     * This deletes the item from the hoversel (should not be called while the
12845     * hoversel is active; use elm_hoversel_expanded_get() to check first).
12846     *
12847     * @see elm_hoversel_item_add()
12848     * @see elm_hoversel_item_del_cb_set()
12849     */
12850    EAPI void               elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
12851    /**
12852     * @brief Set the function to be called when an item from the hoversel is
12853     * freed.
12854     *
12855     * @param item The item to set the callback on
12856     * @param func The function called
12857     *
12858     * That function will receive these parameters:
12859     * @li void *item_data
12860     * @li Evas_Object *the_item_object
12861     * @li Elm_Hoversel_Item *the_object_struct
12862     *
12863     * @see elm_hoversel_item_add()
12864     */
12865    EAPI void               elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
12866    /**
12867     * @brief This returns the data pointer supplied with elm_hoversel_item_add()
12868     * that will be passed to associated function callbacks.
12869     *
12870     * @param item The item to get the data from
12871     * @return The data pointer set with elm_hoversel_item_add()
12872     *
12873     * @see elm_hoversel_item_add()
12874     */
12875    EAPI void              *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
12876    /**
12877     * @brief This returns the label text of the given hoversel item.
12878     *
12879     * @param item The item to get the label
12880     * @return The label text of the hoversel item
12881     *
12882     * @see elm_hoversel_item_add()
12883     */
12884    EAPI const char        *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
12885    /**
12886     * @brief This sets the icon for the given hoversel item.
12887     *
12888     * @param item The item to set the icon
12889     * @param icon_file An image file path on disk to use for the icon or standard
12890     * icon name
12891     * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
12892     * to NULL if the icon is not an edje file
12893     * @param icon_type The icon type
12894     *
12895     * The icon can be loaded from the standard set, from an image file, or from
12896     * an edje file.
12897     *
12898     * @see elm_hoversel_item_add()
12899     */
12900    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);
12901    /**
12902     * @brief Get the icon object of the hoversel item
12903     *
12904     * @param item The item to get the icon from
12905     * @param icon_file The image file path on disk used for the icon or standard
12906     * icon name
12907     * @param icon_group The edje group used if @p icon_file is an edje file. NULL
12908     * if the icon is not an edje file
12909     * @param icon_type The icon type
12910     *
12911     * @see elm_hoversel_item_icon_set()
12912     * @see elm_hoversel_item_add()
12913     */
12914    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);
12915    /**
12916     * @}
12917     */
12918
12919    /**
12920     * @defgroup Toolbar Toolbar
12921     * @ingroup Elementary
12922     *
12923     * @image html img/widget/toolbar/preview-00.png
12924     * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
12925     *
12926     * @image html img/toolbar.png
12927     * @image latex img/toolbar.eps width=\textwidth
12928     *
12929     * A toolbar is a widget that displays a list of items inside
12930     * a box. It can be scrollable, show a menu with items that don't fit
12931     * to toolbar size or even crop them.
12932     *
12933     * Only one item can be selected at a time.
12934     *
12935     * Items can have multiple states, or show menus when selected by the user.
12936     *
12937     * Smart callbacks one can listen to:
12938     * - "clicked" - when the user clicks on a toolbar item and becomes selected.
12939     *
12940     * Available styles for it:
12941     * - @c "default"
12942     * - @c "transparent" - no background or shadow, just show the content
12943     *
12944     * List of examples:
12945     * @li @ref toolbar_example_01
12946     * @li @ref toolbar_example_02
12947     * @li @ref toolbar_example_03
12948     */
12949
12950    /**
12951     * @addtogroup Toolbar
12952     * @{
12953     */
12954
12955    /**
12956     * @enum _Elm_Toolbar_Shrink_Mode
12957     * @typedef Elm_Toolbar_Shrink_Mode
12958     *
12959     * Set toolbar's items display behavior, it can be scrollabel,
12960     * show a menu with exceeding items, or simply hide them.
12961     *
12962     * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
12963     * from elm config.
12964     *
12965     * Values <b> don't </b> work as bitmask, only one can be choosen.
12966     *
12967     * @see elm_toolbar_mode_shrink_set()
12968     * @see elm_toolbar_mode_shrink_get()
12969     *
12970     * @ingroup Toolbar
12971     */
12972    typedef enum _Elm_Toolbar_Shrink_Mode
12973      {
12974         ELM_TOOLBAR_SHRINK_NONE,   /**< Set toolbar minimun size to fit all the items. */
12975         ELM_TOOLBAR_SHRINK_HIDE,   /**< Hide exceeding items. */
12976         ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
12977         ELM_TOOLBAR_SHRINK_MENU    /**< Inserts a button to pop up a menu with exceeding items. */
12978      } Elm_Toolbar_Shrink_Mode;
12979
12980    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(). */
12981
12982    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(). */
12983
12984    /**
12985     * Add a new toolbar widget to the given parent Elementary
12986     * (container) object.
12987     *
12988     * @param parent The parent object.
12989     * @return a new toolbar widget handle or @c NULL, on errors.
12990     *
12991     * This function inserts a new toolbar widget on the canvas.
12992     *
12993     * @ingroup Toolbar
12994     */
12995    EAPI Evas_Object            *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12996
12997    /**
12998     * Set the icon size, in pixels, to be used by toolbar items.
12999     *
13000     * @param obj The toolbar object
13001     * @param icon_size The icon size in pixels
13002     *
13003     * @note Default value is @c 32. It reads value from elm config.
13004     *
13005     * @see elm_toolbar_icon_size_get()
13006     *
13007     * @ingroup Toolbar
13008     */
13009    EAPI void                    elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
13010
13011    /**
13012     * Get the icon size, in pixels, to be used by toolbar items.
13013     *
13014     * @param obj The toolbar object.
13015     * @return The icon size in pixels.
13016     *
13017     * @see elm_toolbar_icon_size_set() for details.
13018     *
13019     * @ingroup Toolbar
13020     */
13021    EAPI int                     elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13022
13023    /**
13024     * Sets icon lookup order, for toolbar items' icons.
13025     *
13026     * @param obj The toolbar object.
13027     * @param order The icon lookup order.
13028     *
13029     * Icons added before calling this function will not be affected.
13030     * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
13031     *
13032     * @see elm_toolbar_icon_order_lookup_get()
13033     *
13034     * @ingroup Toolbar
13035     */
13036    EAPI void                    elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
13037
13038    /**
13039     * Gets the icon lookup order.
13040     *
13041     * @param obj The toolbar object.
13042     * @return The icon lookup order.
13043     *
13044     * @see elm_toolbar_icon_order_lookup_set() for details.
13045     *
13046     * @ingroup Toolbar
13047     */
13048    EAPI Elm_Icon_Lookup_Order   elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13049
13050    /**
13051     * Set whether the toolbar items' should be selected by the user or not.
13052     *
13053     * @param obj The toolbar object.
13054     * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
13055     * enable it.
13056     *
13057     * This will turn off the ability to select items entirely and they will
13058     * neither appear selected nor emit selected signals. The clicked
13059     * callback function will still be called.
13060     *
13061     * Selection is enabled by default.
13062     *
13063     * @see elm_toolbar_no_select_mode_get().
13064     *
13065     * @ingroup Toolbar
13066     */
13067    EAPI void                    elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
13068
13069    /**
13070     * Set whether the toolbar items' should be selected by the user or not.
13071     *
13072     * @param obj The toolbar object.
13073     * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
13074     * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
13075     *
13076     * @see elm_toolbar_no_select_mode_set() for details.
13077     *
13078     * @ingroup Toolbar
13079     */
13080    EAPI Eina_Bool               elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13081
13082    /**
13083     * Append item to the toolbar.
13084     *
13085     * @param obj The toolbar object.
13086     * @param icon A string with icon name or the absolute path of an image file.
13087     * @param label The label of the item.
13088     * @param func The function to call when the item is clicked.
13089     * @param data The data to associate with the item for related callbacks.
13090     * @return The created item or @c NULL upon failure.
13091     *
13092     * A new item will be created and appended to the toolbar, i.e., will
13093     * be set as @b last item.
13094     *
13095     * Items created with this method can be deleted with
13096     * elm_toolbar_item_del().
13097     *
13098     * Associated @p data can be properly freed when item is deleted if a
13099     * callback function is set with elm_toolbar_item_del_cb_set().
13100     *
13101     * If a function is passed as argument, it will be called everytime this item
13102     * is selected, i.e., the user clicks over an unselected item.
13103     * If such function isn't needed, just passing
13104     * @c NULL as @p func is enough. The same should be done for @p data.
13105     *
13106     * Toolbar will load icon image from fdo or current theme.
13107     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13108     * If an absolute path is provided it will load it direct from a file.
13109     *
13110     * @see elm_toolbar_item_icon_set()
13111     * @see elm_toolbar_item_del()
13112     * @see elm_toolbar_item_del_cb_set()
13113     *
13114     * @ingroup Toolbar
13115     */
13116    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);
13117
13118    /**
13119     * Prepend item to the toolbar.
13120     *
13121     * @param obj The toolbar object.
13122     * @param icon A string with icon name or the absolute path of an image file.
13123     * @param label The label of the item.
13124     * @param func The function to call when the item is clicked.
13125     * @param data The data to associate with the item for related callbacks.
13126     * @return The created item or @c NULL upon failure.
13127     *
13128     * A new item will be created and prepended to the toolbar, i.e., will
13129     * be set as @b first item.
13130     *
13131     * Items created with this method can be deleted with
13132     * elm_toolbar_item_del().
13133     *
13134     * Associated @p data can be properly freed when item is deleted if a
13135     * callback function is set with elm_toolbar_item_del_cb_set().
13136     *
13137     * If a function is passed as argument, it will be called everytime this item
13138     * is selected, i.e., the user clicks over an unselected item.
13139     * If such function isn't needed, just passing
13140     * @c NULL as @p func is enough. The same should be done for @p data.
13141     *
13142     * Toolbar will load icon image from fdo or current theme.
13143     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13144     * If an absolute path is provided it will load it direct from a file.
13145     *
13146     * @see elm_toolbar_item_icon_set()
13147     * @see elm_toolbar_item_del()
13148     * @see elm_toolbar_item_del_cb_set()
13149     *
13150     * @ingroup Toolbar
13151     */
13152    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);
13153
13154    /**
13155     * Insert a new item into the toolbar object before item @p before.
13156     *
13157     * @param obj The toolbar object.
13158     * @param before The toolbar item to insert before.
13159     * @param icon A string with icon name or the absolute path of an image file.
13160     * @param label The label of the item.
13161     * @param func The function to call when the item is clicked.
13162     * @param data The data to associate with the item for related callbacks.
13163     * @return The created item or @c NULL upon failure.
13164     *
13165     * A new item will be created and added to the toolbar. Its position in
13166     * this toolbar will be just before item @p before.
13167     *
13168     * Items created with this method can be deleted with
13169     * elm_toolbar_item_del().
13170     *
13171     * Associated @p data can be properly freed when item is deleted if a
13172     * callback function is set with elm_toolbar_item_del_cb_set().
13173     *
13174     * If a function is passed as argument, it will be called everytime this item
13175     * is selected, i.e., the user clicks over an unselected item.
13176     * If such function isn't needed, just passing
13177     * @c NULL as @p func is enough. The same should be done for @p data.
13178     *
13179     * Toolbar will load icon image from fdo or current theme.
13180     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13181     * If an absolute path is provided it will load it direct from a file.
13182     *
13183     * @see elm_toolbar_item_icon_set()
13184     * @see elm_toolbar_item_del()
13185     * @see elm_toolbar_item_del_cb_set()
13186     *
13187     * @ingroup Toolbar
13188     */
13189    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);
13190
13191    /**
13192     * Insert a new item into the toolbar object after item @p after.
13193     *
13194     * @param obj The toolbar object.
13195     * @param before The toolbar item to insert before.
13196     * @param icon A string with icon name or the absolute path of an image file.
13197     * @param label The label of the item.
13198     * @param func The function to call when the item is clicked.
13199     * @param data The data to associate with the item for related callbacks.
13200     * @return The created item or @c NULL upon failure.
13201     *
13202     * A new item will be created and added to the toolbar. Its position in
13203     * this toolbar will be just after item @p after.
13204     *
13205     * Items created with this method can be deleted with
13206     * elm_toolbar_item_del().
13207     *
13208     * Associated @p data can be properly freed when item is deleted if a
13209     * callback function is set with elm_toolbar_item_del_cb_set().
13210     *
13211     * If a function is passed as argument, it will be called everytime this item
13212     * is selected, i.e., the user clicks over an unselected item.
13213     * If such function isn't needed, just passing
13214     * @c NULL as @p func is enough. The same should be done for @p data.
13215     *
13216     * Toolbar will load icon image from fdo or current theme.
13217     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13218     * If an absolute path is provided it will load it direct from a file.
13219     *
13220     * @see elm_toolbar_item_icon_set()
13221     * @see elm_toolbar_item_del()
13222     * @see elm_toolbar_item_del_cb_set()
13223     *
13224     * @ingroup Toolbar
13225     */
13226    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);
13227
13228    /**
13229     * Get the first item in the given toolbar widget's list of
13230     * items.
13231     *
13232     * @param obj The toolbar object
13233     * @return The first item or @c NULL, if it has no items (and on
13234     * errors)
13235     *
13236     * @see elm_toolbar_item_append()
13237     * @see elm_toolbar_last_item_get()
13238     *
13239     * @ingroup Toolbar
13240     */
13241    EAPI Elm_Toolbar_Item       *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13242
13243    /**
13244     * Get the last item in the given toolbar widget's list of
13245     * items.
13246     *
13247     * @param obj The toolbar object
13248     * @return The last item or @c NULL, if it has no items (and on
13249     * errors)
13250     *
13251     * @see elm_toolbar_item_prepend()
13252     * @see elm_toolbar_first_item_get()
13253     *
13254     * @ingroup Toolbar
13255     */
13256    EAPI Elm_Toolbar_Item       *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13257
13258    /**
13259     * Get the item after @p item in toolbar.
13260     *
13261     * @param item The toolbar item.
13262     * @return The item after @p item, or @c NULL if none or on failure.
13263     *
13264     * @note If it is the last item, @c NULL will be returned.
13265     *
13266     * @see elm_toolbar_item_append()
13267     *
13268     * @ingroup Toolbar
13269     */
13270    EAPI Elm_Toolbar_Item       *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13271
13272    /**
13273     * Get the item before @p item in toolbar.
13274     *
13275     * @param item The toolbar item.
13276     * @return The item before @p item, or @c NULL if none or on failure.
13277     *
13278     * @note If it is the first item, @c NULL will be returned.
13279     *
13280     * @see elm_toolbar_item_prepend()
13281     *
13282     * @ingroup Toolbar
13283     */
13284    EAPI Elm_Toolbar_Item       *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13285
13286    /**
13287     * Get the toolbar object from an item.
13288     *
13289     * @param item The item.
13290     * @return The toolbar object.
13291     *
13292     * This returns the toolbar object itself that an item belongs to.
13293     *
13294     * @ingroup Toolbar
13295     */
13296    EAPI Evas_Object            *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13297
13298    /**
13299     * Set the priority of a toolbar item.
13300     *
13301     * @param item The toolbar item.
13302     * @param priority The item priority. The default is zero.
13303     *
13304     * This is used only when the toolbar shrink mode is set to
13305     * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
13306     * When space is less than required, items with low priority
13307     * will be removed from the toolbar and added to a dynamically-created menu,
13308     * while items with higher priority will remain on the toolbar,
13309     * with the same order they were added.
13310     *
13311     * @see elm_toolbar_item_priority_get()
13312     *
13313     * @ingroup Toolbar
13314     */
13315    EAPI void                    elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
13316
13317    /**
13318     * Get the priority of a toolbar item.
13319     *
13320     * @param item The toolbar item.
13321     * @return The @p item priority, or @c 0 on failure.
13322     *
13323     * @see elm_toolbar_item_priority_set() for details.
13324     *
13325     * @ingroup Toolbar
13326     */
13327    EAPI int                     elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13328
13329    /**
13330     * Get the label of item.
13331     *
13332     * @param item The item of toolbar.
13333     * @return The label of item.
13334     *
13335     * The return value is a pointer to the label associated to @p item when
13336     * it was created, with function elm_toolbar_item_append() or similar,
13337     * or later,
13338     * with function elm_toolbar_item_label_set. If no label
13339     * was passed as argument, it will return @c NULL.
13340     *
13341     * @see elm_toolbar_item_label_set() for more details.
13342     * @see elm_toolbar_item_append()
13343     *
13344     * @ingroup Toolbar
13345     */
13346    EAPI const char             *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13347
13348    /**
13349     * Set the label of item.
13350     *
13351     * @param item The item of toolbar.
13352     * @param text The label of item.
13353     *
13354     * The label to be displayed by the item.
13355     * Label will be placed at icons bottom (if set).
13356     *
13357     * If a label was passed as argument on item creation, with function
13358     * elm_toolbar_item_append() or similar, it will be already
13359     * displayed by the item.
13360     *
13361     * @see elm_toolbar_item_label_get()
13362     * @see elm_toolbar_item_append()
13363     *
13364     * @ingroup Toolbar
13365     */
13366    EAPI void                    elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
13367
13368    /**
13369     * Return the data associated with a given toolbar widget item.
13370     *
13371     * @param item The toolbar widget item handle.
13372     * @return The data associated with @p item.
13373     *
13374     * @see elm_toolbar_item_data_set()
13375     *
13376     * @ingroup Toolbar
13377     */
13378    EAPI void                   *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13379
13380    /**
13381     * Set the data associated with a given toolbar widget item.
13382     *
13383     * @param item The toolbar widget item handle.
13384     * @param data The new data pointer to set to @p item.
13385     *
13386     * This sets new item data on @p item.
13387     *
13388     * @warning The old data pointer won't be touched by this function, so
13389     * the user had better to free that old data himself/herself.
13390     *
13391     * @ingroup Toolbar
13392     */
13393    EAPI void                    elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
13394
13395    /**
13396     * Returns a pointer to a toolbar item by its label.
13397     *
13398     * @param obj The toolbar object.
13399     * @param label The label of the item to find.
13400     *
13401     * @return The pointer to the toolbar item matching @p label or @c NULL
13402     * on failure.
13403     *
13404     * @ingroup Toolbar
13405     */
13406    EAPI Elm_Toolbar_Item       *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13407
13408    /*
13409     * Get whether the @p item is selected or not.
13410     *
13411     * @param item The toolbar item.
13412     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
13413     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
13414     *
13415     * @see elm_toolbar_selected_item_set() for details.
13416     * @see elm_toolbar_item_selected_get()
13417     *
13418     * @ingroup Toolbar
13419     */
13420    EAPI Eina_Bool               elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13421
13422    /**
13423     * Set the selected state of an item.
13424     *
13425     * @param item The toolbar item
13426     * @param selected The selected state
13427     *
13428     * This sets the selected state of the given item @p it.
13429     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
13430     *
13431     * If a new item is selected the previosly selected will be unselected.
13432     * Previoulsy selected item can be get with function
13433     * elm_toolbar_selected_item_get().
13434     *
13435     * Selected items will be highlighted.
13436     *
13437     * @see elm_toolbar_item_selected_get()
13438     * @see elm_toolbar_selected_item_get()
13439     *
13440     * @ingroup Toolbar
13441     */
13442    EAPI void                    elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
13443
13444    /**
13445     * Get the selected item.
13446     *
13447     * @param obj The toolbar object.
13448     * @return The selected toolbar item.
13449     *
13450     * The selected item can be unselected with function
13451     * elm_toolbar_item_selected_set().
13452     *
13453     * The selected item always will be highlighted on toolbar.
13454     *
13455     * @see elm_toolbar_selected_items_get()
13456     *
13457     * @ingroup Toolbar
13458     */
13459    EAPI Elm_Toolbar_Item       *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13460
13461    /**
13462     * Set the icon associated with @p item.
13463     *
13464     * @param obj The parent of this item.
13465     * @param item The toolbar item.
13466     * @param icon A string with icon name or the absolute path of an image file.
13467     *
13468     * Toolbar will load icon image from fdo or current theme.
13469     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13470     * If an absolute path is provided it will load it direct from a file.
13471     *
13472     * @see elm_toolbar_icon_order_lookup_set()
13473     * @see elm_toolbar_icon_order_lookup_get()
13474     *
13475     * @ingroup Toolbar
13476     */
13477    EAPI void                    elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
13478
13479    /**
13480     * Get the string used to set the icon of @p item.
13481     *
13482     * @param item The toolbar item.
13483     * @return The string associated with the icon object.
13484     *
13485     * @see elm_toolbar_item_icon_set() for details.
13486     *
13487     * @ingroup Toolbar
13488     */
13489    EAPI const char             *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13490
13491    /**
13492     * Delete them item from the toolbar.
13493     *
13494     * @param item The item of toolbar to be deleted.
13495     *
13496     * @see elm_toolbar_item_append()
13497     * @see elm_toolbar_item_del_cb_set()
13498     *
13499     * @ingroup Toolbar
13500     */
13501    EAPI void                    elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13502
13503    /**
13504     * Set the function called when a toolbar item is freed.
13505     *
13506     * @param item The item to set the callback on.
13507     * @param func The function called.
13508     *
13509     * If there is a @p func, then it will be called prior item's memory release.
13510     * That will be called with the following arguments:
13511     * @li item's data;
13512     * @li item's Evas object;
13513     * @li item itself;
13514     *
13515     * This way, a data associated to a toolbar item could be properly freed.
13516     *
13517     * @ingroup Toolbar
13518     */
13519    EAPI void                    elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
13520
13521    /**
13522     * Get a value whether toolbar item is disabled or not.
13523     *
13524     * @param item The item.
13525     * @return The disabled state.
13526     *
13527     * @see elm_toolbar_item_disabled_set() for more details.
13528     *
13529     * @ingroup Toolbar
13530     */
13531    EAPI Eina_Bool               elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13532
13533    /**
13534     * Sets the disabled/enabled state of a toolbar item.
13535     *
13536     * @param item The item.
13537     * @param disabled The disabled state.
13538     *
13539     * A disabled item cannot be selected or unselected. It will also
13540     * change its appearance (generally greyed out). This sets the
13541     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
13542     * enabled).
13543     *
13544     * @ingroup Toolbar
13545     */
13546    EAPI void                    elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
13547
13548    /**
13549     * Set or unset item as a separator.
13550     *
13551     * @param item The toolbar item.
13552     * @param setting @c EINA_TRUE to set item @p item as separator or
13553     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
13554     *
13555     * Items aren't set as separator by default.
13556     *
13557     * If set as separator it will display separator theme, so won't display
13558     * icons or label.
13559     *
13560     * @see elm_toolbar_item_separator_get()
13561     *
13562     * @ingroup Toolbar
13563     */
13564    EAPI void                    elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
13565
13566    /**
13567     * Get a value whether item is a separator or not.
13568     *
13569     * @param item The toolbar item.
13570     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
13571     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
13572     *
13573     * @see elm_toolbar_item_separator_set() for details.
13574     *
13575     * @ingroup Toolbar
13576     */
13577    EAPI Eina_Bool               elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13578
13579    /**
13580     * Set the shrink state of toolbar @p obj.
13581     *
13582     * @param obj The toolbar object.
13583     * @param shrink_mode Toolbar's items display behavior.
13584     *
13585     * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
13586     * but will enforce a minimun size so all the items will fit, won't scroll
13587     * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
13588     * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
13589     * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
13590     *
13591     * @ingroup Toolbar
13592     */
13593    EAPI void                    elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
13594
13595    /**
13596     * Get the shrink mode of toolbar @p obj.
13597     *
13598     * @param obj The toolbar object.
13599     * @return Toolbar's items display behavior.
13600     *
13601     * @see elm_toolbar_mode_shrink_set() for details.
13602     *
13603     * @ingroup Toolbar
13604     */
13605    EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13606
13607    /**
13608     * Enable/disable homogenous mode.
13609     *
13610     * @param obj The toolbar object
13611     * @param homogeneous Assume the items within the toolbar are of the
13612     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
13613     *
13614     * This will enable the homogeneous mode where items are of the same size.
13615     * @see elm_toolbar_homogeneous_get()
13616     *
13617     * @ingroup Toolbar
13618     */
13619    EAPI void                    elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
13620
13621    /**
13622     * Get whether the homogenous mode is enabled.
13623     *
13624     * @param obj The toolbar object.
13625     * @return Assume the items within the toolbar are of the same height
13626     * and width (EINA_TRUE = on, EINA_FALSE = off).
13627     *
13628     * @see elm_toolbar_homogeneous_set()
13629     *
13630     * @ingroup Toolbar
13631     */
13632    EAPI Eina_Bool               elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13633
13634    /**
13635     * Enable/disable homogenous mode.
13636     *
13637     * @param obj The toolbar object
13638     * @param homogeneous Assume the items within the toolbar are of the
13639     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
13640     *
13641     * This will enable the homogeneous mode where items are of the same size.
13642     * @see elm_toolbar_homogeneous_get()
13643     *
13644     * @deprecated use elm_toolbar_homogeneous_set() instead.
13645     *
13646     * @ingroup Toolbar
13647     */
13648    EINA_DEPRECATED EAPI void    elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
13649
13650    /**
13651     * Get whether the homogenous mode is enabled.
13652     *
13653     * @param obj The toolbar object.
13654     * @return Assume the items within the toolbar are of the same height
13655     * and width (EINA_TRUE = on, EINA_FALSE = off).
13656     *
13657     * @see elm_toolbar_homogeneous_set()
13658     * @deprecated use elm_toolbar_homogeneous_get() instead.
13659     *
13660     * @ingroup Toolbar
13661     */
13662    EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13663
13664    /**
13665     * Set the parent object of the toolbar items' menus.
13666     *
13667     * @param obj The toolbar object.
13668     * @param parent The parent of the menu objects.
13669     *
13670     * Each item can be set as item menu, with elm_toolbar_item_menu_set().
13671     *
13672     * For more details about setting the parent for toolbar menus, see
13673     * elm_menu_parent_set().
13674     *
13675     * @see elm_menu_parent_set() for details.
13676     * @see elm_toolbar_item_menu_set() for details.
13677     *
13678     * @ingroup Toolbar
13679     */
13680    EAPI void                    elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
13681
13682    /**
13683     * Get the parent object of the toolbar items' menus.
13684     *
13685     * @param obj The toolbar object.
13686     * @return The parent of the menu objects.
13687     *
13688     * @see elm_toolbar_menu_parent_set() for details.
13689     *
13690     * @ingroup Toolbar
13691     */
13692    EAPI Evas_Object            *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13693
13694    /**
13695     * Set the alignment of the items.
13696     *
13697     * @param obj The toolbar object.
13698     * @param align The new alignment, a float between <tt> 0.0 </tt>
13699     * and <tt> 1.0 </tt>.
13700     *
13701     * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
13702     * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
13703     * items.
13704     *
13705     * Centered items by default.
13706     *
13707     * @see elm_toolbar_align_get()
13708     *
13709     * @ingroup Toolbar
13710     */
13711    EAPI void                    elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
13712
13713    /**
13714     * Get the alignment of the items.
13715     *
13716     * @param obj The toolbar object.
13717     * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
13718     * <tt> 1.0 </tt>.
13719     *
13720     * @see elm_toolbar_align_set() for details.
13721     *
13722     * @ingroup Toolbar
13723     */
13724    EAPI double                  elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13725
13726    /**
13727     * Set whether the toolbar item opens a menu.
13728     *
13729     * @param item The toolbar item.
13730     * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
13731     *
13732     * A toolbar item can be set to be a menu, using this function.
13733     *
13734     * Once it is set to be a menu, it can be manipulated through the
13735     * menu-like function elm_toolbar_menu_parent_set() and the other
13736     * elm_menu functions, using the Evas_Object @c menu returned by
13737     * elm_toolbar_item_menu_get().
13738     *
13739     * So, items to be displayed in this item's menu should be added with
13740     * elm_menu_item_add().
13741     *
13742     * The following code exemplifies the most basic usage:
13743     * @code
13744     * tb = elm_toolbar_add(win)
13745     * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
13746     * elm_toolbar_item_menu_set(item, EINA_TRUE);
13747     * elm_toolbar_menu_parent_set(tb, win);
13748     * menu = elm_toolbar_item_menu_get(item);
13749     * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
13750     * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
13751     * NULL);
13752     * @endcode
13753     *
13754     * @see elm_toolbar_item_menu_get()
13755     *
13756     * @ingroup Toolbar
13757     */
13758    EAPI void                    elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
13759
13760    /**
13761     * Get toolbar item's menu.
13762     *
13763     * @param item The toolbar item.
13764     * @return Item's menu object or @c NULL on failure.
13765     *
13766     * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
13767     * this function will set it.
13768     *
13769     * @see elm_toolbar_item_menu_set() for details.
13770     *
13771     * @ingroup Toolbar
13772     */
13773    EAPI Evas_Object            *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13774
13775    /**
13776     * Add a new state to @p item.
13777     *
13778     * @param item The item.
13779     * @param icon A string with icon name or the absolute path of an image file.
13780     * @param label The label of the new state.
13781     * @param func The function to call when the item is clicked when this
13782     * state is selected.
13783     * @param data The data to associate with the state.
13784     * @return The toolbar item state, or @c NULL upon failure.
13785     *
13786     * Toolbar will load icon image from fdo or current theme.
13787     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13788     * If an absolute path is provided it will load it direct from a file.
13789     *
13790     * States created with this function can be removed with
13791     * elm_toolbar_item_state_del().
13792     *
13793     * @see elm_toolbar_item_state_del()
13794     * @see elm_toolbar_item_state_sel()
13795     * @see elm_toolbar_item_state_get()
13796     *
13797     * @ingroup Toolbar
13798     */
13799    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);
13800
13801    /**
13802     * Delete a previoulsy added state to @p item.
13803     *
13804     * @param item The toolbar item.
13805     * @param state The state to be deleted.
13806     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
13807     *
13808     * @see elm_toolbar_item_state_add()
13809     */
13810    EAPI Eina_Bool               elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
13811
13812    /**
13813     * Set @p state as the current state of @p it.
13814     *
13815     * @param it The item.
13816     * @param state The state to use.
13817     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
13818     *
13819     * If @p state is @c NULL, it won't select any state and the default item's
13820     * icon and label will be used. It's the same behaviour than
13821     * elm_toolbar_item_state_unser().
13822     *
13823     * @see elm_toolbar_item_state_unset()
13824     *
13825     * @ingroup Toolbar
13826     */
13827    EAPI Eina_Bool               elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
13828
13829    /**
13830     * Unset the state of @p it.
13831     *
13832     * @param it The item.
13833     *
13834     * The default icon and label from this item will be displayed.
13835     *
13836     * @see elm_toolbar_item_state_set() for more details.
13837     *
13838     * @ingroup Toolbar
13839     */
13840    EAPI void                    elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13841
13842    /**
13843     * Get the current state of @p it.
13844     *
13845     * @param item The item.
13846     * @return The selected state or @c NULL if none is selected or on failure.
13847     *
13848     * @see elm_toolbar_item_state_set() for details.
13849     * @see elm_toolbar_item_state_unset()
13850     * @see elm_toolbar_item_state_add()
13851     *
13852     * @ingroup Toolbar
13853     */
13854    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13855
13856    /**
13857     * Get the state after selected state in toolbar's @p item.
13858     *
13859     * @param it The toolbar item to change state.
13860     * @return The state after current state, or @c NULL on failure.
13861     *
13862     * If last state is selected, this function will return first state.
13863     *
13864     * @see elm_toolbar_item_state_set()
13865     * @see elm_toolbar_item_state_add()
13866     *
13867     * @ingroup Toolbar
13868     */
13869    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13870
13871    /**
13872     * Get the state before selected state in toolbar's @p item.
13873     *
13874     * @param it The toolbar item to change state.
13875     * @return The state before current state, or @c NULL on failure.
13876     *
13877     * If first state is selected, this function will return last state.
13878     *
13879     * @see elm_toolbar_item_state_set()
13880     * @see elm_toolbar_item_state_add()
13881     *
13882     * @ingroup Toolbar
13883     */
13884    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13885
13886    /**
13887     * Set the text to be shown in a given toolbar item's tooltips.
13888     *
13889     * @param item Target item.
13890     * @param text The text to set in the content.
13891     *
13892     * Setup the text as tooltip to object. The item can have only one tooltip,
13893     * so any previous tooltip data - set with this function or
13894     * elm_toolbar_item_tooltip_content_cb_set() - is removed.
13895     *
13896     * @see elm_object_tooltip_text_set() for more details.
13897     *
13898     * @ingroup Toolbar
13899     */
13900    EAPI void             elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
13901
13902    /**
13903     * Set the content to be shown in the tooltip item.
13904     *
13905     * Setup the tooltip to item. The item can have only one tooltip,
13906     * so any previous tooltip data is removed. @p func(with @p data) will
13907     * be called every time that need show the tooltip and it should
13908     * return a valid Evas_Object. This object is then managed fully by
13909     * tooltip system and is deleted when the tooltip is gone.
13910     *
13911     * @param item the toolbar item being attached a tooltip.
13912     * @param func the function used to create the tooltip contents.
13913     * @param data what to provide to @a func as callback data/context.
13914     * @param del_cb called when data is not needed anymore, either when
13915     *        another callback replaces @a func, the tooltip is unset with
13916     *        elm_toolbar_item_tooltip_unset() or the owner @a item
13917     *        dies. This callback receives as the first parameter the
13918     *        given @a data, and @c event_info is the item.
13919     *
13920     * @see elm_object_tooltip_content_cb_set() for more details.
13921     *
13922     * @ingroup Toolbar
13923     */
13924    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);
13925
13926    /**
13927     * Unset tooltip from item.
13928     *
13929     * @param item toolbar item to remove previously set tooltip.
13930     *
13931     * Remove tooltip from item. The callback provided as del_cb to
13932     * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
13933     * it is not used anymore.
13934     *
13935     * @see elm_object_tooltip_unset() for more details.
13936     * @see elm_toolbar_item_tooltip_content_cb_set()
13937     *
13938     * @ingroup Toolbar
13939     */
13940    EAPI void             elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13941
13942    /**
13943     * Sets a different style for this item tooltip.
13944     *
13945     * @note before you set a style you should define a tooltip with
13946     *       elm_toolbar_item_tooltip_content_cb_set() or
13947     *       elm_toolbar_item_tooltip_text_set()
13948     *
13949     * @param item toolbar item with tooltip already set.
13950     * @param style the theme style to use (default, transparent, ...)
13951     *
13952     * @see elm_object_tooltip_style_set() for more details.
13953     *
13954     * @ingroup Toolbar
13955     */
13956    EAPI void             elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
13957
13958    /**
13959     * Get the style for this item tooltip.
13960     *
13961     * @param item toolbar item with tooltip already set.
13962     * @return style the theme style in use, defaults to "default". If the
13963     *         object does not have a tooltip set, then NULL is returned.
13964     *
13965     * @see elm_object_tooltip_style_get() for more details.
13966     * @see elm_toolbar_item_tooltip_style_set()
13967     *
13968     * @ingroup Toolbar
13969     */
13970    EAPI const char      *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13971
13972    /**
13973     * Set the type of mouse pointer/cursor decoration to be shown,
13974     * when the mouse pointer is over the given toolbar widget item
13975     *
13976     * @param item toolbar item to customize cursor on
13977     * @param cursor the cursor type's name
13978     *
13979     * This function works analogously as elm_object_cursor_set(), but
13980     * here the cursor's changing area is restricted to the item's
13981     * area, and not the whole widget's. Note that that item cursors
13982     * have precedence over widget cursors, so that a mouse over an
13983     * item with custom cursor set will always show @b that cursor.
13984     *
13985     * If this function is called twice for an object, a previously set
13986     * cursor will be unset on the second call.
13987     *
13988     * @see elm_object_cursor_set()
13989     * @see elm_toolbar_item_cursor_get()
13990     * @see elm_toolbar_item_cursor_unset()
13991     *
13992     * @ingroup Toolbar
13993     */
13994    EAPI void             elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
13995
13996    /*
13997     * Get the type of mouse pointer/cursor decoration set to be shown,
13998     * when the mouse pointer is over the given toolbar widget item
13999     *
14000     * @param item toolbar item with custom cursor set
14001     * @return the cursor type's name or @c NULL, if no custom cursors
14002     * were set to @p item (and on errors)
14003     *
14004     * @see elm_object_cursor_get()
14005     * @see elm_toolbar_item_cursor_set()
14006     * @see elm_toolbar_item_cursor_unset()
14007     *
14008     * @ingroup Toolbar
14009     */
14010    EAPI const char      *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14011
14012    /**
14013     * Unset any custom mouse pointer/cursor decoration set to be
14014     * shown, when the mouse pointer is over the given toolbar widget
14015     * item, thus making it show the @b default cursor again.
14016     *
14017     * @param item a toolbar item
14018     *
14019     * Use this call to undo any custom settings on this item's cursor
14020     * decoration, bringing it back to defaults (no custom style set).
14021     *
14022     * @see elm_object_cursor_unset()
14023     * @see elm_toolbar_item_cursor_set()
14024     *
14025     * @ingroup Toolbar
14026     */
14027    EAPI void             elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14028
14029    /**
14030     * Set a different @b style for a given custom cursor set for a
14031     * toolbar item.
14032     *
14033     * @param item toolbar item with custom cursor set
14034     * @param style the <b>theme style</b> to use (e.g. @c "default",
14035     * @c "transparent", etc)
14036     *
14037     * This function only makes sense when one is using custom mouse
14038     * cursor decorations <b>defined in a theme file</b>, which can have,
14039     * given a cursor name/type, <b>alternate styles</b> on it. It
14040     * works analogously as elm_object_cursor_style_set(), but here
14041     * applyed only to toolbar item objects.
14042     *
14043     * @warning Before you set a cursor style you should have definen a
14044     *       custom cursor previously on the item, with
14045     *       elm_toolbar_item_cursor_set()
14046     *
14047     * @see elm_toolbar_item_cursor_engine_only_set()
14048     * @see elm_toolbar_item_cursor_style_get()
14049     *
14050     * @ingroup Toolbar
14051     */
14052    EAPI void             elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
14053
14054    /**
14055     * Get the current @b style set for a given toolbar item's custom
14056     * cursor
14057     *
14058     * @param item toolbar item with custom cursor set.
14059     * @return style the cursor style in use. If the object does not
14060     *         have a cursor set, then @c NULL is returned.
14061     *
14062     * @see elm_toolbar_item_cursor_style_set() for more details
14063     *
14064     * @ingroup Toolbar
14065     */
14066    EAPI const char      *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14067
14068    /**
14069     * Set if the (custom)cursor for a given toolbar item should be
14070     * searched in its theme, also, or should only rely on the
14071     * rendering engine.
14072     *
14073     * @param item item with custom (custom) cursor already set on
14074     * @param engine_only Use @c EINA_TRUE to have cursors looked for
14075     * only on those provided by the rendering engine, @c EINA_FALSE to
14076     * have them searched on the widget's theme, as well.
14077     *
14078     * @note This call is of use only if you've set a custom cursor
14079     * for toolbar items, with elm_toolbar_item_cursor_set().
14080     *
14081     * @note By default, cursors will only be looked for between those
14082     * provided by the rendering engine.
14083     *
14084     * @ingroup Toolbar
14085     */
14086    EAPI void             elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
14087
14088    /**
14089     * Get if the (custom) cursor for a given toolbar item is being
14090     * searched in its theme, also, or is only relying on the rendering
14091     * engine.
14092     *
14093     * @param item a toolbar item
14094     * @return @c EINA_TRUE, if cursors are being looked for only on
14095     * those provided by the rendering engine, @c EINA_FALSE if they
14096     * are being searched on the widget's theme, as well.
14097     *
14098     * @see elm_toolbar_item_cursor_engine_only_set(), for more details
14099     *
14100     * @ingroup Toolbar
14101     */
14102    EAPI Eina_Bool        elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14103
14104    /**
14105     * Change a toolbar's orientation
14106     * @param obj The toolbar object
14107     * @param vertical If @c EINA_TRUE, the toolbar is vertical
14108     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
14109     * @ingroup Toolbar
14110     */
14111    EAPI void             elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
14112
14113    /**
14114     * Get a toolbar's orientation
14115     * @param obj The toolbar object
14116     * @return If @c EINA_TRUE, the toolbar is vertical
14117     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
14118     * @ingroup Toolbar
14119     */
14120    EAPI Eina_Bool        elm_toolbar_orientation_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
14121
14122    /**
14123     * @}
14124     */
14125
14126    /**
14127     * @defgroup Tooltips Tooltips
14128     *
14129     * The Tooltip is an (internal, for now) smart object used to show a
14130     * content in a frame on mouse hover of objects(or widgets), with
14131     * tips/information about them.
14132     *
14133     * @{
14134     */
14135
14136    EAPI double       elm_tooltip_delay_get(void);
14137    EAPI Eina_Bool    elm_tooltip_delay_set(double delay);
14138    EAPI void         elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
14139    EAPI void         elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
14140    EAPI void         elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
14141    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);
14142    EAPI void         elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14143    EAPI void         elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
14144    EAPI const char  *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14145    EAPI Eina_Bool    elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
14146    EAPI Eina_Bool    elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
14147
14148    /**
14149     * @}
14150     */
14151
14152    /**
14153     * @defgroup Cursors Cursors
14154     *
14155     * The Elementary cursor is an internal smart object used to
14156     * customize the mouse cursor displayed over objects (or
14157     * widgets). In the most common scenario, the cursor decoration
14158     * comes from the graphical @b engine Elementary is running
14159     * on. Those engines may provide different decorations for cursors,
14160     * and Elementary provides functions to choose them (think of X11
14161     * cursors, as an example).
14162     *
14163     * There's also the possibility of, besides using engine provided
14164     * cursors, also use ones coming from Edje theming files. Both
14165     * globally and per widget, Elementary makes it possible for one to
14166     * make the cursors lookup to be held on engines only or on
14167     * Elementary's theme file, too.
14168     *
14169     * @{
14170     */
14171
14172    /**
14173     * Set the cursor to be shown when mouse is over the object
14174     *
14175     * Set the cursor that will be displayed when mouse is over the
14176     * object. The object can have only one cursor set to it, so if
14177     * this function is called twice for an object, the previous set
14178     * will be unset.
14179     * If using X cursors, a definition of all the valid cursor names
14180     * is listed on Elementary_Cursors.h. If an invalid name is set
14181     * the default cursor will be used.
14182     *
14183     * @param obj the object being set a cursor.
14184     * @param cursor the cursor name to be used.
14185     *
14186     * @ingroup Cursors
14187     */
14188    EAPI void         elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
14189
14190    /**
14191     * Get the cursor to be shown when mouse is over the object
14192     *
14193     * @param obj an object with cursor already set.
14194     * @return the cursor name.
14195     *
14196     * @ingroup Cursors
14197     */
14198    EAPI const char  *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14199
14200    /**
14201     * Unset cursor for object
14202     *
14203     * Unset cursor for object, and set the cursor to default if the mouse
14204     * was over this object.
14205     *
14206     * @param obj Target object
14207     * @see elm_object_cursor_set()
14208     *
14209     * @ingroup Cursors
14210     */
14211    EAPI void         elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14212
14213    /**
14214     * Sets a different style for this object cursor.
14215     *
14216     * @note before you set a style you should define a cursor with
14217     *       elm_object_cursor_set()
14218     *
14219     * @param obj an object with cursor already set.
14220     * @param style the theme style to use (default, transparent, ...)
14221     *
14222     * @ingroup Cursors
14223     */
14224    EAPI void         elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
14225
14226    /**
14227     * Get the style for this object cursor.
14228     *
14229     * @param obj an object with cursor already set.
14230     * @return style the theme style in use, defaults to "default". If the
14231     *         object does not have a cursor set, then NULL is returned.
14232     *
14233     * @ingroup Cursors
14234     */
14235    EAPI const char  *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14236
14237    /**
14238     * Set if the cursor set should be searched on the theme or should use
14239     * the provided by the engine, only.
14240     *
14241     * @note before you set if should look on theme you should define a cursor
14242     * with elm_object_cursor_set(). By default it will only look for cursors
14243     * provided by the engine.
14244     *
14245     * @param obj an object with cursor already set.
14246     * @param engine_only boolean to define it cursors should be looked only
14247     * between the provided by the engine or searched on widget's theme as well.
14248     *
14249     * @ingroup Cursors
14250     */
14251    EAPI void         elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
14252
14253    /**
14254     * Get the cursor engine only usage for this object cursor.
14255     *
14256     * @param obj an object with cursor already set.
14257     * @return engine_only boolean to define it cursors should be
14258     * looked only between the provided by the engine or searched on
14259     * widget's theme as well. If the object does not have a cursor
14260     * set, then EINA_FALSE is returned.
14261     *
14262     * @ingroup Cursors
14263     */
14264    EAPI Eina_Bool    elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14265
14266    /**
14267     * Get the configured cursor engine only usage
14268     *
14269     * This gets the globally configured exclusive usage of engine cursors.
14270     *
14271     * @return 1 if only engine cursors should be used
14272     * @ingroup Cursors
14273     */
14274    EAPI int          elm_cursor_engine_only_get(void);
14275
14276    /**
14277     * Set the configured cursor engine only usage
14278     *
14279     * This sets the globally configured exclusive usage of engine cursors.
14280     * It won't affect cursors set before changing this value.
14281     *
14282     * @param engine_only If 1 only engine cursors will be enabled, if 0 will
14283     * look for them on theme before.
14284     * @return EINA_TRUE if value is valid and setted (0 or 1)
14285     * @ingroup Cursors
14286     */
14287    EAPI Eina_Bool    elm_cursor_engine_only_set(int engine_only);
14288
14289    /**
14290     * @}
14291     */
14292
14293    /**
14294     * @defgroup Menu Menu
14295     *
14296     * @image html img/widget/menu/preview-00.png
14297     * @image latex img/widget/menu/preview-00.eps
14298     *
14299     * A menu is a list of items displayed above its parent. When the menu is
14300     * showing its parent is darkened. Each item can have a sub-menu. The menu
14301     * object can be used to display a menu on a right click event, in a toolbar,
14302     * anywhere.
14303     *
14304     * Signals that you can add callbacks for are:
14305     * @li "clicked" - the user clicked the empty space in the menu to dismiss.
14306     *             event_info is NULL.
14307     *
14308     * @see @ref tutorial_menu
14309     * @{
14310     */
14311    typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
14312    /**
14313     * @brief Add a new menu to the parent
14314     *
14315     * @param parent The parent object.
14316     * @return The new object or NULL if it cannot be created.
14317     */
14318    EAPI Evas_Object       *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14319    /**
14320     * @brief Set the parent for the given menu widget
14321     *
14322     * @param obj The menu object.
14323     * @param parent The new parent.
14324     */
14325    EAPI void               elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14326    /**
14327     * @brief Get the parent for the given menu widget
14328     *
14329     * @param obj The menu object.
14330     * @return The parent.
14331     *
14332     * @see elm_menu_parent_set()
14333     */
14334    EAPI Evas_Object       *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14335    /**
14336     * @brief Move the menu to a new position
14337     *
14338     * @param obj The menu object.
14339     * @param x The new position.
14340     * @param y The new position.
14341     *
14342     * Sets the top-left position of the menu to (@p x,@p y).
14343     *
14344     * @note @p x and @p y coordinates are relative to parent.
14345     */
14346    EAPI void               elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
14347    /**
14348     * @brief Close a opened menu
14349     *
14350     * @param obj the menu object
14351     * @return void
14352     *
14353     * Hides the menu and all it's sub-menus.
14354     */
14355    EAPI void               elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
14356    /**
14357     * @brief Returns a list of @p item's items.
14358     *
14359     * @param obj The menu object
14360     * @return An Eina_List* of @p item's items
14361     */
14362    EAPI const Eina_List   *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14363    /**
14364     * @brief Get the Evas_Object of an Elm_Menu_Item
14365     *
14366     * @param item The menu item object.
14367     * @return The edje object containing the swallowed content
14368     *
14369     * @warning Don't manipulate this object!
14370     */
14371    EAPI Evas_Object       *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14372    /**
14373     * @brief Add an item at the end of the given menu widget
14374     *
14375     * @param obj The menu object.
14376     * @param parent The parent menu item (optional)
14377     * @param icon A icon display on the item. The icon will be destryed by the menu.
14378     * @param label The label of the item.
14379     * @param func Function called when the user select the item.
14380     * @param data Data sent by the callback.
14381     * @return Returns the new item.
14382     */
14383    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);
14384    /**
14385     * @brief Add an object swallowed in an item at the end of the given menu
14386     * widget
14387     *
14388     * @param obj The menu object.
14389     * @param parent The parent menu item (optional)
14390     * @param subobj The object to swallow
14391     * @param func Function called when the user select the item.
14392     * @param data Data sent by the callback.
14393     * @return Returns the new item.
14394     *
14395     * Add an evas object as an item to the menu.
14396     */
14397    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);
14398    /**
14399     * @brief Set the label of a menu item
14400     *
14401     * @param item The menu item object.
14402     * @param label The label to set for @p item
14403     *
14404     * @warning Don't use this funcion on items created with
14405     * elm_menu_item_add_object() or elm_menu_item_separator_add().
14406     */
14407    EAPI void               elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
14408    /**
14409     * @brief Get the label of a menu item
14410     *
14411     * @param item The menu item object.
14412     * @return The label of @p item
14413     */
14414    EAPI const char        *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14415    /**
14416     * @brief Set the icon of a menu item to the standard icon with name @p icon
14417     *
14418     * @param item The menu item object.
14419     * @param icon The icon object to set for the content of @p item
14420     *
14421     * Once this icon is set, any previously set icon will be deleted.
14422     */
14423    EAPI void               elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
14424    /**
14425     * @brief Get the string representation from the icon of a menu item
14426     *
14427     * @param item The menu item object.
14428     * @return The string representation of @p item's icon or NULL
14429     *
14430     * @see elm_menu_item_object_icon_name_set()
14431     */
14432    EAPI const char        *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14433    /**
14434     * @brief Set the content object of a menu item
14435     *
14436     * @param item The menu item object
14437     * @param The content object or NULL
14438     * @return EINA_TRUE on success, else EINA_FALSE
14439     *
14440     * Use this function to change the object swallowed by a menu item, deleting
14441     * any previously swallowed object.
14442     */
14443    EAPI Eina_Bool          elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
14444    /**
14445     * @brief Get the content object of a menu item
14446     *
14447     * @param item The menu item object
14448     * @return The content object or NULL
14449     * @note If @p item was added with elm_menu_item_add_object, this
14450     * function will return the object passed, else it will return the
14451     * icon object.
14452     *
14453     * @see elm_menu_item_object_content_set()
14454     */
14455    EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14456    /**
14457     * @brief Set the selected state of @p item.
14458     *
14459     * @param item The menu item object.
14460     * @param selected The selected/unselected state of the item
14461     */
14462    EAPI void               elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14463    /**
14464     * @brief Get the selected state of @p item.
14465     *
14466     * @param item The menu item object.
14467     * @return The selected/unselected state of the item
14468     *
14469     * @see elm_menu_item_selected_set()
14470     */
14471    EAPI Eina_Bool          elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14472    /**
14473     * @brief Set the disabled state of @p item.
14474     *
14475     * @param item The menu item object.
14476     * @param disabled The enabled/disabled state of the item
14477     */
14478    EAPI void               elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14479    /**
14480     * @brief Get the disabled state of @p item.
14481     *
14482     * @param item The menu item object.
14483     * @return The enabled/disabled state of the item
14484     *
14485     * @see elm_menu_item_disabled_set()
14486     */
14487    EAPI Eina_Bool          elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14488    /**
14489     * @brief Add a separator item to menu @p obj under @p parent.
14490     *
14491     * @param obj The menu object
14492     * @param parent The item to add the separator under
14493     * @return The created item or NULL on failure
14494     *
14495     * This is item is a @ref Separator.
14496     */
14497    EAPI Elm_Menu_Item     *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
14498    /**
14499     * @brief Returns whether @p item is a separator.
14500     *
14501     * @param item The item to check
14502     * @return If true, @p item is a separator
14503     *
14504     * @see elm_menu_item_separator_add()
14505     */
14506    EAPI Eina_Bool          elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14507    /**
14508     * @brief Deletes an item from the menu.
14509     *
14510     * @param item The item to delete.
14511     *
14512     * @see elm_menu_item_add()
14513     */
14514    EAPI void               elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14515    /**
14516     * @brief Set the function called when a menu item is deleted.
14517     *
14518     * @param item The item to set the callback on
14519     * @param func The function called
14520     *
14521     * @see elm_menu_item_add()
14522     * @see elm_menu_item_del()
14523     */
14524    EAPI void               elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14525    /**
14526     * @brief Returns the data associated with menu item @p item.
14527     *
14528     * @param item The item
14529     * @return The data associated with @p item or NULL if none was set.
14530     *
14531     * This is the data set with elm_menu_add() or elm_menu_item_data_set().
14532     */
14533    EAPI void              *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14534    /**
14535     * @brief Sets the data to be associated with menu item @p item.
14536     *
14537     * @param item The item
14538     * @param data The data to be associated with @p item
14539     */
14540    EAPI void               elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
14541    /**
14542     * @brief Returns a list of @p item's subitems.
14543     *
14544     * @param item The item
14545     * @return An Eina_List* of @p item's subitems
14546     *
14547     * @see elm_menu_add()
14548     */
14549    EAPI const Eina_List   *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14550    /**
14551     * @brief Get the position of a menu item
14552     *
14553     * @param item The menu item
14554     * @return The item's index
14555     *
14556     * This function returns the index position of a menu item in a menu.
14557     * For a sub-menu, this number is relative to the first item in the sub-menu.
14558     *
14559     * @note Index values begin with 0
14560     */
14561    EAPI unsigned int       elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
14562    /**
14563     * @brief @brief Return a menu item's owner menu
14564     *
14565     * @param item The menu item
14566     * @return The menu object owning @p item, or NULL on failure
14567     *
14568     * Use this function to get the menu object owning an item.
14569     */
14570    EAPI Evas_Object       *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
14571    /**
14572     * @brief Get the selected item in the menu
14573     *
14574     * @param obj The menu object
14575     * @return The selected item, or NULL if none
14576     *
14577     * @see elm_menu_item_selected_get()
14578     * @see elm_menu_item_selected_set()
14579     */
14580    EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14581    /**
14582     * @brief Get the last item in the menu
14583     *
14584     * @param obj The menu object
14585     * @return The last item, or NULL if none
14586     */
14587    EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14588    /**
14589     * @brief Get the first item in the menu
14590     *
14591     * @param obj The menu object
14592     * @return The first item, or NULL if none
14593     */
14594    EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14595    /**
14596     * @brief Get the next item in the menu.
14597     *
14598     * @param item The menu item object.
14599     * @return The item after it, or NULL if none
14600     */
14601    EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14602    /**
14603     * @brief Get the previous item in the menu.
14604     *
14605     * @param item The menu item object.
14606     * @return The item before it, or NULL if none
14607     */
14608    EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14609    /**
14610     * @}
14611     */
14612
14613    /**
14614     * @defgroup List List
14615     * @ingroup Elementary
14616     *
14617     * @image html img/widget/list/preview-00.png
14618     * @image latex img/widget/list/preview-00.eps width=\textwidth
14619     *
14620     * @image html img/list.png
14621     * @image latex img/list.eps width=\textwidth
14622     *
14623     * A list widget is a container whose children are displayed vertically or
14624     * horizontally, in order, and can be selected.
14625     * The list can accept only one or multiple items selection. Also has many
14626     * modes of items displaying.
14627     *
14628     * A list is a very simple type of list widget.  For more robust
14629     * lists, @ref Genlist should probably be used.
14630     *
14631     * Smart callbacks one can listen to:
14632     * - @c "activated" - The user has double-clicked or pressed
14633     *   (enter|return|spacebar) on an item. The @c event_info parameter
14634     *   is the item that was activated.
14635     * - @c "clicked,double" - The user has double-clicked an item.
14636     *   The @c event_info parameter is the item that was double-clicked.
14637     * - "selected" - when the user selected an item
14638     * - "unselected" - when the user unselected an item
14639     * - "longpressed" - an item in the list is long-pressed
14640     * - "scroll,edge,top" - the list is scrolled until the top edge
14641     * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
14642     * - "scroll,edge,left" - the list is scrolled until the left edge
14643     * - "scroll,edge,right" - the list is scrolled until the right edge
14644     *
14645     * Available styles for it:
14646     * - @c "default"
14647     *
14648     * List of examples:
14649     * @li @ref list_example_01
14650     * @li @ref list_example_02
14651     * @li @ref list_example_03
14652     */
14653
14654    /**
14655     * @addtogroup List
14656     * @{
14657     */
14658
14659    /**
14660     * @enum _Elm_List_Mode
14661     * @typedef Elm_List_Mode
14662     *
14663     * Set list's resize behavior, transverse axis scroll and
14664     * items cropping. See each mode's description for more details.
14665     *
14666     * @note Default value is #ELM_LIST_SCROLL.
14667     *
14668     * Values <b> don't </b> work as bitmask, only one can be choosen.
14669     *
14670     * @see elm_list_mode_set()
14671     * @see elm_list_mode_get()
14672     *
14673     * @ingroup List
14674     */
14675    typedef enum _Elm_List_Mode
14676      {
14677         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. */
14678         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). */
14679         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. */
14680         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. */
14681         ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
14682      } Elm_List_Mode;
14683
14684    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().  */
14685
14686    /**
14687     * Add a new list widget to the given parent Elementary
14688     * (container) object.
14689     *
14690     * @param parent The parent object.
14691     * @return a new list widget handle or @c NULL, on errors.
14692     *
14693     * This function inserts a new list widget on the canvas.
14694     *
14695     * @ingroup List
14696     */
14697    EAPI Evas_Object     *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14698
14699    /**
14700     * Starts the list.
14701     *
14702     * @param obj The list object
14703     *
14704     * @note Call before running show() on the list object.
14705     * @warning If not called, it won't display the list properly.
14706     *
14707     * @code
14708     * li = elm_list_add(win);
14709     * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
14710     * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
14711     * elm_list_go(li);
14712     * evas_object_show(li);
14713     * @endcode
14714     *
14715     * @ingroup List
14716     */
14717    EAPI void             elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
14718
14719    /**
14720     * Enable or disable multiple items selection on the list object.
14721     *
14722     * @param obj The list object
14723     * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
14724     * disable it.
14725     *
14726     * Disabled by default. If disabled, the user can select a single item of
14727     * the list each time. Selected items are highlighted on list.
14728     * If enabled, many items can be selected.
14729     *
14730     * If a selected item is selected again, it will be unselected.
14731     *
14732     * @see elm_list_multi_select_get()
14733     *
14734     * @ingroup List
14735     */
14736    EAPI void             elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
14737
14738    /**
14739     * Get a value whether multiple items selection is enabled or not.
14740     *
14741     * @see elm_list_multi_select_set() for details.
14742     *
14743     * @param obj The list object.
14744     * @return @c EINA_TRUE means multiple items selection is enabled.
14745     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14746     * @c EINA_FALSE is returned.
14747     *
14748     * @ingroup List
14749     */
14750    EAPI Eina_Bool        elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14751
14752    /**
14753     * Set which mode to use for the list object.
14754     *
14755     * @param obj The list object
14756     * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
14757     * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
14758     *
14759     * Set list's resize behavior, transverse axis scroll and
14760     * items cropping. See each mode's description for more details.
14761     *
14762     * @note Default value is #ELM_LIST_SCROLL.
14763     *
14764     * Only one can be set, if a previous one was set, it will be changed
14765     * by the new mode set. Bitmask won't work as well.
14766     *
14767     * @see elm_list_mode_get()
14768     *
14769     * @ingroup List
14770     */
14771    EAPI void             elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
14772
14773    /**
14774     * Get the mode the list is at.
14775     *
14776     * @param obj The list object
14777     * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
14778     * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
14779     *
14780     * @note see elm_list_mode_set() for more information.
14781     *
14782     * @ingroup List
14783     */
14784    EAPI Elm_List_Mode    elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14785
14786    /**
14787     * Enable or disable horizontal mode on the list object.
14788     *
14789     * @param obj The list object.
14790     * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
14791     * disable it, i.e., to enable vertical mode.
14792     *
14793     * @note Vertical mode is set by default.
14794     *
14795     * On horizontal mode items are displayed on list from left to right,
14796     * instead of from top to bottom. Also, the list will scroll horizontally.
14797     * Each item will presents left icon on top and right icon, or end, at
14798     * the bottom.
14799     *
14800     * @see elm_list_horizontal_get()
14801     *
14802     * @ingroup List
14803     */
14804    EAPI void             elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14805
14806    /**
14807     * Get a value whether horizontal mode is enabled or not.
14808     *
14809     * @param obj The list object.
14810     * @return @c EINA_TRUE means horizontal mode selection is enabled.
14811     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14812     * @c EINA_FALSE is returned.
14813     *
14814     * @see elm_list_horizontal_set() for details.
14815     *
14816     * @ingroup List
14817     */
14818    EAPI Eina_Bool        elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14819
14820    /**
14821     * Enable or disable always select mode on the list object.
14822     *
14823     * @param obj The list object
14824     * @param always_select @c EINA_TRUE to enable always select mode or
14825     * @c EINA_FALSE to disable it.
14826     *
14827     * @note Always select mode is disabled by default.
14828     *
14829     * Default behavior of list items is to only call its callback function
14830     * the first time it's pressed, i.e., when it is selected. If a selected
14831     * item is pressed again, and multi-select is disabled, it won't call
14832     * this function (if multi-select is enabled it will unselect the item).
14833     *
14834     * If always select is enabled, it will call the callback function
14835     * everytime a item is pressed, so it will call when the item is selected,
14836     * and again when a selected item is pressed.
14837     *
14838     * @see elm_list_always_select_mode_get()
14839     * @see elm_list_multi_select_set()
14840     *
14841     * @ingroup List
14842     */
14843    EAPI void             elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14844
14845    /**
14846     * Get a value whether always select mode is enabled or not, meaning that
14847     * an item will always call its callback function, even if already selected.
14848     *
14849     * @param obj The list object
14850     * @return @c EINA_TRUE means horizontal mode selection is enabled.
14851     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14852     * @c EINA_FALSE is returned.
14853     *
14854     * @see elm_list_always_select_mode_set() for details.
14855     *
14856     * @ingroup List
14857     */
14858    EAPI Eina_Bool        elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14859
14860    /**
14861     * Set bouncing behaviour when the scrolled content reaches an edge.
14862     *
14863     * Tell the internal scroller object whether it should bounce or not
14864     * when it reaches the respective edges for each axis.
14865     *
14866     * @param obj The list object
14867     * @param h_bounce Whether to bounce or not in the horizontal axis.
14868     * @param v_bounce Whether to bounce or not in the vertical axis.
14869     *
14870     * @see elm_scroller_bounce_set()
14871     *
14872     * @ingroup List
14873     */
14874    EAPI void             elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
14875
14876    /**
14877     * Get the bouncing behaviour of the internal scroller.
14878     *
14879     * Get whether the internal scroller should bounce when the edge of each
14880     * axis is reached scrolling.
14881     *
14882     * @param obj The list object.
14883     * @param h_bounce Pointer where to store the bounce state of the horizontal
14884     * axis.
14885     * @param v_bounce Pointer where to store the bounce state of the vertical
14886     * axis.
14887     *
14888     * @see elm_scroller_bounce_get()
14889     * @see elm_list_bounce_set()
14890     *
14891     * @ingroup List
14892     */
14893    EAPI void             elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
14894
14895    /**
14896     * Set the scrollbar policy.
14897     *
14898     * @param obj The list object
14899     * @param policy_h Horizontal scrollbar policy.
14900     * @param policy_v Vertical scrollbar policy.
14901     *
14902     * This sets the scrollbar visibility policy for the given scroller.
14903     * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
14904     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
14905     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
14906     * This applies respectively for the horizontal and vertical scrollbars.
14907     *
14908     * The both are disabled by default, i.e., are set to
14909     * #ELM_SCROLLER_POLICY_OFF.
14910     *
14911     * @ingroup List
14912     */
14913    EAPI void             elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
14914
14915    /**
14916     * Get the scrollbar policy.
14917     *
14918     * @see elm_list_scroller_policy_get() for details.
14919     *
14920     * @param obj The list object.
14921     * @param policy_h Pointer where to store horizontal scrollbar policy.
14922     * @param policy_v Pointer where to store vertical scrollbar policy.
14923     *
14924     * @ingroup List
14925     */
14926    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);
14927
14928    /**
14929     * Append a new item to the list object.
14930     *
14931     * @param obj The list object.
14932     * @param label The label of the list item.
14933     * @param icon The icon object to use for the left side of the item. An
14934     * icon can be any Evas object, but usually it is an icon created
14935     * with elm_icon_add().
14936     * @param end The icon object to use for the right side of the item. An
14937     * icon can be any Evas object.
14938     * @param func The function to call when the item is clicked.
14939     * @param data The data to associate with the item for related callbacks.
14940     *
14941     * @return The created item or @c NULL upon failure.
14942     *
14943     * A new item will be created and appended to the list, i.e., will
14944     * be set as @b last item.
14945     *
14946     * Items created with this method can be deleted with
14947     * elm_list_item_del().
14948     *
14949     * Associated @p data can be properly freed when item is deleted if a
14950     * callback function is set with elm_list_item_del_cb_set().
14951     *
14952     * If a function is passed as argument, it will be called everytime this item
14953     * is selected, i.e., the user clicks over an unselected item.
14954     * If always select is enabled it will call this function every time
14955     * user clicks over an item (already selected or not).
14956     * If such function isn't needed, just passing
14957     * @c NULL as @p func is enough. The same should be done for @p data.
14958     *
14959     * Simple example (with no function callback or data associated):
14960     * @code
14961     * li = elm_list_add(win);
14962     * ic = elm_icon_add(win);
14963     * elm_icon_file_set(ic, "path/to/image", NULL);
14964     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
14965     * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
14966     * elm_list_go(li);
14967     * evas_object_show(li);
14968     * @endcode
14969     *
14970     * @see elm_list_always_select_mode_set()
14971     * @see elm_list_item_del()
14972     * @see elm_list_item_del_cb_set()
14973     * @see elm_list_clear()
14974     * @see elm_icon_add()
14975     *
14976     * @ingroup List
14977     */
14978    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);
14979
14980    /**
14981     * Prepend a new item to the list object.
14982     *
14983     * @param obj The list object.
14984     * @param label The label of the list item.
14985     * @param icon The icon object to use for the left side of the item. An
14986     * icon can be any Evas object, but usually it is an icon created
14987     * with elm_icon_add().
14988     * @param end The icon object to use for the right side of the item. An
14989     * icon can be any Evas object.
14990     * @param func The function to call when the item is clicked.
14991     * @param data The data to associate with the item for related callbacks.
14992     *
14993     * @return The created item or @c NULL upon failure.
14994     *
14995     * A new item will be created and prepended to the list, i.e., will
14996     * be set as @b first item.
14997     *
14998     * Items created with this method can be deleted with
14999     * elm_list_item_del().
15000     *
15001     * Associated @p data can be properly freed when item is deleted if a
15002     * callback function is set with elm_list_item_del_cb_set().
15003     *
15004     * If a function is passed as argument, it will be called everytime this item
15005     * is selected, i.e., the user clicks over an unselected item.
15006     * If always select is enabled it will call this function every time
15007     * user clicks over an item (already selected or not).
15008     * If such function isn't needed, just passing
15009     * @c NULL as @p func is enough. The same should be done for @p data.
15010     *
15011     * @see elm_list_item_append() for a simple code example.
15012     * @see elm_list_always_select_mode_set()
15013     * @see elm_list_item_del()
15014     * @see elm_list_item_del_cb_set()
15015     * @see elm_list_clear()
15016     * @see elm_icon_add()
15017     *
15018     * @ingroup List
15019     */
15020    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);
15021
15022    /**
15023     * Insert a new item into the list object before item @p before.
15024     *
15025     * @param obj The list object.
15026     * @param before The list item to insert before.
15027     * @param label The label of the list item.
15028     * @param icon The icon object to use for the left side of the item. An
15029     * icon can be any Evas object, but usually it is an icon created
15030     * with elm_icon_add().
15031     * @param end The icon object to use for the right side of the item. An
15032     * icon can be any Evas object.
15033     * @param func The function to call when the item is clicked.
15034     * @param data The data to associate with the item for related callbacks.
15035     *
15036     * @return The created item or @c NULL upon failure.
15037     *
15038     * A new item will be created and added to the list. Its position in
15039     * this list will be just before item @p before.
15040     *
15041     * Items created with this method can be deleted with
15042     * elm_list_item_del().
15043     *
15044     * Associated @p data can be properly freed when item is deleted if a
15045     * callback function is set with elm_list_item_del_cb_set().
15046     *
15047     * If a function is passed as argument, it will be called everytime this item
15048     * is selected, i.e., the user clicks over an unselected item.
15049     * If always select is enabled it will call this function every time
15050     * user clicks over an item (already selected or not).
15051     * If such function isn't needed, just passing
15052     * @c NULL as @p func is enough. The same should be done for @p data.
15053     *
15054     * @see elm_list_item_append() for a simple code example.
15055     * @see elm_list_always_select_mode_set()
15056     * @see elm_list_item_del()
15057     * @see elm_list_item_del_cb_set()
15058     * @see elm_list_clear()
15059     * @see elm_icon_add()
15060     *
15061     * @ingroup List
15062     */
15063    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);
15064
15065    /**
15066     * Insert a new item into the list object after item @p after.
15067     *
15068     * @param obj The list object.
15069     * @param after The list item to insert after.
15070     * @param label The label of the list item.
15071     * @param icon The icon object to use for the left side of the item. An
15072     * icon can be any Evas object, but usually it is an icon created
15073     * with elm_icon_add().
15074     * @param end The icon object to use for the right side of the item. An
15075     * icon can be any Evas object.
15076     * @param func The function to call when the item is clicked.
15077     * @param data The data to associate with the item for related callbacks.
15078     *
15079     * @return The created item or @c NULL upon failure.
15080     *
15081     * A new item will be created and added to the list. Its position in
15082     * this list will be just after item @p after.
15083     *
15084     * Items created with this method can be deleted with
15085     * elm_list_item_del().
15086     *
15087     * Associated @p data can be properly freed when item is deleted if a
15088     * callback function is set with elm_list_item_del_cb_set().
15089     *
15090     * If a function is passed as argument, it will be called everytime this item
15091     * is selected, i.e., the user clicks over an unselected item.
15092     * If always select is enabled it will call this function every time
15093     * user clicks over an item (already selected or not).
15094     * If such function isn't needed, just passing
15095     * @c NULL as @p func is enough. The same should be done for @p data.
15096     *
15097     * @see elm_list_item_append() for a simple code example.
15098     * @see elm_list_always_select_mode_set()
15099     * @see elm_list_item_del()
15100     * @see elm_list_item_del_cb_set()
15101     * @see elm_list_clear()
15102     * @see elm_icon_add()
15103     *
15104     * @ingroup List
15105     */
15106    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);
15107
15108    /**
15109     * Insert a new item into the sorted list object.
15110     *
15111     * @param obj The list object.
15112     * @param label The label of the list item.
15113     * @param icon The icon object to use for the left side of the item. An
15114     * icon can be any Evas object, but usually it is an icon created
15115     * with elm_icon_add().
15116     * @param end The icon object to use for the right side of the item. An
15117     * icon can be any Evas object.
15118     * @param func The function to call when the item is clicked.
15119     * @param data The data to associate with the item for related callbacks.
15120     * @param cmp_func The comparing function to be used to sort list
15121     * items <b>by #Elm_List_Item item handles</b>. This function will
15122     * receive two items and compare them, returning a non-negative integer
15123     * if the second item should be place after the first, or negative value
15124     * if should be placed before.
15125     *
15126     * @return The created item or @c NULL upon failure.
15127     *
15128     * @note This function inserts values into a list object assuming it was
15129     * sorted and the result will be sorted.
15130     *
15131     * A new item will be created and added to the list. Its position in
15132     * this list will be found comparing the new item with previously inserted
15133     * items using function @p cmp_func.
15134     *
15135     * Items created with this method can be deleted with
15136     * elm_list_item_del().
15137     *
15138     * Associated @p data can be properly freed when item is deleted if a
15139     * callback function is set with elm_list_item_del_cb_set().
15140     *
15141     * If a function is passed as argument, it will be called everytime this item
15142     * is selected, i.e., the user clicks over an unselected item.
15143     * If always select is enabled it will call this function every time
15144     * user clicks over an item (already selected or not).
15145     * If such function isn't needed, just passing
15146     * @c NULL as @p func is enough. The same should be done for @p data.
15147     *
15148     * @see elm_list_item_append() for a simple code example.
15149     * @see elm_list_always_select_mode_set()
15150     * @see elm_list_item_del()
15151     * @see elm_list_item_del_cb_set()
15152     * @see elm_list_clear()
15153     * @see elm_icon_add()
15154     *
15155     * @ingroup List
15156     */
15157    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);
15158
15159    /**
15160     * Remove all list's items.
15161     *
15162     * @param obj The list object
15163     *
15164     * @see elm_list_item_del()
15165     * @see elm_list_item_append()
15166     *
15167     * @ingroup List
15168     */
15169    EAPI void             elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
15170
15171    /**
15172     * Get a list of all the list items.
15173     *
15174     * @param obj The list object
15175     * @return An @c Eina_List of list items, #Elm_List_Item,
15176     * or @c NULL on failure.
15177     *
15178     * @see elm_list_item_append()
15179     * @see elm_list_item_del()
15180     * @see elm_list_clear()
15181     *
15182     * @ingroup List
15183     */
15184    EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15185
15186    /**
15187     * Get the selected item.
15188     *
15189     * @param obj The list object.
15190     * @return The selected list item.
15191     *
15192     * The selected item can be unselected with function
15193     * elm_list_item_selected_set().
15194     *
15195     * The selected item always will be highlighted on list.
15196     *
15197     * @see elm_list_selected_items_get()
15198     *
15199     * @ingroup List
15200     */
15201    EAPI Elm_List_Item   *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15202
15203    /**
15204     * Return a list of the currently selected list items.
15205     *
15206     * @param obj The list object.
15207     * @return An @c Eina_List of list items, #Elm_List_Item,
15208     * or @c NULL on failure.
15209     *
15210     * Multiple items can be selected if multi select is enabled. It can be
15211     * done with elm_list_multi_select_set().
15212     *
15213     * @see elm_list_selected_item_get()
15214     * @see elm_list_multi_select_set()
15215     *
15216     * @ingroup List
15217     */
15218    EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15219
15220    /**
15221     * Set the selected state of an item.
15222     *
15223     * @param item The list item
15224     * @param selected The selected state
15225     *
15226     * This sets the selected state of the given item @p it.
15227     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
15228     *
15229     * If a new item is selected the previosly selected will be unselected,
15230     * unless multiple selection is enabled with elm_list_multi_select_set().
15231     * Previoulsy selected item can be get with function
15232     * elm_list_selected_item_get().
15233     *
15234     * Selected items will be highlighted.
15235     *
15236     * @see elm_list_item_selected_get()
15237     * @see elm_list_selected_item_get()
15238     * @see elm_list_multi_select_set()
15239     *
15240     * @ingroup List
15241     */
15242    EAPI void             elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15243
15244    /*
15245     * Get whether the @p item is selected or not.
15246     *
15247     * @param item The list item.
15248     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
15249     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
15250     *
15251     * @see elm_list_selected_item_set() for details.
15252     * @see elm_list_item_selected_get()
15253     *
15254     * @ingroup List
15255     */
15256    EAPI Eina_Bool        elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15257
15258    /**
15259     * Set or unset item as a separator.
15260     *
15261     * @param it The list item.
15262     * @param setting @c EINA_TRUE to set item @p it as separator or
15263     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15264     *
15265     * Items aren't set as separator by default.
15266     *
15267     * If set as separator it will display separator theme, so won't display
15268     * icons or label.
15269     *
15270     * @see elm_list_item_separator_get()
15271     *
15272     * @ingroup List
15273     */
15274    EAPI void             elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
15275
15276    /**
15277     * Get a value whether item is a separator or not.
15278     *
15279     * @see elm_list_item_separator_set() for details.
15280     *
15281     * @param it The list item.
15282     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15283     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15284     *
15285     * @ingroup List
15286     */
15287    EAPI Eina_Bool        elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15288
15289    /**
15290     * Show @p item in the list view.
15291     *
15292     * @param item The list item to be shown.
15293     *
15294     * It won't animate list until item is visible. If such behavior is wanted,
15295     * use elm_list_bring_in() intead.
15296     *
15297     * @ingroup List
15298     */
15299    EAPI void             elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15300
15301    /**
15302     * Bring in the given item to list view.
15303     *
15304     * @param item The item.
15305     *
15306     * This causes list to jump to the given item @p item and show it
15307     * (by scrolling), if it is not fully visible.
15308     *
15309     * This may use animation to do so and take a period of time.
15310     *
15311     * If animation isn't wanted, elm_list_item_show() can be used.
15312     *
15313     * @ingroup List
15314     */
15315    EAPI void             elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15316
15317    /**
15318     * Delete them item from the list.
15319     *
15320     * @param item The item of list to be deleted.
15321     *
15322     * If deleting all list items is required, elm_list_clear()
15323     * should be used instead of getting items list and deleting each one.
15324     *
15325     * @see elm_list_clear()
15326     * @see elm_list_item_append()
15327     * @see elm_list_item_del_cb_set()
15328     *
15329     * @ingroup List
15330     */
15331    EAPI void             elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15332
15333    /**
15334     * Set the function called when a list item is freed.
15335     *
15336     * @param item The item to set the callback on
15337     * @param func The function called
15338     *
15339     * If there is a @p func, then it will be called prior item's memory release.
15340     * That will be called with the following arguments:
15341     * @li item's data;
15342     * @li item's Evas object;
15343     * @li item itself;
15344     *
15345     * This way, a data associated to a list item could be properly freed.
15346     *
15347     * @ingroup List
15348     */
15349    EAPI void             elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15350
15351    /**
15352     * Get the data associated to the item.
15353     *
15354     * @param item The list item
15355     * @return The data associated to @p item
15356     *
15357     * The return value is a pointer to data associated to @p item when it was
15358     * created, with function elm_list_item_append() or similar. If no data
15359     * was passed as argument, it will return @c NULL.
15360     *
15361     * @see elm_list_item_append()
15362     *
15363     * @ingroup List
15364     */
15365    EAPI void            *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15366
15367    /**
15368     * Get the left side icon associated to the item.
15369     *
15370     * @param item The list item
15371     * @return The left side icon associated to @p item
15372     *
15373     * The return value is a pointer to the icon associated to @p item when
15374     * it was
15375     * created, with function elm_list_item_append() or similar, or later
15376     * with function elm_list_item_icon_set(). If no icon
15377     * was passed as argument, it will return @c NULL.
15378     *
15379     * @see elm_list_item_append()
15380     * @see elm_list_item_icon_set()
15381     *
15382     * @ingroup List
15383     */
15384    EAPI Evas_Object     *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15385
15386    /**
15387     * Set the left side icon associated to the item.
15388     *
15389     * @param item The list item
15390     * @param icon The left side icon object to associate with @p item
15391     *
15392     * The icon object to use at left side of the item. An
15393     * icon can be any Evas object, but usually it is an icon created
15394     * with elm_icon_add().
15395     *
15396     * Once the icon object is set, a previously set one will be deleted.
15397     * @warning Setting the same icon for two items will cause the icon to
15398     * dissapear from the first item.
15399     *
15400     * If an icon was passed as argument on item creation, with function
15401     * elm_list_item_append() or similar, it will be already
15402     * associated to the item.
15403     *
15404     * @see elm_list_item_append()
15405     * @see elm_list_item_icon_get()
15406     *
15407     * @ingroup List
15408     */
15409    EAPI void             elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
15410
15411    /**
15412     * Get the right side icon associated to the item.
15413     *
15414     * @param item The list item
15415     * @return The right side icon associated to @p item
15416     *
15417     * The return value is a pointer to the icon associated to @p item when
15418     * it was
15419     * created, with function elm_list_item_append() or similar, or later
15420     * with function elm_list_item_icon_set(). If no icon
15421     * was passed as argument, it will return @c NULL.
15422     *
15423     * @see elm_list_item_append()
15424     * @see elm_list_item_icon_set()
15425     *
15426     * @ingroup List
15427     */
15428    EAPI Evas_Object     *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15429
15430    /**
15431     * Set the right side icon associated to the item.
15432     *
15433     * @param item The list item
15434     * @param end The right side icon object to associate with @p item
15435     *
15436     * The icon object to use at right side of the item. An
15437     * icon can be any Evas object, but usually it is an icon created
15438     * with elm_icon_add().
15439     *
15440     * Once the icon object is set, a previously set one will be deleted.
15441     * @warning Setting the same icon for two items will cause the icon to
15442     * dissapear from the first item.
15443     *
15444     * If an icon was passed as argument on item creation, with function
15445     * elm_list_item_append() or similar, it will be already
15446     * associated to the item.
15447     *
15448     * @see elm_list_item_append()
15449     * @see elm_list_item_end_get()
15450     *
15451     * @ingroup List
15452     */
15453    EAPI void             elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
15454
15455    /**
15456     * Gets the base object of the item.
15457     *
15458     * @param item The list item
15459     * @return The base object associated with @p item
15460     *
15461     * Base object is the @c Evas_Object that represents that item.
15462     *
15463     * @ingroup List
15464     */
15465    EAPI Evas_Object     *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15466    EINA_DEPRECATED EAPI Evas_Object     *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15467
15468    /**
15469     * Get the label of item.
15470     *
15471     * @param item The item of list.
15472     * @return The label of item.
15473     *
15474     * The return value is a pointer to the label associated to @p item when
15475     * it was created, with function elm_list_item_append(), or later
15476     * with function elm_list_item_label_set. If no label
15477     * was passed as argument, it will return @c NULL.
15478     *
15479     * @see elm_list_item_label_set() for more details.
15480     * @see elm_list_item_append()
15481     *
15482     * @ingroup List
15483     */
15484    EAPI const char      *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15485
15486    /**
15487     * Set the label of item.
15488     *
15489     * @param item The item of list.
15490     * @param text The label of item.
15491     *
15492     * The label to be displayed by the item.
15493     * Label will be placed between left and right side icons (if set).
15494     *
15495     * If a label was passed as argument on item creation, with function
15496     * elm_list_item_append() or similar, it will be already
15497     * displayed by the item.
15498     *
15499     * @see elm_list_item_label_get()
15500     * @see elm_list_item_append()
15501     *
15502     * @ingroup List
15503     */
15504    EAPI void             elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
15505
15506
15507    /**
15508     * Get the item before @p it in list.
15509     *
15510     * @param it The list item.
15511     * @return The item before @p it, or @c NULL if none or on failure.
15512     *
15513     * @note If it is the first item, @c NULL will be returned.
15514     *
15515     * @see elm_list_item_append()
15516     * @see elm_list_items_get()
15517     *
15518     * @ingroup List
15519     */
15520    EAPI Elm_List_Item   *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15521
15522    /**
15523     * Get the item after @p it in list.
15524     *
15525     * @param it The list item.
15526     * @return The item after @p it, or @c NULL if none or on failure.
15527     *
15528     * @note If it is the last item, @c NULL will be returned.
15529     *
15530     * @see elm_list_item_append()
15531     * @see elm_list_items_get()
15532     *
15533     * @ingroup List
15534     */
15535    EAPI Elm_List_Item   *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15536
15537    /**
15538     * Sets the disabled/enabled state of a list item.
15539     *
15540     * @param it The item.
15541     * @param disabled The disabled state.
15542     *
15543     * A disabled item cannot be selected or unselected. It will also
15544     * change its appearance (generally greyed out). This sets the
15545     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15546     * enabled).
15547     *
15548     * @ingroup List
15549     */
15550    EAPI void             elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15551
15552    /**
15553     * Get a value whether list item is disabled or not.
15554     *
15555     * @param it The item.
15556     * @return The disabled state.
15557     *
15558     * @see elm_list_item_disabled_set() for more details.
15559     *
15560     * @ingroup List
15561     */
15562    EAPI Eina_Bool        elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15563
15564    /**
15565     * Set the text to be shown in a given list item's tooltips.
15566     *
15567     * @param item Target item.
15568     * @param text The text to set in the content.
15569     *
15570     * Setup the text as tooltip to object. The item can have only one tooltip,
15571     * so any previous tooltip data - set with this function or
15572     * elm_list_item_tooltip_content_cb_set() - is removed.
15573     *
15574     * @see elm_object_tooltip_text_set() for more details.
15575     *
15576     * @ingroup List
15577     */
15578    EAPI void             elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
15579
15580
15581    /**
15582     * @brief Disable size restrictions on an object's tooltip
15583     * @param item The tooltip's anchor object
15584     * @param disable If EINA_TRUE, size restrictions are disabled
15585     * @return EINA_FALSE on failure, EINA_TRUE on success
15586     *
15587     * This function allows a tooltip to expand beyond its parant window's canvas.
15588     * It will instead be limited only by the size of the display.
15589     */
15590    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
15591    /**
15592     * @brief Retrieve size restriction state of an object's tooltip
15593     * @param obj The tooltip's anchor object
15594     * @return If EINA_TRUE, size restrictions are disabled
15595     *
15596     * This function returns whether a tooltip is allowed to expand beyond
15597     * its parant window's canvas.
15598     * It will instead be limited only by the size of the display.
15599     */
15600    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15601
15602    /**
15603     * Set the content to be shown in the tooltip item.
15604     *
15605     * Setup the tooltip to item. The item can have only one tooltip,
15606     * so any previous tooltip data is removed. @p func(with @p data) will
15607     * be called every time that need show the tooltip and it should
15608     * return a valid Evas_Object. This object is then managed fully by
15609     * tooltip system and is deleted when the tooltip is gone.
15610     *
15611     * @param item the list item being attached a tooltip.
15612     * @param func the function used to create the tooltip contents.
15613     * @param data what to provide to @a func as callback data/context.
15614     * @param del_cb called when data is not needed anymore, either when
15615     *        another callback replaces @a func, the tooltip is unset with
15616     *        elm_list_item_tooltip_unset() or the owner @a item
15617     *        dies. This callback receives as the first parameter the
15618     *        given @a data, and @c event_info is the item.
15619     *
15620     * @see elm_object_tooltip_content_cb_set() for more details.
15621     *
15622     * @ingroup List
15623     */
15624    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);
15625
15626    /**
15627     * Unset tooltip from item.
15628     *
15629     * @param item list item to remove previously set tooltip.
15630     *
15631     * Remove tooltip from item. The callback provided as del_cb to
15632     * elm_list_item_tooltip_content_cb_set() will be called to notify
15633     * it is not used anymore.
15634     *
15635     * @see elm_object_tooltip_unset() for more details.
15636     * @see elm_list_item_tooltip_content_cb_set()
15637     *
15638     * @ingroup List
15639     */
15640    EAPI void             elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15641
15642    /**
15643     * Sets a different style for this item tooltip.
15644     *
15645     * @note before you set a style you should define a tooltip with
15646     *       elm_list_item_tooltip_content_cb_set() or
15647     *       elm_list_item_tooltip_text_set()
15648     *
15649     * @param item list item with tooltip already set.
15650     * @param style the theme style to use (default, transparent, ...)
15651     *
15652     * @see elm_object_tooltip_style_set() for more details.
15653     *
15654     * @ingroup List
15655     */
15656    EAPI void             elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
15657
15658    /**
15659     * Get the style for this item tooltip.
15660     *
15661     * @param item list item with tooltip already set.
15662     * @return style the theme style in use, defaults to "default". If the
15663     *         object does not have a tooltip set, then NULL is returned.
15664     *
15665     * @see elm_object_tooltip_style_get() for more details.
15666     * @see elm_list_item_tooltip_style_set()
15667     *
15668     * @ingroup List
15669     */
15670    EAPI const char      *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15671
15672    /**
15673     * Set the type of mouse pointer/cursor decoration to be shown,
15674     * when the mouse pointer is over the given list widget item
15675     *
15676     * @param item list item to customize cursor on
15677     * @param cursor the cursor type's name
15678     *
15679     * This function works analogously as elm_object_cursor_set(), but
15680     * here the cursor's changing area is restricted to the item's
15681     * area, and not the whole widget's. Note that that item cursors
15682     * have precedence over widget cursors, so that a mouse over an
15683     * item with custom cursor set will always show @b that cursor.
15684     *
15685     * If this function is called twice for an object, a previously set
15686     * cursor will be unset on the second call.
15687     *
15688     * @see elm_object_cursor_set()
15689     * @see elm_list_item_cursor_get()
15690     * @see elm_list_item_cursor_unset()
15691     *
15692     * @ingroup List
15693     */
15694    EAPI void             elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15695
15696    /*
15697     * Get the type of mouse pointer/cursor decoration set to be shown,
15698     * when the mouse pointer is over the given list widget item
15699     *
15700     * @param item list item with custom cursor set
15701     * @return the cursor type's name or @c NULL, if no custom cursors
15702     * were set to @p item (and on errors)
15703     *
15704     * @see elm_object_cursor_get()
15705     * @see elm_list_item_cursor_set()
15706     * @see elm_list_item_cursor_unset()
15707     *
15708     * @ingroup List
15709     */
15710    EAPI const char      *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15711
15712    /**
15713     * Unset any custom mouse pointer/cursor decoration set to be
15714     * shown, when the mouse pointer is over the given list widget
15715     * item, thus making it show the @b default cursor again.
15716     *
15717     * @param item a list item
15718     *
15719     * Use this call to undo any custom settings on this item's cursor
15720     * decoration, bringing it back to defaults (no custom style set).
15721     *
15722     * @see elm_object_cursor_unset()
15723     * @see elm_list_item_cursor_set()
15724     *
15725     * @ingroup List
15726     */
15727    EAPI void             elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15728
15729    /**
15730     * Set a different @b style for a given custom cursor set for a
15731     * list item.
15732     *
15733     * @param item list item with custom cursor set
15734     * @param style the <b>theme style</b> to use (e.g. @c "default",
15735     * @c "transparent", etc)
15736     *
15737     * This function only makes sense when one is using custom mouse
15738     * cursor decorations <b>defined in a theme file</b>, which can have,
15739     * given a cursor name/type, <b>alternate styles</b> on it. It
15740     * works analogously as elm_object_cursor_style_set(), but here
15741     * applyed only to list item objects.
15742     *
15743     * @warning Before you set a cursor style you should have definen a
15744     *       custom cursor previously on the item, with
15745     *       elm_list_item_cursor_set()
15746     *
15747     * @see elm_list_item_cursor_engine_only_set()
15748     * @see elm_list_item_cursor_style_get()
15749     *
15750     * @ingroup List
15751     */
15752    EAPI void             elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
15753
15754    /**
15755     * Get the current @b style set for a given list item's custom
15756     * cursor
15757     *
15758     * @param item list item with custom cursor set.
15759     * @return style the cursor style in use. If the object does not
15760     *         have a cursor set, then @c NULL is returned.
15761     *
15762     * @see elm_list_item_cursor_style_set() for more details
15763     *
15764     * @ingroup List
15765     */
15766    EAPI const char      *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15767
15768    /**
15769     * Set if the (custom)cursor for a given list item should be
15770     * searched in its theme, also, or should only rely on the
15771     * rendering engine.
15772     *
15773     * @param item item with custom (custom) cursor already set on
15774     * @param engine_only Use @c EINA_TRUE to have cursors looked for
15775     * only on those provided by the rendering engine, @c EINA_FALSE to
15776     * have them searched on the widget's theme, as well.
15777     *
15778     * @note This call is of use only if you've set a custom cursor
15779     * for list items, with elm_list_item_cursor_set().
15780     *
15781     * @note By default, cursors will only be looked for between those
15782     * provided by the rendering engine.
15783     *
15784     * @ingroup List
15785     */
15786    EAPI void             elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15787
15788    /**
15789     * Get if the (custom) cursor for a given list item is being
15790     * searched in its theme, also, or is only relying on the rendering
15791     * engine.
15792     *
15793     * @param item a list item
15794     * @return @c EINA_TRUE, if cursors are being looked for only on
15795     * those provided by the rendering engine, @c EINA_FALSE if they
15796     * are being searched on the widget's theme, as well.
15797     *
15798     * @see elm_list_item_cursor_engine_only_set(), for more details
15799     *
15800     * @ingroup List
15801     */
15802    EAPI Eina_Bool        elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15803
15804    /**
15805     * @}
15806     */
15807
15808    /**
15809     * @defgroup Slider Slider
15810     * @ingroup Elementary
15811     *
15812     * @image html img/widget/slider/preview-00.png
15813     * @image latex img/widget/slider/preview-00.eps width=\textwidth
15814     *
15815     * The slider adds a dragable “slider” widget for selecting the value of
15816     * something within a range.
15817     *
15818     * A slider can be horizontal or vertical. It can contain an Icon and has a
15819     * primary label as well as a units label (that is formatted with floating
15820     * point values and thus accepts a printf-style format string, like
15821     * “%1.2f units”. There is also an indicator string that may be somewhere
15822     * else (like on the slider itself) that also accepts a format string like
15823     * units. Label, Icon Unit and Indicator strings/objects are optional.
15824     *
15825     * A slider may be inverted which means values invert, with high vales being
15826     * on the left or top and low values on the right or bottom (as opposed to
15827     * normally being low on the left or top and high on the bottom and right).
15828     *
15829     * The slider should have its minimum and maximum values set by the
15830     * application with  elm_slider_min_max_set() and value should also be set by
15831     * the application before use with  elm_slider_value_set(). The span of the
15832     * slider is its length (horizontally or vertically). This will be scaled by
15833     * the object or applications scaling factor. At any point code can query the
15834     * slider for its value with elm_slider_value_get().
15835     *
15836     * Smart callbacks one can listen to:
15837     * - "changed" - Whenever the slider value is changed by the user.
15838     * - "slider,drag,start" - dragging the slider indicator around has started.
15839     * - "slider,drag,stop" - dragging the slider indicator around has stopped.
15840     * - "delay,changed" - A short time after the value is changed by the user.
15841     * This will be called only when the user stops dragging for
15842     * a very short period or when they release their
15843     * finger/mouse, so it avoids possibly expensive reactions to
15844     * the value change.
15845     *
15846     * Available styles for it:
15847     * - @c "default"
15848     *
15849     * Here is an example on its usage:
15850     * @li @ref slider_example
15851     */
15852
15853    /**
15854     * @addtogroup Slider
15855     * @{
15856     */
15857
15858    /**
15859     * Add a new slider widget to the given parent Elementary
15860     * (container) object.
15861     *
15862     * @param parent The parent object.
15863     * @return a new slider widget handle or @c NULL, on errors.
15864     *
15865     * This function inserts a new slider widget on the canvas.
15866     *
15867     * @ingroup Slider
15868     */
15869    EAPI Evas_Object       *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15870
15871    /**
15872     * Set the label of a given slider widget
15873     *
15874     * @param obj The progress bar object
15875     * @param label The text label string, in UTF-8
15876     *
15877     * @ingroup Slider
15878     * @deprecated use elm_object_text_set() instead.
15879     */
15880    EINA_DEPRECATED EAPI void               elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15881
15882    /**
15883     * Get the label of a given slider widget
15884     *
15885     * @param obj The progressbar object
15886     * @return The text label string, in UTF-8
15887     *
15888     * @ingroup Slider
15889     * @deprecated use elm_object_text_get() instead.
15890     */
15891    EINA_DEPRECATED EAPI const char        *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15892
15893    /**
15894     * Set the icon object of the slider object.
15895     *
15896     * @param obj The slider object.
15897     * @param icon The icon object.
15898     *
15899     * On horizontal mode, icon is placed at left, and on vertical mode,
15900     * placed at top.
15901     *
15902     * @note Once the icon object is set, a previously set one will be deleted.
15903     * If you want to keep that old content object, use the
15904     * elm_slider_icon_unset() function.
15905     *
15906     * @warning If the object being set does not have minimum size hints set,
15907     * it won't get properly displayed.
15908     *
15909     * @ingroup Slider
15910     */
15911    EAPI void               elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
15912
15913    /**
15914     * Unset an icon set on a given slider widget.
15915     *
15916     * @param obj The slider object.
15917     * @return The icon object that was being used, if any was set, or
15918     * @c NULL, otherwise (and on errors).
15919     *
15920     * On horizontal mode, icon is placed at left, and on vertical mode,
15921     * placed at top.
15922     *
15923     * This call will unparent and return the icon object which was set
15924     * for this widget, previously, on success.
15925     *
15926     * @see elm_slider_icon_set() for more details
15927     * @see elm_slider_icon_get()
15928     *
15929     * @ingroup Slider
15930     */
15931    EAPI Evas_Object       *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15932
15933    /**
15934     * Retrieve the icon object set for a given slider widget.
15935     *
15936     * @param obj The slider object.
15937     * @return The icon object's handle, if @p obj had one set, or @c NULL,
15938     * otherwise (and on errors).
15939     *
15940     * On horizontal mode, icon is placed at left, and on vertical mode,
15941     * placed at top.
15942     *
15943     * @see elm_slider_icon_set() for more details
15944     * @see elm_slider_icon_unset()
15945     *
15946     * @ingroup Slider
15947     */
15948    EAPI Evas_Object       *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15949
15950    /**
15951     * Set the end object of the slider object.
15952     *
15953     * @param obj The slider object.
15954     * @param end The end object.
15955     *
15956     * On horizontal mode, end is placed at left, and on vertical mode,
15957     * placed at bottom.
15958     *
15959     * @note Once the icon object is set, a previously set one will be deleted.
15960     * If you want to keep that old content object, use the
15961     * elm_slider_end_unset() function.
15962     *
15963     * @warning If the object being set does not have minimum size hints set,
15964     * it won't get properly displayed.
15965     *
15966     * @ingroup Slider
15967     */
15968    EAPI void               elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
15969
15970    /**
15971     * Unset an end object set on a given slider widget.
15972     *
15973     * @param obj The slider object.
15974     * @return The end object that was being used, if any was set, or
15975     * @c NULL, otherwise (and on errors).
15976     *
15977     * On horizontal mode, end is placed at left, and on vertical mode,
15978     * placed at bottom.
15979     *
15980     * This call will unparent and return the icon object which was set
15981     * for this widget, previously, on success.
15982     *
15983     * @see elm_slider_end_set() for more details.
15984     * @see elm_slider_end_get()
15985     *
15986     * @ingroup Slider
15987     */
15988    EAPI Evas_Object       *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15989
15990    /**
15991     * Retrieve the end object set for a given slider widget.
15992     *
15993     * @param obj The slider object.
15994     * @return The end object's handle, if @p obj had one set, or @c NULL,
15995     * otherwise (and on errors).
15996     *
15997     * On horizontal mode, icon is placed at right, and on vertical mode,
15998     * placed at bottom.
15999     *
16000     * @see elm_slider_end_set() for more details.
16001     * @see elm_slider_end_unset()
16002     *
16003     * @ingroup Slider
16004     */
16005    EAPI Evas_Object       *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16006
16007    /**
16008     * Set the (exact) length of the bar region of a given slider widget.
16009     *
16010     * @param obj The slider object.
16011     * @param size The length of the slider's bar region.
16012     *
16013     * This sets the minimum width (when in horizontal mode) or height
16014     * (when in vertical mode) of the actual bar area of the slider
16015     * @p obj. This in turn affects the object's minimum size. Use
16016     * this when you're not setting other size hints expanding on the
16017     * given direction (like weight and alignment hints) and you would
16018     * like it to have a specific size.
16019     *
16020     * @note Icon, end, label, indicator and unit text around @p obj
16021     * will require their
16022     * own space, which will make @p obj to require more the @p size,
16023     * actually.
16024     *
16025     * @see elm_slider_span_size_get()
16026     *
16027     * @ingroup Slider
16028     */
16029    EAPI void               elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
16030
16031    /**
16032     * Get the length set for the bar region of a given slider widget
16033     *
16034     * @param obj The slider object.
16035     * @return The length of the slider's bar region.
16036     *
16037     * If that size was not set previously, with
16038     * elm_slider_span_size_set(), this call will return @c 0.
16039     *
16040     * @ingroup Slider
16041     */
16042    EAPI Evas_Coord         elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16043
16044    /**
16045     * Set the format string for the unit label.
16046     *
16047     * @param obj The slider object.
16048     * @param format The format string for the unit display.
16049     *
16050     * Unit label is displayed all the time, if set, after slider's bar.
16051     * In horizontal mode, at right and in vertical mode, at bottom.
16052     *
16053     * If @c NULL, unit label won't be visible. If not it sets the format
16054     * string for the label text. To the label text is provided a floating point
16055     * value, so the label text can display up to 1 floating point value.
16056     * Note that this is optional.
16057     *
16058     * Use a format string such as "%1.2f meters" for example, and it will
16059     * display values like: "3.14 meters" for a value equal to 3.14159.
16060     *
16061     * Default is unit label disabled.
16062     *
16063     * @see elm_slider_indicator_format_get()
16064     *
16065     * @ingroup Slider
16066     */
16067    EAPI void               elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
16068
16069    /**
16070     * Get the unit label format of the slider.
16071     *
16072     * @param obj The slider object.
16073     * @return The unit label format string in UTF-8.
16074     *
16075     * Unit label is displayed all the time, if set, after slider's bar.
16076     * In horizontal mode, at right and in vertical mode, at bottom.
16077     *
16078     * @see elm_slider_unit_format_set() for more
16079     * information on how this works.
16080     *
16081     * @ingroup Slider
16082     */
16083    EAPI const char        *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16084
16085    /**
16086     * Set the format string for the indicator label.
16087     *
16088     * @param obj The slider object.
16089     * @param indicator The format string for the indicator display.
16090     *
16091     * The slider may display its value somewhere else then unit label,
16092     * for example, above the slider knob that is dragged around. This function
16093     * sets the format string used for this.
16094     *
16095     * If @c NULL, indicator label won't be visible. If not it sets the format
16096     * string for the label text. To the label text is provided a floating point
16097     * value, so the label text can display up to 1 floating point value.
16098     * Note that this is optional.
16099     *
16100     * Use a format string such as "%1.2f meters" for example, and it will
16101     * display values like: "3.14 meters" for a value equal to 3.14159.
16102     *
16103     * Default is indicator label disabled.
16104     *
16105     * @see elm_slider_indicator_format_get()
16106     *
16107     * @ingroup Slider
16108     */
16109    EAPI void               elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
16110
16111    /**
16112     * Get the indicator label format of the slider.
16113     *
16114     * @param obj The slider object.
16115     * @return The indicator label format string in UTF-8.
16116     *
16117     * The slider may display its value somewhere else then unit label,
16118     * for example, above the slider knob that is dragged around. This function
16119     * gets the format string used for this.
16120     *
16121     * @see elm_slider_indicator_format_set() for more
16122     * information on how this works.
16123     *
16124     * @ingroup Slider
16125     */
16126    EAPI const char        *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16127
16128    /**
16129     * Set the format function pointer for the indicator label
16130     *
16131     * @param obj The slider object.
16132     * @param func The indicator format function.
16133     * @param free_func The freeing function for the format string.
16134     *
16135     * Set the callback function to format the indicator string.
16136     *
16137     * @see elm_slider_indicator_format_set() for more info on how this works.
16138     *
16139     * @ingroup Slider
16140     */
16141   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);
16142
16143   /**
16144    * Set the format function pointer for the units label
16145    *
16146    * @param obj The slider object.
16147    * @param func The units format function.
16148    * @param free_func The freeing function for the format string.
16149    *
16150    * Set the callback function to format the indicator string.
16151    *
16152    * @see elm_slider_units_format_set() for more info on how this works.
16153    *
16154    * @ingroup Slider
16155    */
16156   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);
16157
16158   /**
16159    * Set the orientation of a given slider widget.
16160    *
16161    * @param obj The slider object.
16162    * @param horizontal Use @c EINA_TRUE to make @p obj to be
16163    * @b horizontal, @c EINA_FALSE to make it @b vertical.
16164    *
16165    * Use this function to change how your slider is to be
16166    * disposed: vertically or horizontally.
16167    *
16168    * By default it's displayed horizontally.
16169    *
16170    * @see elm_slider_horizontal_get()
16171    *
16172    * @ingroup Slider
16173    */
16174    EAPI void               elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16175
16176    /**
16177     * Retrieve the orientation of a given slider widget
16178     *
16179     * @param obj The slider object.
16180     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
16181     * @c EINA_FALSE if it's @b vertical (and on errors).
16182     *
16183     * @see elm_slider_horizontal_set() for more details.
16184     *
16185     * @ingroup Slider
16186     */
16187    EAPI Eina_Bool          elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16188
16189    /**
16190     * Set the minimum and maximum values for the slider.
16191     *
16192     * @param obj The slider object.
16193     * @param min The minimum value.
16194     * @param max The maximum value.
16195     *
16196     * Define the allowed range of values to be selected by the user.
16197     *
16198     * If actual value is less than @p min, it will be updated to @p min. If it
16199     * is bigger then @p max, will be updated to @p max. Actual value can be
16200     * get with elm_slider_value_get().
16201     *
16202     * By default, min is equal to 0.0, and max is equal to 1.0.
16203     *
16204     * @warning Maximum must be greater than minimum, otherwise behavior
16205     * is undefined.
16206     *
16207     * @see elm_slider_min_max_get()
16208     *
16209     * @ingroup Slider
16210     */
16211    EAPI void               elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
16212
16213    /**
16214     * Get the minimum and maximum values of the slider.
16215     *
16216     * @param obj The slider object.
16217     * @param min Pointer where to store the minimum value.
16218     * @param max Pointer where to store the maximum value.
16219     *
16220     * @note If only one value is needed, the other pointer can be passed
16221     * as @c NULL.
16222     *
16223     * @see elm_slider_min_max_set() for details.
16224     *
16225     * @ingroup Slider
16226     */
16227    EAPI void               elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
16228
16229    /**
16230     * Set the value the slider displays.
16231     *
16232     * @param obj The slider object.
16233     * @param val The value to be displayed.
16234     *
16235     * Value will be presented on the unit label following format specified with
16236     * elm_slider_unit_format_set() and on indicator with
16237     * elm_slider_indicator_format_set().
16238     *
16239     * @warning The value must to be between min and max values. This values
16240     * are set by elm_slider_min_max_set().
16241     *
16242     * @see elm_slider_value_get()
16243     * @see elm_slider_unit_format_set()
16244     * @see elm_slider_indicator_format_set()
16245     * @see elm_slider_min_max_set()
16246     *
16247     * @ingroup Slider
16248     */
16249    EAPI void               elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
16250
16251    /**
16252     * Get the value displayed by the spinner.
16253     *
16254     * @param obj The spinner object.
16255     * @return The value displayed.
16256     *
16257     * @see elm_spinner_value_set() for details.
16258     *
16259     * @ingroup Slider
16260     */
16261    EAPI double             elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16262
16263    /**
16264     * Invert a given slider widget's displaying values order
16265     *
16266     * @param obj The slider object.
16267     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
16268     * @c EINA_FALSE to bring it back to default, non-inverted values.
16269     *
16270     * A slider may be @b inverted, in which state it gets its
16271     * values inverted, with high vales being on the left or top and
16272     * low values on the right or bottom, as opposed to normally have
16273     * the low values on the former and high values on the latter,
16274     * respectively, for horizontal and vertical modes.
16275     *
16276     * @see elm_slider_inverted_get()
16277     *
16278     * @ingroup Slider
16279     */
16280    EAPI void               elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
16281
16282    /**
16283     * Get whether a given slider widget's displaying values are
16284     * inverted or not.
16285     *
16286     * @param obj The slider object.
16287     * @return @c EINA_TRUE, if @p obj has inverted values,
16288     * @c EINA_FALSE otherwise (and on errors).
16289     *
16290     * @see elm_slider_inverted_set() for more details.
16291     *
16292     * @ingroup Slider
16293     */
16294    EAPI Eina_Bool          elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16295
16296    /**
16297     * Set whether to enlarge slider indicator (augmented knob) or not.
16298     *
16299     * @param obj The slider object.
16300     * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
16301     * let the knob always at default size.
16302     *
16303     * By default, indicator will be bigger while dragged by the user.
16304     *
16305     * @warning It won't display values set with
16306     * elm_slider_indicator_format_set() if you disable indicator.
16307     *
16308     * @ingroup Slider
16309     */
16310    EAPI void               elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
16311
16312    /**
16313     * Get whether a given slider widget's enlarging indicator or not.
16314     *
16315     * @param obj The slider object.
16316     * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
16317     * @c EINA_FALSE otherwise (and on errors).
16318     *
16319     * @see elm_slider_indicator_show_set() for details.
16320     *
16321     * @ingroup Slider
16322     */
16323    EAPI Eina_Bool          elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16324
16325    /**
16326     * @}
16327     */
16328
16329    /**
16330     * @addtogroup Actionslider Actionslider
16331     *
16332     * @image html img/widget/actionslider/preview-00.png
16333     * @image latex img/widget/actionslider/preview-00.eps
16334     *
16335     * A actionslider is a switcher for 2 or 3 labels with customizable magnet
16336     * properties. The indicator is the element the user drags to choose a label.
16337     * When the position is set with magnet, when released the indicator will be
16338     * moved to it if it's nearest the magnetized position.
16339     *
16340     * @note By default all positions are set as enabled.
16341     *
16342     * Signals that you can add callbacks for are:
16343     *
16344     * "selected" - when user selects an enabled position (the label is passed
16345     *              as event info)".
16346     * @n
16347     * "pos_changed" - when the indicator reaches any of the positions("left",
16348     *                 "right" or "center").
16349     *
16350     * See an example of actionslider usage @ref actionslider_example_page "here"
16351     * @{
16352     */
16353    typedef enum _Elm_Actionslider_Pos
16354      {
16355         ELM_ACTIONSLIDER_NONE = 0,
16356         ELM_ACTIONSLIDER_LEFT = 1 << 0,
16357         ELM_ACTIONSLIDER_CENTER = 1 << 1,
16358         ELM_ACTIONSLIDER_RIGHT = 1 << 2,
16359         ELM_ACTIONSLIDER_ALL = (1 << 3) -1
16360      } Elm_Actionslider_Pos;
16361
16362    /**
16363     * Add a new actionslider to the parent.
16364     *
16365     * @param parent The parent object
16366     * @return The new actionslider object or NULL if it cannot be created
16367     */
16368    EAPI Evas_Object          *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16369    /**
16370     * Set actionslider labels.
16371     *
16372     * @param obj The actionslider object
16373     * @param left_label The label to be set on the left.
16374     * @param center_label The label to be set on the center.
16375     * @param right_label The label to be set on the right.
16376     * @deprecated use elm_object_text_set() instead.
16377     */
16378    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);
16379    /**
16380     * Get actionslider labels.
16381     *
16382     * @param obj The actionslider object
16383     * @param left_label A char** to place the left_label of @p obj into.
16384     * @param center_label A char** to place the center_label of @p obj into.
16385     * @param right_label A char** to place the right_label of @p obj into.
16386     * @deprecated use elm_object_text_set() instead.
16387     */
16388    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);
16389    /**
16390     * Get actionslider selected label.
16391     *
16392     * @param obj The actionslider object
16393     * @return The selected label
16394     */
16395    EAPI const char           *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16396    /**
16397     * Set actionslider indicator position.
16398     *
16399     * @param obj The actionslider object.
16400     * @param pos The position of the indicator.
16401     */
16402    EAPI void                  elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16403    /**
16404     * Get actionslider indicator position.
16405     *
16406     * @param obj The actionslider object.
16407     * @return The position of the indicator.
16408     */
16409    EAPI Elm_Actionslider_Pos  elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16410    /**
16411     * Set actionslider magnet position. To make multiple positions magnets @c or
16412     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
16413     *
16414     * @param obj The actionslider object.
16415     * @param pos Bit mask indicating the magnet positions.
16416     */
16417    EAPI void                  elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16418    /**
16419     * Get actionslider magnet position.
16420     *
16421     * @param obj The actionslider object.
16422     * @return The positions with magnet property.
16423     */
16424    EAPI Elm_Actionslider_Pos  elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16425    /**
16426     * Set actionslider enabled position. To set multiple positions as enabled @c or
16427     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
16428     *
16429     * @note All the positions are enabled by default.
16430     *
16431     * @param obj The actionslider object.
16432     * @param pos Bit mask indicating the enabled positions.
16433     */
16434    EAPI void                  elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16435    /**
16436     * Get actionslider enabled position.
16437     *
16438     * @param obj The actionslider object.
16439     * @return The enabled positions.
16440     */
16441    EAPI Elm_Actionslider_Pos  elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16442    /**
16443     * Set the label used on the indicator.
16444     *
16445     * @param obj The actionslider object
16446     * @param label The label to be set on the indicator.
16447     * @deprecated use elm_object_text_set() instead.
16448     */
16449    EINA_DEPRECATED EAPI void                  elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
16450    /**
16451     * Get the label used on the indicator object.
16452     *
16453     * @param obj The actionslider object
16454     * @return The indicator label
16455     * @deprecated use elm_object_text_get() instead.
16456     */
16457    EINA_DEPRECATED EAPI const char           *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
16458    /**
16459     * @}
16460     */
16461
16462    /**
16463     * @defgroup Genlist Genlist
16464     *
16465     * @image html img/widget/genlist/preview-00.png
16466     * @image latex img/widget/genlist/preview-00.eps
16467     * @image html img/genlist.png
16468     * @image latex img/genlist.eps
16469     *
16470     * This widget aims to have more expansive list than the simple list in
16471     * Elementary that could have more flexible items and allow many more entries
16472     * while still being fast and low on memory usage. At the same time it was
16473     * also made to be able to do tree structures. But the price to pay is more
16474     * complexity when it comes to usage. If all you want is a simple list with
16475     * icons and a single label, use the normal @ref List object.
16476     *
16477     * Genlist has a fairly large API, mostly because it's relatively complex,
16478     * trying to be both expansive, powerful and efficient. First we will begin
16479     * an overview on the theory behind genlist.
16480     *
16481     * @section Genlist_Item_Class Genlist item classes - creating items
16482     *
16483     * In order to have the ability to add and delete items on the fly, genlist
16484     * implements a class (callback) system where the application provides a
16485     * structure with information about that type of item (genlist may contain
16486     * multiple different items with different classes, states and styles).
16487     * Genlist will call the functions in this struct (methods) when an item is
16488     * "realized" (i.e., created dynamically, while the user is scrolling the
16489     * grid). All objects will simply be deleted when no longer needed with
16490     * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
16491     * following members:
16492     * - @c item_style - This is a constant string and simply defines the name
16493     *   of the item style. It @b must be specified and the default should be @c
16494     *   "default".
16495     * - @c mode_item_style - This is a constant string and simply defines the
16496     *   name of the style that will be used for mode animations. It can be left
16497     *   as @c NULL if you don't plan to use Genlist mode. See
16498     *   elm_genlist_item_mode_set() for more info.
16499     *
16500     * - @c func - A struct with pointers to functions that will be called when
16501     *   an item is going to be actually created. All of them receive a @c data
16502     *   parameter that will point to the same data passed to
16503     *   elm_genlist_item_append() and related item creation functions, and a @c
16504     *   obj parameter that points to the genlist object itself.
16505     *
16506     * The function pointers inside @c func are @c label_get, @c icon_get, @c
16507     * state_get and @c del. The 3 first functions also receive a @c part
16508     * parameter described below. A brief description of these functions follows:
16509     *
16510     * - @c label_get - The @c part parameter is the name string of one of the
16511     *   existing text parts in the Edje group implementing the item's theme.
16512     *   This function @b must return a strdup'()ed string, as the caller will
16513     *   free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
16514     * - @c icon_get - The @c part parameter is the name string of one of the
16515     *   existing (icon) swallow parts in the Edje group implementing the item's
16516     *   theme. It must return @c NULL, when no icon is desired, or a valid
16517     *   object handle, otherwise.  The object will be deleted by the genlist on
16518     *   its deletion or when the item is "unrealized".  See
16519     *   #Elm_Genlist_Item_Icon_Get_Cb.
16520     * - @c func.state_get - The @c part parameter is the name string of one of
16521     *   the state parts in the Edje group implementing the item's theme. Return
16522     *   @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
16523     *   emit a signal to its theming Edje object with @c "elm,state,XXX,active"
16524     *   and @c "elm" as "emission" and "source" arguments, respectively, when
16525     *   the state is true (the default is false), where @c XXX is the name of
16526     *   the (state) part.  See #Elm_Genlist_Item_State_Get_Cb.
16527     * - @c func.del - This is intended for use when genlist items are deleted,
16528     *   so any data attached to the item (e.g. its data parameter on creation)
16529     *   can be deleted. See #Elm_Genlist_Item_Del_Cb.
16530     *
16531     * available item styles:
16532     * - default
16533     * - default_style - The text part is a textblock
16534     *
16535     * @image html img/widget/genlist/preview-04.png
16536     * @image latex img/widget/genlist/preview-04.eps
16537     *
16538     * - double_label
16539     *
16540     * @image html img/widget/genlist/preview-01.png
16541     * @image latex img/widget/genlist/preview-01.eps
16542     *
16543     * - icon_top_text_bottom
16544     *
16545     * @image html img/widget/genlist/preview-02.png
16546     * @image latex img/widget/genlist/preview-02.eps
16547     *
16548     * - group_index
16549     *
16550     * @image html img/widget/genlist/preview-03.png
16551     * @image latex img/widget/genlist/preview-03.eps
16552     *
16553     * @section Genlist_Items Structure of items
16554     *
16555     * An item in a genlist can have 0 or more text labels (they can be regular
16556     * text or textblock Evas objects - that's up to the style to determine), 0
16557     * or more icons (which are simply objects swallowed into the genlist item's
16558     * theming Edje object) and 0 or more <b>boolean states</b>, which have the
16559     * behavior left to the user to define. The Edje part names for each of
16560     * these properties will be looked up, in the theme file for the genlist,
16561     * under the Edje (string) data items named @c "labels", @c "icons" and @c
16562     * "states", respectively. For each of those properties, if more than one
16563     * part is provided, they must have names listed separated by spaces in the
16564     * data fields. For the default genlist item theme, we have @b one label
16565     * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
16566     * "elm.swallow.end") and @b no state parts.
16567     *
16568     * A genlist item may be at one of several styles. Elementary provides one
16569     * by default - "default", but this can be extended by system or application
16570     * custom themes/overlays/extensions (see @ref Theme "themes" for more
16571     * details).
16572     *
16573     * @section Genlist_Manipulation Editing and Navigating
16574     *
16575     * Items can be added by several calls. All of them return a @ref
16576     * Elm_Genlist_Item handle that is an internal member inside the genlist.
16577     * They all take a data parameter that is meant to be used for a handle to
16578     * the applications internal data (eg the struct with the original item
16579     * data). The parent parameter is the parent genlist item this belongs to if
16580     * it is a tree or an indexed group, and NULL if there is no parent. The
16581     * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
16582     * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
16583     * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
16584     * that is able to expand and have child items.  If ELM_GENLIST_ITEM_GROUP
16585     * is set then this item is group index item that is displayed at the top
16586     * until the next group comes. The func parameter is a convenience callback
16587     * that is called when the item is selected and the data parameter will be
16588     * the func_data parameter, obj be the genlist object and event_info will be
16589     * the genlist item.
16590     *
16591     * elm_genlist_item_append() adds an item to the end of the list, or if
16592     * there is a parent, to the end of all the child items of the parent.
16593     * elm_genlist_item_prepend() is the same but adds to the beginning of
16594     * the list or children list. elm_genlist_item_insert_before() inserts at
16595     * item before another item and elm_genlist_item_insert_after() inserts after
16596     * the indicated item.
16597     *
16598     * The application can clear the list with elm_genlist_clear() which deletes
16599     * all the items in the list and elm_genlist_item_del() will delete a specific
16600     * item. elm_genlist_item_subitems_clear() will clear all items that are
16601     * children of the indicated parent item.
16602     *
16603     * To help inspect list items you can jump to the item at the top of the list
16604     * with elm_genlist_first_item_get() which will return the item pointer, and
16605     * similarly elm_genlist_last_item_get() gets the item at the end of the list.
16606     * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
16607     * and previous items respectively relative to the indicated item. Using
16608     * these calls you can walk the entire item list/tree. Note that as a tree
16609     * the items are flattened in the list, so elm_genlist_item_parent_get() will
16610     * let you know which item is the parent (and thus know how to skip them if
16611     * wanted).
16612     *
16613     * @section Genlist_Muti_Selection Multi-selection
16614     *
16615     * If the application wants multiple items to be able to be selected,
16616     * elm_genlist_multi_select_set() can enable this. If the list is
16617     * single-selection only (the default), then elm_genlist_selected_item_get()
16618     * will return the selected item, if any, or NULL I none is selected. If the
16619     * list is multi-select then elm_genlist_selected_items_get() will return a
16620     * list (that is only valid as long as no items are modified (added, deleted,
16621     * selected or unselected)).
16622     *
16623     * @section Genlist_Usage_Hints Usage hints
16624     *
16625     * There are also convenience functions. elm_genlist_item_genlist_get() will
16626     * return the genlist object the item belongs to. elm_genlist_item_show()
16627     * will make the scroller scroll to show that specific item so its visible.
16628     * elm_genlist_item_data_get() returns the data pointer set by the item
16629     * creation functions.
16630     *
16631     * If an item changes (state of boolean changes, label or icons change),
16632     * then use elm_genlist_item_update() to have genlist update the item with
16633     * the new state. Genlist will re-realize the item thus call the functions
16634     * in the _Elm_Genlist_Item_Class for that item.
16635     *
16636     * To programmatically (un)select an item use elm_genlist_item_selected_set().
16637     * To get its selected state use elm_genlist_item_selected_get(). Similarly
16638     * to expand/contract an item and get its expanded state, use
16639     * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
16640     * again to make an item disabled (unable to be selected and appear
16641     * differently) use elm_genlist_item_disabled_set() to set this and
16642     * elm_genlist_item_disabled_get() to get the disabled state.
16643     *
16644     * In general to indicate how the genlist should expand items horizontally to
16645     * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
16646     * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
16647     * mode means that if items are too wide to fit, the scroller will scroll
16648     * horizontally. Otherwise items are expanded to fill the width of the
16649     * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
16650     * to the viewport width and limited to that size. This can be combined with
16651     * a different style that uses edjes' ellipsis feature (cutting text off like
16652     * this: "tex...").
16653     *
16654     * Items will only call their selection func and callback when first becoming
16655     * selected. Any further clicks will do nothing, unless you enable always
16656     * select with elm_genlist_always_select_mode_set(). This means even if
16657     * selected, every click will make the selected callbacks be called.
16658     * elm_genlist_no_select_mode_set() will turn off the ability to select
16659     * items entirely and they will neither appear selected nor call selected
16660     * callback functions.
16661     *
16662     * Remember that you can create new styles and add your own theme augmentation
16663     * per application with elm_theme_extension_add(). If you absolutely must
16664     * have a specific style that overrides any theme the user or system sets up
16665     * you can use elm_theme_overlay_add() to add such a file.
16666     *
16667     * @section Genlist_Implementation Implementation
16668     *
16669     * Evas tracks every object you create. Every time it processes an event
16670     * (mouse move, down, up etc.) it needs to walk through objects and find out
16671     * what event that affects. Even worse every time it renders display updates,
16672     * in order to just calculate what to re-draw, it needs to walk through many
16673     * many many objects. Thus, the more objects you keep active, the more
16674     * overhead Evas has in just doing its work. It is advisable to keep your
16675     * active objects to the minimum working set you need. Also remember that
16676     * object creation and deletion carries an overhead, so there is a
16677     * middle-ground, which is not easily determined. But don't keep massive lists
16678     * of objects you can't see or use. Genlist does this with list objects. It
16679     * creates and destroys them dynamically as you scroll around. It groups them
16680     * into blocks so it can determine the visibility etc. of a whole block at
16681     * once as opposed to having to walk the whole list. This 2-level list allows
16682     * for very large numbers of items to be in the list (tests have used up to
16683     * 2,000,000 items). Also genlist employs a queue for adding items. As items
16684     * may be different sizes, every item added needs to be calculated as to its
16685     * size and thus this presents a lot of overhead on populating the list, this
16686     * genlist employs a queue. Any item added is queued and spooled off over
16687     * time, actually appearing some time later, so if your list has many members
16688     * you may find it takes a while for them to all appear, with your process
16689     * consuming a lot of CPU while it is busy spooling.
16690     *
16691     * Genlist also implements a tree structure, but it does so with callbacks to
16692     * the application, with the application filling in tree structures when
16693     * requested (allowing for efficient building of a very deep tree that could
16694     * even be used for file-management). See the above smart signal callbacks for
16695     * details.
16696     *
16697     * @section Genlist_Smart_Events Genlist smart events
16698     *
16699     * Signals that you can add callbacks for are:
16700     * - @c "activated" - The user has double-clicked or pressed
16701     *   (enter|return|spacebar) on an item. The @c event_info parameter is the
16702     *   item that was activated.
16703     * - @c "clicked,double" - The user has double-clicked an item.  The @c
16704     *   event_info parameter is the item that was double-clicked.
16705     * - @c "selected" - This is called when a user has made an item selected.
16706     *   The event_info parameter is the genlist item that was selected.
16707     * - @c "unselected" - This is called when a user has made an item
16708     *   unselected. The event_info parameter is the genlist item that was
16709     *   unselected.
16710     * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
16711     *   called and the item is now meant to be expanded. The event_info
16712     *   parameter is the genlist item that was indicated to expand.  It is the
16713     *   job of this callback to then fill in the child items.
16714     * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
16715     *   called and the item is now meant to be contracted. The event_info
16716     *   parameter is the genlist item that was indicated to contract. It is the
16717     *   job of this callback to then delete the child items.
16718     * - @c "expand,request" - This is called when a user has indicated they want
16719     *   to expand a tree branch item. The callback should decide if the item can
16720     *   expand (has any children) and then call elm_genlist_item_expanded_set()
16721     *   appropriately to set the state. The event_info parameter is the genlist
16722     *   item that was indicated to expand.
16723     * - @c "contract,request" - This is called when a user has indicated they
16724     *   want to contract a tree branch item. The callback should decide if the
16725     *   item can contract (has any children) and then call
16726     *   elm_genlist_item_expanded_set() appropriately to set the state. The
16727     *   event_info parameter is the genlist item that was indicated to contract.
16728     * - @c "realized" - This is called when the item in the list is created as a
16729     *   real evas object. event_info parameter is the genlist item that was
16730     *   created. The object may be deleted at any time, so it is up to the
16731     *   caller to not use the object pointer from elm_genlist_item_object_get()
16732     *   in a way where it may point to freed objects.
16733     * - @c "unrealized" - This is called just before an item is unrealized.
16734     *   After this call icon objects provided will be deleted and the item
16735     *   object itself delete or be put into a floating cache.
16736     * - @c "drag,start,up" - This is called when the item in the list has been
16737     *   dragged (not scrolled) up.
16738     * - @c "drag,start,down" - This is called when the item in the list has been
16739     *   dragged (not scrolled) down.
16740     * - @c "drag,start,left" - This is called when the item in the list has been
16741     *   dragged (not scrolled) left.
16742     * - @c "drag,start,right" - This is called when the item in the list has
16743     *   been dragged (not scrolled) right.
16744     * - @c "drag,stop" - This is called when the item in the list has stopped
16745     *   being dragged.
16746     * - @c "drag" - This is called when the item in the list is being dragged.
16747     * - @c "longpressed" - This is called when the item is pressed for a certain
16748     *   amount of time. By default it's 1 second.
16749     * - @c "scroll,anim,start" - This is called when scrolling animation has
16750     *   started.
16751     * - @c "scroll,anim,stop" - This is called when scrolling animation has
16752     *   stopped.
16753     * - @c "scroll,drag,start" - This is called when dragging the content has
16754     *   started.
16755     * - @c "scroll,drag,stop" - This is called when dragging the content has
16756     *   stopped.
16757     * - @c "scroll,edge,top" - This is called when the genlist is scrolled until
16758     *   the top edge.
16759     * - @c "scroll,edge,bottom" - This is called when the genlist is scrolled
16760     *   until the bottom edge.
16761     * - @c "scroll,edge,left" - This is called when the genlist is scrolled
16762     *   until the left edge.
16763     * - @c "scroll,edge,right" - This is called when the genlist is scrolled
16764     *   until the right edge.
16765     * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
16766     *   swiped left.
16767     * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
16768     *   swiped right.
16769     * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
16770     *   swiped up.
16771     * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
16772     *   swiped down.
16773     * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
16774     *   pinched out.  "- @c multi,pinch,in" - This is called when the genlist is
16775     *   multi-touch pinched in.
16776     * - @c "swipe" - This is called when the genlist is swiped.
16777     *
16778     * @section Genlist_Examples Examples
16779     *
16780     * Here is a list of examples that use the genlist, trying to show some of
16781     * its capabilities:
16782     * - @ref genlist_example_01
16783     * - @ref genlist_example_02
16784     * - @ref genlist_example_03
16785     * - @ref genlist_example_04
16786     * - @ref genlist_example_05
16787     */
16788
16789    /**
16790     * @addtogroup Genlist
16791     * @{
16792     */
16793
16794    /**
16795     * @enum _Elm_Genlist_Item_Flags
16796     * @typedef Elm_Genlist_Item_Flags
16797     *
16798     * Defines if the item is of any special type (has subitems or it's the
16799     * index of a group), or is just a simple item.
16800     *
16801     * @ingroup Genlist
16802     */
16803    typedef enum _Elm_Genlist_Item_Flags
16804      {
16805         ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
16806         ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
16807         ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
16808      } Elm_Genlist_Item_Flags;
16809    typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;  /**< Genlist item class definition structs */
16810    typedef struct _Elm_Genlist_Item       Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
16811    typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
16812    typedef char        *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
16813    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. */
16814    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. */
16815    typedef void         (*Elm_Genlist_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
16816    typedef void         (*GenlistItemMovedFunc)    (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after); /** TODO: remove this by SeoZ **/
16817
16818    typedef char        *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Label_Get_Cb instead. */
16819    typedef Evas_Object *(*GenlistItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Icon_Get_Cb instead. */
16820    typedef Eina_Bool    (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_State_Get_Cb instead. */
16821    typedef void         (*GenlistItemDelFunc)      (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Del_Cb instead. */
16822
16823    /**
16824     * @struct _Elm_Genlist_Item_Class
16825     *
16826     * Genlist item class definition structs.
16827     *
16828     * This struct contains the style and fetching functions that will define the
16829     * contents of each item.
16830     *
16831     * @see @ref Genlist_Item_Class
16832     */
16833    struct _Elm_Genlist_Item_Class
16834      {
16835         const char                *item_style; /**< style of this class. */
16836         struct
16837           {
16838              Elm_Genlist_Item_Label_Get_Cb  label_get; /**< Label fetching class function for genlist item classes.*/
16839              Elm_Genlist_Item_Icon_Get_Cb   icon_get; /**< Icon fetching class function for genlist item classes. */
16840              Elm_Genlist_Item_State_Get_Cb  state_get; /**< State fetching class function for genlist item classes. */
16841              Elm_Genlist_Item_Del_Cb        del; /**< Deletion class function for genlist item classes. */
16842              GenlistItemMovedFunc     moved; // TODO: do not use this. change this to smart callback.
16843           } func;
16844         const char                *mode_item_style;
16845      };
16846
16847    /**
16848     * Add a new genlist widget to the given parent Elementary
16849     * (container) object
16850     *
16851     * @param parent The parent object
16852     * @return a new genlist widget handle or @c NULL, on errors
16853     *
16854     * This function inserts a new genlist widget on the canvas.
16855     *
16856     * @see elm_genlist_item_append()
16857     * @see elm_genlist_item_del()
16858     * @see elm_genlist_clear()
16859     *
16860     * @ingroup Genlist
16861     */
16862    EAPI Evas_Object      *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16863    /**
16864     * Remove all items from a given genlist widget.
16865     *
16866     * @param obj The genlist object
16867     *
16868     * This removes (and deletes) all items in @p obj, leaving it empty.
16869     *
16870     * @see elm_genlist_item_del(), to remove just one item.
16871     *
16872     * @ingroup Genlist
16873     */
16874    EAPI void              elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16875    /**
16876     * Enable or disable multi-selection in the genlist
16877     *
16878     * @param obj The genlist object
16879     * @param multi Multi-select enable/disable. Default is disabled.
16880     *
16881     * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
16882     * the list. This allows more than 1 item to be selected. To retrieve the list
16883     * of selected items, use elm_genlist_selected_items_get().
16884     *
16885     * @see elm_genlist_selected_items_get()
16886     * @see elm_genlist_multi_select_get()
16887     *
16888     * @ingroup Genlist
16889     */
16890    EAPI void              elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16891    /**
16892     * Gets if multi-selection in genlist is enabled or disabled.
16893     *
16894     * @param obj The genlist object
16895     * @return Multi-select enabled/disabled
16896     * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
16897     *
16898     * @see elm_genlist_multi_select_set()
16899     *
16900     * @ingroup Genlist
16901     */
16902    EAPI Eina_Bool         elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16903    /**
16904     * This sets the horizontal stretching mode.
16905     *
16906     * @param obj The genlist object
16907     * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
16908     *
16909     * This sets the mode used for sizing items horizontally. Valid modes
16910     * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
16911     * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
16912     * the scroller will scroll horizontally. Otherwise items are expanded
16913     * to fill the width of the viewport of the scroller. If it is
16914     * ELM_LIST_LIMIT, items will be expanded to the viewport width and
16915     * limited to that size.
16916     *
16917     * @see elm_genlist_horizontal_get()
16918     *
16919     * @ingroup Genlist
16920     */
16921    EAPI void              elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16922    EINA_DEPRECATED EAPI void              elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16923    /**
16924     * Gets the horizontal stretching mode.
16925     *
16926     * @param obj The genlist object
16927     * @return The mode to use
16928     * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
16929     *
16930     * @see elm_genlist_horizontal_set()
16931     *
16932     * @ingroup Genlist
16933     */
16934    EAPI Elm_List_Mode     elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16935    EINA_DEPRECATED EAPI Elm_List_Mode     elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16936    /**
16937     * Set the always select mode.
16938     *
16939     * @param obj The genlist object
16940     * @param always_select The always select mode (@c EINA_TRUE = on, @c
16941     * EINA_FALSE = off). Default is @c EINA_FALSE.
16942     *
16943     * Items will only call their selection func and callback when first
16944     * becoming selected. Any further clicks will do nothing, unless you
16945     * enable always select with elm_genlist_always_select_mode_set().
16946     * This means that, even if selected, every click will make the selected
16947     * callbacks be called.
16948     *
16949     * @see elm_genlist_always_select_mode_get()
16950     *
16951     * @ingroup Genlist
16952     */
16953    EAPI void              elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16954    /**
16955     * Get the always select mode.
16956     *
16957     * @param obj The genlist object
16958     * @return The always select mode
16959     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
16960     *
16961     * @see elm_genlist_always_select_mode_set()
16962     *
16963     * @ingroup Genlist
16964     */
16965    EAPI Eina_Bool         elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16966    /**
16967     * Enable/disable the no select mode.
16968     *
16969     * @param obj The genlist object
16970     * @param no_select The no select mode
16971     * (EINA_TRUE = on, EINA_FALSE = off)
16972     *
16973     * This will turn off the ability to select items entirely and they
16974     * will neither appear selected nor call selected callback functions.
16975     *
16976     * @see elm_genlist_no_select_mode_get()
16977     *
16978     * @ingroup Genlist
16979     */
16980    EAPI void              elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
16981    /**
16982     * Gets whether the no select mode is enabled.
16983     *
16984     * @param obj The genlist object
16985     * @return The no select mode
16986     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
16987     *
16988     * @see elm_genlist_no_select_mode_set()
16989     *
16990     * @ingroup Genlist
16991     */
16992    EAPI Eina_Bool         elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16993    /**
16994     * Enable/disable compress mode.
16995     *
16996     * @param obj The genlist object
16997     * @param compress The compress mode
16998     * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
16999     *
17000     * This will enable the compress mode where items are "compressed"
17001     * horizontally to fit the genlist scrollable viewport width. This is
17002     * special for genlist.  Do not rely on
17003     * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
17004     * work as genlist needs to handle it specially.
17005     *
17006     * @see elm_genlist_compress_mode_get()
17007     *
17008     * @ingroup Genlist
17009     */
17010    EAPI void              elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
17011    /**
17012     * Get whether the compress mode is enabled.
17013     *
17014     * @param obj The genlist object
17015     * @return The compress mode
17016     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
17017     *
17018     * @see elm_genlist_compress_mode_set()
17019     *
17020     * @ingroup Genlist
17021     */
17022    EAPI Eina_Bool         elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17023    /**
17024     * Enable/disable height-for-width mode.
17025     *
17026     * @param obj The genlist object
17027     * @param setting The height-for-width mode (@c EINA_TRUE = on,
17028     * @c EINA_FALSE = off). Default is @c EINA_FALSE.
17029     *
17030     * With height-for-width mode the item width will be fixed (restricted
17031     * to a minimum of) to the list width when calculating its size in
17032     * order to allow the height to be calculated based on it. This allows,
17033     * for instance, text block to wrap lines if the Edje part is
17034     * configured with "text.min: 0 1".
17035     *
17036     * @note This mode will make list resize slower as it will have to
17037     *       recalculate every item height again whenever the list width
17038     *       changes!
17039     *
17040     * @note When height-for-width mode is enabled, it also enables
17041     *       compress mode (see elm_genlist_compress_mode_set()) and
17042     *       disables homogeneous (see elm_genlist_homogeneous_set()).
17043     *
17044     * @ingroup Genlist
17045     */
17046    EAPI void              elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
17047    /**
17048     * Get whether the height-for-width mode is enabled.
17049     *
17050     * @param obj The genlist object
17051     * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
17052     * off)
17053     *
17054     * @ingroup Genlist
17055     */
17056    EAPI Eina_Bool         elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17057    /**
17058     * Enable/disable horizontal and vertical bouncing effect.
17059     *
17060     * @param obj The genlist object
17061     * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
17062     * EINA_FALSE = off). Default is @c EINA_FALSE.
17063     * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
17064     * EINA_FALSE = off). Default is @c EINA_TRUE.
17065     *
17066     * This will enable or disable the scroller bouncing effect for the
17067     * genlist. See elm_scroller_bounce_set() for details.
17068     *
17069     * @see elm_scroller_bounce_set()
17070     * @see elm_genlist_bounce_get()
17071     *
17072     * @ingroup Genlist
17073     */
17074    EAPI void              elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
17075    /**
17076     * Get whether the horizontal and vertical bouncing effect is enabled.
17077     *
17078     * @param obj The genlist object
17079     * @param h_bounce Pointer to a bool to receive if the bounce horizontally
17080     * option is set.
17081     * @param v_bounce Pointer to a bool to receive if the bounce vertically
17082     * option is set.
17083     *
17084     * @see elm_genlist_bounce_set()
17085     *
17086     * @ingroup Genlist
17087     */
17088    EAPI void              elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
17089    /**
17090     * Enable/disable homogenous mode.
17091     *
17092     * @param obj The genlist object
17093     * @param homogeneous Assume the items within the genlist are of the
17094     * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
17095     * EINA_FALSE.
17096     *
17097     * This will enable the homogeneous mode where items are of the same
17098     * height and width so that genlist may do the lazy-loading at its
17099     * maximum (which increases the performance for scrolling the list). This
17100     * implies 'compressed' mode.
17101     *
17102     * @see elm_genlist_compress_mode_set()
17103     * @see elm_genlist_homogeneous_get()
17104     *
17105     * @ingroup Genlist
17106     */
17107    EAPI void              elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
17108    /**
17109     * Get whether the homogenous mode is enabled.
17110     *
17111     * @param obj The genlist object
17112     * @return Assume the items within the genlist are of the same height
17113     * and width (EINA_TRUE = on, EINA_FALSE = off)
17114     *
17115     * @see elm_genlist_homogeneous_set()
17116     *
17117     * @ingroup Genlist
17118     */
17119    EAPI Eina_Bool         elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17120    /**
17121     * Set the maximum number of items within an item block
17122     *
17123     * @param obj The genlist object
17124     * @param n   Maximum number of items within an item block. Default is 32.
17125     *
17126     * This will configure the block count to tune to the target with
17127     * particular performance matrix.
17128     *
17129     * A block of objects will be used to reduce the number of operations due to
17130     * many objects in the screen. It can determine the visibility, or if the
17131     * object has changed, it theme needs to be updated, etc. doing this kind of
17132     * calculation to the entire block, instead of per object.
17133     *
17134     * The default value for the block count is enough for most lists, so unless
17135     * you know you will have a lot of objects visible in the screen at the same
17136     * time, don't try to change this.
17137     *
17138     * @see elm_genlist_block_count_get()
17139     * @see @ref Genlist_Implementation
17140     *
17141     * @ingroup Genlist
17142     */
17143    EAPI void              elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
17144    /**
17145     * Get the maximum number of items within an item block
17146     *
17147     * @param obj The genlist object
17148     * @return Maximum number of items within an item block
17149     *
17150     * @see elm_genlist_block_count_set()
17151     *
17152     * @ingroup Genlist
17153     */
17154    EAPI int               elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17155    /**
17156     * Set the timeout in seconds for the longpress event.
17157     *
17158     * @param obj The genlist object
17159     * @param timeout timeout in seconds. Default is 1.
17160     *
17161     * This option will change how long it takes to send an event "longpressed"
17162     * after the mouse down signal is sent to the list. If this event occurs, no
17163     * "clicked" event will be sent.
17164     *
17165     * @see elm_genlist_longpress_timeout_set()
17166     *
17167     * @ingroup Genlist
17168     */
17169    EAPI void              elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
17170    /**
17171     * Get the timeout in seconds for the longpress event.
17172     *
17173     * @param obj The genlist object
17174     * @return timeout in seconds
17175     *
17176     * @see elm_genlist_longpress_timeout_get()
17177     *
17178     * @ingroup Genlist
17179     */
17180    EAPI double            elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17181    /**
17182     * Append a new item in a given genlist widget.
17183     *
17184     * @param obj The genlist object
17185     * @param itc The item class for the item
17186     * @param data The item data
17187     * @param parent The parent item, or NULL if none
17188     * @param flags Item flags
17189     * @param func Convenience function called when the item is selected
17190     * @param func_data Data passed to @p func above.
17191     * @return A handle to the item added or @c NULL if not possible
17192     *
17193     * This adds the given item to the end of the list or the end of
17194     * the children list if the @p parent is given.
17195     *
17196     * @see elm_genlist_item_prepend()
17197     * @see elm_genlist_item_insert_before()
17198     * @see elm_genlist_item_insert_after()
17199     * @see elm_genlist_item_del()
17200     *
17201     * @ingroup Genlist
17202     */
17203    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);
17204    /**
17205     * Prepend a new item in a given genlist widget.
17206     *
17207     * @param obj The genlist object
17208     * @param itc The item class for the item
17209     * @param data The item data
17210     * @param parent The parent item, or NULL if none
17211     * @param flags Item flags
17212     * @param func Convenience function called when the item is selected
17213     * @param func_data Data passed to @p func above.
17214     * @return A handle to the item added or NULL if not possible
17215     *
17216     * This adds an item to the beginning of the list or beginning of the
17217     * children of the parent if given.
17218     *
17219     * @see elm_genlist_item_append()
17220     * @see elm_genlist_item_insert_before()
17221     * @see elm_genlist_item_insert_after()
17222     * @see elm_genlist_item_del()
17223     *
17224     * @ingroup Genlist
17225     */
17226    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);
17227    /**
17228     * Insert an item before another in a genlist widget
17229     *
17230     * @param obj The genlist object
17231     * @param itc The item class for the item
17232     * @param data The item data
17233     * @param before The item to place this new one before.
17234     * @param flags Item flags
17235     * @param func Convenience function called when the item is selected
17236     * @param func_data Data passed to @p func above.
17237     * @return A handle to the item added or @c NULL if not possible
17238     *
17239     * This inserts an item before another in the list. It will be in the
17240     * same tree level or group as the item it is inserted before.
17241     *
17242     * @see elm_genlist_item_append()
17243     * @see elm_genlist_item_prepend()
17244     * @see elm_genlist_item_insert_after()
17245     * @see elm_genlist_item_del()
17246     *
17247     * @ingroup Genlist
17248     */
17249    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);
17250    /**
17251     * Insert an item after another in a genlist widget
17252     *
17253     * @param obj The genlist object
17254     * @param itc The item class for the item
17255     * @param data The item data
17256     * @param after The item to place this new one after.
17257     * @param flags Item flags
17258     * @param func Convenience function called when the item is selected
17259     * @param func_data Data passed to @p func above.
17260     * @return A handle to the item added or @c NULL if not possible
17261     *
17262     * This inserts an item after another in the list. It will be in the
17263     * same tree level or group as the item it is inserted after.
17264     *
17265     * @see elm_genlist_item_append()
17266     * @see elm_genlist_item_prepend()
17267     * @see elm_genlist_item_insert_before()
17268     * @see elm_genlist_item_del()
17269     *
17270     * @ingroup Genlist
17271     */
17272    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);
17273    /**
17274     * Insert a new item into the sorted genlist object
17275     *
17276     * @param obj The genlist object
17277     * @param itc The item class for the item
17278     * @param data The item data
17279     * @param parent The parent item, or NULL if none
17280     * @param flags Item flags
17281     * @param comp The function called for the sort
17282     * @param func Convenience function called when item selected
17283     * @param func_data Data passed to @p func above.
17284     * @return A handle to the item added or NULL if not possible
17285     *
17286     * @ingroup Genlist
17287     */
17288    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);
17289    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);
17290    /* operations to retrieve existing items */
17291    /**
17292     * Get the selectd item in the genlist.
17293     *
17294     * @param obj The genlist object
17295     * @return The selected item, or NULL if none is selected.
17296     *
17297     * This gets the selected item in the list (if multi-selection is enabled, only
17298     * the item that was first selected in the list is returned - which is not very
17299     * useful, so see elm_genlist_selected_items_get() for when multi-selection is
17300     * used).
17301     *
17302     * If no item is selected, NULL is returned.
17303     *
17304     * @see elm_genlist_selected_items_get()
17305     *
17306     * @ingroup Genlist
17307     */
17308    EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17309    /**
17310     * Get a list of selected items in the genlist.
17311     *
17312     * @param obj The genlist object
17313     * @return The list of selected items, or NULL if none are selected.
17314     *
17315     * It returns a list of the selected items. This list pointer is only valid so
17316     * long as the selection doesn't change (no items are selected or unselected, or
17317     * unselected implicitly by deletion). The list contains Elm_Genlist_Item
17318     * pointers. The order of the items in this list is the order which they were
17319     * selected, i.e. the first item in this list is the first item that was
17320     * selected, and so on.
17321     *
17322     * @note If not in multi-select mode, consider using function
17323     * elm_genlist_selected_item_get() instead.
17324     *
17325     * @see elm_genlist_multi_select_set()
17326     * @see elm_genlist_selected_item_get()
17327     *
17328     * @ingroup Genlist
17329     */
17330    EAPI const Eina_List  *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17331    /**
17332     * Get a list of realized items in genlist
17333     *
17334     * @param obj The genlist object
17335     * @return The list of realized items, nor NULL if none are realized.
17336     *
17337     * This returns a list of the realized items in the genlist. The list
17338     * contains Elm_Genlist_Item pointers. The list must be freed by the
17339     * caller when done with eina_list_free(). The item pointers in the
17340     * list are only valid so long as those items are not deleted or the
17341     * genlist is not deleted.
17342     *
17343     * @see elm_genlist_realized_items_update()
17344     *
17345     * @ingroup Genlist
17346     */
17347    EAPI Eina_List        *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17348    /**
17349     * Get the item that is at the x, y canvas coords.
17350     *
17351     * @param obj The gelinst object.
17352     * @param x The input x coordinate
17353     * @param y The input y coordinate
17354     * @param posret The position relative to the item returned here
17355     * @return The item at the coordinates or NULL if none
17356     *
17357     * This returns the item at the given coordinates (which are canvas
17358     * relative, not object-relative). If an item is at that coordinate,
17359     * that item handle is returned, and if @p posret is not NULL, the
17360     * integer pointed to is set to a value of -1, 0 or 1, depending if
17361     * the coordinate is on the upper portion of that item (-1), on the
17362     * middle section (0) or on the lower part (1). If NULL is returned as
17363     * an item (no item found there), then posret may indicate -1 or 1
17364     * based if the coordinate is above or below all items respectively in
17365     * the genlist.
17366     *
17367     * @ingroup Genlist
17368     */
17369    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);
17370    /**
17371     * Get the first item in the genlist
17372     *
17373     * This returns the first item in the list.
17374     *
17375     * @param obj The genlist object
17376     * @return The first item, or NULL if none
17377     *
17378     * @ingroup Genlist
17379     */
17380    EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17381    /**
17382     * Get the last item in the genlist
17383     *
17384     * This returns the last item in the list.
17385     *
17386     * @return The last item, or NULL if none
17387     *
17388     * @ingroup Genlist
17389     */
17390    EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17391    /**
17392     * Set the scrollbar policy
17393     *
17394     * @param obj The genlist object
17395     * @param policy_h Horizontal scrollbar policy.
17396     * @param policy_v Vertical scrollbar policy.
17397     *
17398     * This sets the scrollbar visibility policy for the given genlist
17399     * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
17400     * made visible if it is needed, and otherwise kept hidden.
17401     * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
17402     * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
17403     * respectively for the horizontal and vertical scrollbars. Default is
17404     * #ELM_SMART_SCROLLER_POLICY_AUTO
17405     *
17406     * @see elm_genlist_scroller_policy_get()
17407     *
17408     * @ingroup Genlist
17409     */
17410    EAPI void              elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
17411    /**
17412     * Get the scrollbar policy
17413     *
17414     * @param obj The genlist object
17415     * @param policy_h Pointer to store the horizontal scrollbar policy.
17416     * @param policy_v Pointer to store the vertical scrollbar policy.
17417     *
17418     * @see elm_genlist_scroller_policy_set()
17419     *
17420     * @ingroup Genlist
17421     */
17422    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);
17423    /**
17424     * Get the @b next item in a genlist widget's internal list of items,
17425     * given a handle to one of those items.
17426     *
17427     * @param item The genlist item to fetch next from
17428     * @return The item after @p item, or @c NULL if there's none (and
17429     * on errors)
17430     *
17431     * This returns the item placed after the @p item, on the container
17432     * genlist.
17433     *
17434     * @see elm_genlist_item_prev_get()
17435     *
17436     * @ingroup Genlist
17437     */
17438    EAPI Elm_Genlist_Item  *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17439    /**
17440     * Get the @b previous item in a genlist widget's internal list of items,
17441     * given a handle to one of those items.
17442     *
17443     * @param item The genlist item to fetch previous from
17444     * @return The item before @p item, or @c NULL if there's none (and
17445     * on errors)
17446     *
17447     * This returns the item placed before the @p item, on the container
17448     * genlist.
17449     *
17450     * @see elm_genlist_item_next_get()
17451     *
17452     * @ingroup Genlist
17453     */
17454    EAPI Elm_Genlist_Item  *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17455    /**
17456     * Get the genlist object's handle which contains a given genlist
17457     * item
17458     *
17459     * @param item The item to fetch the container from
17460     * @return The genlist (parent) object
17461     *
17462     * This returns the genlist object itself that an item belongs to.
17463     *
17464     * @ingroup Genlist
17465     */
17466    EAPI Evas_Object       *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17467    /**
17468     * Get the parent item of the given item
17469     *
17470     * @param it The item
17471     * @return The parent of the item or @c NULL if it has no parent.
17472     *
17473     * This returns the item that was specified as parent of the item @p it on
17474     * elm_genlist_item_append() and insertion related functions.
17475     *
17476     * @ingroup Genlist
17477     */
17478    EAPI Elm_Genlist_Item  *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17479    /**
17480     * Remove all sub-items (children) of the given item
17481     *
17482     * @param it The item
17483     *
17484     * This removes all items that are children (and their descendants) of the
17485     * given item @p it.
17486     *
17487     * @see elm_genlist_clear()
17488     * @see elm_genlist_item_del()
17489     *
17490     * @ingroup Genlist
17491     */
17492    EAPI void               elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17493    /**
17494     * Set whether a given genlist item is selected or not
17495     *
17496     * @param it The item
17497     * @param selected Use @c EINA_TRUE, to make it selected, @c
17498     * EINA_FALSE to make it unselected
17499     *
17500     * This sets the selected state of an item. If multi selection is
17501     * not enabled on the containing genlist and @p selected is @c
17502     * EINA_TRUE, any other previously selected items will get
17503     * unselected in favor of this new one.
17504     *
17505     * @see elm_genlist_item_selected_get()
17506     *
17507     * @ingroup Genlist
17508     */
17509    EAPI void               elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
17510    /**
17511     * Get whether a given genlist item is selected or not
17512     *
17513     * @param it The item
17514     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
17515     *
17516     * @see elm_genlist_item_selected_set() for more details
17517     *
17518     * @ingroup Genlist
17519     */
17520    EAPI Eina_Bool          elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17521    /**
17522     * Sets the expanded state of an item.
17523     *
17524     * @param it The item
17525     * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
17526     *
17527     * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
17528     * expanded or not.
17529     *
17530     * The theme will respond to this change visually, and a signal "expanded" or
17531     * "contracted" will be sent from the genlist with a pointer to the item that
17532     * has been expanded/contracted.
17533     *
17534     * Calling this function won't show or hide any child of this item (if it is
17535     * a parent). You must manually delete and create them on the callbacks fo
17536     * the "expanded" or "contracted" signals.
17537     *
17538     * @see elm_genlist_item_expanded_get()
17539     *
17540     * @ingroup Genlist
17541     */
17542    EAPI void               elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
17543    /**
17544     * Get the expanded state of an item
17545     *
17546     * @param it The item
17547     * @return The expanded state
17548     *
17549     * This gets the expanded state of an item.
17550     *
17551     * @see elm_genlist_item_expanded_set()
17552     *
17553     * @ingroup Genlist
17554     */
17555    EAPI Eina_Bool          elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17556    /**
17557     * Get the depth of expanded item
17558     *
17559     * @param it The genlist item object
17560     * @return The depth of expanded item
17561     *
17562     * @ingroup Genlist
17563     */
17564    EAPI int                elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17565    /**
17566     * Set whether a given genlist item is disabled or not.
17567     *
17568     * @param it The item
17569     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
17570     * to enable it back.
17571     *
17572     * A disabled item cannot be selected or unselected. It will also
17573     * change its appearance, to signal the user it's disabled.
17574     *
17575     * @see elm_genlist_item_disabled_get()
17576     *
17577     * @ingroup Genlist
17578     */
17579    EAPI void               elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17580    /**
17581     * Get whether a given genlist item is disabled or not.
17582     *
17583     * @param it The item
17584     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
17585     * (and on errors).
17586     *
17587     * @see elm_genlist_item_disabled_set() for more details
17588     *
17589     * @ingroup Genlist
17590     */
17591    EAPI Eina_Bool          elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17592    /**
17593     * Sets the display only state of an item.
17594     *
17595     * @param it The item
17596     * @param display_only @c EINA_TRUE if the item is display only, @c
17597     * EINA_FALSE otherwise.
17598     *
17599     * A display only item cannot be selected or unselected. It is for
17600     * display only and not selecting or otherwise clicking, dragging
17601     * etc. by the user, thus finger size rules will not be applied to
17602     * this item.
17603     *
17604     * It's good to set group index items to display only state.
17605     *
17606     * @see elm_genlist_item_display_only_get()
17607     *
17608     * @ingroup Genlist
17609     */
17610    EAPI void               elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
17611    /**
17612     * Get the display only state of an item
17613     *
17614     * @param it The item
17615     * @return @c EINA_TRUE if the item is display only, @c
17616     * EINA_FALSE otherwise.
17617     *
17618     * @see elm_genlist_item_display_only_set()
17619     *
17620     * @ingroup Genlist
17621     */
17622    EAPI Eina_Bool          elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17623    /**
17624     * Show the portion of a genlist's internal list containing a given
17625     * item, immediately.
17626     *
17627     * @param it The item to display
17628     *
17629     * This causes genlist to jump to the given item @p it and show it (by
17630     * immediately scrolling to that position), if it is not fully visible.
17631     *
17632     * @see elm_genlist_item_bring_in()
17633     * @see elm_genlist_item_top_show()
17634     * @see elm_genlist_item_middle_show()
17635     *
17636     * @ingroup Genlist
17637     */
17638    EAPI void               elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17639    /**
17640     * Animatedly bring in, to the visible are of a genlist, a given
17641     * item on it.
17642     *
17643     * @param it The item to display
17644     *
17645     * This causes genlist to jump to the given item @p it and show it (by
17646     * animatedly scrolling), if it is not fully visible. This may use animation
17647     * to do so and take a period of time
17648     *
17649     * @see elm_genlist_item_show()
17650     * @see elm_genlist_item_top_bring_in()
17651     * @see elm_genlist_item_middle_bring_in()
17652     *
17653     * @ingroup Genlist
17654     */
17655    EAPI void               elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17656    /**
17657     * Show the portion of a genlist's internal list containing a given
17658     * item, immediately.
17659     *
17660     * @param it The item to display
17661     *
17662     * This causes genlist to jump to the given item @p it and show it (by
17663     * immediately scrolling to that position), if it is not fully visible.
17664     *
17665     * The item will be positioned at the top of the genlist viewport.
17666     *
17667     * @see elm_genlist_item_show()
17668     * @see elm_genlist_item_top_bring_in()
17669     *
17670     * @ingroup Genlist
17671     */
17672    EAPI void               elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17673    /**
17674     * Animatedly bring in, to the visible are of a genlist, a given
17675     * item on it.
17676     *
17677     * @param it The item
17678     *
17679     * This causes genlist to jump to the given item @p it and show it (by
17680     * animatedly scrolling), if it is not fully visible. This may use animation
17681     * to do so and take a period of time
17682     *
17683     * The item will be positioned at the top of the genlist viewport.
17684     *
17685     * @see elm_genlist_item_bring_in()
17686     * @see elm_genlist_item_top_show()
17687     *
17688     * @ingroup Genlist
17689     */
17690    EAPI void               elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17691    /**
17692     * Show the portion of a genlist's internal list containing a given
17693     * item, immediately.
17694     *
17695     * @param it The item to display
17696     *
17697     * This causes genlist to jump to the given item @p it and show it (by
17698     * immediately scrolling to that position), if it is not fully visible.
17699     *
17700     * The item will be positioned at the middle of the genlist viewport.
17701     *
17702     * @see elm_genlist_item_show()
17703     * @see elm_genlist_item_middle_bring_in()
17704     *
17705     * @ingroup Genlist
17706     */
17707    EAPI void               elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17708    /**
17709     * Animatedly bring in, to the visible are of a genlist, a given
17710     * item on it.
17711     *
17712     * @param it The item
17713     *
17714     * This causes genlist to jump to the given item @p it and show it (by
17715     * animatedly scrolling), if it is not fully visible. This may use animation
17716     * to do so and take a period of time
17717     *
17718     * The item will be positioned at the middle of the genlist viewport.
17719     *
17720     * @see elm_genlist_item_bring_in()
17721     * @see elm_genlist_item_middle_show()
17722     *
17723     * @ingroup Genlist
17724     */
17725    EAPI void               elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17726    /**
17727     * Remove a genlist item from the its parent, deleting it.
17728     *
17729     * @param item The item to be removed.
17730     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
17731     *
17732     * @see elm_genlist_clear(), to remove all items in a genlist at
17733     * once.
17734     *
17735     * @ingroup Genlist
17736     */
17737    EAPI void               elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17738    /**
17739     * Return the data associated to a given genlist item
17740     *
17741     * @param item The genlist item.
17742     * @return the data associated to this item.
17743     *
17744     * This returns the @c data value passed on the
17745     * elm_genlist_item_append() and related item addition calls.
17746     *
17747     * @see elm_genlist_item_append()
17748     * @see elm_genlist_item_data_set()
17749     *
17750     * @ingroup Genlist
17751     */
17752    EAPI void              *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17753    /**
17754     * Set the data associated to a given genlist item
17755     *
17756     * @param item The genlist item
17757     * @param data The new data pointer to set on it
17758     *
17759     * This @b overrides the @c data value passed on the
17760     * elm_genlist_item_append() and related item addition calls. This
17761     * function @b won't call elm_genlist_item_update() automatically,
17762     * so you'd issue it afterwards if you want to hove the item
17763     * updated to reflect the that new data.
17764     *
17765     * @see elm_genlist_item_data_get()
17766     *
17767     * @ingroup Genlist
17768     */
17769    EAPI void               elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
17770    /**
17771     * Tells genlist to "orphan" icons fetchs by the item class
17772     *
17773     * @param it The item
17774     *
17775     * This instructs genlist to release references to icons in the item,
17776     * meaning that they will no longer be managed by genlist and are
17777     * floating "orphans" that can be re-used elsewhere if the user wants
17778     * to.
17779     *
17780     * @ingroup Genlist
17781     */
17782    EAPI void               elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17783    /**
17784     * Get the real Evas object created to implement the view of a
17785     * given genlist item
17786     *
17787     * @param item The genlist item.
17788     * @return the Evas object implementing this item's view.
17789     *
17790     * This returns the actual Evas object used to implement the
17791     * specified genlist item's view. This may be @c NULL, as it may
17792     * not have been created or may have been deleted, at any time, by
17793     * the genlist. <b>Do not modify this object</b> (move, resize,
17794     * show, hide, etc.), as the genlist is controlling it. This
17795     * function is for querying, emitting custom signals or hooking
17796     * lower level callbacks for events on that object. Do not delete
17797     * this object under any circumstances.
17798     *
17799     * @see elm_genlist_item_data_get()
17800     *
17801     * @ingroup Genlist
17802     */
17803    EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17804    /**
17805     * Update the contents of an item
17806     *
17807     * @param it The item
17808     *
17809     * This updates an item by calling all the item class functions again
17810     * to get the icons, labels and states. Use this when the original
17811     * item data has changed and the changes are desired to be reflected.
17812     *
17813     * Use elm_genlist_realized_items_update() to update all already realized
17814     * items.
17815     *
17816     * @see elm_genlist_realized_items_update()
17817     *
17818     * @ingroup Genlist
17819     */
17820    EAPI void               elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17821    /**
17822     * Update the item class of an item
17823     *
17824     * @param it The item
17825     * @param itc The item class for the item
17826     *
17827     * This sets another class fo the item, changing the way that it is
17828     * displayed. After changing the item class, elm_genlist_item_update() is
17829     * called on the item @p it.
17830     *
17831     * @ingroup Genlist
17832     */
17833    EAPI void               elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
17834    EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17835    /**
17836     * Set the text to be shown in a given genlist item's tooltips.
17837     *
17838     * @param item The genlist item
17839     * @param text The text to set in the content
17840     *
17841     * This call will setup the text to be used as tooltip to that item
17842     * (analogous to elm_object_tooltip_text_set(), but being item
17843     * tooltips with higher precedence than object tooltips). It can
17844     * have only one tooltip at a time, so any previous tooltip data
17845     * will get removed.
17846     *
17847     * In order to set an icon or something else as a tooltip, look at
17848     * elm_genlist_item_tooltip_content_cb_set().
17849     *
17850     * @ingroup Genlist
17851     */
17852    EAPI void               elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
17853    /**
17854     * Set the content to be shown in a given genlist item's tooltips
17855     *
17856     * @param item The genlist item.
17857     * @param func The function returning the tooltip contents.
17858     * @param data What to provide to @a func as callback data/context.
17859     * @param del_cb Called when data is not needed anymore, either when
17860     *        another callback replaces @p func, the tooltip is unset with
17861     *        elm_genlist_item_tooltip_unset() or the owner @p item
17862     *        dies. This callback receives as its first parameter the
17863     *        given @p data, being @c event_info the item handle.
17864     *
17865     * This call will setup the tooltip's contents to @p item
17866     * (analogous to elm_object_tooltip_content_cb_set(), but being
17867     * item tooltips with higher precedence than object tooltips). It
17868     * can have only one tooltip at a time, so any previous tooltip
17869     * content will get removed. @p func (with @p data) will be called
17870     * every time Elementary needs to show the tooltip and it should
17871     * return a valid Evas object, which will be fully managed by the
17872     * tooltip system, getting deleted when the tooltip is gone.
17873     *
17874     * In order to set just a text as a tooltip, look at
17875     * elm_genlist_item_tooltip_text_set().
17876     *
17877     * @ingroup Genlist
17878     */
17879    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);
17880    /**
17881     * Unset a tooltip from a given genlist item
17882     *
17883     * @param item genlist item to remove a previously set tooltip from.
17884     *
17885     * This call removes any tooltip set on @p item. The callback
17886     * provided as @c del_cb to
17887     * elm_genlist_item_tooltip_content_cb_set() will be called to
17888     * notify it is not used anymore (and have resources cleaned, if
17889     * need be).
17890     *
17891     * @see elm_genlist_item_tooltip_content_cb_set()
17892     *
17893     * @ingroup Genlist
17894     */
17895    EAPI void               elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17896    /**
17897     * Set a different @b style for a given genlist item's tooltip.
17898     *
17899     * @param item genlist item with tooltip set
17900     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
17901     * "default", @c "transparent", etc)
17902     *
17903     * Tooltips can have <b>alternate styles</b> to be displayed on,
17904     * which are defined by the theme set on Elementary. This function
17905     * works analogously as elm_object_tooltip_style_set(), but here
17906     * applied only to genlist item objects. The default style for
17907     * tooltips is @c "default".
17908     *
17909     * @note before you set a style you should define a tooltip with
17910     *       elm_genlist_item_tooltip_content_cb_set() or
17911     *       elm_genlist_item_tooltip_text_set()
17912     *
17913     * @see elm_genlist_item_tooltip_style_get()
17914     *
17915     * @ingroup Genlist
17916     */
17917    EAPI void               elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
17918    /**
17919     * Get the style set a given genlist item's tooltip.
17920     *
17921     * @param item genlist item with tooltip already set on.
17922     * @return style the theme style in use, which defaults to
17923     *         "default". If the object does not have a tooltip set,
17924     *         then @c NULL is returned.
17925     *
17926     * @see elm_genlist_item_tooltip_style_set() for more details
17927     *
17928     * @ingroup Genlist
17929     */
17930    EAPI const char        *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17931    /**
17932     * @brief Disable size restrictions on an object's tooltip
17933     * @param item The tooltip's anchor object
17934     * @param disable If EINA_TRUE, size restrictions are disabled
17935     * @return EINA_FALSE on failure, EINA_TRUE on success
17936     *
17937     * This function allows a tooltip to expand beyond its parant window's canvas.
17938     * It will instead be limited only by the size of the display.
17939     */
17940    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
17941    /**
17942     * @brief Retrieve size restriction state of an object's tooltip
17943     * @param item The tooltip's anchor object
17944     * @return If EINA_TRUE, size restrictions are disabled
17945     *
17946     * This function returns whether a tooltip is allowed to expand beyond
17947     * its parant window's canvas.
17948     * It will instead be limited only by the size of the display.
17949     */
17950    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
17951    /**
17952     * Set the type of mouse pointer/cursor decoration to be shown,
17953     * when the mouse pointer is over the given genlist widget item
17954     *
17955     * @param item genlist item to customize cursor on
17956     * @param cursor the cursor type's name
17957     *
17958     * This function works analogously as elm_object_cursor_set(), but
17959     * here the cursor's changing area is restricted to the item's
17960     * area, and not the whole widget's. Note that that item cursors
17961     * have precedence over widget cursors, so that a mouse over @p
17962     * item will always show cursor @p type.
17963     *
17964     * If this function is called twice for an object, a previously set
17965     * cursor will be unset on the second call.
17966     *
17967     * @see elm_object_cursor_set()
17968     * @see elm_genlist_item_cursor_get()
17969     * @see elm_genlist_item_cursor_unset()
17970     *
17971     * @ingroup Genlist
17972     */
17973    EAPI void               elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17974    /**
17975     * Get the type of mouse pointer/cursor decoration set to be shown,
17976     * when the mouse pointer is over the given genlist widget item
17977     *
17978     * @param item genlist item with custom cursor set
17979     * @return the cursor type's name or @c NULL, if no custom cursors
17980     * were set to @p item (and on errors)
17981     *
17982     * @see elm_object_cursor_get()
17983     * @see elm_genlist_item_cursor_set() for more details
17984     * @see elm_genlist_item_cursor_unset()
17985     *
17986     * @ingroup Genlist
17987     */
17988    EAPI const char        *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17989    /**
17990     * Unset any custom mouse pointer/cursor decoration set to be
17991     * shown, when the mouse pointer is over the given genlist widget
17992     * item, thus making it show the @b default cursor again.
17993     *
17994     * @param item a genlist item
17995     *
17996     * Use this call to undo any custom settings on this item's cursor
17997     * decoration, bringing it back to defaults (no custom style set).
17998     *
17999     * @see elm_object_cursor_unset()
18000     * @see elm_genlist_item_cursor_set() for more details
18001     *
18002     * @ingroup Genlist
18003     */
18004    EAPI void               elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18005    /**
18006     * Set a different @b style for a given custom cursor set for a
18007     * genlist item.
18008     *
18009     * @param item genlist item with custom cursor set
18010     * @param style the <b>theme style</b> to use (e.g. @c "default",
18011     * @c "transparent", etc)
18012     *
18013     * This function only makes sense when one is using custom mouse
18014     * cursor decorations <b>defined in a theme file</b> , which can
18015     * have, given a cursor name/type, <b>alternate styles</b> on
18016     * it. It works analogously as elm_object_cursor_style_set(), but
18017     * here applied only to genlist item objects.
18018     *
18019     * @warning Before you set a cursor style you should have defined a
18020     *       custom cursor previously on the item, with
18021     *       elm_genlist_item_cursor_set()
18022     *
18023     * @see elm_genlist_item_cursor_engine_only_set()
18024     * @see elm_genlist_item_cursor_style_get()
18025     *
18026     * @ingroup Genlist
18027     */
18028    EAPI void               elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
18029    /**
18030     * Get the current @b style set for a given genlist item's custom
18031     * cursor
18032     *
18033     * @param item genlist item with custom cursor set.
18034     * @return style the cursor style in use. If the object does not
18035     *         have a cursor set, then @c NULL is returned.
18036     *
18037     * @see elm_genlist_item_cursor_style_set() for more details
18038     *
18039     * @ingroup Genlist
18040     */
18041    EAPI const char        *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18042    /**
18043     * Set if the (custom) cursor for a given genlist item should be
18044     * searched in its theme, also, or should only rely on the
18045     * rendering engine.
18046     *
18047     * @param item item with custom (custom) cursor already set on
18048     * @param engine_only Use @c EINA_TRUE to have cursors looked for
18049     * only on those provided by the rendering engine, @c EINA_FALSE to
18050     * have them searched on the widget's theme, as well.
18051     *
18052     * @note This call is of use only if you've set a custom cursor
18053     * for genlist items, with elm_genlist_item_cursor_set().
18054     *
18055     * @note By default, cursors will only be looked for between those
18056     * provided by the rendering engine.
18057     *
18058     * @ingroup Genlist
18059     */
18060    EAPI void               elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
18061    /**
18062     * Get if the (custom) cursor for a given genlist item is being
18063     * searched in its theme, also, or is only relying on the rendering
18064     * engine.
18065     *
18066     * @param item a genlist item
18067     * @return @c EINA_TRUE, if cursors are being looked for only on
18068     * those provided by the rendering engine, @c EINA_FALSE if they
18069     * are being searched on the widget's theme, as well.
18070     *
18071     * @see elm_genlist_item_cursor_engine_only_set(), for more details
18072     *
18073     * @ingroup Genlist
18074     */
18075    EAPI Eina_Bool          elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18076    /**
18077     * Update the contents of all realized items.
18078     *
18079     * @param obj The genlist object.
18080     *
18081     * This updates all realized items by calling all the item class functions again
18082     * to get the icons, labels and states. Use this when the original
18083     * item data has changed and the changes are desired to be reflected.
18084     *
18085     * To update just one item, use elm_genlist_item_update().
18086     *
18087     * @see elm_genlist_realized_items_get()
18088     * @see elm_genlist_item_update()
18089     *
18090     * @ingroup Genlist
18091     */
18092    EAPI void               elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
18093    /**
18094     * Activate a genlist mode on an item
18095     *
18096     * @param item The genlist item
18097     * @param mode Mode name
18098     * @param mode_set Boolean to define set or unset mode.
18099     *
18100     * A genlist mode is a different way of selecting an item. Once a mode is
18101     * activated on an item, any other selected item is immediately unselected.
18102     * This feature provides an easy way of implementing a new kind of animation
18103     * for selecting an item, without having to entirely rewrite the item style
18104     * theme. However, the elm_genlist_selected_* API can't be used to get what
18105     * item is activate for a mode.
18106     *
18107     * The current item style will still be used, but applying a genlist mode to
18108     * an item will select it using a different kind of animation.
18109     *
18110     * The current active item for a mode can be found by
18111     * elm_genlist_mode_item_get().
18112     *
18113     * The characteristics of genlist mode are:
18114     * - Only one mode can be active at any time, and for only one item.
18115     * - Genlist handles deactivating other items when one item is activated.
18116     * - A mode is defined in the genlist theme (edc), and more modes can easily
18117     *   be added.
18118     * - A mode style and the genlist item style are different things. They
18119     *   can be combined to provide a default style to the item, with some kind
18120     *   of animation for that item when the mode is activated.
18121     *
18122     * When a mode is activated on an item, a new view for that item is created.
18123     * The theme of this mode defines the animation that will be used to transit
18124     * the item from the old view to the new view. This second (new) view will be
18125     * active for that item while the mode is active on the item, and will be
18126     * destroyed after the mode is totally deactivated from that item.
18127     *
18128     * @see elm_genlist_mode_get()
18129     * @see elm_genlist_mode_item_get()
18130     *
18131     * @ingroup Genlist
18132     */
18133    EAPI void               elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
18134    /**
18135     * Get the last (or current) genlist mode used.
18136     *
18137     * @param obj The genlist object
18138     *
18139     * This function just returns the name of the last used genlist mode. It will
18140     * be the current mode if it's still active.
18141     *
18142     * @see elm_genlist_item_mode_set()
18143     * @see elm_genlist_mode_item_get()
18144     *
18145     * @ingroup Genlist
18146     */
18147    EAPI const char        *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18148    /**
18149     * Get active genlist mode item
18150     *
18151     * @param obj The genlist object
18152     * @return The active item for that current mode. Or @c NULL if no item is
18153     * activated with any mode.
18154     *
18155     * This function returns the item that was activated with a mode, by the
18156     * function elm_genlist_item_mode_set().
18157     *
18158     * @see elm_genlist_item_mode_set()
18159     * @see elm_genlist_mode_get()
18160     *
18161     * @ingroup Genlist
18162     */
18163    EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18164
18165    /**
18166     * Set reorder mode
18167     *
18168     * @param obj The genlist object
18169     * @param reorder_mode The reorder mode
18170     * (EINA_TRUE = on, EINA_FALSE = off)
18171     *
18172     * @ingroup Genlist
18173     */
18174    EAPI void               elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
18175
18176    /**
18177     * Get the reorder mode
18178     *
18179     * @param obj The genlist object
18180     * @return The reorder mode
18181     * (EINA_TRUE = on, EINA_FALSE = off)
18182     *
18183     * @ingroup Genlist
18184     */
18185    EAPI Eina_Bool          elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18186
18187    /**
18188     * @}
18189     */
18190
18191    /**
18192     * @defgroup Check Check
18193     *
18194     * @image html img/widget/check/preview-00.png
18195     * @image latex img/widget/check/preview-00.eps
18196     * @image html img/widget/check/preview-01.png
18197     * @image latex img/widget/check/preview-01.eps
18198     * @image html img/widget/check/preview-02.png
18199     * @image latex img/widget/check/preview-02.eps
18200     *
18201     * @brief The check widget allows for toggling a value between true and
18202     * false.
18203     *
18204     * Check objects are a lot like radio objects in layout and functionality
18205     * except they do not work as a group, but independently and only toggle the
18206     * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
18207     * the boolean state (1 for true, 0 for false), and elm_check_state_get()
18208     * returns the current state. For convenience, like the radio objects, you
18209     * can set a pointer to a boolean directly with elm_check_state_pointer_set()
18210     * for it to modify.
18211     *
18212     * Signals that you can add callbacks for are:
18213     * "changed" - This is called whenever the user changes the state of one of
18214     *             the check object(event_info is NULL).
18215     *
18216     * @ref tutorial_check should give you a firm grasp of how to use this widget.
18217     * @{
18218     */
18219    /**
18220     * @brief Add a new Check object
18221     *
18222     * @param parent The parent object
18223     * @return The new object or NULL if it cannot be created
18224     */
18225    EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18226    /**
18227     * @brief Set the text label of the check object
18228     *
18229     * @param obj The check object
18230     * @param label The text label string in UTF-8
18231     *
18232     * @deprecated use elm_object_text_set() instead.
18233     */
18234    EINA_DEPRECATED EAPI void         elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18235    /**
18236     * @brief Get the text label of the check object
18237     *
18238     * @param obj The check object
18239     * @return The text label string in UTF-8
18240     *
18241     * @deprecated use elm_object_text_get() instead.
18242     */
18243    EINA_DEPRECATED EAPI const char  *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18244    /**
18245     * @brief Set the icon object of the check object
18246     *
18247     * @param obj The check object
18248     * @param icon The icon object
18249     *
18250     * Once the icon object is set, a previously set one will be deleted.
18251     * If you want to keep that old content object, use the
18252     * elm_check_icon_unset() function.
18253     */
18254    EAPI void         elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18255    /**
18256     * @brief Get the icon object of the check object
18257     *
18258     * @param obj The check object
18259     * @return The icon object
18260     */
18261    EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18262    /**
18263     * @brief Unset the icon used for the check object
18264     *
18265     * @param obj The check object
18266     * @return The icon object that was being used
18267     *
18268     * Unparent and return the icon object which was set for this widget.
18269     */
18270    EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18271    /**
18272     * @brief Set the on/off state of the check object
18273     *
18274     * @param obj The check object
18275     * @param state The state to use (1 == on, 0 == off)
18276     *
18277     * This sets the state of the check. If set
18278     * with elm_check_state_pointer_set() the state of that variable is also
18279     * changed. Calling this @b doesn't cause the "changed" signal to be emited.
18280     */
18281    EAPI void         elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
18282    /**
18283     * @brief Get the state of the check object
18284     *
18285     * @param obj The check object
18286     * @return The boolean state
18287     */
18288    EAPI Eina_Bool    elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18289    /**
18290     * @brief Set a convenience pointer to a boolean to change
18291     *
18292     * @param obj The check object
18293     * @param statep Pointer to the boolean to modify
18294     *
18295     * This sets a pointer to a boolean, that, in addition to the check objects
18296     * state will also be modified directly. To stop setting the object pointed
18297     * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
18298     * then when this is called, the check objects state will also be modified to
18299     * reflect the value of the boolean @p statep points to, just like calling
18300     * elm_check_state_set().
18301     */
18302    EAPI void         elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
18303    /**
18304     * @}
18305     */
18306
18307    /**
18308     * @defgroup Radio Radio
18309     *
18310     * @image html img/widget/radio/preview-00.png
18311     * @image latex img/widget/radio/preview-00.eps
18312     *
18313     * @brief Radio is a widget that allows for 1 or more options to be displayed
18314     * and have the user choose only 1 of them.
18315     *
18316     * A radio object contains an indicator, an optional Label and an optional
18317     * icon object. While it's possible to have a group of only one radio they,
18318     * are normally used in groups of 2 or more. To add a radio to a group use
18319     * elm_radio_group_add(). The radio object(s) will select from one of a set
18320     * of integer values, so any value they are configuring needs to be mapped to
18321     * a set of integers. To configure what value that radio object represents,
18322     * use  elm_radio_state_value_set() to set the integer it represents. To set
18323     * the value the whole group(which one is currently selected) is to indicate
18324     * use elm_radio_value_set() on any group member, and to get the groups value
18325     * use elm_radio_value_get(). For convenience the radio objects are also able
18326     * to directly set an integer(int) to the value that is selected. To specify
18327     * the pointer to this integer to modify, use elm_radio_value_pointer_set().
18328     * The radio objects will modify this directly. That implies the pointer must
18329     * point to valid memory for as long as the radio objects exist.
18330     *
18331     * Signals that you can add callbacks for are:
18332     * @li changed - This is called whenever the user changes the state of one of
18333     * the radio objects within the group of radio objects that work together.
18334     *
18335     * @ref tutorial_radio show most of this API in action.
18336     * @{
18337     */
18338    /**
18339     * @brief Add a new radio to the parent
18340     *
18341     * @param parent The parent object
18342     * @return The new object or NULL if it cannot be created
18343     */
18344    EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18345    /**
18346     * @brief Set the text label of the radio object
18347     *
18348     * @param obj The radio object
18349     * @param label The text label string in UTF-8
18350     *
18351     * @deprecated use elm_object_text_set() instead.
18352     */
18353    EINA_DEPRECATED EAPI void         elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18354    /**
18355     * @brief Get the text label of the radio object
18356     *
18357     * @param obj The radio object
18358     * @return The text label string in UTF-8
18359     *
18360     * @deprecated use elm_object_text_set() instead.
18361     */
18362    EINA_DEPRECATED EAPI const char  *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18363    /**
18364     * @brief Set the icon object of the radio object
18365     *
18366     * @param obj The radio object
18367     * @param icon The icon object
18368     *
18369     * Once the icon object is set, a previously set one will be deleted. If you
18370     * want to keep that old content object, use the elm_radio_icon_unset()
18371     * function.
18372     */
18373    EAPI void         elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18374    /**
18375     * @brief Get the icon object of the radio object
18376     *
18377     * @param obj The radio object
18378     * @return The icon object
18379     *
18380     * @see elm_radio_icon_set()
18381     */
18382    EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18383    /**
18384     * @brief Unset the icon used for the radio object
18385     *
18386     * @param obj The radio object
18387     * @return The icon object that was being used
18388     *
18389     * Unparent and return the icon object which was set for this widget.
18390     *
18391     * @see elm_radio_icon_set()
18392     */
18393    EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18394    /**
18395     * @brief Add this radio to a group of other radio objects
18396     *
18397     * @param obj The radio object
18398     * @param group Any object whose group the @p obj is to join.
18399     *
18400     * Radio objects work in groups. Each member should have a different integer
18401     * value assigned. In order to have them work as a group, they need to know
18402     * about each other. This adds the given radio object to the group of which
18403     * the group object indicated is a member.
18404     */
18405    EAPI void         elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
18406    /**
18407     * @brief Set the integer value that this radio object represents
18408     *
18409     * @param obj The radio object
18410     * @param value The value to use if this radio object is selected
18411     *
18412     * This sets the value of the radio.
18413     */
18414    EAPI void         elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
18415    /**
18416     * @brief Get the integer value that this radio object represents
18417     *
18418     * @param obj The radio object
18419     * @return The value used if this radio object is selected
18420     *
18421     * This gets the value of the radio.
18422     *
18423     * @see elm_radio_value_set()
18424     */
18425    EAPI int          elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18426    /**
18427     * @brief Set the value of the radio.
18428     *
18429     * @param obj The radio object
18430     * @param value The value to use for the group
18431     *
18432     * This sets the value of the radio group and will also set the value if
18433     * pointed to, to the value supplied, but will not call any callbacks.
18434     */
18435    EAPI void         elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
18436    /**
18437     * @brief Get the state of the radio object
18438     *
18439     * @param obj The radio object
18440     * @return The integer state
18441     */
18442    EAPI int          elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18443    /**
18444     * @brief Set a convenience pointer to a integer to change
18445     *
18446     * @param obj The radio object
18447     * @param valuep Pointer to the integer to modify
18448     *
18449     * This sets a pointer to a integer, that, in addition to the radio objects
18450     * state will also be modified directly. To stop setting the object pointed
18451     * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
18452     * when this is called, the radio objects state will also be modified to
18453     * reflect the value of the integer valuep points to, just like calling
18454     * elm_radio_value_set().
18455     */
18456    EAPI void         elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
18457    /**
18458     * @}
18459     */
18460
18461    /**
18462     * @defgroup Pager Pager
18463     *
18464     * @image html img/widget/pager/preview-00.png
18465     * @image latex img/widget/pager/preview-00.eps
18466     *
18467     * @brief Widget that allows flipping between 1 or more “pages” of objects.
18468     *
18469     * The flipping between “pages” of objects is animated. All content in pager
18470     * is kept in a stack, the last content to be added will be on the top of the
18471     * stack(be visible).
18472     *
18473     * Objects can be pushed or popped from the stack or deleted as normal.
18474     * Pushes and pops will animate (and a pop will delete the object once the
18475     * animation is finished). Any object already in the pager can be promoted to
18476     * the top(from its current stacking position) through the use of
18477     * elm_pager_content_promote(). Objects are pushed to the top with
18478     * elm_pager_content_push() and when the top item is no longer wanted, simply
18479     * pop it with elm_pager_content_pop() and it will also be deleted. If an
18480     * object is no longer needed and is not the top item, just delete it as
18481     * normal. You can query which objects are the top and bottom with
18482     * elm_pager_content_bottom_get() and elm_pager_content_top_get().
18483     *
18484     * Signals that you can add callbacks for are:
18485     * "hide,finished" - when the previous page is hided
18486     *
18487     * This widget has the following styles available:
18488     * @li default
18489     * @li fade
18490     * @li fade_translucide
18491     * @li fade_invisible
18492     * @note This styles affect only the flipping animations, the appearance when
18493     * not animating is unaffected by styles.
18494     *
18495     * @ref tutorial_pager gives a good overview of the usage of the API.
18496     * @{
18497     */
18498    /**
18499     * Add a new pager to the parent
18500     *
18501     * @param parent The parent object
18502     * @return The new object or NULL if it cannot be created
18503     *
18504     * @ingroup Pager
18505     */
18506    EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18507    /**
18508     * @brief Push an object to the top of the pager stack (and show it).
18509     *
18510     * @param obj The pager object
18511     * @param content The object to push
18512     *
18513     * The object pushed becomes a child of the pager, it will be controlled and
18514     * deleted when the pager is deleted.
18515     *
18516     * @note If the content is already in the stack use
18517     * elm_pager_content_promote().
18518     * @warning Using this function on @p content already in the stack results in
18519     * undefined behavior.
18520     */
18521    EAPI void         elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18522    /**
18523     * @brief Pop the object that is on top of the stack
18524     *
18525     * @param obj The pager object
18526     *
18527     * This pops the object that is on the top(visible) of the pager, makes it
18528     * disappear, then deletes the object. The object that was underneath it on
18529     * the stack will become visible.
18530     */
18531    EAPI void         elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
18532    /**
18533     * @brief Moves an object already in the pager stack to the top of the stack.
18534     *
18535     * @param obj The pager object
18536     * @param content The object to promote
18537     *
18538     * This will take the @p content and move it to the top of the stack as
18539     * if it had been pushed there.
18540     *
18541     * @note If the content isn't already in the stack use
18542     * elm_pager_content_push().
18543     * @warning Using this function on @p content not already in the stack
18544     * results in undefined behavior.
18545     */
18546    EAPI void         elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18547    /**
18548     * @brief Return the object at the bottom of the pager stack
18549     *
18550     * @param obj The pager object
18551     * @return The bottom object or NULL if none
18552     */
18553    EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18554    /**
18555     * @brief  Return the object at the top of the pager stack
18556     *
18557     * @param obj The pager object
18558     * @return The top object or NULL if none
18559     */
18560    EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18561    /**
18562     * @}
18563     */
18564
18565    /**
18566     * @defgroup Slideshow Slideshow
18567     *
18568     * @image html img/widget/slideshow/preview-00.png
18569     * @image latex img/widget/slideshow/preview-00.eps
18570     *
18571     * This widget, as the name indicates, is a pre-made image
18572     * slideshow panel, with API functions acting on (child) image
18573     * items presentation. Between those actions, are:
18574     * - advance to next/previous image
18575     * - select the style of image transition animation
18576     * - set the exhibition time for each image
18577     * - start/stop the slideshow
18578     *
18579     * The transition animations are defined in the widget's theme,
18580     * consequently new animations can be added without having to
18581     * update the widget's code.
18582     *
18583     * @section Slideshow_Items Slideshow items
18584     *
18585     * For slideshow items, just like for @ref Genlist "genlist" ones,
18586     * the user defines a @b classes, specifying functions that will be
18587     * called on the item's creation and deletion times.
18588     *
18589     * The #Elm_Slideshow_Item_Class structure contains the following
18590     * members:
18591     *
18592     * - @c func.get - When an item is displayed, this function is
18593     *   called, and it's where one should create the item object, de
18594     *   facto. For example, the object can be a pure Evas image object
18595     *   or an Elementary @ref Photocam "photocam" widget. See
18596     *   #SlideshowItemGetFunc.
18597     * - @c func.del - When an item is no more displayed, this function
18598     *   is called, where the user must delete any data associated to
18599     *   the item. See #SlideshowItemDelFunc.
18600     *
18601     * @section Slideshow_Caching Slideshow caching
18602     *
18603     * The slideshow provides facilities to have items adjacent to the
18604     * one being displayed <b>already "realized"</b> (i.e. loaded) for
18605     * you, so that the system does not have to decode image data
18606     * anymore at the time it has to actually switch images on its
18607     * viewport. The user is able to set the numbers of items to be
18608     * cached @b before and @b after the current item, in the widget's
18609     * item list.
18610     *
18611     * Smart events one can add callbacks for are:
18612     *
18613     * - @c "changed" - when the slideshow switches its view to a new
18614     *   item
18615     *
18616     * List of examples for the slideshow widget:
18617     * @li @ref slideshow_example
18618     */
18619
18620    /**
18621     * @addtogroup Slideshow
18622     * @{
18623     */
18624
18625    typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
18626    typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
18627    typedef struct _Elm_Slideshow_Item       Elm_Slideshow_Item; /**< Slideshow item handle */
18628    typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
18629    typedef void         (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
18630
18631    /**
18632     * @struct _Elm_Slideshow_Item_Class
18633     *
18634     * Slideshow item class definition. See @ref Slideshow_Items for
18635     * field details.
18636     */
18637    struct _Elm_Slideshow_Item_Class
18638      {
18639         struct _Elm_Slideshow_Item_Class_Func
18640           {
18641              SlideshowItemGetFunc get;
18642              SlideshowItemDelFunc del;
18643           } func;
18644      }; /**< #Elm_Slideshow_Item_Class member definitions */
18645
18646    /**
18647     * Add a new slideshow widget to the given parent Elementary
18648     * (container) object
18649     *
18650     * @param parent The parent object
18651     * @return A new slideshow widget handle or @c NULL, on errors
18652     *
18653     * This function inserts a new slideshow widget on the canvas.
18654     *
18655     * @ingroup Slideshow
18656     */
18657    EAPI Evas_Object        *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18658
18659    /**
18660     * Add (append) a new item in a given slideshow widget.
18661     *
18662     * @param obj The slideshow object
18663     * @param itc The item class for the item
18664     * @param data The item's data
18665     * @return A handle to the item added or @c NULL, on errors
18666     *
18667     * Add a new item to @p obj's internal list of items, appending it.
18668     * The item's class must contain the function really fetching the
18669     * image object to show for this item, which could be an Evas image
18670     * object or an Elementary photo, for example. The @p data
18671     * parameter is going to be passed to both class functions of the
18672     * item.
18673     *
18674     * @see #Elm_Slideshow_Item_Class
18675     * @see elm_slideshow_item_sorted_insert()
18676     *
18677     * @ingroup Slideshow
18678     */
18679    EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
18680
18681    /**
18682     * Insert a new item into the given slideshow widget, using the @p func
18683     * function to sort items (by item handles).
18684     *
18685     * @param obj The slideshow object
18686     * @param itc The item class for the item
18687     * @param data The item's data
18688     * @param func The comparing function to be used to sort slideshow
18689     * items <b>by #Elm_Slideshow_Item item handles</b>
18690     * @return Returns The slideshow item handle, on success, or
18691     * @c NULL, on errors
18692     *
18693     * Add a new item to @p obj's internal list of items, in a position
18694     * determined by the @p func comparing function. The item's class
18695     * must contain the function really fetching the image object to
18696     * show for this item, which could be an Evas image object or an
18697     * Elementary photo, for example. The @p data parameter is going to
18698     * be passed to both class functions of the item.
18699     *
18700     * @see #Elm_Slideshow_Item_Class
18701     * @see elm_slideshow_item_add()
18702     *
18703     * @ingroup Slideshow
18704     */
18705    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);
18706
18707    /**
18708     * Display a given slideshow widget's item, programmatically.
18709     *
18710     * @param obj The slideshow object
18711     * @param item The item to display on @p obj's viewport
18712     *
18713     * The change between the current item and @p item will use the
18714     * transition @p obj is set to use (@see
18715     * elm_slideshow_transition_set()).
18716     *
18717     * @ingroup Slideshow
18718     */
18719    EAPI void                elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18720
18721    /**
18722     * Slide to the @b next item, in a given slideshow widget
18723     *
18724     * @param obj The slideshow object
18725     *
18726     * The sliding animation @p obj is set to use will be the
18727     * transition effect used, after this call is issued.
18728     *
18729     * @note If the end of the slideshow's internal list of items is
18730     * reached, it'll wrap around to the list's beginning, again.
18731     *
18732     * @ingroup Slideshow
18733     */
18734    EAPI void                elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
18735
18736    /**
18737     * Slide to the @b previous item, in a given slideshow widget
18738     *
18739     * @param obj The slideshow object
18740     *
18741     * The sliding animation @p obj is set to use will be the
18742     * transition effect used, after this call is issued.
18743     *
18744     * @note If the beginning of the slideshow's internal list of items
18745     * is reached, it'll wrap around to the list's end, again.
18746     *
18747     * @ingroup Slideshow
18748     */
18749    EAPI void                elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
18750
18751    /**
18752     * Returns the list of sliding transition/effect names available, for a
18753     * given slideshow widget.
18754     *
18755     * @param obj The slideshow object
18756     * @return The list of transitions (list of @b stringshared strings
18757     * as data)
18758     *
18759     * The transitions, which come from @p obj's theme, must be an EDC
18760     * data item named @c "transitions" on the theme file, with (prefix)
18761     * names of EDC programs actually implementing them.
18762     *
18763     * The available transitions for slideshows on the default theme are:
18764     * - @c "fade" - the current item fades out, while the new one
18765     *   fades in to the slideshow's viewport.
18766     * - @c "black_fade" - the current item fades to black, and just
18767     *   then, the new item will fade in.
18768     * - @c "horizontal" - the current item slides horizontally, until
18769     *   it gets out of the slideshow's viewport, while the new item
18770     *   comes from the left to take its place.
18771     * - @c "vertical" - the current item slides vertically, until it
18772     *   gets out of the slideshow's viewport, while the new item comes
18773     *   from the bottom to take its place.
18774     * - @c "square" - the new item starts to appear from the middle of
18775     *   the current one, but with a tiny size, growing until its
18776     *   target (full) size and covering the old one.
18777     *
18778     * @warning The stringshared strings get no new references
18779     * exclusive to the user grabbing the list, here, so if you'd like
18780     * to use them out of this call's context, you'd better @c
18781     * eina_stringshare_ref() them.
18782     *
18783     * @see elm_slideshow_transition_set()
18784     *
18785     * @ingroup Slideshow
18786     */
18787    EAPI const Eina_List    *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18788
18789    /**
18790     * Set the current slide transition/effect in use for a given
18791     * slideshow widget
18792     *
18793     * @param obj The slideshow object
18794     * @param transition The new transition's name string
18795     *
18796     * If @p transition is implemented in @p obj's theme (i.e., is
18797     * contained in the list returned by
18798     * elm_slideshow_transitions_get()), this new sliding effect will
18799     * be used on the widget.
18800     *
18801     * @see elm_slideshow_transitions_get() for more details
18802     *
18803     * @ingroup Slideshow
18804     */
18805    EAPI void                elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
18806
18807    /**
18808     * Get the current slide transition/effect in use for a given
18809     * slideshow widget
18810     *
18811     * @param obj The slideshow object
18812     * @return The current transition's name
18813     *
18814     * @see elm_slideshow_transition_set() for more details
18815     *
18816     * @ingroup Slideshow
18817     */
18818    EAPI const char         *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18819
18820    /**
18821     * Set the interval between each image transition on a given
18822     * slideshow widget, <b>and start the slideshow, itself</b>
18823     *
18824     * @param obj The slideshow object
18825     * @param timeout The new displaying timeout for images
18826     *
18827     * After this call, the slideshow widget will start cycling its
18828     * view, sequentially and automatically, with the images of the
18829     * items it has. The time between each new image displayed is going
18830     * to be @p timeout, in @b seconds. If a different timeout was set
18831     * previously and an slideshow was in progress, it will continue
18832     * with the new time between transitions, after this call.
18833     *
18834     * @note A value less than or equal to 0 on @p timeout will disable
18835     * the widget's internal timer, thus halting any slideshow which
18836     * could be happening on @p obj.
18837     *
18838     * @see elm_slideshow_timeout_get()
18839     *
18840     * @ingroup Slideshow
18841     */
18842    EAPI void                elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18843
18844    /**
18845     * Get the interval set for image transitions on a given slideshow
18846     * widget.
18847     *
18848     * @param obj The slideshow object
18849     * @return Returns the timeout set on it
18850     *
18851     * @see elm_slideshow_timeout_set() for more details
18852     *
18853     * @ingroup Slideshow
18854     */
18855    EAPI double              elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18856
18857    /**
18858     * Set if, after a slideshow is started, for a given slideshow
18859     * widget, its items should be displayed cyclically or not.
18860     *
18861     * @param obj The slideshow object
18862     * @param loop Use @c EINA_TRUE to make it cycle through items or
18863     * @c EINA_FALSE for it to stop at the end of @p obj's internal
18864     * list of items
18865     *
18866     * @note elm_slideshow_next() and elm_slideshow_previous() will @b
18867     * ignore what is set by this functions, i.e., they'll @b always
18868     * cycle through items. This affects only the "automatic"
18869     * slideshow, as set by elm_slideshow_timeout_set().
18870     *
18871     * @see elm_slideshow_loop_get()
18872     *
18873     * @ingroup Slideshow
18874     */
18875    EAPI void                elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
18876
18877    /**
18878     * Get if, after a slideshow is started, for a given slideshow
18879     * widget, its items are to be displayed cyclically or not.
18880     *
18881     * @param obj The slideshow object
18882     * @return @c EINA_TRUE, if the items in @p obj will be cycled
18883     * through or @c EINA_FALSE, otherwise
18884     *
18885     * @see elm_slideshow_loop_set() for more details
18886     *
18887     * @ingroup Slideshow
18888     */
18889    EAPI Eina_Bool           elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18890
18891    /**
18892     * Remove all items from a given slideshow widget
18893     *
18894     * @param obj The slideshow object
18895     *
18896     * This removes (and deletes) all items in @p obj, leaving it
18897     * empty.
18898     *
18899     * @see elm_slideshow_item_del(), to remove just one item.
18900     *
18901     * @ingroup Slideshow
18902     */
18903    EAPI void                elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18904
18905    /**
18906     * Get the internal list of items in a given slideshow widget.
18907     *
18908     * @param obj The slideshow object
18909     * @return The list of items (#Elm_Slideshow_Item as data) or
18910     * @c NULL on errors.
18911     *
18912     * This list is @b not to be modified in any way and must not be
18913     * freed. Use the list members with functions like
18914     * elm_slideshow_item_del(), elm_slideshow_item_data_get().
18915     *
18916     * @warning This list is only valid until @p obj object's internal
18917     * items list is changed. It should be fetched again with another
18918     * call to this function when changes happen.
18919     *
18920     * @ingroup Slideshow
18921     */
18922    EAPI const Eina_List    *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18923
18924    /**
18925     * Delete a given item from a slideshow widget.
18926     *
18927     * @param item The slideshow item
18928     *
18929     * @ingroup Slideshow
18930     */
18931    EAPI void                elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18932
18933    /**
18934     * Return the data associated with a given slideshow item
18935     *
18936     * @param item The slideshow item
18937     * @return Returns the data associated to this item
18938     *
18939     * @ingroup Slideshow
18940     */
18941    EAPI void               *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18942
18943    /**
18944     * Returns the currently displayed item, in a given slideshow widget
18945     *
18946     * @param obj The slideshow object
18947     * @return A handle to the item being displayed in @p obj or
18948     * @c NULL, if none is (and on errors)
18949     *
18950     * @ingroup Slideshow
18951     */
18952    EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18953
18954    /**
18955     * Get the real Evas object created to implement the view of a
18956     * given slideshow item
18957     *
18958     * @param item The slideshow item.
18959     * @return the Evas object implementing this item's view.
18960     *
18961     * This returns the actual Evas object used to implement the
18962     * specified slideshow item's view. This may be @c NULL, as it may
18963     * not have been created or may have been deleted, at any time, by
18964     * the slideshow. <b>Do not modify this object</b> (move, resize,
18965     * show, hide, etc.), as the slideshow is controlling it. This
18966     * function is for querying, emitting custom signals or hooking
18967     * lower level callbacks for events on that object. Do not delete
18968     * this object under any circumstances.
18969     *
18970     * @see elm_slideshow_item_data_get()
18971     *
18972     * @ingroup Slideshow
18973     */
18974    EAPI Evas_Object*        elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
18975
18976    /**
18977     * Get the the item, in a given slideshow widget, placed at
18978     * position @p nth, in its internal items list
18979     *
18980     * @param obj The slideshow object
18981     * @param nth The number of the item to grab a handle to (0 being
18982     * the first)
18983     * @return The item stored in @p obj at position @p nth or @c NULL,
18984     * if there's no item with that index (and on errors)
18985     *
18986     * @ingroup Slideshow
18987     */
18988    EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
18989
18990    /**
18991     * Set the current slide layout in use for a given slideshow widget
18992     *
18993     * @param obj The slideshow object
18994     * @param layout The new layout's name string
18995     *
18996     * If @p layout is implemented in @p obj's theme (i.e., is contained
18997     * in the list returned by elm_slideshow_layouts_get()), this new
18998     * images layout will be used on the widget.
18999     *
19000     * @see elm_slideshow_layouts_get() for more details
19001     *
19002     * @ingroup Slideshow
19003     */
19004    EAPI void                elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
19005
19006    /**
19007     * Get the current slide layout in use for a given slideshow widget
19008     *
19009     * @param obj The slideshow object
19010     * @return The current layout's name
19011     *
19012     * @see elm_slideshow_layout_set() for more details
19013     *
19014     * @ingroup Slideshow
19015     */
19016    EAPI const char         *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19017
19018    /**
19019     * Returns the list of @b layout names available, for a given
19020     * slideshow widget.
19021     *
19022     * @param obj The slideshow object
19023     * @return The list of layouts (list of @b stringshared strings
19024     * as data)
19025     *
19026     * Slideshow layouts will change how the widget is to dispose each
19027     * image item in its viewport, with regard to cropping, scaling,
19028     * etc.
19029     *
19030     * The layouts, which come from @p obj's theme, must be an EDC
19031     * data item name @c "layouts" on the theme file, with (prefix)
19032     * names of EDC programs actually implementing them.
19033     *
19034     * The available layouts for slideshows on the default theme are:
19035     * - @c "fullscreen" - item images with original aspect, scaled to
19036     *   touch top and down slideshow borders or, if the image's heigh
19037     *   is not enough, left and right slideshow borders.
19038     * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
19039     *   one, but always leaving 10% of the slideshow's dimensions of
19040     *   distance between the item image's borders and the slideshow
19041     *   borders, for each axis.
19042     *
19043     * @warning The stringshared strings get no new references
19044     * exclusive to the user grabbing the list, here, so if you'd like
19045     * to use them out of this call's context, you'd better @c
19046     * eina_stringshare_ref() them.
19047     *
19048     * @see elm_slideshow_layout_set()
19049     *
19050     * @ingroup Slideshow
19051     */
19052    EAPI const Eina_List    *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19053
19054    /**
19055     * Set the number of items to cache, on a given slideshow widget,
19056     * <b>before the current item</b>
19057     *
19058     * @param obj The slideshow object
19059     * @param count Number of items to cache before the current one
19060     *
19061     * The default value for this property is @c 2. See
19062     * @ref Slideshow_Caching "slideshow caching" for more details.
19063     *
19064     * @see elm_slideshow_cache_before_get()
19065     *
19066     * @ingroup Slideshow
19067     */
19068    EAPI void                elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
19069
19070    /**
19071     * Retrieve the number of items to cache, on a given slideshow widget,
19072     * <b>before the current item</b>
19073     *
19074     * @param obj The slideshow object
19075     * @return The number of items set to be cached before the current one
19076     *
19077     * @see elm_slideshow_cache_before_set() for more details
19078     *
19079     * @ingroup Slideshow
19080     */
19081    EAPI int                 elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19082
19083    /**
19084     * Set the number of items to cache, on a given slideshow widget,
19085     * <b>after the current item</b>
19086     *
19087     * @param obj The slideshow object
19088     * @param count Number of items to cache after the current one
19089     *
19090     * The default value for this property is @c 2. See
19091     * @ref Slideshow_Caching "slideshow caching" for more details.
19092     *
19093     * @see elm_slideshow_cache_after_get()
19094     *
19095     * @ingroup Slideshow
19096     */
19097    EAPI void                elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
19098
19099    /**
19100     * Retrieve the number of items to cache, on a given slideshow widget,
19101     * <b>after the current item</b>
19102     *
19103     * @param obj The slideshow object
19104     * @return The number of items set to be cached after the current one
19105     *
19106     * @see elm_slideshow_cache_after_set() for more details
19107     *
19108     * @ingroup Slideshow
19109     */
19110    EAPI int                 elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19111
19112    /**
19113     * Get the number of items stored in a given slideshow widget
19114     *
19115     * @param obj The slideshow object
19116     * @return The number of items on @p obj, at the moment of this call
19117     *
19118     * @ingroup Slideshow
19119     */
19120    EAPI unsigned int        elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19121
19122    /**
19123     * @}
19124     */
19125
19126    /**
19127     * @defgroup Fileselector File Selector
19128     *
19129     * @image html img/widget/fileselector/preview-00.png
19130     * @image latex img/widget/fileselector/preview-00.eps
19131     *
19132     * A file selector is a widget that allows a user to navigate
19133     * through a file system, reporting file selections back via its
19134     * API.
19135     *
19136     * It contains shortcut buttons for home directory (@c ~) and to
19137     * jump one directory upwards (..), as well as cancel/ok buttons to
19138     * confirm/cancel a given selection. After either one of those two
19139     * former actions, the file selector will issue its @c "done" smart
19140     * callback.
19141     *
19142     * There's a text entry on it, too, showing the name of the current
19143     * selection. There's the possibility of making it editable, so it
19144     * is useful on file saving dialogs on applications, where one
19145     * gives a file name to save contents to, in a given directory in
19146     * the system. This custom file name will be reported on the @c
19147     * "done" smart callback (explained in sequence).
19148     *
19149     * Finally, it has a view to display file system items into in two
19150     * possible forms:
19151     * - list
19152     * - grid
19153     *
19154     * If Elementary is built with support of the Ethumb thumbnailing
19155     * library, the second form of view will display preview thumbnails
19156     * of files which it supports.
19157     *
19158     * Smart callbacks one can register to:
19159     *
19160     * - @c "selected" - the user has clicked on a file (when not in
19161     *      folders-only mode) or directory (when in folders-only mode)
19162     * - @c "directory,open" - the list has been populated with new
19163     *      content (@c event_info is a pointer to the directory's
19164     *      path, a @b stringshared string)
19165     * - @c "done" - the user has clicked on the "ok" or "cancel"
19166     *      buttons (@c event_info is a pointer to the selection's
19167     *      path, a @b stringshared string)
19168     *
19169     * Here is an example on its usage:
19170     * @li @ref fileselector_example
19171     */
19172
19173    /**
19174     * @addtogroup Fileselector
19175     * @{
19176     */
19177
19178    /**
19179     * Defines how a file selector widget is to layout its contents
19180     * (file system entries).
19181     */
19182    typedef enum _Elm_Fileselector_Mode
19183      {
19184         ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
19185         ELM_FILESELECTOR_GRID, /**< layout as a grid */
19186         ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
19187      } Elm_Fileselector_Mode;
19188
19189    /**
19190     * Add a new file selector widget to the given parent Elementary
19191     * (container) object
19192     *
19193     * @param parent The parent object
19194     * @return a new file selector widget handle or @c NULL, on errors
19195     *
19196     * This function inserts a new file selector widget on the canvas.
19197     *
19198     * @ingroup Fileselector
19199     */
19200    EAPI Evas_Object          *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19201
19202    /**
19203     * Enable/disable the file name entry box where the user can type
19204     * in a name for a file, in a given file selector widget
19205     *
19206     * @param obj The file selector object
19207     * @param is_save @c EINA_TRUE to make the file selector a "saving
19208     * dialog", @c EINA_FALSE otherwise
19209     *
19210     * Having the entry editable is useful on file saving dialogs on
19211     * applications, where one gives a file name to save contents to,
19212     * in a given directory in the system. This custom file name will
19213     * be reported on the @c "done" smart callback.
19214     *
19215     * @see elm_fileselector_is_save_get()
19216     *
19217     * @ingroup Fileselector
19218     */
19219    EAPI void                  elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
19220
19221    /**
19222     * Get whether the given file selector is in "saving dialog" mode
19223     *
19224     * @param obj The file selector object
19225     * @return @c EINA_TRUE, if the file selector is in "saving dialog"
19226     * mode, @c EINA_FALSE otherwise (and on errors)
19227     *
19228     * @see elm_fileselector_is_save_set() for more details
19229     *
19230     * @ingroup Fileselector
19231     */
19232    EAPI Eina_Bool             elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19233
19234    /**
19235     * Enable/disable folder-only view for a given file selector widget
19236     *
19237     * @param obj The file selector object
19238     * @param only @c EINA_TRUE to make @p obj only display
19239     * directories, @c EINA_FALSE to make files to be displayed in it
19240     * too
19241     *
19242     * If enabled, the widget's view will only display folder items,
19243     * naturally.
19244     *
19245     * @see elm_fileselector_folder_only_get()
19246     *
19247     * @ingroup Fileselector
19248     */
19249    EAPI void                  elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
19250
19251    /**
19252     * Get whether folder-only view is set for a given file selector
19253     * widget
19254     *
19255     * @param obj The file selector object
19256     * @return only @c EINA_TRUE if @p obj is only displaying
19257     * directories, @c EINA_FALSE if files are being displayed in it
19258     * too (and on errors)
19259     *
19260     * @see elm_fileselector_folder_only_get()
19261     *
19262     * @ingroup Fileselector
19263     */
19264    EAPI Eina_Bool             elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19265
19266    /**
19267     * Enable/disable the "ok" and "cancel" buttons on a given file
19268     * selector widget
19269     *
19270     * @param obj The file selector object
19271     * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
19272     *
19273     * @note A file selector without those buttons will never emit the
19274     * @c "done" smart event, and is only usable if one is just hooking
19275     * to the other two events.
19276     *
19277     * @see elm_fileselector_buttons_ok_cancel_get()
19278     *
19279     * @ingroup Fileselector
19280     */
19281    EAPI void                  elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
19282
19283    /**
19284     * Get whether the "ok" and "cancel" buttons on a given file
19285     * selector widget are being shown.
19286     *
19287     * @param obj The file selector object
19288     * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
19289     * otherwise (and on errors)
19290     *
19291     * @see elm_fileselector_buttons_ok_cancel_set() for more details
19292     *
19293     * @ingroup Fileselector
19294     */
19295    EAPI Eina_Bool             elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19296
19297    /**
19298     * Enable/disable a tree view in the given file selector widget,
19299     * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
19300     *
19301     * @param obj The file selector object
19302     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
19303     * disable
19304     *
19305     * In a tree view, arrows are created on the sides of directories,
19306     * allowing them to expand in place.
19307     *
19308     * @note If it's in other mode, the changes made by this function
19309     * will only be visible when one switches back to "list" mode.
19310     *
19311     * @see elm_fileselector_expandable_get()
19312     *
19313     * @ingroup Fileselector
19314     */
19315    EAPI void                  elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
19316
19317    /**
19318     * Get whether tree view is enabled for the given file selector
19319     * widget
19320     *
19321     * @param obj The file selector object
19322     * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
19323     * otherwise (and or errors)
19324     *
19325     * @see elm_fileselector_expandable_set() for more details
19326     *
19327     * @ingroup Fileselector
19328     */
19329    EAPI Eina_Bool             elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19330
19331    /**
19332     * Set, programmatically, the @b directory that a given file
19333     * selector widget will display contents from
19334     *
19335     * @param obj The file selector object
19336     * @param path The path to display in @p obj
19337     *
19338     * This will change the @b directory that @p obj is displaying. It
19339     * will also clear the text entry area on the @p obj object, which
19340     * displays select files' names.
19341     *
19342     * @see elm_fileselector_path_get()
19343     *
19344     * @ingroup Fileselector
19345     */
19346    EAPI void                  elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
19347
19348    /**
19349     * Get the parent directory's path that a given file selector
19350     * widget is displaying
19351     *
19352     * @param obj The file selector object
19353     * @return The (full) path of the directory the file selector is
19354     * displaying, a @b stringshared string
19355     *
19356     * @see elm_fileselector_path_set()
19357     *
19358     * @ingroup Fileselector
19359     */
19360    EAPI const char           *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19361
19362    /**
19363     * Set, programmatically, the currently selected file/directory in
19364     * the given file selector widget
19365     *
19366     * @param obj The file selector object
19367     * @param path The (full) path to a file or directory
19368     * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
19369     * latter case occurs if the directory or file pointed to do not
19370     * exist.
19371     *
19372     * @see elm_fileselector_selected_get()
19373     *
19374     * @ingroup Fileselector
19375     */
19376    EAPI Eina_Bool             elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
19377
19378    /**
19379     * Get the currently selected item's (full) path, in the given file
19380     * selector widget
19381     *
19382     * @param obj The file selector object
19383     * @return The absolute path of the selected item, a @b
19384     * stringshared string
19385     *
19386     * @note Custom editions on @p obj object's text entry, if made,
19387     * will appear on the return string of this function, naturally.
19388     *
19389     * @see elm_fileselector_selected_set() for more details
19390     *
19391     * @ingroup Fileselector
19392     */
19393    EAPI const char           *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19394
19395    /**
19396     * Set the mode in which a given file selector widget will display
19397     * (layout) file system entries in its view
19398     *
19399     * @param obj The file selector object
19400     * @param mode The mode of the fileselector, being it one of
19401     * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
19402     * first one, naturally, will display the files in a list. The
19403     * latter will make the widget to display its entries in a grid
19404     * form.
19405     *
19406     * @note By using elm_fileselector_expandable_set(), the user may
19407     * trigger a tree view for that list.
19408     *
19409     * @note If Elementary is built with support of the Ethumb
19410     * thumbnailing library, the second form of view will display
19411     * preview thumbnails of files which it supports. You must have
19412     * elm_need_ethumb() called in your Elementary for thumbnailing to
19413     * work, though.
19414     *
19415     * @see elm_fileselector_expandable_set().
19416     * @see elm_fileselector_mode_get().
19417     *
19418     * @ingroup Fileselector
19419     */
19420    EAPI void                  elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
19421
19422    /**
19423     * Get the mode in which a given file selector widget is displaying
19424     * (layouting) file system entries in its view
19425     *
19426     * @param obj The fileselector object
19427     * @return The mode in which the fileselector is at
19428     *
19429     * @see elm_fileselector_mode_set() for more details
19430     *
19431     * @ingroup Fileselector
19432     */
19433    EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19434
19435    /**
19436     * @}
19437     */
19438
19439    /**
19440     * @defgroup Progressbar Progress bar
19441     *
19442     * The progress bar is a widget for visually representing the
19443     * progress status of a given job/task.
19444     *
19445     * A progress bar may be horizontal or vertical. It may display an
19446     * icon besides it, as well as primary and @b units labels. The
19447     * former is meant to label the widget as a whole, while the
19448     * latter, which is formatted with floating point values (and thus
19449     * accepts a <c>printf</c>-style format string, like <c>"%1.2f
19450     * units"</c>), is meant to label the widget's <b>progress
19451     * value</b>. Label, icon and unit strings/objects are @b optional
19452     * for progress bars.
19453     *
19454     * A progress bar may be @b inverted, in which state it gets its
19455     * values inverted, with high values being on the left or top and
19456     * low values on the right or bottom, as opposed to normally have
19457     * the low values on the former and high values on the latter,
19458     * respectively, for horizontal and vertical modes.
19459     *
19460     * The @b span of the progress, as set by
19461     * elm_progressbar_span_size_set(), is its length (horizontally or
19462     * vertically), unless one puts size hints on the widget to expand
19463     * on desired directions, by any container. That length will be
19464     * scaled by the object or applications scaling factor. At any
19465     * point code can query the progress bar for its value with
19466     * elm_progressbar_value_get().
19467     *
19468     * Available widget styles for progress bars:
19469     * - @c "default"
19470     * - @c "wheel" (simple style, no text, no progression, only
19471     *      "pulse" effect is available)
19472     *
19473     * Here is an example on its usage:
19474     * @li @ref progressbar_example
19475     */
19476
19477    /**
19478     * Add a new progress bar widget to the given parent Elementary
19479     * (container) object
19480     *
19481     * @param parent The parent object
19482     * @return a new progress bar widget handle or @c NULL, on errors
19483     *
19484     * This function inserts a new progress bar widget on the canvas.
19485     *
19486     * @ingroup Progressbar
19487     */
19488    EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19489
19490    /**
19491     * Set whether a given progress bar widget is at "pulsing mode" or
19492     * not.
19493     *
19494     * @param obj The progress bar object
19495     * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
19496     * @c EINA_FALSE to put it back to its default one
19497     *
19498     * By default, progress bars will display values from the low to
19499     * high value boundaries. There are, though, contexts in which the
19500     * state of progression of a given task is @b unknown.  For those,
19501     * one can set a progress bar widget to a "pulsing state", to give
19502     * the user an idea that some computation is being held, but
19503     * without exact progress values. In the default theme it will
19504     * animate its bar with the contents filling in constantly and back
19505     * to non-filled, in a loop. To start and stop this pulsing
19506     * animation, one has to explicitly call elm_progressbar_pulse().
19507     *
19508     * @see elm_progressbar_pulse_get()
19509     * @see elm_progressbar_pulse()
19510     *
19511     * @ingroup Progressbar
19512     */
19513    EAPI void         elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
19514
19515    /**
19516     * Get whether a given progress bar widget is at "pulsing mode" or
19517     * not.
19518     *
19519     * @param obj The progress bar object
19520     * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
19521     * if it's in the default one (and on errors)
19522     *
19523     * @ingroup Progressbar
19524     */
19525    EAPI Eina_Bool    elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19526
19527    /**
19528     * Start/stop a given progress bar "pulsing" animation, if its
19529     * under that mode
19530     *
19531     * @param obj The progress bar object
19532     * @param state @c EINA_TRUE, to @b start the pulsing animation,
19533     * @c EINA_FALSE to @b stop it
19534     *
19535     * @note This call won't do anything if @p obj is not under "pulsing mode".
19536     *
19537     * @see elm_progressbar_pulse_set() for more details.
19538     *
19539     * @ingroup Progressbar
19540     */
19541    EAPI void         elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19542
19543    /**
19544     * Set the progress value (in percentage) on a given progress bar
19545     * widget
19546     *
19547     * @param obj The progress bar object
19548     * @param val The progress value (@b must be between @c 0.0 and @c
19549     * 1.0)
19550     *
19551     * Use this call to set progress bar levels.
19552     *
19553     * @note If you passes a value out of the specified range for @p
19554     * val, it will be interpreted as the @b closest of the @b boundary
19555     * values in the range.
19556     *
19557     * @ingroup Progressbar
19558     */
19559    EAPI void         elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
19560
19561    /**
19562     * Get the progress value (in percentage) on a given progress bar
19563     * widget
19564     *
19565     * @param obj The progress bar object
19566     * @return The value of the progressbar
19567     *
19568     * @see elm_progressbar_value_set() for more details
19569     *
19570     * @ingroup Progressbar
19571     */
19572    EAPI double       elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19573
19574    /**
19575     * Set the label of a given progress bar widget
19576     *
19577     * @param obj The progress bar object
19578     * @param label The text label string, in UTF-8
19579     *
19580     * @ingroup Progressbar
19581     * @deprecated use elm_object_text_set() instead.
19582     */
19583    EINA_DEPRECATED EAPI void         elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19584
19585    /**
19586     * Get the label of a given progress bar widget
19587     *
19588     * @param obj The progressbar object
19589     * @return The text label string, in UTF-8
19590     *
19591     * @ingroup Progressbar
19592     * @deprecated use elm_object_text_set() instead.
19593     */
19594    EINA_DEPRECATED EAPI const char  *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19595
19596    /**
19597     * Set the icon object of a given progress bar widget
19598     *
19599     * @param obj The progress bar object
19600     * @param icon The icon object
19601     *
19602     * Use this call to decorate @p obj with an icon next to it.
19603     *
19604     * @note Once the icon object is set, a previously set one will be
19605     * deleted. If you want to keep that old content object, use the
19606     * elm_progressbar_icon_unset() function.
19607     *
19608     * @see elm_progressbar_icon_get()
19609     *
19610     * @ingroup Progressbar
19611     */
19612    EAPI void         elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19613
19614    /**
19615     * Retrieve the icon object set for a given progress bar widget
19616     *
19617     * @param obj The progress bar object
19618     * @return The icon object's handle, if @p obj had one set, or @c NULL,
19619     * otherwise (and on errors)
19620     *
19621     * @see elm_progressbar_icon_set() for more details
19622     *
19623     * @ingroup Progressbar
19624     */
19625    EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19626
19627    /**
19628     * Unset an icon set on a given progress bar widget
19629     *
19630     * @param obj The progress bar object
19631     * @return The icon object that was being used, if any was set, or
19632     * @c NULL, otherwise (and on errors)
19633     *
19634     * This call will unparent and return the icon object which was set
19635     * for this widget, previously, on success.
19636     *
19637     * @see elm_progressbar_icon_set() for more details
19638     *
19639     * @ingroup Progressbar
19640     */
19641    EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19642
19643    /**
19644     * Set the (exact) length of the bar region of a given progress bar
19645     * widget
19646     *
19647     * @param obj The progress bar object
19648     * @param size The length of the progress bar's bar region
19649     *
19650     * This sets the minimum width (when in horizontal mode) or height
19651     * (when in vertical mode) of the actual bar area of the progress
19652     * bar @p obj. This in turn affects the object's minimum size. Use
19653     * this when you're not setting other size hints expanding on the
19654     * given direction (like weight and alignment hints) and you would
19655     * like it to have a specific size.
19656     *
19657     * @note Icon, label and unit text around @p obj will require their
19658     * own space, which will make @p obj to require more the @p size,
19659     * actually.
19660     *
19661     * @see elm_progressbar_span_size_get()
19662     *
19663     * @ingroup Progressbar
19664     */
19665    EAPI void         elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
19666
19667    /**
19668     * Get the length set for the bar region of a given progress bar
19669     * widget
19670     *
19671     * @param obj The progress bar object
19672     * @return The length of the progress bar's bar region
19673     *
19674     * If that size was not set previously, with
19675     * elm_progressbar_span_size_set(), this call will return @c 0.
19676     *
19677     * @ingroup Progressbar
19678     */
19679    EAPI Evas_Coord   elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19680
19681    /**
19682     * Set the format string for a given progress bar widget's units
19683     * label
19684     *
19685     * @param obj The progress bar object
19686     * @param format The format string for @p obj's units label
19687     *
19688     * If @c NULL is passed on @p format, it will make @p obj's units
19689     * area to be hidden completely. If not, it'll set the <b>format
19690     * string</b> for the units label's @b text. The units label is
19691     * provided a floating point value, so the units text is up display
19692     * at most one floating point falue. Note that the units label is
19693     * optional. Use a format string such as "%1.2f meters" for
19694     * example.
19695     *
19696     * @note The default format string for a progress bar is an integer
19697     * percentage, as in @c "%.0f %%".
19698     *
19699     * @see elm_progressbar_unit_format_get()
19700     *
19701     * @ingroup Progressbar
19702     */
19703    EAPI void         elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
19704
19705    /**
19706     * Retrieve the format string set for a given progress bar widget's
19707     * units label
19708     *
19709     * @param obj The progress bar object
19710     * @return The format set string for @p obj's units label or
19711     * @c NULL, if none was set (and on errors)
19712     *
19713     * @see elm_progressbar_unit_format_set() for more details
19714     *
19715     * @ingroup Progressbar
19716     */
19717    EAPI const char  *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19718
19719    /**
19720     * Set the orientation of a given progress bar widget
19721     *
19722     * @param obj The progress bar object
19723     * @param horizontal Use @c EINA_TRUE to make @p obj to be
19724     * @b horizontal, @c EINA_FALSE to make it @b vertical
19725     *
19726     * Use this function to change how your progress bar is to be
19727     * disposed: vertically or horizontally.
19728     *
19729     * @see elm_progressbar_horizontal_get()
19730     *
19731     * @ingroup Progressbar
19732     */
19733    EAPI void         elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
19734
19735    /**
19736     * Retrieve the orientation of a given progress bar widget
19737     *
19738     * @param obj The progress bar object
19739     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
19740     * @c EINA_FALSE if it's @b vertical (and on errors)
19741     *
19742     * @see elm_progressbar_horizontal_set() for more details
19743     *
19744     * @ingroup Progressbar
19745     */
19746    EAPI Eina_Bool    elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19747
19748    /**
19749     * Invert a given progress bar widget's displaying values order
19750     *
19751     * @param obj The progress bar object
19752     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
19753     * @c EINA_FALSE to bring it back to default, non-inverted values.
19754     *
19755     * A progress bar may be @b inverted, in which state it gets its
19756     * values inverted, with high values being on the left or top and
19757     * low values on the right or bottom, as opposed to normally have
19758     * the low values on the former and high values on the latter,
19759     * respectively, for horizontal and vertical modes.
19760     *
19761     * @see elm_progressbar_inverted_get()
19762     *
19763     * @ingroup Progressbar
19764     */
19765    EAPI void         elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
19766
19767    /**
19768     * Get whether a given progress bar widget's displaying values are
19769     * inverted or not
19770     *
19771     * @param obj The progress bar object
19772     * @return @c EINA_TRUE, if @p obj has inverted values,
19773     * @c EINA_FALSE otherwise (and on errors)
19774     *
19775     * @see elm_progressbar_inverted_set() for more details
19776     *
19777     * @ingroup Progressbar
19778     */
19779    EAPI Eina_Bool    elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19780
19781    /**
19782     * @defgroup Separator Separator
19783     *
19784     * @brief Separator is a very thin object used to separate other objects.
19785     *
19786     * A separator can be vertical or horizontal.
19787     *
19788     * @ref tutorial_separator is a good example of how to use a separator.
19789     * @{
19790     */
19791    /**
19792     * @brief Add a separator object to @p parent
19793     *
19794     * @param parent The parent object
19795     *
19796     * @return The separator object, or NULL upon failure
19797     */
19798    EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19799    /**
19800     * @brief Set the horizontal mode of a separator object
19801     *
19802     * @param obj The separator object
19803     * @param horizontal If true, the separator is horizontal
19804     */
19805    EAPI void         elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
19806    /**
19807     * @brief Get the horizontal mode of a separator object
19808     *
19809     * @param obj The separator object
19810     * @return If true, the separator is horizontal
19811     *
19812     * @see elm_separator_horizontal_set()
19813     */
19814    EAPI Eina_Bool    elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19815    /**
19816     * @}
19817     */
19818
19819    /**
19820     * @defgroup Spinner Spinner
19821     * @ingroup Elementary
19822     *
19823     * @image html img/widget/spinner/preview-00.png
19824     * @image latex img/widget/spinner/preview-00.eps
19825     *
19826     * A spinner is a widget which allows the user to increase or decrease
19827     * numeric values using arrow buttons, or edit values directly, clicking
19828     * over it and typing the new value.
19829     *
19830     * By default the spinner will not wrap and has a label
19831     * of "%.0f" (just showing the integer value of the double).
19832     *
19833     * A spinner has a label that is formatted with floating
19834     * point values and thus accepts a printf-style format string, like
19835     * “%1.2f units”.
19836     *
19837     * It also allows specific values to be replaced by pre-defined labels.
19838     *
19839     * Smart callbacks one can register to:
19840     *
19841     * - "changed" - Whenever the spinner value is changed.
19842     * - "delay,changed" - A short time after the value is changed by the user.
19843     *    This will be called only when the user stops dragging for a very short
19844     *    period or when they release their finger/mouse, so it avoids possibly
19845     *    expensive reactions to the value change.
19846     *
19847     * Available styles for it:
19848     * - @c "default";
19849     * - @c "vertical": up/down buttons at the right side and text left aligned.
19850     *
19851     * Here is an example on its usage:
19852     * @ref spinner_example
19853     */
19854
19855    /**
19856     * @addtogroup Spinner
19857     * @{
19858     */
19859
19860    /**
19861     * Add a new spinner widget to the given parent Elementary
19862     * (container) object.
19863     *
19864     * @param parent The parent object.
19865     * @return a new spinner widget handle or @c NULL, on errors.
19866     *
19867     * This function inserts a new spinner widget on the canvas.
19868     *
19869     * @ingroup Spinner
19870     *
19871     */
19872    EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19873
19874    /**
19875     * Set the format string of the displayed label.
19876     *
19877     * @param obj The spinner object.
19878     * @param fmt The format string for the label display.
19879     *
19880     * If @c NULL, this sets the format to "%.0f". If not it sets the format
19881     * string for the label text. The label text is provided a floating point
19882     * value, so the label text can display up to 1 floating point value.
19883     * Note that this is optional.
19884     *
19885     * Use a format string such as "%1.2f meters" for example, and it will
19886     * display values like: "3.14 meters" for a value equal to 3.14159.
19887     *
19888     * Default is "%0.f".
19889     *
19890     * @see elm_spinner_label_format_get()
19891     *
19892     * @ingroup Spinner
19893     */
19894    EAPI void         elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
19895
19896    /**
19897     * Get the label format of the spinner.
19898     *
19899     * @param obj The spinner object.
19900     * @return The text label format string in UTF-8.
19901     *
19902     * @see elm_spinner_label_format_set() for details.
19903     *
19904     * @ingroup Spinner
19905     */
19906    EAPI const char  *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19907
19908    /**
19909     * Set the minimum and maximum values for the spinner.
19910     *
19911     * @param obj The spinner object.
19912     * @param min The minimum value.
19913     * @param max The maximum value.
19914     *
19915     * Define the allowed range of values to be selected by the user.
19916     *
19917     * If actual value is less than @p min, it will be updated to @p min. If it
19918     * is bigger then @p max, will be updated to @p max. Actual value can be
19919     * get with elm_spinner_value_get().
19920     *
19921     * By default, min is equal to 0, and max is equal to 100.
19922     *
19923     * @warning Maximum must be greater than minimum.
19924     *
19925     * @see elm_spinner_min_max_get()
19926     *
19927     * @ingroup Spinner
19928     */
19929    EAPI void         elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
19930
19931    /**
19932     * Get the minimum and maximum values of the spinner.
19933     *
19934     * @param obj The spinner object.
19935     * @param min Pointer where to store the minimum value.
19936     * @param max Pointer where to store the maximum value.
19937     *
19938     * @note If only one value is needed, the other pointer can be passed
19939     * as @c NULL.
19940     *
19941     * @see elm_spinner_min_max_set() for details.
19942     *
19943     * @ingroup Spinner
19944     */
19945    EAPI void         elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
19946
19947    /**
19948     * Set the step used to increment or decrement the spinner value.
19949     *
19950     * @param obj The spinner object.
19951     * @param step The step value.
19952     *
19953     * This value will be incremented or decremented to the displayed value.
19954     * It will be incremented while the user keep right or top arrow pressed,
19955     * and will be decremented while the user keep left or bottom arrow pressed.
19956     *
19957     * The interval to increment / decrement can be set with
19958     * elm_spinner_interval_set().
19959     *
19960     * By default step value is equal to 1.
19961     *
19962     * @see elm_spinner_step_get()
19963     *
19964     * @ingroup Spinner
19965     */
19966    EAPI void         elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
19967
19968    /**
19969     * Get the step used to increment or decrement the spinner value.
19970     *
19971     * @param obj The spinner object.
19972     * @return The step value.
19973     *
19974     * @see elm_spinner_step_get() for more details.
19975     *
19976     * @ingroup Spinner
19977     */
19978    EAPI double       elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19979
19980    /**
19981     * Set the value the spinner displays.
19982     *
19983     * @param obj The spinner object.
19984     * @param val The value to be displayed.
19985     *
19986     * Value will be presented on the label following format specified with
19987     * elm_spinner_format_set().
19988     *
19989     * @warning The value must to be between min and max values. This values
19990     * are set by elm_spinner_min_max_set().
19991     *
19992     * @see elm_spinner_value_get().
19993     * @see elm_spinner_format_set().
19994     * @see elm_spinner_min_max_set().
19995     *
19996     * @ingroup Spinner
19997     */
19998    EAPI void         elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
19999
20000    /**
20001     * Get the value displayed by the spinner.
20002     *
20003     * @param obj The spinner object.
20004     * @return The value displayed.
20005     *
20006     * @see elm_spinner_value_set() for details.
20007     *
20008     * @ingroup Spinner
20009     */
20010    EAPI double       elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20011
20012    /**
20013     * Set whether the spinner should wrap when it reaches its
20014     * minimum or maximum value.
20015     *
20016     * @param obj The spinner object.
20017     * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
20018     * disable it.
20019     *
20020     * Disabled by default. If disabled, when the user tries to increment the
20021     * value,
20022     * but displayed value plus step value is bigger than maximum value,
20023     * the spinner
20024     * won't allow it. The same happens when the user tries to decrement it,
20025     * but the value less step is less than minimum value.
20026     *
20027     * When wrap is enabled, in such situations it will allow these changes,
20028     * but will get the value that would be less than minimum and subtracts
20029     * from maximum. Or add the value that would be more than maximum to
20030     * the minimum.
20031     *
20032     * E.g.:
20033     * @li min value = 10
20034     * @li max value = 50
20035     * @li step value = 20
20036     * @li displayed value = 20
20037     *
20038     * When the user decrement value (using left or bottom arrow), it will
20039     * displays @c 40, because max - (min - (displayed - step)) is
20040     * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
20041     *
20042     * @see elm_spinner_wrap_get().
20043     *
20044     * @ingroup Spinner
20045     */
20046    EAPI void         elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
20047
20048    /**
20049     * Get whether the spinner should wrap when it reaches its
20050     * minimum or maximum value.
20051     *
20052     * @param obj The spinner object
20053     * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
20054     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20055     *
20056     * @see elm_spinner_wrap_set() for details.
20057     *
20058     * @ingroup Spinner
20059     */
20060    EAPI Eina_Bool    elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20061
20062    /**
20063     * Set whether the spinner can be directly edited by the user or not.
20064     *
20065     * @param obj The spinner object.
20066     * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
20067     * don't allow users to edit it directly.
20068     *
20069     * Spinner objects can have edition @b disabled, in which state they will
20070     * be changed only by arrows.
20071     * Useful for contexts
20072     * where you don't want your users to interact with it writting the value.
20073     * Specially
20074     * when using special values, the user can see real value instead
20075     * of special label on edition.
20076     *
20077     * It's enabled by default.
20078     *
20079     * @see elm_spinner_editable_get()
20080     *
20081     * @ingroup Spinner
20082     */
20083    EAPI void         elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
20084
20085    /**
20086     * Get whether the spinner can be directly edited by the user or not.
20087     *
20088     * @param obj The spinner object.
20089     * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
20090     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20091     *
20092     * @see elm_spinner_editable_set() for details.
20093     *
20094     * @ingroup Spinner
20095     */
20096    EAPI Eina_Bool    elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20097
20098    /**
20099     * Set a special string to display in the place of the numerical value.
20100     *
20101     * @param obj The spinner object.
20102     * @param value The value to be replaced.
20103     * @param label The label to be used.
20104     *
20105     * It's useful for cases when a user should select an item that is
20106     * better indicated by a label than a value. For example, weekdays or months.
20107     *
20108     * E.g.:
20109     * @code
20110     * sp = elm_spinner_add(win);
20111     * elm_spinner_min_max_set(sp, 1, 3);
20112     * elm_spinner_special_value_add(sp, 1, "January");
20113     * elm_spinner_special_value_add(sp, 2, "February");
20114     * elm_spinner_special_value_add(sp, 3, "March");
20115     * evas_object_show(sp);
20116     * @endcode
20117     *
20118     * @ingroup Spinner
20119     */
20120    EAPI void         elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
20121
20122    /**
20123     * Set the interval on time updates for an user mouse button hold
20124     * on spinner widgets' arrows.
20125     *
20126     * @param obj The spinner object.
20127     * @param interval The (first) interval value in seconds.
20128     *
20129     * This interval value is @b decreased while the user holds the
20130     * mouse pointer either incrementing or decrementing spinner's value.
20131     *
20132     * This helps the user to get to a given value distant from the
20133     * current one easier/faster, as it will start to change quicker and
20134     * quicker on mouse button holds.
20135     *
20136     * The calculation for the next change interval value, starting from
20137     * the one set with this call, is the previous interval divided by
20138     * @c 1.05, so it decreases a little bit.
20139     *
20140     * The default starting interval value for automatic changes is
20141     * @c 0.85 seconds.
20142     *
20143     * @see elm_spinner_interval_get()
20144     *
20145     * @ingroup Spinner
20146     */
20147    EAPI void         elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
20148
20149    /**
20150     * Get the interval on time updates for an user mouse button hold
20151     * on spinner widgets' arrows.
20152     *
20153     * @param obj The spinner object.
20154     * @return The (first) interval value, in seconds, set on it.
20155     *
20156     * @see elm_spinner_interval_set() for more details.
20157     *
20158     * @ingroup Spinner
20159     */
20160    EAPI double       elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20161
20162    /**
20163     * @}
20164     */
20165
20166    /**
20167     * @defgroup Index Index
20168     *
20169     * @image html img/widget/index/preview-00.png
20170     * @image latex img/widget/index/preview-00.eps
20171     *
20172     * An index widget gives you an index for fast access to whichever
20173     * group of other UI items one might have. It's a list of text
20174     * items (usually letters, for alphabetically ordered access).
20175     *
20176     * Index widgets are by default hidden and just appear when the
20177     * user clicks over it's reserved area in the canvas. In its
20178     * default theme, it's an area one @ref Fingers "finger" wide on
20179     * the right side of the index widget's container.
20180     *
20181     * When items on the index are selected, smart callbacks get
20182     * called, so that its user can make other container objects to
20183     * show a given area or child object depending on the index item
20184     * selected. You'd probably be using an index together with @ref
20185     * List "lists", @ref Genlist "generic lists" or @ref Gengrid
20186     * "general grids".
20187     *
20188     * Smart events one  can add callbacks for are:
20189     * - @c "changed" - When the selected index item changes. @c
20190     *      event_info is the selected item's data pointer.
20191     * - @c "delay,changed" - When the selected index item changes, but
20192     *      after a small idling period. @c event_info is the selected
20193     *      item's data pointer.
20194     * - @c "selected" - When the user releases a mouse button and
20195     *      selects an item. @c event_info is the selected item's data
20196     *      pointer.
20197     * - @c "level,up" - when the user moves a finger from the first
20198     *      level to the second level
20199     * - @c "level,down" - when the user moves a finger from the second
20200     *      level to the first level
20201     *
20202     * The @c "delay,changed" event is so that it'll wait a small time
20203     * before actually reporting those events and, moreover, just the
20204     * last event happening on those time frames will actually be
20205     * reported.
20206     *
20207     * Here are some examples on its usage:
20208     * @li @ref index_example_01
20209     * @li @ref index_example_02
20210     */
20211
20212    /**
20213     * @addtogroup Index
20214     * @{
20215     */
20216
20217    typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
20218
20219    /**
20220     * Add a new index widget to the given parent Elementary
20221     * (container) object
20222     *
20223     * @param parent The parent object
20224     * @return a new index widget handle or @c NULL, on errors
20225     *
20226     * This function inserts a new index widget on the canvas.
20227     *
20228     * @ingroup Index
20229     */
20230    EAPI Evas_Object    *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20231
20232    /**
20233     * Set whether a given index widget is or not visible,
20234     * programatically.
20235     *
20236     * @param obj The index object
20237     * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
20238     *
20239     * Not to be confused with visible as in @c evas_object_show() --
20240     * visible with regard to the widget's auto hiding feature.
20241     *
20242     * @see elm_index_active_get()
20243     *
20244     * @ingroup Index
20245     */
20246    EAPI void            elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
20247
20248    /**
20249     * Get whether a given index widget is currently visible or not.
20250     *
20251     * @param obj The index object
20252     * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
20253     *
20254     * @see elm_index_active_set() for more details
20255     *
20256     * @ingroup Index
20257     */
20258    EAPI Eina_Bool       elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20259
20260    /**
20261     * Set the items level for a given index widget.
20262     *
20263     * @param obj The index object.
20264     * @param level @c 0 or @c 1, the currently implemented levels.
20265     *
20266     * @see elm_index_item_level_get()
20267     *
20268     * @ingroup Index
20269     */
20270    EAPI void            elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20271
20272    /**
20273     * Get the items level set for a given index widget.
20274     *
20275     * @param obj The index object.
20276     * @return @c 0 or @c 1, which are the levels @p obj might be at.
20277     *
20278     * @see elm_index_item_level_set() for more information
20279     *
20280     * @ingroup Index
20281     */
20282    EAPI int             elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20283
20284    /**
20285     * Returns the last selected item's data, for a given index widget.
20286     *
20287     * @param obj The index object.
20288     * @return The item @b data associated to the last selected item on
20289     * @p obj (or @c NULL, on errors).
20290     *
20291     * @warning The returned value is @b not an #Elm_Index_Item item
20292     * handle, but the data associated to it (see the @c item parameter
20293     * in elm_index_item_append(), as an example).
20294     *
20295     * @ingroup Index
20296     */
20297    EAPI void           *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20298
20299    /**
20300     * Append a new item on a given index widget.
20301     *
20302     * @param obj The index object.
20303     * @param letter Letter under which the item should be indexed
20304     * @param item The item data to set for the index's item
20305     *
20306     * Despite the most common usage of the @p letter argument is for
20307     * single char strings, one could use arbitrary strings as index
20308     * entries.
20309     *
20310     * @c item will be the pointer returned back on @c "changed", @c
20311     * "delay,changed" and @c "selected" smart events.
20312     *
20313     * @ingroup Index
20314     */
20315    EAPI void            elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
20316
20317    /**
20318     * Prepend a new item on a given index widget.
20319     *
20320     * @param obj The index object.
20321     * @param letter Letter under which the item should be indexed
20322     * @param item The item data to set for the index's item
20323     *
20324     * Despite the most common usage of the @p letter argument is for
20325     * single char strings, one could use arbitrary strings as index
20326     * entries.
20327     *
20328     * @c item will be the pointer returned back on @c "changed", @c
20329     * "delay,changed" and @c "selected" smart events.
20330     *
20331     * @ingroup Index
20332     */
20333    EAPI void            elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
20334
20335    /**
20336     * Append a new item, on a given index widget, <b>after the item
20337     * having @p relative as data</b>.
20338     *
20339     * @param obj The index object.
20340     * @param letter Letter under which the item should be indexed
20341     * @param item The item data to set for the index's item
20342     * @param relative The item data of the index item to be the
20343     * predecessor of this new one
20344     *
20345     * Despite the most common usage of the @p letter argument is for
20346     * single char strings, one could use arbitrary strings as index
20347     * entries.
20348     *
20349     * @c item will be the pointer returned back on @c "changed", @c
20350     * "delay,changed" and @c "selected" smart events.
20351     *
20352     * @note If @p relative is @c NULL or if it's not found to be data
20353     * set on any previous item on @p obj, this function will behave as
20354     * elm_index_item_append().
20355     *
20356     * @ingroup Index
20357     */
20358    EAPI void            elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
20359
20360    /**
20361     * Prepend a new item, on a given index widget, <b>after the item
20362     * having @p relative as data</b>.
20363     *
20364     * @param obj The index object.
20365     * @param letter Letter under which the item should be indexed
20366     * @param item The item data to set for the index's item
20367     * @param relative The item data of the index item to be the
20368     * successor of this new one
20369     *
20370     * Despite the most common usage of the @p letter argument is for
20371     * single char strings, one could use arbitrary strings as index
20372     * entries.
20373     *
20374     * @c item will be the pointer returned back on @c "changed", @c
20375     * "delay,changed" and @c "selected" smart events.
20376     *
20377     * @note If @p relative is @c NULL or if it's not found to be data
20378     * set on any previous item on @p obj, this function will behave as
20379     * elm_index_item_prepend().
20380     *
20381     * @ingroup Index
20382     */
20383    EAPI void            elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
20384
20385    /**
20386     * Insert a new item into the given index widget, using @p cmp_func
20387     * function to sort items (by item handles).
20388     *
20389     * @param obj The index object.
20390     * @param letter Letter under which the item should be indexed
20391     * @param item The item data to set for the index's item
20392     * @param cmp_func The comparing function to be used to sort index
20393     * items <b>by #Elm_Index_Item item handles</b>
20394     * @param cmp_data_func A @b fallback function to be called for the
20395     * sorting of index items <b>by item data</b>). It will be used
20396     * when @p cmp_func returns @c 0 (equality), which means an index
20397     * item with provided item data already exists. To decide which
20398     * data item should be pointed to by the index item in question, @p
20399     * cmp_data_func will be used. If @p cmp_data_func returns a
20400     * non-negative value, the previous index item data will be
20401     * replaced by the given @p item pointer. If the previous data need
20402     * to be freed, it should be done by the @p cmp_data_func function,
20403     * because all references to it will be lost. If this function is
20404     * not provided (@c NULL is given), index items will be @b
20405     * duplicated, if @p cmp_func returns @c 0.
20406     *
20407     * Despite the most common usage of the @p letter argument is for
20408     * single char strings, one could use arbitrary strings as index
20409     * entries.
20410     *
20411     * @c item will be the pointer returned back on @c "changed", @c
20412     * "delay,changed" and @c "selected" smart events.
20413     *
20414     * @ingroup Index
20415     */
20416    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);
20417
20418    /**
20419     * Remove an item from a given index widget, <b>to be referenced by
20420     * it's data value</b>.
20421     *
20422     * @param obj The index object
20423     * @param item The item's data pointer for the item to be removed
20424     * from @p obj
20425     *
20426     * If a deletion callback is set, via elm_index_item_del_cb_set(),
20427     * that callback function will be called by this one.
20428     *
20429     * @warning The item to be removed from @p obj will be found via
20430     * its item data pointer, and not by an #Elm_Index_Item handle.
20431     *
20432     * @ingroup Index
20433     */
20434    EAPI void            elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
20435
20436    /**
20437     * Find a given index widget's item, <b>using item data</b>.
20438     *
20439     * @param obj The index object
20440     * @param item The item data pointed to by the desired index item
20441     * @return The index item handle, if found, or @c NULL otherwise
20442     *
20443     * @ingroup Index
20444     */
20445    EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
20446
20447    /**
20448     * Removes @b all items from a given index widget.
20449     *
20450     * @param obj The index object.
20451     *
20452     * If deletion callbacks are set, via elm_index_item_del_cb_set(),
20453     * that callback function will be called for each item in @p obj.
20454     *
20455     * @ingroup Index
20456     */
20457    EAPI void            elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20458
20459    /**
20460     * Go to a given items level on a index widget
20461     *
20462     * @param obj The index object
20463     * @param level The index level (one of @c 0 or @c 1)
20464     *
20465     * @ingroup Index
20466     */
20467    EAPI void            elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20468
20469    /**
20470     * Return the data associated with a given index widget item
20471     *
20472     * @param it The index widget item handle
20473     * @return The data associated with @p it
20474     *
20475     * @see elm_index_item_data_set()
20476     *
20477     * @ingroup Index
20478     */
20479    EAPI void           *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
20480
20481    /**
20482     * Set the data associated with a given index widget item
20483     *
20484     * @param it The index widget item handle
20485     * @param data The new data pointer to set to @p it
20486     *
20487     * This sets new item data on @p it.
20488     *
20489     * @warning The old data pointer won't be touched by this function, so
20490     * the user had better to free that old data himself/herself.
20491     *
20492     * @ingroup Index
20493     */
20494    EAPI void            elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
20495
20496    /**
20497     * Set the function to be called when a given index widget item is freed.
20498     *
20499     * @param it The item to set the callback on
20500     * @param func The function to call on the item's deletion
20501     *
20502     * When called, @p func will have both @c data and @c event_info
20503     * arguments with the @p it item's data value and, naturally, the
20504     * @c obj argument with a handle to the parent index widget.
20505     *
20506     * @ingroup Index
20507     */
20508    EAPI void            elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
20509
20510    /**
20511     * Get the letter (string) set on a given index widget item.
20512     *
20513     * @param it The index item handle
20514     * @return The letter string set on @p it
20515     *
20516     * @ingroup Index
20517     */
20518    EAPI const char     *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
20519
20520    /**
20521     * @}
20522     */
20523
20524    /**
20525     * @defgroup Photocam Photocam
20526     *
20527     * @image html img/widget/photocam/preview-00.png
20528     * @image latex img/widget/photocam/preview-00.eps
20529     *
20530     * This is a widget specifically for displaying high-resolution digital
20531     * camera photos giving speedy feedback (fast load), low memory footprint
20532     * and zooming and panning as well as fitting logic. It is entirely focused
20533     * on jpeg images, and takes advantage of properties of the jpeg format (via
20534     * evas loader features in the jpeg loader).
20535     *
20536     * Signals that you can add callbacks for are:
20537     * @li "clicked" - This is called when a user has clicked the photo without
20538     *                 dragging around.
20539     * @li "press" - This is called when a user has pressed down on the photo.
20540     * @li "longpressed" - This is called when a user has pressed down on the
20541     *                     photo for a long time without dragging around.
20542     * @li "clicked,double" - This is called when a user has double-clicked the
20543     *                        photo.
20544     * @li "load" - Photo load begins.
20545     * @li "loaded" - This is called when the image file load is complete for the
20546     *                first view (low resolution blurry version).
20547     * @li "load,detail" - Photo detailed data load begins.
20548     * @li "loaded,detail" - This is called when the image file load is complete
20549     *                      for the detailed image data (full resolution needed).
20550     * @li "zoom,start" - Zoom animation started.
20551     * @li "zoom,stop" - Zoom animation stopped.
20552     * @li "zoom,change" - Zoom changed when using an auto zoom mode.
20553     * @li "scroll" - the content has been scrolled (moved)
20554     * @li "scroll,anim,start" - scrolling animation has started
20555     * @li "scroll,anim,stop" - scrolling animation has stopped
20556     * @li "scroll,drag,start" - dragging the contents around has started
20557     * @li "scroll,drag,stop" - dragging the contents around has stopped
20558     *
20559     * @ref tutorial_photocam shows the API in action.
20560     * @{
20561     */
20562    /**
20563     * @brief Types of zoom available.
20564     */
20565    typedef enum _Elm_Photocam_Zoom_Mode
20566      {
20567         ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
20568         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
20569         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
20570         ELM_PHOTOCAM_ZOOM_MODE_LAST
20571      } Elm_Photocam_Zoom_Mode;
20572    /**
20573     * @brief Add a new Photocam object
20574     *
20575     * @param parent The parent object
20576     * @return The new object or NULL if it cannot be created
20577     */
20578    EAPI Evas_Object           *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20579    /**
20580     * @brief Set the photo file to be shown
20581     *
20582     * @param obj The photocam object
20583     * @param file The photo file
20584     * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
20585     *
20586     * This sets (and shows) the specified file (with a relative or absolute
20587     * path) and will return a load error (same error that
20588     * evas_object_image_load_error_get() will return). The image will change and
20589     * adjust its size at this point and begin a background load process for this
20590     * photo that at some time in the future will be displayed at the full
20591     * quality needed.
20592     */
20593    EAPI Evas_Load_Error        elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
20594    /**
20595     * @brief Returns the path of the current image file
20596     *
20597     * @param obj The photocam object
20598     * @return Returns the path
20599     *
20600     * @see elm_photocam_file_set()
20601     */
20602    EAPI const char            *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20603    /**
20604     * @brief Set the zoom level of the photo
20605     *
20606     * @param obj The photocam object
20607     * @param zoom The zoom level to set
20608     *
20609     * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
20610     * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
20611     * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
20612     * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
20613     * 16, 32, etc.).
20614     */
20615    EAPI void                   elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
20616    /**
20617     * @brief Get the zoom level of the photo
20618     *
20619     * @param obj The photocam object
20620     * @return The current zoom level
20621     *
20622     * This returns the current zoom level of the photocam object. Note that if
20623     * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
20624     * (which is the default), the zoom level may be changed at any time by the
20625     * photocam object itself to account for photo size and photocam viewpoer
20626     * size.
20627     *
20628     * @see elm_photocam_zoom_set()
20629     * @see elm_photocam_zoom_mode_set()
20630     */
20631    EAPI double                 elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20632    /**
20633     * @brief Set the zoom mode
20634     *
20635     * @param obj The photocam object
20636     * @param mode The desired mode
20637     *
20638     * This sets the zoom mode to manual or one of several automatic levels.
20639     * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
20640     * elm_photocam_zoom_set() and will stay at that level until changed by code
20641     * or until zoom mode is changed. This is the default mode. The Automatic
20642     * modes will allow the photocam object to automatically adjust zoom mode
20643     * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
20644     * the photo fits EXACTLY inside the scroll frame with no pixels outside this
20645     * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
20646     * pixels within the frame are left unfilled.
20647     */
20648    EAPI void                   elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
20649    /**
20650     * @brief Get the zoom mode
20651     *
20652     * @param obj The photocam object
20653     * @return The current zoom mode
20654     *
20655     * This gets the current zoom mode of the photocam object.
20656     *
20657     * @see elm_photocam_zoom_mode_set()
20658     */
20659    EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20660    /**
20661     * @brief Get the current image pixel width and height
20662     *
20663     * @param obj The photocam object
20664     * @param w A pointer to the width return
20665     * @param h A pointer to the height return
20666     *
20667     * This gets the current photo pixel width and height (for the original).
20668     * The size will be returned in the integers @p w and @p h that are pointed
20669     * to.
20670     */
20671    EAPI void                   elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
20672    /**
20673     * @brief Get the area of the image that is currently shown
20674     *
20675     * @param obj
20676     * @param x A pointer to the X-coordinate of region
20677     * @param y A pointer to the Y-coordinate of region
20678     * @param w A pointer to the width
20679     * @param h A pointer to the height
20680     *
20681     * @see elm_photocam_image_region_show()
20682     * @see elm_photocam_image_region_bring_in()
20683     */
20684    EAPI void                   elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
20685    /**
20686     * @brief Set the viewed portion of the image
20687     *
20688     * @param obj The photocam object
20689     * @param x X-coordinate of region in image original pixels
20690     * @param y Y-coordinate of region in image original pixels
20691     * @param w Width of region in image original pixels
20692     * @param h Height of region in image original pixels
20693     *
20694     * This shows the region of the image without using animation.
20695     */
20696    EAPI void                   elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
20697    /**
20698     * @brief Bring in the viewed portion of the image
20699     *
20700     * @param obj The photocam object
20701     * @param x X-coordinate of region in image original pixels
20702     * @param y Y-coordinate of region in image original pixels
20703     * @param w Width of region in image original pixels
20704     * @param h Height of region in image original pixels
20705     *
20706     * This shows the region of the image using animation.
20707     */
20708    EAPI void                   elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
20709    /**
20710     * @brief Set the paused state for photocam
20711     *
20712     * @param obj The photocam object
20713     * @param paused The pause state to set
20714     *
20715     * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
20716     * photocam. The default is off. This will stop zooming using animation on
20717     * zoom levels changes and change instantly. This will stop any existing
20718     * animations that are running.
20719     */
20720    EAPI void                   elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
20721    /**
20722     * @brief Get the paused state for photocam
20723     *
20724     * @param obj The photocam object
20725     * @return The current paused state
20726     *
20727     * This gets the current paused state for the photocam object.
20728     *
20729     * @see elm_photocam_paused_set()
20730     */
20731    EAPI Eina_Bool              elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20732    /**
20733     * @brief Get the internal low-res image used for photocam
20734     *
20735     * @param obj The photocam object
20736     * @return The internal image object handle, or NULL if none exists
20737     *
20738     * This gets the internal image object inside photocam. Do not modify it. It
20739     * is for inspection only, and hooking callbacks to. Nothing else. It may be
20740     * deleted at any time as well.
20741     */
20742    EAPI Evas_Object           *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20743    /**
20744     * @brief Set the photocam scrolling bouncing.
20745     *
20746     * @param obj The photocam object
20747     * @param h_bounce bouncing for horizontal
20748     * @param v_bounce bouncing for vertical
20749     */
20750    EAPI void                   elm_photocam_bounce_set(Evas_Object *obj,  Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
20751    /**
20752     * @brief Get the photocam scrolling bouncing.
20753     *
20754     * @param obj The photocam object
20755     * @param h_bounce bouncing for horizontal
20756     * @param v_bounce bouncing for vertical
20757     *
20758     * @see elm_photocam_bounce_set()
20759     */
20760    EAPI void                   elm_photocam_bounce_get(const Evas_Object *obj,  Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
20761    /**
20762     * @}
20763     */
20764
20765    /**
20766     * @defgroup Map Map
20767     * @ingroup Elementary
20768     *
20769     * @image html img/widget/map/preview-00.png
20770     * @image latex img/widget/map/preview-00.eps
20771     *
20772     * This is a widget specifically for displaying a map. It uses basically
20773     * OpenStreetMap provider http://www.openstreetmap.org/,
20774     * but custom providers can be added.
20775     *
20776     * It supports some basic but yet nice features:
20777     * @li zoom and scroll
20778     * @li markers with content to be displayed when user clicks over it
20779     * @li group of markers
20780     * @li routes
20781     *
20782     * Smart callbacks one can listen to:
20783     *
20784     * - "clicked" - This is called when a user has clicked the map without
20785     *   dragging around.
20786     * - "press" - This is called when a user has pressed down on the map.
20787     * - "longpressed" - This is called when a user has pressed down on the map
20788     *   for a long time without dragging around.
20789     * - "clicked,double" - This is called when a user has double-clicked
20790     *   the map.
20791     * - "load,detail" - Map detailed data load begins.
20792     * - "loaded,detail" - This is called when all currently visible parts of
20793     *   the map are loaded.
20794     * - "zoom,start" - Zoom animation started.
20795     * - "zoom,stop" - Zoom animation stopped.
20796     * - "zoom,change" - Zoom changed when using an auto zoom mode.
20797     * - "scroll" - the content has been scrolled (moved).
20798     * - "scroll,anim,start" - scrolling animation has started.
20799     * - "scroll,anim,stop" - scrolling animation has stopped.
20800     * - "scroll,drag,start" - dragging the contents around has started.
20801     * - "scroll,drag,stop" - dragging the contents around has stopped.
20802     * - "downloaded" - This is called when all currently required map images
20803     *   are downloaded.
20804     * - "route,load" - This is called when route request begins.
20805     * - "route,loaded" - This is called when route request ends.
20806     * - "name,load" - This is called when name request begins.
20807     * - "name,loaded- This is called when name request ends.
20808     *
20809     * Available style for map widget:
20810     * - @c "default"
20811     *
20812     * Available style for markers:
20813     * - @c "radio"
20814     * - @c "radio2"
20815     * - @c "empty"
20816     *
20817     * Available style for marker bubble:
20818     * - @c "default"
20819     *
20820     * List of examples:
20821     * @li @ref map_example_01
20822     * @li @ref map_example_02
20823     * @li @ref map_example_03
20824     */
20825
20826    /**
20827     * @addtogroup Map
20828     * @{
20829     */
20830
20831    /**
20832     * @enum _Elm_Map_Zoom_Mode
20833     * @typedef Elm_Map_Zoom_Mode
20834     *
20835     * Set map's zoom behavior. It can be set to manual or automatic.
20836     *
20837     * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
20838     *
20839     * Values <b> don't </b> work as bitmask, only one can be choosen.
20840     *
20841     * @note Valid sizes are 2^zoom, consequently the map may be smaller
20842     * than the scroller view.
20843     *
20844     * @see elm_map_zoom_mode_set()
20845     * @see elm_map_zoom_mode_get()
20846     *
20847     * @ingroup Map
20848     */
20849    typedef enum _Elm_Map_Zoom_Mode
20850      {
20851         ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
20852         ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
20853         ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
20854         ELM_MAP_ZOOM_MODE_LAST
20855      } Elm_Map_Zoom_Mode;
20856
20857    /**
20858     * @enum _Elm_Map_Route_Sources
20859     * @typedef Elm_Map_Route_Sources
20860     *
20861     * Set route service to be used. By default used source is
20862     * #ELM_MAP_ROUTE_SOURCE_YOURS.
20863     *
20864     * @see elm_map_route_source_set()
20865     * @see elm_map_route_source_get()
20866     *
20867     * @ingroup Map
20868     */
20869    typedef enum _Elm_Map_Route_Sources
20870      {
20871         ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
20872         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. */
20873         ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
20874         ELM_MAP_ROUTE_SOURCE_LAST
20875      } Elm_Map_Route_Sources;
20876
20877    typedef enum _Elm_Map_Name_Sources
20878      {
20879         ELM_MAP_NAME_SOURCE_NOMINATIM,
20880         ELM_MAP_NAME_SOURCE_LAST
20881      } Elm_Map_Name_Sources;
20882
20883    /**
20884     * @enum _Elm_Map_Route_Type
20885     * @typedef Elm_Map_Route_Type
20886     *
20887     * Set type of transport used on route.
20888     *
20889     * @see elm_map_route_add()
20890     *
20891     * @ingroup Map
20892     */
20893    typedef enum _Elm_Map_Route_Type
20894      {
20895         ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
20896         ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
20897         ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
20898         ELM_MAP_ROUTE_TYPE_LAST
20899      } Elm_Map_Route_Type;
20900
20901    /**
20902     * @enum _Elm_Map_Route_Method
20903     * @typedef Elm_Map_Route_Method
20904     *
20905     * Set the routing method, what should be priorized, time or distance.
20906     *
20907     * @see elm_map_route_add()
20908     *
20909     * @ingroup Map
20910     */
20911    typedef enum _Elm_Map_Route_Method
20912      {
20913         ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
20914         ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
20915         ELM_MAP_ROUTE_METHOD_LAST
20916      } Elm_Map_Route_Method;
20917
20918    typedef enum _Elm_Map_Name_Method
20919      {
20920         ELM_MAP_NAME_METHOD_SEARCH,
20921         ELM_MAP_NAME_METHOD_REVERSE,
20922         ELM_MAP_NAME_METHOD_LAST
20923      } Elm_Map_Name_Method;
20924
20925    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(). */
20926    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(). */
20927    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(). */
20928    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(). */
20929    typedef struct _Elm_Map_Name            Elm_Map_Name; /**< A handle for specific coordinates. */
20930    typedef struct _Elm_Map_Track           Elm_Map_Track;
20931
20932    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. */
20933    typedef void         (*ElmMapMarkerDelFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
20934    typedef Evas_Object *(*ElmMapMarkerIconGetFunc)  (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
20935    typedef Evas_Object *(*ElmMapGroupIconGetFunc)   (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
20936
20937    typedef char        *(*ElmMapModuleSourceFunc) (void);
20938    typedef int          (*ElmMapModuleZoomMinFunc) (void);
20939    typedef int          (*ElmMapModuleZoomMaxFunc) (void);
20940    typedef char        *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
20941    typedef int          (*ElmMapModuleRouteSourceFunc) (void);
20942    typedef char        *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
20943    typedef char        *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
20944    typedef Eina_Bool    (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
20945    typedef Eina_Bool    (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
20946
20947    /**
20948     * Add a new map widget to the given parent Elementary (container) object.
20949     *
20950     * @param parent The parent object.
20951     * @return a new map widget handle or @c NULL, on errors.
20952     *
20953     * This function inserts a new map widget on the canvas.
20954     *
20955     * @ingroup Map
20956     */
20957    EAPI Evas_Object          *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20958
20959    /**
20960     * Set the zoom level of the map.
20961     *
20962     * @param obj The map object.
20963     * @param zoom The zoom level to set.
20964     *
20965     * This sets the zoom level.
20966     *
20967     * It will respect limits defined by elm_map_source_zoom_min_set() and
20968     * elm_map_source_zoom_max_set().
20969     *
20970     * By default these values are 0 (world map) and 18 (maximum zoom).
20971     *
20972     * This function should be used when zoom mode is set to
20973     * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
20974     * with elm_map_zoom_mode_set().
20975     *
20976     * @see elm_map_zoom_mode_set().
20977     * @see elm_map_zoom_get().
20978     *
20979     * @ingroup Map
20980     */
20981    EAPI void                  elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
20982
20983    /**
20984     * Get the zoom level of the map.
20985     *
20986     * @param obj The map object.
20987     * @return The current zoom level.
20988     *
20989     * This returns the current zoom level of the map object.
20990     *
20991     * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
20992     * (which is the default), the zoom level may be changed at any time by the
20993     * map object itself to account for map size and map viewport size.
20994     *
20995     * @see elm_map_zoom_set() for details.
20996     *
20997     * @ingroup Map
20998     */
20999    EAPI int                   elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21000
21001    /**
21002     * Set the zoom mode used by the map object.
21003     *
21004     * @param obj The map object.
21005     * @param mode The zoom mode of the map, being it one of
21006     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
21007     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
21008     *
21009     * This sets the zoom mode to manual or one of the automatic levels.
21010     * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
21011     * elm_map_zoom_set() and will stay at that level until changed by code
21012     * or until zoom mode is changed. This is the default mode.
21013     *
21014     * The Automatic modes will allow the map object to automatically
21015     * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
21016     * adjust zoom so the map fits inside the scroll frame with no pixels
21017     * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
21018     * ensure no pixels within the frame are left unfilled. Do not forget that
21019     * the valid sizes are 2^zoom, consequently the map may be smaller than
21020     * the scroller view.
21021     *
21022     * @see elm_map_zoom_set()
21023     *
21024     * @ingroup Map
21025     */
21026    EAPI void                  elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
21027
21028    /**
21029     * Get the zoom mode used by the map object.
21030     *
21031     * @param obj The map object.
21032     * @return The zoom mode of the map, being it one of
21033     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
21034     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
21035     *
21036     * This function returns the current zoom mode used by the map object.
21037     *
21038     * @see elm_map_zoom_mode_set() for more details.
21039     *
21040     * @ingroup Map
21041     */
21042    EAPI Elm_Map_Zoom_Mode     elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21043
21044    /**
21045     * Get the current coordinates of the map.
21046     *
21047     * @param obj The map object.
21048     * @param lon Pointer where to store longitude.
21049     * @param lat Pointer where to store latitude.
21050     *
21051     * This gets the current center coordinates of the map object. It can be
21052     * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
21053     *
21054     * @see elm_map_geo_region_bring_in()
21055     * @see elm_map_geo_region_show()
21056     *
21057     * @ingroup Map
21058     */
21059    EAPI void                  elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
21060
21061    /**
21062     * Animatedly bring in given coordinates to the center of the map.
21063     *
21064     * @param obj The map object.
21065     * @param lon Longitude to center at.
21066     * @param lat Latitude to center at.
21067     *
21068     * This causes map to jump to the given @p lat and @p lon coordinates
21069     * and show it (by scrolling) in the center of the viewport, if it is not
21070     * already centered. This will use animation to do so and take a period
21071     * of time to complete.
21072     *
21073     * @see elm_map_geo_region_show() for a function to avoid animation.
21074     * @see elm_map_geo_region_get()
21075     *
21076     * @ingroup Map
21077     */
21078    EAPI void                  elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
21079
21080    /**
21081     * Show the given coordinates at the center of the map, @b immediately.
21082     *
21083     * @param obj The map object.
21084     * @param lon Longitude to center at.
21085     * @param lat Latitude to center at.
21086     *
21087     * This causes map to @b redraw its viewport's contents to the
21088     * region contining the given @p lat and @p lon, that will be moved to the
21089     * center of the map.
21090     *
21091     * @see elm_map_geo_region_bring_in() for a function to move with animation.
21092     * @see elm_map_geo_region_get()
21093     *
21094     * @ingroup Map
21095     */
21096    EAPI void                  elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
21097
21098    /**
21099     * Pause or unpause the map.
21100     *
21101     * @param obj The map object.
21102     * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
21103     * to unpause it.
21104     *
21105     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21106     * for map.
21107     *
21108     * The default is off.
21109     *
21110     * This will stop zooming using animation, changing zoom levels will
21111     * change instantly. This will stop any existing animations that are running.
21112     *
21113     * @see elm_map_paused_get()
21114     *
21115     * @ingroup Map
21116     */
21117    EAPI void                  elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
21118
21119    /**
21120     * Get a value whether map is paused or not.
21121     *
21122     * @param obj The map object.
21123     * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
21124     * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
21125     *
21126     * This gets the current paused state for the map object.
21127     *
21128     * @see elm_map_paused_set() for details.
21129     *
21130     * @ingroup Map
21131     */
21132    EAPI Eina_Bool             elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21133
21134    /**
21135     * Set to show markers during zoom level changes or not.
21136     *
21137     * @param obj The map object.
21138     * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
21139     * to show them.
21140     *
21141     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21142     * for map.
21143     *
21144     * The default is off.
21145     *
21146     * This will stop zooming using animation, changing zoom levels will
21147     * change instantly. This will stop any existing animations that are running.
21148     *
21149     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21150     * for the markers.
21151     *
21152     * The default  is off.
21153     *
21154     * Enabling it will force the map to stop displaying the markers during
21155     * zoom level changes. Set to on if you have a large number of markers.
21156     *
21157     * @see elm_map_paused_markers_get()
21158     *
21159     * @ingroup Map
21160     */
21161    EAPI void                  elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
21162
21163    /**
21164     * Get a value whether markers will be displayed on zoom level changes or not
21165     *
21166     * @param obj The map object.
21167     * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
21168     * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
21169     *
21170     * This gets the current markers paused state for the map object.
21171     *
21172     * @see elm_map_paused_markers_set() for details.
21173     *
21174     * @ingroup Map
21175     */
21176    EAPI Eina_Bool             elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21177
21178    /**
21179     * Get the information of downloading status.
21180     *
21181     * @param obj The map object.
21182     * @param try_num Pointer where to store number of tiles being downloaded.
21183     * @param finish_num Pointer where to store number of tiles successfully
21184     * downloaded.
21185     *
21186     * This gets the current downloading status for the map object, the number
21187     * of tiles being downloaded and the number of tiles already downloaded.
21188     *
21189     * @ingroup Map
21190     */
21191    EAPI void                  elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
21192
21193    /**
21194     * Convert a pixel coordinate (x,y) into a geographic coordinate
21195     * (longitude, latitude).
21196     *
21197     * @param obj The map object.
21198     * @param x the coordinate.
21199     * @param y the coordinate.
21200     * @param size the size in pixels of the map.
21201     * The map is a square and generally his size is : pow(2.0, zoom)*256.
21202     * @param lon Pointer where to store the longitude that correspond to x.
21203     * @param lat Pointer where to store the latitude that correspond to y.
21204     *
21205     * @note Origin pixel point is the top left corner of the viewport.
21206     * Map zoom and size are taken on account.
21207     *
21208     * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
21209     *
21210     * @ingroup Map
21211     */
21212    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);
21213
21214    /**
21215     * Convert a geographic coordinate (longitude, latitude) into a pixel
21216     * coordinate (x, y).
21217     *
21218     * @param obj The map object.
21219     * @param lon the longitude.
21220     * @param lat the latitude.
21221     * @param size the size in pixels of the map. The map is a square
21222     * and generally his size is : pow(2.0, zoom)*256.
21223     * @param x Pointer where to store the horizontal pixel coordinate that
21224     * correspond to the longitude.
21225     * @param y Pointer where to store the vertical pixel coordinate that
21226     * correspond to the latitude.
21227     *
21228     * @note Origin pixel point is the top left corner of the viewport.
21229     * Map zoom and size are taken on account.
21230     *
21231     * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
21232     *
21233     * @ingroup Map
21234     */
21235    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);
21236
21237    /**
21238     * Convert a geographic coordinate (longitude, latitude) into a name
21239     * (address).
21240     *
21241     * @param obj The map object.
21242     * @param lon the longitude.
21243     * @param lat the latitude.
21244     * @return name A #Elm_Map_Name handle for this coordinate.
21245     *
21246     * To get the string for this address, elm_map_name_address_get()
21247     * should be used.
21248     *
21249     * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
21250     *
21251     * @ingroup Map
21252     */
21253    EAPI Elm_Map_Name         *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
21254
21255    /**
21256     * Convert a name (address) into a geographic coordinate
21257     * (longitude, latitude).
21258     *
21259     * @param obj The map object.
21260     * @param name The address.
21261     * @return name A #Elm_Map_Name handle for this address.
21262     *
21263     * To get the longitude and latitude, elm_map_name_region_get()
21264     * should be used.
21265     *
21266     * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
21267     *
21268     * @ingroup Map
21269     */
21270    EAPI Elm_Map_Name         *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
21271
21272    /**
21273     * Convert a pixel coordinate into a rotated pixel coordinate.
21274     *
21275     * @param obj The map object.
21276     * @param x horizontal coordinate of the point to rotate.
21277     * @param y vertical coordinate of the point to rotate.
21278     * @param cx rotation's center horizontal position.
21279     * @param cy rotation's center vertical position.
21280     * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
21281     * @param xx Pointer where to store rotated x.
21282     * @param yy Pointer where to store rotated y.
21283     *
21284     * @ingroup Map
21285     */
21286    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);
21287
21288    /**
21289     * Add a new marker to the map object.
21290     *
21291     * @param obj The map object.
21292     * @param lon The longitude of the marker.
21293     * @param lat The latitude of the marker.
21294     * @param clas The class, to use when marker @b isn't grouped to others.
21295     * @param clas_group The class group, to use when marker is grouped to others
21296     * @param data The data passed to the callbacks.
21297     *
21298     * @return The created marker or @c NULL upon failure.
21299     *
21300     * A marker will be created and shown in a specific point of the map, defined
21301     * by @p lon and @p lat.
21302     *
21303     * It will be displayed using style defined by @p class when this marker
21304     * is displayed alone (not grouped). A new class can be created with
21305     * elm_map_marker_class_new().
21306     *
21307     * If the marker is grouped to other markers, it will be displayed with
21308     * style defined by @p class_group. Markers with the same group are grouped
21309     * if they are close. A new group class can be created with
21310     * elm_map_marker_group_class_new().
21311     *
21312     * Markers created with this method can be deleted with
21313     * elm_map_marker_remove().
21314     *
21315     * A marker can have associated content to be displayed by a bubble,
21316     * when a user click over it, as well as an icon. These objects will
21317     * be fetch using class' callback functions.
21318     *
21319     * @see elm_map_marker_class_new()
21320     * @see elm_map_marker_group_class_new()
21321     * @see elm_map_marker_remove()
21322     *
21323     * @ingroup Map
21324     */
21325    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);
21326
21327    /**
21328     * Set the maximum numbers of markers' content to be displayed in a group.
21329     *
21330     * @param obj The map object.
21331     * @param max The maximum numbers of items displayed in a bubble.
21332     *
21333     * A bubble will be displayed when the user clicks over the group,
21334     * and will place the content of markers that belong to this group
21335     * inside it.
21336     *
21337     * A group can have a long list of markers, consequently the creation
21338     * of the content of the bubble can be very slow.
21339     *
21340     * In order to avoid this, a maximum number of items is displayed
21341     * in a bubble.
21342     *
21343     * By default this number is 30.
21344     *
21345     * Marker with the same group class are grouped if they are close.
21346     *
21347     * @see elm_map_marker_add()
21348     *
21349     * @ingroup Map
21350     */
21351    EAPI void                  elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
21352
21353    /**
21354     * Remove a marker from the map.
21355     *
21356     * @param marker The marker to remove.
21357     *
21358     * @see elm_map_marker_add()
21359     *
21360     * @ingroup Map
21361     */
21362    EAPI void                  elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21363
21364    /**
21365     * Get the current coordinates of the marker.
21366     *
21367     * @param marker marker.
21368     * @param lat Pointer where to store the marker's latitude.
21369     * @param lon Pointer where to store the marker's longitude.
21370     *
21371     * These values are set when adding markers, with function
21372     * elm_map_marker_add().
21373     *
21374     * @see elm_map_marker_add()
21375     *
21376     * @ingroup Map
21377     */
21378    EAPI void                  elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
21379
21380    /**
21381     * Animatedly bring in given marker to the center of the map.
21382     *
21383     * @param marker The marker to center at.
21384     *
21385     * This causes map to jump to the given @p marker's coordinates
21386     * and show it (by scrolling) in the center of the viewport, if it is not
21387     * already centered. This will use animation to do so and take a period
21388     * of time to complete.
21389     *
21390     * @see elm_map_marker_show() for a function to avoid animation.
21391     * @see elm_map_marker_region_get()
21392     *
21393     * @ingroup Map
21394     */
21395    EAPI void                  elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21396
21397    /**
21398     * Show the given marker at the center of the map, @b immediately.
21399     *
21400     * @param marker The marker to center at.
21401     *
21402     * This causes map to @b redraw its viewport's contents to the
21403     * region contining the given @p marker's coordinates, that will be
21404     * moved to the center of the map.
21405     *
21406     * @see elm_map_marker_bring_in() for a function to move with animation.
21407     * @see elm_map_markers_list_show() if more than one marker need to be
21408     * displayed.
21409     * @see elm_map_marker_region_get()
21410     *
21411     * @ingroup Map
21412     */
21413    EAPI void                  elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21414
21415    /**
21416     * Move and zoom the map to display a list of markers.
21417     *
21418     * @param markers A list of #Elm_Map_Marker handles.
21419     *
21420     * The map will be centered on the center point of the markers in the list.
21421     * Then the map will be zoomed in order to fit the markers using the maximum
21422     * zoom which allows display of all the markers.
21423     *
21424     * @warning All the markers should belong to the same map object.
21425     *
21426     * @see elm_map_marker_show() to show a single marker.
21427     * @see elm_map_marker_bring_in()
21428     *
21429     * @ingroup Map
21430     */
21431    EAPI void                  elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
21432
21433    /**
21434     * Get the Evas object returned by the ElmMapMarkerGetFunc callback
21435     *
21436     * @param marker The marker wich content should be returned.
21437     * @return Return the evas object if it exists, else @c NULL.
21438     *
21439     * To set callback function #ElmMapMarkerGetFunc for the marker class,
21440     * elm_map_marker_class_get_cb_set() should be used.
21441     *
21442     * This content is what will be inside the bubble that will be displayed
21443     * when an user clicks over the marker.
21444     *
21445     * This returns the actual Evas object used to be placed inside
21446     * the bubble. This may be @c NULL, as it may
21447     * not have been created or may have been deleted, at any time, by
21448     * the map. <b>Do not modify this object</b> (move, resize,
21449     * show, hide, etc.), as the map is controlling it. This
21450     * function is for querying, emitting custom signals or hooking
21451     * lower level callbacks for events on that object. Do not delete
21452     * this object under any circumstances.
21453     *
21454     * @ingroup Map
21455     */
21456    EAPI Evas_Object          *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21457
21458    /**
21459     * Update the marker
21460     *
21461     * @param marker The marker to be updated.
21462     *
21463     * If a content is set to this marker, it will call function to delete it,
21464     * #ElmMapMarkerDelFunc, and then will fetch the content again with
21465     * #ElmMapMarkerGetFunc.
21466     *
21467     * These functions are set for the marker class with
21468     * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
21469     *
21470     * @ingroup Map
21471     */
21472    EAPI void                  elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21473
21474    /**
21475     * Close all the bubbles opened by the user.
21476     *
21477     * @param obj The map object.
21478     *
21479     * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
21480     * when the user clicks on a marker.
21481     *
21482     * This functions is set for the marker class with
21483     * elm_map_marker_class_get_cb_set().
21484     *
21485     * @ingroup Map
21486     */
21487    EAPI void                  elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
21488
21489    /**
21490     * Create a new group class.
21491     *
21492     * @param obj The map object.
21493     * @return Returns the new group class.
21494     *
21495     * Each marker must be associated to a group class. Markers in the same
21496     * group are grouped if they are close.
21497     *
21498     * The group class defines the style of the marker when a marker is grouped
21499     * to others markers. When it is alone, another class will be used.
21500     *
21501     * A group class will need to be provided when creating a marker with
21502     * elm_map_marker_add().
21503     *
21504     * Some properties and functions can be set by class, as:
21505     * - style, with elm_map_group_class_style_set()
21506     * - data - to be associated to the group class. It can be set using
21507     *   elm_map_group_class_data_set().
21508     * - min zoom to display markers, set with
21509     *   elm_map_group_class_zoom_displayed_set().
21510     * - max zoom to group markers, set using
21511     *   elm_map_group_class_zoom_grouped_set().
21512     * - visibility - set if markers will be visible or not, set with
21513     *   elm_map_group_class_hide_set().
21514     * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
21515     *   It can be set using elm_map_group_class_icon_cb_set().
21516     *
21517     * @see elm_map_marker_add()
21518     * @see elm_map_group_class_style_set()
21519     * @see elm_map_group_class_data_set()
21520     * @see elm_map_group_class_zoom_displayed_set()
21521     * @see elm_map_group_class_zoom_grouped_set()
21522     * @see elm_map_group_class_hide_set()
21523     * @see elm_map_group_class_icon_cb_set()
21524     *
21525     * @ingroup Map
21526     */
21527    EAPI Elm_Map_Group_Class  *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
21528
21529    /**
21530     * Set the marker's style of a group class.
21531     *
21532     * @param clas The group class.
21533     * @param style The style to be used by markers.
21534     *
21535     * Each marker must be associated to a group class, and will use the style
21536     * defined by such class when grouped to other markers.
21537     *
21538     * The following styles are provided by default theme:
21539     * @li @c radio - blue circle
21540     * @li @c radio2 - green circle
21541     * @li @c empty
21542     *
21543     * @see elm_map_group_class_new() for more details.
21544     * @see elm_map_marker_add()
21545     *
21546     * @ingroup Map
21547     */
21548    EAPI void                  elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
21549
21550    /**
21551     * Set the icon callback function of a group class.
21552     *
21553     * @param clas The group class.
21554     * @param icon_get The callback function that will return the icon.
21555     *
21556     * Each marker must be associated to a group class, and it can display a
21557     * custom icon. The function @p icon_get must return this icon.
21558     *
21559     * @see elm_map_group_class_new() for more details.
21560     * @see elm_map_marker_add()
21561     *
21562     * @ingroup Map
21563     */
21564    EAPI void                  elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
21565
21566    /**
21567     * Set the data associated to the group class.
21568     *
21569     * @param clas The group class.
21570     * @param data The new user data.
21571     *
21572     * This data will be passed for callback functions, like icon get callback,
21573     * that can be set with elm_map_group_class_icon_cb_set().
21574     *
21575     * If a data was previously set, the object will lose the pointer for it,
21576     * so if needs to be freed, you must do it yourself.
21577     *
21578     * @see elm_map_group_class_new() for more details.
21579     * @see elm_map_group_class_icon_cb_set()
21580     * @see elm_map_marker_add()
21581     *
21582     * @ingroup Map
21583     */
21584    EAPI void                  elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
21585
21586    /**
21587     * Set the minimum zoom from where the markers are displayed.
21588     *
21589     * @param clas The group class.
21590     * @param zoom The minimum zoom.
21591     *
21592     * Markers only will be displayed when the map is displayed at @p zoom
21593     * or bigger.
21594     *
21595     * @see elm_map_group_class_new() for more details.
21596     * @see elm_map_marker_add()
21597     *
21598     * @ingroup Map
21599     */
21600    EAPI void                  elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
21601
21602    /**
21603     * Set the zoom from where the markers are no more grouped.
21604     *
21605     * @param clas The group class.
21606     * @param zoom The maximum zoom.
21607     *
21608     * Markers only will be grouped when the map is displayed at
21609     * less than @p zoom.
21610     *
21611     * @see elm_map_group_class_new() for more details.
21612     * @see elm_map_marker_add()
21613     *
21614     * @ingroup Map
21615     */
21616    EAPI void                  elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
21617
21618    /**
21619     * Set if the markers associated to the group class @clas are hidden or not.
21620     *
21621     * @param clas The group class.
21622     * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
21623     * to show them.
21624     *
21625     * If @p hide is @c EINA_TRUE the markers will be hidden, but default
21626     * is to show them.
21627     *
21628     * @ingroup Map
21629     */
21630    EAPI void                  elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
21631
21632    /**
21633     * Create a new marker class.
21634     *
21635     * @param obj The map object.
21636     * @return Returns the new group class.
21637     *
21638     * Each marker must be associated to a class.
21639     *
21640     * The marker class defines the style of the marker when a marker is
21641     * displayed alone, i.e., not grouped to to others markers. When grouped
21642     * it will use group class style.
21643     *
21644     * A marker class will need to be provided when creating a marker with
21645     * elm_map_marker_add().
21646     *
21647     * Some properties and functions can be set by class, as:
21648     * - style, with elm_map_marker_class_style_set()
21649     * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
21650     *   It can be set using elm_map_marker_class_icon_cb_set().
21651     * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
21652     *   Set using elm_map_marker_class_get_cb_set().
21653     * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
21654     *   Set using elm_map_marker_class_del_cb_set().
21655     *
21656     * @see elm_map_marker_add()
21657     * @see elm_map_marker_class_style_set()
21658     * @see elm_map_marker_class_icon_cb_set()
21659     * @see elm_map_marker_class_get_cb_set()
21660     * @see elm_map_marker_class_del_cb_set()
21661     *
21662     * @ingroup Map
21663     */
21664    EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
21665
21666    /**
21667     * Set the marker's style of a marker class.
21668     *
21669     * @param clas The marker class.
21670     * @param style The style to be used by markers.
21671     *
21672     * Each marker must be associated to a marker class, and will use the style
21673     * defined by such class when alone, i.e., @b not grouped to other markers.
21674     *
21675     * The following styles are provided by default theme:
21676     * @li @c radio
21677     * @li @c radio2
21678     * @li @c empty
21679     *
21680     * @see elm_map_marker_class_new() for more details.
21681     * @see elm_map_marker_add()
21682     *
21683     * @ingroup Map
21684     */
21685    EAPI void                  elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
21686
21687    /**
21688     * Set the icon callback function of a marker class.
21689     *
21690     * @param clas The marker class.
21691     * @param icon_get The callback function that will return the icon.
21692     *
21693     * Each marker must be associated to a marker class, and it can display a
21694     * custom icon. The function @p icon_get must return this icon.
21695     *
21696     * @see elm_map_marker_class_new() for more details.
21697     * @see elm_map_marker_add()
21698     *
21699     * @ingroup Map
21700     */
21701    EAPI void                  elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
21702
21703    /**
21704     * Set the bubble content callback function of a marker class.
21705     *
21706     * @param clas The marker class.
21707     * @param get The callback function that will return the content.
21708     *
21709     * Each marker must be associated to a marker class, and it can display a
21710     * a content on a bubble that opens when the user click over the marker.
21711     * The function @p get must return this content object.
21712     *
21713     * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
21714     * can be used.
21715     *
21716     * @see elm_map_marker_class_new() for more details.
21717     * @see elm_map_marker_class_del_cb_set()
21718     * @see elm_map_marker_add()
21719     *
21720     * @ingroup Map
21721     */
21722    EAPI void                  elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
21723
21724    /**
21725     * Set the callback function used to delete bubble content of a marker class.
21726     *
21727     * @param clas The marker class.
21728     * @param del The callback function that will delete the content.
21729     *
21730     * Each marker must be associated to a marker class, and it can display a
21731     * a content on a bubble that opens when the user click over the marker.
21732     * The function to return such content can be set with
21733     * elm_map_marker_class_get_cb_set().
21734     *
21735     * If this content must be freed, a callback function need to be
21736     * set for that task with this function.
21737     *
21738     * If this callback is defined it will have to delete (or not) the
21739     * object inside, but if the callback is not defined the object will be
21740     * destroyed with evas_object_del().
21741     *
21742     * @see elm_map_marker_class_new() for more details.
21743     * @see elm_map_marker_class_get_cb_set()
21744     * @see elm_map_marker_add()
21745     *
21746     * @ingroup Map
21747     */
21748    EAPI void                  elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
21749
21750    /**
21751     * Get the list of available sources.
21752     *
21753     * @param obj The map object.
21754     * @return The source names list.
21755     *
21756     * It will provide a list with all available sources, that can be set as
21757     * current source with elm_map_source_name_set(), or get with
21758     * elm_map_source_name_get().
21759     *
21760     * Available sources:
21761     * @li "Mapnik"
21762     * @li "Osmarender"
21763     * @li "CycleMap"
21764     * @li "Maplint"
21765     *
21766     * @see elm_map_source_name_set() for more details.
21767     * @see elm_map_source_name_get()
21768     *
21769     * @ingroup Map
21770     */
21771    EAPI const char          **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21772
21773    /**
21774     * Set the source of the map.
21775     *
21776     * @param obj The map object.
21777     * @param source The source to be used.
21778     *
21779     * Map widget retrieves images that composes the map from a web service.
21780     * This web service can be set with this method.
21781     *
21782     * A different service can return a different maps with different
21783     * information and it can use different zoom values.
21784     *
21785     * The @p source_name need to match one of the names provided by
21786     * elm_map_source_names_get().
21787     *
21788     * The current source can be get using elm_map_source_name_get().
21789     *
21790     * @see elm_map_source_names_get()
21791     * @see elm_map_source_name_get()
21792     *
21793     *
21794     * @ingroup Map
21795     */
21796    EAPI void                  elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
21797
21798    /**
21799     * Get the name of currently used source.
21800     *
21801     * @param obj The map object.
21802     * @return Returns the name of the source in use.
21803     *
21804     * @see elm_map_source_name_set() for more details.
21805     *
21806     * @ingroup Map
21807     */
21808    EAPI const char           *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21809
21810    /**
21811     * Set the source of the route service to be used by the map.
21812     *
21813     * @param obj The map object.
21814     * @param source The route service to be used, being it one of
21815     * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
21816     * and #ELM_MAP_ROUTE_SOURCE_ORS.
21817     *
21818     * Each one has its own algorithm, so the route retrieved may
21819     * differ depending on the source route. Now, only the default is working.
21820     *
21821     * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
21822     * http://www.yournavigation.org/.
21823     *
21824     * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
21825     * assumptions. Its routing core is based on Contraction Hierarchies.
21826     *
21827     * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
21828     *
21829     * @see elm_map_route_source_get().
21830     *
21831     * @ingroup Map
21832     */
21833    EAPI void                  elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
21834
21835    /**
21836     * Get the current route source.
21837     *
21838     * @param obj The map object.
21839     * @return The source of the route service used by the map.
21840     *
21841     * @see elm_map_route_source_set() for details.
21842     *
21843     * @ingroup Map
21844     */
21845    EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21846
21847    /**
21848     * Set the minimum zoom of the source.
21849     *
21850     * @param obj The map object.
21851     * @param zoom New minimum zoom value to be used.
21852     *
21853     * By default, it's 0.
21854     *
21855     * @ingroup Map
21856     */
21857    EAPI void                  elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
21858
21859    /**
21860     * Get the minimum zoom of the source.
21861     *
21862     * @param obj The map object.
21863     * @return Returns the minimum zoom of the source.
21864     *
21865     * @see elm_map_source_zoom_min_set() for details.
21866     *
21867     * @ingroup Map
21868     */
21869    EAPI int                   elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21870
21871    /**
21872     * Set the maximum zoom of the source.
21873     *
21874     * @param obj The map object.
21875     * @param zoom New maximum zoom value to be used.
21876     *
21877     * By default, it's 18.
21878     *
21879     * @ingroup Map
21880     */
21881    EAPI void                  elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
21882
21883    /**
21884     * Get the maximum zoom of the source.
21885     *
21886     * @param obj The map object.
21887     * @return Returns the maximum zoom of the source.
21888     *
21889     * @see elm_map_source_zoom_min_set() for details.
21890     *
21891     * @ingroup Map
21892     */
21893    EAPI int                   elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21894
21895    /**
21896     * Set the user agent used by the map object to access routing services.
21897     *
21898     * @param obj The map object.
21899     * @param user_agent The user agent to be used by the map.
21900     *
21901     * User agent is a client application implementing a network protocol used
21902     * in communications within a client–server distributed computing system
21903     *
21904     * The @p user_agent identification string will transmitted in a header
21905     * field @c User-Agent.
21906     *
21907     * @see elm_map_user_agent_get()
21908     *
21909     * @ingroup Map
21910     */
21911    EAPI void                  elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
21912
21913    /**
21914     * Get the user agent used by the map object.
21915     *
21916     * @param obj The map object.
21917     * @return The user agent identification string used by the map.
21918     *
21919     * @see elm_map_user_agent_set() for details.
21920     *
21921     * @ingroup Map
21922     */
21923    EAPI const char           *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21924
21925    /**
21926     * Add a new route to the map object.
21927     *
21928     * @param obj The map object.
21929     * @param type The type of transport to be considered when tracing a route.
21930     * @param method The routing method, what should be priorized.
21931     * @param flon The start longitude.
21932     * @param flat The start latitude.
21933     * @param tlon The destination longitude.
21934     * @param tlat The destination latitude.
21935     *
21936     * @return The created route or @c NULL upon failure.
21937     *
21938     * A route will be traced by point on coordinates (@p flat, @p flon)
21939     * to point on coordinates (@p tlat, @p tlon), using the route service
21940     * set with elm_map_route_source_set().
21941     *
21942     * It will take @p type on consideration to define the route,
21943     * depending if the user will be walking or driving, the route may vary.
21944     * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
21945     * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
21946     *
21947     * Another parameter is what the route should priorize, the minor distance
21948     * or the less time to be spend on the route. So @p method should be one
21949     * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
21950     *
21951     * Routes created with this method can be deleted with
21952     * elm_map_route_remove(), colored with elm_map_route_color_set(),
21953     * and distance can be get with elm_map_route_distance_get().
21954     *
21955     * @see elm_map_route_remove()
21956     * @see elm_map_route_color_set()
21957     * @see elm_map_route_distance_get()
21958     * @see elm_map_route_source_set()
21959     *
21960     * @ingroup Map
21961     */
21962    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);
21963
21964    /**
21965     * Remove a route from the map.
21966     *
21967     * @param route The route to remove.
21968     *
21969     * @see elm_map_route_add()
21970     *
21971     * @ingroup Map
21972     */
21973    EAPI void                  elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21974
21975    /**
21976     * Set the route color.
21977     *
21978     * @param route The route object.
21979     * @param r Red channel value, from 0 to 255.
21980     * @param g Green channel value, from 0 to 255.
21981     * @param b Blue channel value, from 0 to 255.
21982     * @param a Alpha channel value, from 0 to 255.
21983     *
21984     * It uses an additive color model, so each color channel represents
21985     * how much of each primary colors must to be used. 0 represents
21986     * ausence of this color, so if all of the three are set to 0,
21987     * the color will be black.
21988     *
21989     * These component values should be integers in the range 0 to 255,
21990     * (single 8-bit byte).
21991     *
21992     * This sets the color used for the route. By default, it is set to
21993     * solid red (r = 255, g = 0, b = 0, a = 255).
21994     *
21995     * For alpha channel, 0 represents completely transparent, and 255, opaque.
21996     *
21997     * @see elm_map_route_color_get()
21998     *
21999     * @ingroup Map
22000     */
22001    EAPI void                  elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
22002
22003    /**
22004     * Get the route color.
22005     *
22006     * @param route The route object.
22007     * @param r Pointer where to store the red channel value.
22008     * @param g Pointer where to store the green channel value.
22009     * @param b Pointer where to store the blue channel value.
22010     * @param a Pointer where to store the alpha channel value.
22011     *
22012     * @see elm_map_route_color_set() for details.
22013     *
22014     * @ingroup Map
22015     */
22016    EAPI void                  elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
22017
22018    /**
22019     * Get the route distance in kilometers.
22020     *
22021     * @param route The route object.
22022     * @return The distance of route (unit : km).
22023     *
22024     * @ingroup Map
22025     */
22026    EAPI double                elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
22027
22028    /**
22029     * Get the information of route nodes.
22030     *
22031     * @param route The route object.
22032     * @return Returns a string with the nodes of route.
22033     *
22034     * @ingroup Map
22035     */
22036    EAPI const char           *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
22037
22038    /**
22039     * Get the information of route waypoint.
22040     *
22041     * @param route the route object.
22042     * @return Returns a string with information about waypoint of route.
22043     *
22044     * @ingroup Map
22045     */
22046    EAPI const char           *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
22047
22048    /**
22049     * Get the address of the name.
22050     *
22051     * @param name The name handle.
22052     * @return Returns the address string of @p name.
22053     *
22054     * This gets the coordinates of the @p name, created with one of the
22055     * conversion functions.
22056     *
22057     * @see elm_map_utils_convert_name_into_coord()
22058     * @see elm_map_utils_convert_coord_into_name()
22059     *
22060     * @ingroup Map
22061     */
22062    EAPI const char           *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
22063
22064    /**
22065     * Get the current coordinates of the name.
22066     *
22067     * @param name The name handle.
22068     * @param lat Pointer where to store the latitude.
22069     * @param lon Pointer where to store The longitude.
22070     *
22071     * This gets the coordinates of the @p name, created with one of the
22072     * conversion functions.
22073     *
22074     * @see elm_map_utils_convert_name_into_coord()
22075     * @see elm_map_utils_convert_coord_into_name()
22076     *
22077     * @ingroup Map
22078     */
22079    EAPI void                  elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
22080
22081    /**
22082     * Remove a name from the map.
22083     *
22084     * @param name The name to remove.
22085     *
22086     * Basically the struct handled by @p name will be freed, so convertions
22087     * between address and coordinates will be lost.
22088     *
22089     * @see elm_map_utils_convert_name_into_coord()
22090     * @see elm_map_utils_convert_coord_into_name()
22091     *
22092     * @ingroup Map
22093     */
22094    EAPI void                  elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
22095
22096    /**
22097     * Rotate the map.
22098     *
22099     * @param obj The map object.
22100     * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
22101     * @param cx Rotation's center horizontal position.
22102     * @param cy Rotation's center vertical position.
22103     *
22104     * @see elm_map_rotate_get()
22105     *
22106     * @ingroup Map
22107     */
22108    EAPI void                  elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
22109
22110    /**
22111     * Get the rotate degree of the map
22112     *
22113     * @param obj The map object
22114     * @param degree Pointer where to store degrees from 0.0 to 360.0
22115     * to rotate arount Z axis.
22116     * @param cx Pointer where to store rotation's center horizontal position.
22117     * @param cy Pointer where to store rotation's center vertical position.
22118     *
22119     * @see elm_map_rotate_set() to set map rotation.
22120     *
22121     * @ingroup Map
22122     */
22123    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);
22124
22125    /**
22126     * Enable or disable mouse wheel to be used to zoom in / out the map.
22127     *
22128     * @param obj The map object.
22129     * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
22130     * to enable it.
22131     *
22132     * Mouse wheel can be used for the user to zoom in or zoom out the map.
22133     *
22134     * It's disabled by default.
22135     *
22136     * @see elm_map_wheel_disabled_get()
22137     *
22138     * @ingroup Map
22139     */
22140    EAPI void                  elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22141
22142    /**
22143     * Get a value whether mouse wheel is enabled or not.
22144     *
22145     * @param obj The map object.
22146     * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
22147     * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22148     *
22149     * Mouse wheel can be used for the user to zoom in or zoom out the map.
22150     *
22151     * @see elm_map_wheel_disabled_set() for details.
22152     *
22153     * @ingroup Map
22154     */
22155    EAPI Eina_Bool             elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22156
22157 #ifdef ELM_EMAP
22158    /**
22159     * Add a track on the map
22160     *
22161     * @param obj The map object.
22162     * @param emap The emap route object.
22163     * @return The route object. This is an elm object of type Route.
22164     *
22165     * @see elm_route_add() for details.
22166     *
22167     * @ingroup Map
22168     */
22169    EAPI Evas_Object          *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
22170 #endif
22171
22172    /**
22173     * Remove a track from the map
22174     *
22175     * @param obj The map object.
22176     * @param route The track to remove.
22177     *
22178     * @ingroup Map
22179     */
22180    EAPI void                  elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
22181
22182    /**
22183     * @}
22184     */
22185
22186    /* Route */
22187    EAPI Evas_Object *elm_route_add(Evas_Object *parent);
22188 #ifdef ELM_EMAP
22189    EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
22190 #endif
22191    EAPI double elm_route_lon_min_get(Evas_Object *obj);
22192    EAPI double elm_route_lat_min_get(Evas_Object *obj);
22193    EAPI double elm_route_lon_max_get(Evas_Object *obj);
22194    EAPI double elm_route_lat_max_get(Evas_Object *obj);
22195
22196
22197    /**
22198     * @defgroup Panel Panel
22199     *
22200     * @image html img/widget/panel/preview-00.png
22201     * @image latex img/widget/panel/preview-00.eps
22202     *
22203     * @brief A panel is a type of animated container that contains subobjects.
22204     * It can be expanded or contracted by clicking the button on it's edge.
22205     *
22206     * Orientations are as follows:
22207     * @li ELM_PANEL_ORIENT_TOP
22208     * @li ELM_PANEL_ORIENT_LEFT
22209     * @li ELM_PANEL_ORIENT_RIGHT
22210     *
22211     * @ref tutorial_panel shows one way to use this widget.
22212     * @{
22213     */
22214    typedef enum _Elm_Panel_Orient
22215      {
22216         ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
22217         ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
22218         ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
22219         ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
22220      } Elm_Panel_Orient;
22221    /**
22222     * @brief Adds a panel object
22223     *
22224     * @param parent The parent object
22225     *
22226     * @return The panel object, or NULL on failure
22227     */
22228    EAPI Evas_Object          *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22229    /**
22230     * @brief Sets the orientation of the panel
22231     *
22232     * @param parent The parent object
22233     * @param orient The panel orientation. Can be one of the following:
22234     * @li ELM_PANEL_ORIENT_TOP
22235     * @li ELM_PANEL_ORIENT_LEFT
22236     * @li ELM_PANEL_ORIENT_RIGHT
22237     *
22238     * Sets from where the panel will (dis)appear.
22239     */
22240    EAPI void                  elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
22241    /**
22242     * @brief Get the orientation of the panel.
22243     *
22244     * @param obj The panel object
22245     * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
22246     */
22247    EAPI Elm_Panel_Orient      elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22248    /**
22249     * @brief Set the content of the panel.
22250     *
22251     * @param obj The panel object
22252     * @param content The panel content
22253     *
22254     * Once the content object is set, a previously set one will be deleted.
22255     * If you want to keep that old content object, use the
22256     * elm_panel_content_unset() function.
22257     */
22258    EAPI void                  elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22259    /**
22260     * @brief Get the content of the panel.
22261     *
22262     * @param obj The panel object
22263     * @return The content that is being used
22264     *
22265     * Return the content object which is set for this widget.
22266     *
22267     * @see elm_panel_content_set()
22268     */
22269    EAPI Evas_Object          *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22270    /**
22271     * @brief Unset the content of the panel.
22272     *
22273     * @param obj The panel object
22274     * @return The content that was being used
22275     *
22276     * Unparent and return the content object which was set for this widget.
22277     *
22278     * @see elm_panel_content_set()
22279     */
22280    EAPI Evas_Object          *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22281    /**
22282     * @brief Set the state of the panel.
22283     *
22284     * @param obj The panel object
22285     * @param hidden If true, the panel will run the animation to contract
22286     */
22287    EAPI void                  elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
22288    /**
22289     * @brief Get the state of the panel.
22290     *
22291     * @param obj The panel object
22292     * @param hidden If true, the panel is in the "hide" state
22293     */
22294    EAPI Eina_Bool             elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22295    /**
22296     * @brief Toggle the hidden state of the panel from code
22297     *
22298     * @param obj The panel object
22299     */
22300    EAPI void                  elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
22301    /**
22302     * @}
22303     */
22304
22305    /**
22306     * @defgroup Panes Panes
22307     * @ingroup Elementary
22308     *
22309     * @image html img/widget/panes/preview-00.png
22310     * @image latex img/widget/panes/preview-00.eps width=\textwidth
22311     *
22312     * @image html img/panes.png
22313     * @image latex img/panes.eps width=\textwidth
22314     *
22315     * The panes adds a dragable bar between two contents. When dragged
22316     * this bar will resize contents size.
22317     *
22318     * Panes can be displayed vertically or horizontally, and contents
22319     * size proportion can be customized (homogeneous by default).
22320     *
22321     * Smart callbacks one can listen to:
22322     * - "press" - The panes has been pressed (button wasn't released yet).
22323     * - "unpressed" - The panes was released after being pressed.
22324     * - "clicked" - The panes has been clicked>
22325     * - "clicked,double" - The panes has been double clicked
22326     *
22327     * Available styles for it:
22328     * - @c "default"
22329     *
22330     * Here is an example on its usage:
22331     * @li @ref panes_example
22332     */
22333
22334    /**
22335     * @addtogroup Panes
22336     * @{
22337     */
22338
22339    /**
22340     * Add a new panes widget to the given parent Elementary
22341     * (container) object.
22342     *
22343     * @param parent The parent object.
22344     * @return a new panes widget handle or @c NULL, on errors.
22345     *
22346     * This function inserts a new panes widget on the canvas.
22347     *
22348     * @ingroup Panes
22349     */
22350    EAPI Evas_Object          *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22351
22352    /**
22353     * Set the left content of the panes widget.
22354     *
22355     * @param obj The panes object.
22356     * @param content The new left content object.
22357     *
22358     * Once the content object is set, a previously set one will be deleted.
22359     * If you want to keep that old content object, use the
22360     * elm_panes_content_left_unset() function.
22361     *
22362     * If panes is displayed vertically, left content will be displayed at
22363     * top.
22364     *
22365     * @see elm_panes_content_left_get()
22366     * @see elm_panes_content_right_set() to set content on the other side.
22367     *
22368     * @ingroup Panes
22369     */
22370    EAPI void                  elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22371
22372    /**
22373     * Set the right content of the panes widget.
22374     *
22375     * @param obj The panes object.
22376     * @param content The new right content object.
22377     *
22378     * Once the content object is set, a previously set one will be deleted.
22379     * If you want to keep that old content object, use the
22380     * elm_panes_content_right_unset() function.
22381     *
22382     * If panes is displayed vertically, left content will be displayed at
22383     * bottom.
22384     *
22385     * @see elm_panes_content_right_get()
22386     * @see elm_panes_content_left_set() to set content on the other side.
22387     *
22388     * @ingroup Panes
22389     */
22390    EAPI void                  elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22391
22392    /**
22393     * Get the left content of the panes.
22394     *
22395     * @param obj The panes object.
22396     * @return The left content object that is being used.
22397     *
22398     * Return the left content object which is set for this widget.
22399     *
22400     * @see elm_panes_content_left_set() for details.
22401     *
22402     * @ingroup Panes
22403     */
22404    EAPI Evas_Object          *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22405
22406    /**
22407     * Get the right content of the panes.
22408     *
22409     * @param obj The panes object
22410     * @return The right content object that is being used
22411     *
22412     * Return the right content object which is set for this widget.
22413     *
22414     * @see elm_panes_content_right_set() for details.
22415     *
22416     * @ingroup Panes
22417     */
22418    EAPI Evas_Object          *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22419
22420    /**
22421     * Unset the left content used for the panes.
22422     *
22423     * @param obj The panes object.
22424     * @return The left content object that was being used.
22425     *
22426     * Unparent and return the left content object which was set for this widget.
22427     *
22428     * @see elm_panes_content_left_set() for details.
22429     * @see elm_panes_content_left_get().
22430     *
22431     * @ingroup Panes
22432     */
22433    EAPI Evas_Object          *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22434
22435    /**
22436     * Unset the right content used for the panes.
22437     *
22438     * @param obj The panes object.
22439     * @return The right content object that was being used.
22440     *
22441     * Unparent and return the right content object which was set for this
22442     * widget.
22443     *
22444     * @see elm_panes_content_right_set() for details.
22445     * @see elm_panes_content_right_get().
22446     *
22447     * @ingroup Panes
22448     */
22449    EAPI Evas_Object          *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22450
22451    /**
22452     * Get the size proportion of panes widget's left side.
22453     *
22454     * @param obj The panes object.
22455     * @return float value between 0.0 and 1.0 representing size proportion
22456     * of left side.
22457     *
22458     * @see elm_panes_content_left_size_set() for more details.
22459     *
22460     * @ingroup Panes
22461     */
22462    EAPI double                elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22463
22464    /**
22465     * Set the size proportion of panes widget's left side.
22466     *
22467     * @param obj The panes object.
22468     * @param size Value between 0.0 and 1.0 representing size proportion
22469     * of left side.
22470     *
22471     * By default it's homogeneous, i.e., both sides have the same size.
22472     *
22473     * If something different is required, it can be set with this function.
22474     * For example, if the left content should be displayed over
22475     * 75% of the panes size, @p size should be passed as @c 0.75.
22476     * This way, right content will be resized to 25% of panes size.
22477     *
22478     * If displayed vertically, left content is displayed at top, and
22479     * right content at bottom.
22480     *
22481     * @note This proportion will change when user drags the panes bar.
22482     *
22483     * @see elm_panes_content_left_size_get()
22484     *
22485     * @ingroup Panes
22486     */
22487    EAPI void                  elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
22488
22489   /**
22490    * Set the orientation of a given panes widget.
22491    *
22492    * @param obj The panes object.
22493    * @param horizontal Use @c EINA_TRUE to make @p obj to be
22494    * @b horizontal, @c EINA_FALSE to make it @b vertical.
22495    *
22496    * Use this function to change how your panes is to be
22497    * disposed: vertically or horizontally.
22498    *
22499    * By default it's displayed horizontally.
22500    *
22501    * @see elm_panes_horizontal_get()
22502    *
22503    * @ingroup Panes
22504    */
22505    EAPI void                  elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22506
22507    /**
22508     * Retrieve the orientation of a given panes widget.
22509     *
22510     * @param obj The panes object.
22511     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
22512     * @c EINA_FALSE if it's @b vertical (and on errors).
22513     *
22514     * @see elm_panes_horizontal_set() for more details.
22515     *
22516     * @ingroup Panes
22517     */
22518    EAPI Eina_Bool             elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22519
22520    /**
22521     * @}
22522     */
22523
22524    /**
22525     * @defgroup Flip Flip
22526     *
22527     * @image html img/widget/flip/preview-00.png
22528     * @image latex img/widget/flip/preview-00.eps
22529     *
22530     * This widget holds 2 content objects(Evas_Object): one on the front and one
22531     * on the back. It allows you to flip from front to back and vice-versa using
22532     * various animations.
22533     *
22534     * If either the front or back contents are not set the flip will treat that
22535     * as transparent. So if you wore to set the front content but not the back,
22536     * and then call elm_flip_go() you would see whatever is below the flip.
22537     *
22538     * For a list of supported animations see elm_flip_go().
22539     *
22540     * Signals that you can add callbacks for are:
22541     * "animate,begin" - when a flip animation was started
22542     * "animate,done" - when a flip animation is finished
22543     *
22544     * @ref tutorial_flip show how to use most of the API.
22545     *
22546     * @{
22547     */
22548    typedef enum _Elm_Flip_Mode
22549      {
22550         ELM_FLIP_ROTATE_Y_CENTER_AXIS,
22551         ELM_FLIP_ROTATE_X_CENTER_AXIS,
22552         ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
22553         ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
22554         ELM_FLIP_CUBE_LEFT,
22555         ELM_FLIP_CUBE_RIGHT,
22556         ELM_FLIP_CUBE_UP,
22557         ELM_FLIP_CUBE_DOWN,
22558         ELM_FLIP_PAGE_LEFT,
22559         ELM_FLIP_PAGE_RIGHT,
22560         ELM_FLIP_PAGE_UP,
22561         ELM_FLIP_PAGE_DOWN
22562      } Elm_Flip_Mode;
22563    typedef enum _Elm_Flip_Interaction
22564      {
22565         ELM_FLIP_INTERACTION_NONE,
22566         ELM_FLIP_INTERACTION_ROTATE,
22567         ELM_FLIP_INTERACTION_CUBE,
22568         ELM_FLIP_INTERACTION_PAGE
22569      } Elm_Flip_Interaction;
22570    typedef enum _Elm_Flip_Direction
22571      {
22572         ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
22573         ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
22574         ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
22575         ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
22576      } Elm_Flip_Direction;
22577    /**
22578     * @brief Add a new flip to the parent
22579     *
22580     * @param parent The parent object
22581     * @return The new object or NULL if it cannot be created
22582     */
22583    EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22584    /**
22585     * @brief Set the front content of the flip widget.
22586     *
22587     * @param obj The flip object
22588     * @param content The new front content object
22589     *
22590     * Once the content object is set, a previously set one will be deleted.
22591     * If you want to keep that old content object, use the
22592     * elm_flip_content_front_unset() function.
22593     */
22594    EAPI void         elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22595    /**
22596     * @brief Set the back content of the flip widget.
22597     *
22598     * @param obj The flip object
22599     * @param content The new back content object
22600     *
22601     * Once the content object is set, a previously set one will be deleted.
22602     * If you want to keep that old content object, use the
22603     * elm_flip_content_back_unset() function.
22604     */
22605    EAPI void         elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22606    /**
22607     * @brief Get the front content used for the flip
22608     *
22609     * @param obj The flip object
22610     * @return The front content object that is being used
22611     *
22612     * Return the front content object which is set for this widget.
22613     */
22614    EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22615    /**
22616     * @brief Get the back content used for the flip
22617     *
22618     * @param obj The flip object
22619     * @return The back content object that is being used
22620     *
22621     * Return the back content object which is set for this widget.
22622     */
22623    EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22624    /**
22625     * @brief Unset the front content used for the flip
22626     *
22627     * @param obj The flip object
22628     * @return The front content object that was being used
22629     *
22630     * Unparent and return the front content object which was set for this widget.
22631     */
22632    EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22633    /**
22634     * @brief Unset the back content used for the flip
22635     *
22636     * @param obj The flip object
22637     * @return The back content object that was being used
22638     *
22639     * Unparent and return the back content object which was set for this widget.
22640     */
22641    EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22642    /**
22643     * @brief Get flip front visibility state
22644     *
22645     * @param obj The flip objct
22646     * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
22647     * showing.
22648     */
22649    EAPI Eina_Bool    elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22650    /**
22651     * @brief Set flip perspective
22652     *
22653     * @param obj The flip object
22654     * @param foc The coordinate to set the focus on
22655     * @param x The X coordinate
22656     * @param y The Y coordinate
22657     *
22658     * @warning This function currently does nothing.
22659     */
22660    EAPI void         elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
22661    /**
22662     * @brief Runs the flip animation
22663     *
22664     * @param obj The flip object
22665     * @param mode The mode type
22666     *
22667     * Flips the front and back contents using the @p mode animation. This
22668     * efectively hides the currently visible content and shows the hidden one.
22669     *
22670     * There a number of possible animations to use for the flipping:
22671     * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
22672     * around a horizontal axis in the middle of its height, the other content
22673     * is shown as the other side of the flip.
22674     * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
22675     * around a vertical axis in the middle of its width, the other content is
22676     * shown as the other side of the flip.
22677     * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
22678     * around a diagonal axis in the middle of its width, the other content is
22679     * shown as the other side of the flip.
22680     * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
22681     * around a diagonal axis in the middle of its height, the other content is
22682     * shown as the other side of the flip.
22683     * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
22684     * as if the flip was a cube, the other content is show as the right face of
22685     * the cube.
22686     * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
22687     * right as if the flip was a cube, the other content is show as the left
22688     * face of the cube.
22689     * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
22690     * flip was a cube, the other content is show as the bottom face of the cube.
22691     * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
22692     * the flip was a cube, the other content is show as the upper face of the
22693     * cube.
22694     * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
22695     * if the flip was a book, the other content is shown as the page below that.
22696     * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
22697     * as if the flip was a book, the other content is shown as the page below
22698     * that.
22699     * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
22700     * flip was a book, the other content is shown as the page below that.
22701     * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
22702     * flip was a book, the other content is shown as the page below that.
22703     *
22704     * @image html elm_flip.png
22705     * @image latex elm_flip.eps width=\textwidth
22706     */
22707    EAPI void         elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
22708    /**
22709     * @brief Set the interactive flip mode
22710     *
22711     * @param obj The flip object
22712     * @param mode The interactive flip mode to use
22713     *
22714     * This sets if the flip should be interactive (allow user to click and
22715     * drag a side of the flip to reveal the back page and cause it to flip).
22716     * By default a flip is not interactive. You may also need to set which
22717     * sides of the flip are "active" for flipping and how much space they use
22718     * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
22719     * and elm_flip_interacton_direction_hitsize_set()
22720     *
22721     * The four avilable mode of interaction are:
22722     * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
22723     * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
22724     * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
22725     * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
22726     *
22727     * @note ELM_FLIP_INTERACTION_ROTATE won't cause
22728     * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
22729     * happen, those can only be acheived with elm_flip_go();
22730     */
22731    EAPI void         elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
22732    /**
22733     * @brief Get the interactive flip mode
22734     *
22735     * @param obj The flip object
22736     * @return The interactive flip mode
22737     *
22738     * Returns the interactive flip mode set by elm_flip_interaction_set()
22739     */
22740    EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
22741    /**
22742     * @brief Set which directions of the flip respond to interactive flip
22743     *
22744     * @param obj The flip object
22745     * @param dir The direction to change
22746     * @param enabled If that direction is enabled or not
22747     *
22748     * By default all directions are disabled, so you may want to enable the
22749     * desired directions for flipping if you need interactive flipping. You must
22750     * call this function once for each direction that should be enabled.
22751     *
22752     * @see elm_flip_interaction_set()
22753     */
22754    EAPI void         elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
22755    /**
22756     * @brief Get the enabled state of that flip direction
22757     *
22758     * @param obj The flip object
22759     * @param dir The direction to check
22760     * @return If that direction is enabled or not
22761     *
22762     * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
22763     *
22764     * @see elm_flip_interaction_set()
22765     */
22766    EAPI Eina_Bool    elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
22767    /**
22768     * @brief Set the amount of the flip that is sensitive to interactive flip
22769     *
22770     * @param obj The flip object
22771     * @param dir The direction to modify
22772     * @param hitsize The amount of that dimension (0.0 to 1.0) to use
22773     *
22774     * Set the amount of the flip that is sensitive to interactive flip, with 0
22775     * representing no area in the flip and 1 representing the entire flip. There
22776     * is however a consideration to be made in that the area will never be
22777     * smaller than the finger size set(as set in your Elementary configuration).
22778     *
22779     * @see elm_flip_interaction_set()
22780     */
22781    EAPI void         elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
22782    /**
22783     * @brief Get the amount of the flip that is sensitive to interactive flip
22784     *
22785     * @param obj The flip object
22786     * @param dir The direction to check
22787     * @return The size set for that direction
22788     *
22789     * Returns the amount os sensitive area set by
22790     * elm_flip_interacton_direction_hitsize_set().
22791     */
22792    EAPI double       elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
22793    /**
22794     * @}
22795     */
22796
22797    /* scrolledentry */
22798    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22799    EINA_DEPRECATED EAPI void         elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
22800    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22801    EINA_DEPRECATED EAPI void         elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
22802    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22803    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22804    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22805    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22806    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22807    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22808    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22809    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
22810    EINA_DEPRECATED EAPI void         elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
22811    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22812    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
22813    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
22814    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
22815    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
22816    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
22817    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
22818    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22819    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22820    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22821    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22822    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
22823    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
22824    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22825    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22826    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22827    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
22828    EINA_DEPRECATED EAPI int          elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22829    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
22830    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
22831    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
22832    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22833    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);
22834    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22835    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22836    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);
22837    EINA_DEPRECATED EAPI void         elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22838    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);
22839    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
22840    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22841    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22842    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
22843    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
22844    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22845    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22846    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
22847    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);
22848    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);
22849    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);
22850    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);
22851    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);
22852    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);
22853    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
22854    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
22855    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
22856    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
22857    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22858    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
22859    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
22860
22861    /**
22862     * @defgroup Conformant Conformant
22863     * @ingroup Elementary
22864     *
22865     * @image html img/widget/conformant/preview-00.png
22866     * @image latex img/widget/conformant/preview-00.eps width=\textwidth
22867     *
22868     * @image html img/conformant.png
22869     * @image latex img/conformant.eps width=\textwidth
22870     *
22871     * The aim is to provide a widget that can be used in elementary apps to
22872     * account for space taken up by the indicator, virtual keypad & softkey
22873     * windows when running the illume2 module of E17.
22874     *
22875     * So conformant content will be sized and positioned considering the
22876     * space required for such stuff, and when they popup, as a keyboard
22877     * shows when an entry is selected, conformant content won't change.
22878     *
22879     * Available styles for it:
22880     * - @c "default"
22881     *
22882     * See how to use this widget in this example:
22883     * @ref conformant_example
22884     */
22885
22886    /**
22887     * @addtogroup Conformant
22888     * @{
22889     */
22890
22891    /**
22892     * Add a new conformant widget to the given parent Elementary
22893     * (container) object.
22894     *
22895     * @param parent The parent object.
22896     * @return A new conformant widget handle or @c NULL, on errors.
22897     *
22898     * This function inserts a new conformant widget on the canvas.
22899     *
22900     * @ingroup Conformant
22901     */
22902    EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22903
22904    /**
22905     * Set the content of the conformant widget.
22906     *
22907     * @param obj The conformant object.
22908     * @param content The content to be displayed by the conformant.
22909     *
22910     * Content will be sized and positioned considering the space required
22911     * to display a virtual keyboard. So it won't fill all the conformant
22912     * size. This way is possible to be sure that content won't resize
22913     * or be re-positioned after the keyboard is displayed.
22914     *
22915     * Once the content object is set, a previously set one will be deleted.
22916     * If you want to keep that old content object, use the
22917     * elm_conformat_content_unset() function.
22918     *
22919     * @see elm_conformant_content_unset()
22920     * @see elm_conformant_content_get()
22921     *
22922     * @ingroup Conformant
22923     */
22924    EAPI void         elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22925
22926    /**
22927     * Get the content of the conformant widget.
22928     *
22929     * @param obj The conformant object.
22930     * @return The content that is being used.
22931     *
22932     * Return the content object which is set for this widget.
22933     * It won't be unparent from conformant. For that, use
22934     * elm_conformant_content_unset().
22935     *
22936     * @see elm_conformant_content_set() for more details.
22937     * @see elm_conformant_content_unset()
22938     *
22939     * @ingroup Conformant
22940     */
22941    EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22942
22943    /**
22944     * Unset the content of the conformant widget.
22945     *
22946     * @param obj The conformant object.
22947     * @return The content that was being used.
22948     *
22949     * Unparent and return the content object which was set for this widget.
22950     *
22951     * @see elm_conformant_content_set() for more details.
22952     *
22953     * @ingroup Conformant
22954     */
22955    EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22956
22957    /**
22958     * Returns the Evas_Object that represents the content area.
22959     *
22960     * @param obj The conformant object.
22961     * @return The content area of the widget.
22962     *
22963     * @ingroup Conformant
22964     */
22965    EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22966
22967    /**
22968     * @}
22969     */
22970
22971    /**
22972     * @defgroup Mapbuf Mapbuf
22973     * @ingroup Elementary
22974     *
22975     * @image html img/widget/mapbuf/preview-00.png
22976     * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
22977     *
22978     * This holds one content object and uses an Evas Map of transformation
22979     * points to be later used with this content. So the content will be
22980     * moved, resized, etc as a single image. So it will improve performance
22981     * when you have a complex interafce, with a lot of elements, and will
22982     * need to resize or move it frequently (the content object and its
22983     * children).
22984     *
22985     * See how to use this widget in this example:
22986     * @ref mapbuf_example
22987     */
22988
22989    /**
22990     * @addtogroup Mapbuf
22991     * @{
22992     */
22993
22994    /**
22995     * Add a new mapbuf widget to the given parent Elementary
22996     * (container) object.
22997     *
22998     * @param parent The parent object.
22999     * @return A new mapbuf widget handle or @c NULL, on errors.
23000     *
23001     * This function inserts a new mapbuf widget on the canvas.
23002     *
23003     * @ingroup Mapbuf
23004     */
23005    EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23006
23007    /**
23008     * Set the content of the mapbuf.
23009     *
23010     * @param obj The mapbuf object.
23011     * @param content The content that will be filled in this mapbuf object.
23012     *
23013     * Once the content object is set, a previously set one will be deleted.
23014     * If you want to keep that old content object, use the
23015     * elm_mapbuf_content_unset() function.
23016     *
23017     * To enable map, elm_mapbuf_enabled_set() should be used.
23018     *
23019     * @ingroup Mapbuf
23020     */
23021    EAPI void         elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23022
23023    /**
23024     * Get the content of the mapbuf.
23025     *
23026     * @param obj The mapbuf object.
23027     * @return The content that is being used.
23028     *
23029     * Return the content object which is set for this widget.
23030     *
23031     * @see elm_mapbuf_content_set() for details.
23032     *
23033     * @ingroup Mapbuf
23034     */
23035    EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23036
23037    /**
23038     * Unset the content of the mapbuf.
23039     *
23040     * @param obj The mapbuf object.
23041     * @return The content that was being used.
23042     *
23043     * Unparent and return the content object which was set for this widget.
23044     *
23045     * @see elm_mapbuf_content_set() for details.
23046     *
23047     * @ingroup Mapbuf
23048     */
23049    EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23050
23051    /**
23052     * Enable or disable the map.
23053     *
23054     * @param obj The mapbuf object.
23055     * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
23056     *
23057     * This enables the map that is set or disables it. On enable, the object
23058     * geometry will be saved, and the new geometry will change (position and
23059     * size) to reflect the map geometry set.
23060     *
23061     * Also, when enabled, alpha and smooth states will be used, so if the
23062     * content isn't solid, alpha should be enabled, for example, otherwise
23063     * a black retangle will fill the content.
23064     *
23065     * When disabled, the stored map will be freed and geometry prior to
23066     * enabling the map will be restored.
23067     *
23068     * It's disabled by default.
23069     *
23070     * @see elm_mapbuf_alpha_set()
23071     * @see elm_mapbuf_smooth_set()
23072     *
23073     * @ingroup Mapbuf
23074     */
23075    EAPI void         elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23076
23077    /**
23078     * Get a value whether map is enabled or not.
23079     *
23080     * @param obj The mapbuf object.
23081     * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
23082     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23083     *
23084     * @see elm_mapbuf_enabled_set() for details.
23085     *
23086     * @ingroup Mapbuf
23087     */
23088    EAPI Eina_Bool    elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23089
23090    /**
23091     * Enable or disable smooth map rendering.
23092     *
23093     * @param obj The mapbuf object.
23094     * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
23095     * to disable it.
23096     *
23097     * This sets smoothing for map rendering. If the object is a type that has
23098     * its own smoothing settings, then both the smooth settings for this object
23099     * and the map must be turned off.
23100     *
23101     * By default smooth maps are enabled.
23102     *
23103     * @ingroup Mapbuf
23104     */
23105    EAPI void         elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
23106
23107    /**
23108     * Get a value whether smooth map rendering is enabled or not.
23109     *
23110     * @param obj The mapbuf object.
23111     * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
23112     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23113     *
23114     * @see elm_mapbuf_smooth_set() for details.
23115     *
23116     * @ingroup Mapbuf
23117     */
23118    EAPI Eina_Bool    elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23119
23120    /**
23121     * Set or unset alpha flag for map rendering.
23122     *
23123     * @param obj The mapbuf object.
23124     * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
23125     * to disable it.
23126     *
23127     * This sets alpha flag for map rendering. If the object is a type that has
23128     * its own alpha settings, then this will take precedence. Only image objects
23129     * have this currently. It stops alpha blending of the map area, and is
23130     * useful if you know the object and/or all sub-objects is 100% solid.
23131     *
23132     * Alpha is enabled by default.
23133     *
23134     * @ingroup Mapbuf
23135     */
23136    EAPI void         elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
23137
23138    /**
23139     * Get a value whether alpha blending is enabled or not.
23140     *
23141     * @param obj The mapbuf object.
23142     * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
23143     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23144     *
23145     * @see elm_mapbuf_alpha_set() for details.
23146     *
23147     * @ingroup Mapbuf
23148     */
23149    EAPI Eina_Bool    elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23150
23151    /**
23152     * @}
23153     */
23154
23155    /**
23156     * @defgroup Flipselector Flip Selector
23157     *
23158     * @image html img/widget/flipselector/preview-00.png
23159     * @image latex img/widget/flipselector/preview-00.eps
23160     *
23161     * A flip selector is a widget to show a set of @b text items, one
23162     * at a time, with the same sheet switching style as the @ref Clock
23163     * "clock" widget, when one changes the current displaying sheet
23164     * (thus, the "flip" in the name).
23165     *
23166     * User clicks to flip sheets which are @b held for some time will
23167     * make the flip selector to flip continuosly and automatically for
23168     * the user. The interval between flips will keep growing in time,
23169     * so that it helps the user to reach an item which is distant from
23170     * the current selection.
23171     *
23172     * Smart callbacks one can register to:
23173     * - @c "selected" - when the widget's selected text item is changed
23174     * - @c "overflowed" - when the widget's current selection is changed
23175     *   from the first item in its list to the last
23176     * - @c "underflowed" - when the widget's current selection is changed
23177     *   from the last item in its list to the first
23178     *
23179     * Available styles for it:
23180     * - @c "default"
23181     *
23182     * Here is an example on its usage:
23183     * @li @ref flipselector_example
23184     */
23185
23186    /**
23187     * @addtogroup Flipselector
23188     * @{
23189     */
23190
23191    typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
23192
23193    /**
23194     * Add a new flip selector widget to the given parent Elementary
23195     * (container) widget
23196     *
23197     * @param parent The parent object
23198     * @return a new flip selector widget handle or @c NULL, on errors
23199     *
23200     * This function inserts a new flip selector widget on the canvas.
23201     *
23202     * @ingroup Flipselector
23203     */
23204    EAPI Evas_Object               *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23205
23206    /**
23207     * Programmatically select the next item of a flip selector widget
23208     *
23209     * @param obj The flipselector object
23210     *
23211     * @note The selection will be animated. Also, if it reaches the
23212     * end of its list of member items, it will continue with the first
23213     * one onwards.
23214     *
23215     * @ingroup Flipselector
23216     */
23217    EAPI void                       elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
23218
23219    /**
23220     * Programmatically select the previous item of a flip selector
23221     * widget
23222     *
23223     * @param obj The flipselector object
23224     *
23225     * @note The selection will be animated.  Also, if it reaches the
23226     * beginning of its list of member items, it will continue with the
23227     * last one backwards.
23228     *
23229     * @ingroup Flipselector
23230     */
23231    EAPI void                       elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
23232
23233    /**
23234     * Append a (text) item to a flip selector widget
23235     *
23236     * @param obj The flipselector object
23237     * @param label The (text) label of the new item
23238     * @param func Convenience callback function to take place when
23239     * item is selected
23240     * @param data Data passed to @p func, above
23241     * @return A handle to the item added or @c NULL, on errors
23242     *
23243     * The widget's list of labels to show will be appended with the
23244     * given value. If the user wishes so, a callback function pointer
23245     * can be passed, which will get called when this same item is
23246     * selected.
23247     *
23248     * @note The current selection @b won't be modified by appending an
23249     * element to the list.
23250     *
23251     * @note The maximum length of the text label is going to be
23252     * determined <b>by the widget's theme</b>. Strings larger than
23253     * that value are going to be @b truncated.
23254     *
23255     * @ingroup Flipselector
23256     */
23257    EAPI Elm_Flipselector_Item     *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
23258
23259    /**
23260     * Prepend a (text) item to a flip selector widget
23261     *
23262     * @param obj The flipselector object
23263     * @param label The (text) label of the new item
23264     * @param func Convenience callback function to take place when
23265     * item is selected
23266     * @param data Data passed to @p func, above
23267     * @return A handle to the item added or @c NULL, on errors
23268     *
23269     * The widget's list of labels to show will be prepended with the
23270     * given value. If the user wishes so, a callback function pointer
23271     * can be passed, which will get called when this same item is
23272     * selected.
23273     *
23274     * @note The current selection @b won't be modified by prepending
23275     * an element to the list.
23276     *
23277     * @note The maximum length of the text label is going to be
23278     * determined <b>by the widget's theme</b>. Strings larger than
23279     * that value are going to be @b truncated.
23280     *
23281     * @ingroup Flipselector
23282     */
23283    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
23284
23285    /**
23286     * Get the internal list of items in a given flip selector widget.
23287     *
23288     * @param obj The flipselector object
23289     * @return The list of items (#Elm_Flipselector_Item as data) or
23290     * @c NULL on errors.
23291     *
23292     * This list is @b not to be modified in any way and must not be
23293     * freed. Use the list members with functions like
23294     * elm_flipselector_item_label_set(),
23295     * elm_flipselector_item_label_get(),
23296     * elm_flipselector_item_del(),
23297     * elm_flipselector_item_selected_get(),
23298     * elm_flipselector_item_selected_set().
23299     *
23300     * @warning This list is only valid until @p obj object's internal
23301     * items list is changed. It should be fetched again with another
23302     * call to this function when changes happen.
23303     *
23304     * @ingroup Flipselector
23305     */
23306    EAPI const Eina_List           *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23307
23308    /**
23309     * Get the first item in the given flip selector widget's list of
23310     * items.
23311     *
23312     * @param obj The flipselector object
23313     * @return The first item or @c NULL, if it has no items (and on
23314     * errors)
23315     *
23316     * @see elm_flipselector_item_append()
23317     * @see elm_flipselector_last_item_get()
23318     *
23319     * @ingroup Flipselector
23320     */
23321    EAPI Elm_Flipselector_Item     *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23322
23323    /**
23324     * Get the last item in the given flip selector widget's list of
23325     * items.
23326     *
23327     * @param obj The flipselector object
23328     * @return The last item or @c NULL, if it has no items (and on
23329     * errors)
23330     *
23331     * @see elm_flipselector_item_prepend()
23332     * @see elm_flipselector_first_item_get()
23333     *
23334     * @ingroup Flipselector
23335     */
23336    EAPI Elm_Flipselector_Item     *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23337
23338    /**
23339     * Get the currently selected item in a flip selector widget.
23340     *
23341     * @param obj The flipselector object
23342     * @return The selected item or @c NULL, if the widget has no items
23343     * (and on erros)
23344     *
23345     * @ingroup Flipselector
23346     */
23347    EAPI Elm_Flipselector_Item     *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23348
23349    /**
23350     * Set whether a given flip selector widget's item should be the
23351     * currently selected one.
23352     *
23353     * @param item The flip selector item
23354     * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
23355     *
23356     * This sets whether @p item is or not the selected (thus, under
23357     * display) one. If @p item is different than one under display,
23358     * the latter will be unselected. If the @p item is set to be
23359     * unselected, on the other hand, the @b first item in the widget's
23360     * internal members list will be the new selected one.
23361     *
23362     * @see elm_flipselector_item_selected_get()
23363     *
23364     * @ingroup Flipselector
23365     */
23366    EAPI void                       elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
23367
23368    /**
23369     * Get whether a given flip selector widget's item is the currently
23370     * selected one.
23371     *
23372     * @param item The flip selector item
23373     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
23374     * (or on errors).
23375     *
23376     * @see elm_flipselector_item_selected_set()
23377     *
23378     * @ingroup Flipselector
23379     */
23380    EAPI Eina_Bool                  elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23381
23382    /**
23383     * Delete a given item from a flip selector widget.
23384     *
23385     * @param item The item to delete
23386     *
23387     * @ingroup Flipselector
23388     */
23389    EAPI void                       elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23390
23391    /**
23392     * Get the label of a given flip selector widget's item.
23393     *
23394     * @param item The item to get label from
23395     * @return The text label of @p item or @c NULL, on errors
23396     *
23397     * @see elm_flipselector_item_label_set()
23398     *
23399     * @ingroup Flipselector
23400     */
23401    EAPI const char                *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23402
23403    /**
23404     * Set the label of a given flip selector widget's item.
23405     *
23406     * @param item The item to set label on
23407     * @param label The text label string, in UTF-8 encoding
23408     *
23409     * @see elm_flipselector_item_label_get()
23410     *
23411     * @ingroup Flipselector
23412     */
23413    EAPI void                       elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
23414
23415    /**
23416     * Gets the item before @p item in a flip selector widget's
23417     * internal list of items.
23418     *
23419     * @param item The item to fetch previous from
23420     * @return The item before the @p item, in its parent's list. If
23421     *         there is no previous item for @p item or there's an
23422     *         error, @c NULL is returned.
23423     *
23424     * @see elm_flipselector_item_next_get()
23425     *
23426     * @ingroup Flipselector
23427     */
23428    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23429
23430    /**
23431     * Gets the item after @p item in a flip selector widget's
23432     * internal list of items.
23433     *
23434     * @param item The item to fetch next from
23435     * @return The item after the @p item, in its parent's list. If
23436     *         there is no next item for @p item or there's an
23437     *         error, @c NULL is returned.
23438     *
23439     * @see elm_flipselector_item_next_get()
23440     *
23441     * @ingroup Flipselector
23442     */
23443    EAPI Elm_Flipselector_Item     *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23444
23445    /**
23446     * Set the interval on time updates for an user mouse button hold
23447     * on a flip selector widget.
23448     *
23449     * @param obj The flip selector object
23450     * @param interval The (first) interval value in seconds
23451     *
23452     * This interval value is @b decreased while the user holds the
23453     * mouse pointer either flipping up or flipping doww a given flip
23454     * selector.
23455     *
23456     * This helps the user to get to a given item distant from the
23457     * current one easier/faster, as it will start to flip quicker and
23458     * quicker on mouse button holds.
23459     *
23460     * The calculation for the next flip interval value, starting from
23461     * the one set with this call, is the previous interval divided by
23462     * 1.05, so it decreases a little bit.
23463     *
23464     * The default starting interval value for automatic flips is
23465     * @b 0.85 seconds.
23466     *
23467     * @see elm_flipselector_interval_get()
23468     *
23469     * @ingroup Flipselector
23470     */
23471    EAPI void                       elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
23472
23473    /**
23474     * Get the interval on time updates for an user mouse button hold
23475     * on a flip selector widget.
23476     *
23477     * @param obj The flip selector object
23478     * @return The (first) interval value, in seconds, set on it
23479     *
23480     * @see elm_flipselector_interval_set() for more details
23481     *
23482     * @ingroup Flipselector
23483     */
23484    EAPI double                     elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23485    /**
23486     * @}
23487     */
23488
23489    /**
23490     * @addtogroup Calendar
23491     * @{
23492     */
23493
23494    /**
23495     * @enum _Elm_Calendar_Mark_Repeat
23496     * @typedef Elm_Calendar_Mark_Repeat
23497     *
23498     * Event periodicity, used to define if a mark should be repeated
23499     * @b beyond event's day. It's set when a mark is added.
23500     *
23501     * So, for a mark added to 13th May with periodicity set to WEEKLY,
23502     * there will be marks every week after this date. Marks will be displayed
23503     * at 13th, 20th, 27th, 3rd June ...
23504     *
23505     * Values don't work as bitmask, only one can be choosen.
23506     *
23507     * @see elm_calendar_mark_add()
23508     *
23509     * @ingroup Calendar
23510     */
23511    typedef enum _Elm_Calendar_Mark_Repeat
23512      {
23513         ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
23514         ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
23515         ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
23516         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*/
23517         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. */
23518      } Elm_Calendar_Mark_Repeat;
23519
23520    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(). */
23521
23522    /**
23523     * Add a new calendar widget to the given parent Elementary
23524     * (container) object.
23525     *
23526     * @param parent The parent object.
23527     * @return a new calendar widget handle or @c NULL, on errors.
23528     *
23529     * This function inserts a new calendar widget on the canvas.
23530     *
23531     * @ref calendar_example_01
23532     *
23533     * @ingroup Calendar
23534     */
23535    EAPI Evas_Object       *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23536
23537    /**
23538     * Get weekdays names displayed by the calendar.
23539     *
23540     * @param obj The calendar object.
23541     * @return Array of seven strings to be used as weekday names.
23542     *
23543     * By default, weekdays abbreviations get from system are displayed:
23544     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
23545     * The first string is related to Sunday, the second to Monday...
23546     *
23547     * @see elm_calendar_weekdays_name_set()
23548     *
23549     * @ref calendar_example_05
23550     *
23551     * @ingroup Calendar
23552     */
23553    EAPI const char       **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23554
23555    /**
23556     * Set weekdays names to be displayed by the calendar.
23557     *
23558     * @param obj The calendar object.
23559     * @param weekdays Array of seven strings to be used as weekday names.
23560     * @warning It must have 7 elements, or it will access invalid memory.
23561     * @warning The strings must be NULL terminated ('@\0').
23562     *
23563     * By default, weekdays abbreviations get from system are displayed:
23564     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
23565     *
23566     * The first string should be related to Sunday, the second to Monday...
23567     *
23568     * The usage should be like this:
23569     * @code
23570     *   const char *weekdays[] =
23571     *   {
23572     *      "Sunday", "Monday", "Tuesday", "Wednesday",
23573     *      "Thursday", "Friday", "Saturday"
23574     *   };
23575     *   elm_calendar_weekdays_names_set(calendar, weekdays);
23576     * @endcode
23577     *
23578     * @see elm_calendar_weekdays_name_get()
23579     *
23580     * @ref calendar_example_02
23581     *
23582     * @ingroup Calendar
23583     */
23584    EAPI void               elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
23585
23586    /**
23587     * Set the minimum and maximum values for the year
23588     *
23589     * @param obj The calendar object
23590     * @param min The minimum year, greater than 1901;
23591     * @param max The maximum year;
23592     *
23593     * Maximum must be greater than minimum, except if you don't wan't to set
23594     * maximum year.
23595     * Default values are 1902 and -1.
23596     *
23597     * If the maximum year is a negative value, it will be limited depending
23598     * on the platform architecture (year 2037 for 32 bits);
23599     *
23600     * @see elm_calendar_min_max_year_get()
23601     *
23602     * @ref calendar_example_03
23603     *
23604     * @ingroup Calendar
23605     */
23606    EAPI void               elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
23607
23608    /**
23609     * Get the minimum and maximum values for the year
23610     *
23611     * @param obj The calendar object.
23612     * @param min The minimum year.
23613     * @param max The maximum year.
23614     *
23615     * Default values are 1902 and -1.
23616     *
23617     * @see elm_calendar_min_max_year_get() for more details.
23618     *
23619     * @ref calendar_example_05
23620     *
23621     * @ingroup Calendar
23622     */
23623    EAPI void               elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
23624
23625    /**
23626     * Enable or disable day selection
23627     *
23628     * @param obj The calendar object.
23629     * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
23630     * disable it.
23631     *
23632     * Enabled by default. If disabled, the user still can select months,
23633     * but not days. Selected days are highlighted on calendar.
23634     * It should be used if you won't need such selection for the widget usage.
23635     *
23636     * When a day is selected, or month is changed, smart callbacks for
23637     * signal "changed" will be called.
23638     *
23639     * @see elm_calendar_day_selection_enable_get()
23640     *
23641     * @ref calendar_example_04
23642     *
23643     * @ingroup Calendar
23644     */
23645    EAPI void               elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23646
23647    /**
23648     * Get a value whether day selection is enabled or not.
23649     *
23650     * @see elm_calendar_day_selection_enable_set() for details.
23651     *
23652     * @param obj The calendar object.
23653     * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
23654     * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
23655     *
23656     * @ref calendar_example_05
23657     *
23658     * @ingroup Calendar
23659     */
23660    EAPI Eina_Bool          elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23661
23662
23663    /**
23664     * Set selected date to be highlighted on calendar.
23665     *
23666     * @param obj The calendar object.
23667     * @param selected_time A @b tm struct to represent the selected date.
23668     *
23669     * Set the selected date, changing the displayed month if needed.
23670     * Selected date changes when the user goes to next/previous month or
23671     * select a day pressing over it on calendar.
23672     *
23673     * @see elm_calendar_selected_time_get()
23674     *
23675     * @ref calendar_example_04
23676     *
23677     * @ingroup Calendar
23678     */
23679    EAPI void               elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
23680
23681    /**
23682     * Get selected date.
23683     *
23684     * @param obj The calendar object
23685     * @param selected_time A @b tm struct to point to selected date
23686     * @return EINA_FALSE means an error ocurred and returned time shouldn't
23687     * be considered.
23688     *
23689     * Get date selected by the user or set by function
23690     * elm_calendar_selected_time_set().
23691     * Selected date changes when the user goes to next/previous month or
23692     * select a day pressing over it on calendar.
23693     *
23694     * @see elm_calendar_selected_time_get()
23695     *
23696     * @ref calendar_example_05
23697     *
23698     * @ingroup Calendar
23699     */
23700    EAPI Eina_Bool          elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
23701
23702    /**
23703     * Set a function to format the string that will be used to display
23704     * month and year;
23705     *
23706     * @param obj The calendar object
23707     * @param format_function Function to set the month-year string given
23708     * the selected date
23709     *
23710     * By default it uses strftime with "%B %Y" format string.
23711     * It should allocate the memory that will be used by the string,
23712     * that will be freed by the widget after usage.
23713     * A pointer to the string and a pointer to the time struct will be provided.
23714     *
23715     * Example:
23716     * @code
23717     * static char *
23718     * _format_month_year(struct tm *selected_time)
23719     * {
23720     *    char buf[32];
23721     *    if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
23722     *    return strdup(buf);
23723     * }
23724     *
23725     * elm_calendar_format_function_set(calendar, _format_month_year);
23726     * @endcode
23727     *
23728     * @ref calendar_example_02
23729     *
23730     * @ingroup Calendar
23731     */
23732    EAPI void               elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
23733
23734    /**
23735     * Add a new mark to the calendar
23736     *
23737     * @param obj The calendar object
23738     * @param mark_type A string used to define the type of mark. It will be
23739     * emitted to the theme, that should display a related modification on these
23740     * days representation.
23741     * @param mark_time A time struct to represent the date of inclusion of the
23742     * mark. For marks that repeats it will just be displayed after the inclusion
23743     * date in the calendar.
23744     * @param repeat Repeat the event following this periodicity. Can be a unique
23745     * mark (that don't repeat), daily, weekly, monthly or annually.
23746     * @return The created mark or @p NULL upon failure.
23747     *
23748     * Add a mark that will be drawn in the calendar respecting the insertion
23749     * time and periodicity. It will emit the type as signal to the widget theme.
23750     * Default theme supports "holiday" and "checked", but it can be extended.
23751     *
23752     * It won't immediately update the calendar, drawing the marks.
23753     * For this, call elm_calendar_marks_draw(). However, when user selects
23754     * next or previous month calendar forces marks drawn.
23755     *
23756     * Marks created with this method can be deleted with
23757     * elm_calendar_mark_del().
23758     *
23759     * Example
23760     * @code
23761     * struct tm selected_time;
23762     * time_t current_time;
23763     *
23764     * current_time = time(NULL) + 5 * 84600;
23765     * localtime_r(&current_time, &selected_time);
23766     * elm_calendar_mark_add(cal, "holiday", selected_time,
23767     *     ELM_CALENDAR_ANNUALLY);
23768     *
23769     * current_time = time(NULL) + 1 * 84600;
23770     * localtime_r(&current_time, &selected_time);
23771     * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
23772     *
23773     * elm_calendar_marks_draw(cal);
23774     * @endcode
23775     *
23776     * @see elm_calendar_marks_draw()
23777     * @see elm_calendar_mark_del()
23778     *
23779     * @ref calendar_example_06
23780     *
23781     * @ingroup Calendar
23782     */
23783    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);
23784
23785    /**
23786     * Delete mark from the calendar.
23787     *
23788     * @param mark The mark to be deleted.
23789     *
23790     * If deleting all calendar marks is required, elm_calendar_marks_clear()
23791     * should be used instead of getting marks list and deleting each one.
23792     *
23793     * @see elm_calendar_mark_add()
23794     *
23795     * @ref calendar_example_06
23796     *
23797     * @ingroup Calendar
23798     */
23799    EAPI void               elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
23800
23801    /**
23802     * Remove all calendar's marks
23803     *
23804     * @param obj The calendar object.
23805     *
23806     * @see elm_calendar_mark_add()
23807     * @see elm_calendar_mark_del()
23808     *
23809     * @ingroup Calendar
23810     */
23811    EAPI void               elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
23812
23813
23814    /**
23815     * Get a list of all the calendar marks.
23816     *
23817     * @param obj The calendar object.
23818     * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
23819     *
23820     * @see elm_calendar_mark_add()
23821     * @see elm_calendar_mark_del()
23822     * @see elm_calendar_marks_clear()
23823     *
23824     * @ingroup Calendar
23825     */
23826    EAPI const Eina_List   *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23827
23828    /**
23829     * Draw calendar marks.
23830     *
23831     * @param obj The calendar object.
23832     *
23833     * Should be used after adding, removing or clearing marks.
23834     * It will go through the entire marks list updating the calendar.
23835     * If lots of marks will be added, add all the marks and then call
23836     * this function.
23837     *
23838     * When the month is changed, i.e. user selects next or previous month,
23839     * marks will be drawed.
23840     *
23841     * @see elm_calendar_mark_add()
23842     * @see elm_calendar_mark_del()
23843     * @see elm_calendar_marks_clear()
23844     *
23845     * @ref calendar_example_06
23846     *
23847     * @ingroup Calendar
23848     */
23849    EAPI void               elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
23850
23851    /**
23852     * Set a day text color to the same that represents Saturdays.
23853     *
23854     * @param obj The calendar object.
23855     * @param pos The text position. Position is the cell counter, from left
23856     * to right, up to down. It starts on 0 and ends on 41.
23857     *
23858     * @deprecated use elm_calendar_mark_add() instead like:
23859     *
23860     * @code
23861     * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
23862     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
23863     * @endcode
23864     *
23865     * @see elm_calendar_mark_add()
23866     *
23867     * @ingroup Calendar
23868     */
23869    EINA_DEPRECATED EAPI void               elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23870
23871    /**
23872     * Set a day text color to the same that represents Sundays.
23873     *
23874     * @param obj The calendar object.
23875     * @param pos The text position. Position is the cell counter, from left
23876     * to right, up to down. It starts on 0 and ends on 41.
23877
23878     * @deprecated use elm_calendar_mark_add() instead like:
23879     *
23880     * @code
23881     * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
23882     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
23883     * @endcode
23884     *
23885     * @see elm_calendar_mark_add()
23886     *
23887     * @ingroup Calendar
23888     */
23889    EINA_DEPRECATED EAPI void               elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23890
23891    /**
23892     * Set a day text color to the same that represents Weekdays.
23893     *
23894     * @param obj The calendar object
23895     * @param pos The text position. Position is the cell counter, from left
23896     * to right, up to down. It starts on 0 and ends on 41.
23897     *
23898     * @deprecated use elm_calendar_mark_add() instead like:
23899     *
23900     * @code
23901     * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
23902     *
23903     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
23904     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23905     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
23906     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23907     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
23908     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23909     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
23910     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23911     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
23912     * @endcode
23913     *
23914     * @see elm_calendar_mark_add()
23915     *
23916     * @ingroup Calendar
23917     */
23918    EINA_DEPRECATED EAPI void               elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23919
23920    /**
23921     * Set the interval on time updates for an user mouse button hold
23922     * on calendar widgets' month selection.
23923     *
23924     * @param obj The calendar object
23925     * @param interval The (first) interval value in seconds
23926     *
23927     * This interval value is @b decreased while the user holds the
23928     * mouse pointer either selecting next or previous month.
23929     *
23930     * This helps the user to get to a given month distant from the
23931     * current one easier/faster, as it will start to change quicker and
23932     * quicker on mouse button holds.
23933     *
23934     * The calculation for the next change interval value, starting from
23935     * the one set with this call, is the previous interval divided by
23936     * 1.05, so it decreases a little bit.
23937     *
23938     * The default starting interval value for automatic changes is
23939     * @b 0.85 seconds.
23940     *
23941     * @see elm_calendar_interval_get()
23942     *
23943     * @ingroup Calendar
23944     */
23945    EAPI void               elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
23946
23947    /**
23948     * Get the interval on time updates for an user mouse button hold
23949     * on calendar widgets' month selection.
23950     *
23951     * @param obj The calendar object
23952     * @return The (first) interval value, in seconds, set on it
23953     *
23954     * @see elm_calendar_interval_set() for more details
23955     *
23956     * @ingroup Calendar
23957     */
23958    EAPI double             elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23959
23960    /**
23961     * @}
23962     */
23963
23964    /**
23965     * @defgroup Diskselector Diskselector
23966     * @ingroup Elementary
23967     *
23968     * @image html img/widget/diskselector/preview-00.png
23969     * @image latex img/widget/diskselector/preview-00.eps
23970     *
23971     * A diskselector is a kind of list widget. It scrolls horizontally,
23972     * and can contain label and icon objects. Three items are displayed
23973     * with the selected one in the middle.
23974     *
23975     * It can act like a circular list with round mode and labels can be
23976     * reduced for a defined length for side items.
23977     *
23978     * Smart callbacks one can listen to:
23979     * - "selected" - when item is selected, i.e. scroller stops.
23980     *
23981     * Available styles for it:
23982     * - @c "default"
23983     *
23984     * List of examples:
23985     * @li @ref diskselector_example_01
23986     * @li @ref diskselector_example_02
23987     */
23988
23989    /**
23990     * @addtogroup Diskselector
23991     * @{
23992     */
23993
23994    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(). */
23995
23996    /**
23997     * Add a new diskselector widget to the given parent Elementary
23998     * (container) object.
23999     *
24000     * @param parent The parent object.
24001     * @return a new diskselector widget handle or @c NULL, on errors.
24002     *
24003     * This function inserts a new diskselector widget on the canvas.
24004     *
24005     * @ingroup Diskselector
24006     */
24007    EAPI Evas_Object           *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24008
24009    /**
24010     * Enable or disable round mode.
24011     *
24012     * @param obj The diskselector object.
24013     * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
24014     * disable it.
24015     *
24016     * Disabled by default. If round mode is enabled the items list will
24017     * work like a circle list, so when the user reaches the last item,
24018     * the first one will popup.
24019     *
24020     * @see elm_diskselector_round_get()
24021     *
24022     * @ingroup Diskselector
24023     */
24024    EAPI void                   elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
24025
24026    /**
24027     * Get a value whether round mode is enabled or not.
24028     *
24029     * @see elm_diskselector_round_set() for details.
24030     *
24031     * @param obj The diskselector object.
24032     * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
24033     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24034     *
24035     * @ingroup Diskselector
24036     */
24037    EAPI Eina_Bool              elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24038
24039    /**
24040     * Get the side labels max length.
24041     *
24042     * @deprecated use elm_diskselector_side_label_length_get() instead:
24043     *
24044     * @param obj The diskselector object.
24045     * @return The max length defined for side labels, or 0 if not a valid
24046     * diskselector.
24047     *
24048     * @ingroup Diskselector
24049     */
24050    EINA_DEPRECATED EAPI int    elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24051
24052    /**
24053     * Set the side labels max length.
24054     *
24055     * @deprecated use elm_diskselector_side_label_length_set() instead:
24056     *
24057     * @param obj The diskselector object.
24058     * @param len The max length defined for side labels.
24059     *
24060     * @ingroup Diskselector
24061     */
24062    EINA_DEPRECATED EAPI void   elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
24063
24064    /**
24065     * Get the side labels max length.
24066     *
24067     * @see elm_diskselector_side_label_length_set() for details.
24068     *
24069     * @param obj The diskselector object.
24070     * @return The max length defined for side labels, or 0 if not a valid
24071     * diskselector.
24072     *
24073     * @ingroup Diskselector
24074     */
24075    EAPI int                    elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24076
24077    /**
24078     * Set the side labels max length.
24079     *
24080     * @param obj The diskselector object.
24081     * @param len The max length defined for side labels.
24082     *
24083     * Length is the number of characters of items' label that will be
24084     * visible when it's set on side positions. It will just crop
24085     * the string after defined size. E.g.:
24086     *
24087     * An item with label "January" would be displayed on side position as
24088     * "Jan" if max length is set to 3, or "Janu", if this property
24089     * is set to 4.
24090     *
24091     * When it's selected, the entire label will be displayed, except for
24092     * width restrictions. In this case label will be cropped and "..."
24093     * will be concatenated.
24094     *
24095     * Default side label max length is 3.
24096     *
24097     * This property will be applyed over all items, included before or
24098     * later this function call.
24099     *
24100     * @ingroup Diskselector
24101     */
24102    EAPI void                   elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
24103
24104    /**
24105     * Set the number of items to be displayed.
24106     *
24107     * @param obj The diskselector object.
24108     * @param num The number of items the diskselector will display.
24109     *
24110     * Default value is 3, and also it's the minimun. If @p num is less
24111     * than 3, it will be set to 3.
24112     *
24113     * Also, it can be set on theme, using data item @c display_item_num
24114     * on group "elm/diskselector/item/X", where X is style set.
24115     * E.g.:
24116     *
24117     * group { name: "elm/diskselector/item/X";
24118     * data {
24119     *     item: "display_item_num" "5";
24120     *     }
24121     *
24122     * @ingroup Diskselector
24123     */
24124    EAPI void                   elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
24125
24126    /**
24127     * Set bouncing behaviour when the scrolled content reaches an edge.
24128     *
24129     * Tell the internal scroller object whether it should bounce or not
24130     * when it reaches the respective edges for each axis.
24131     *
24132     * @param obj The diskselector object.
24133     * @param h_bounce Whether to bounce or not in the horizontal axis.
24134     * @param v_bounce Whether to bounce or not in the vertical axis.
24135     *
24136     * @see elm_scroller_bounce_set()
24137     *
24138     * @ingroup Diskselector
24139     */
24140    EAPI void                   elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24141
24142    /**
24143     * Get the bouncing behaviour of the internal scroller.
24144     *
24145     * Get whether the internal scroller should bounce when the edge of each
24146     * axis is reached scrolling.
24147     *
24148     * @param obj The diskselector object.
24149     * @param h_bounce Pointer where to store the bounce state of the horizontal
24150     * axis.
24151     * @param v_bounce Pointer where to store the bounce state of the vertical
24152     * axis.
24153     *
24154     * @see elm_scroller_bounce_get()
24155     * @see elm_diskselector_bounce_set()
24156     *
24157     * @ingroup Diskselector
24158     */
24159    EAPI void                   elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
24160
24161    /**
24162     * Get the scrollbar policy.
24163     *
24164     * @see elm_diskselector_scroller_policy_get() for details.
24165     *
24166     * @param obj The diskselector object.
24167     * @param policy_h Pointer where to store horizontal scrollbar policy.
24168     * @param policy_v Pointer where to store vertical scrollbar policy.
24169     *
24170     * @ingroup Diskselector
24171     */
24172    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);
24173
24174    /**
24175     * Set the scrollbar policy.
24176     *
24177     * @param obj The diskselector object.
24178     * @param policy_h Horizontal scrollbar policy.
24179     * @param policy_v Vertical scrollbar policy.
24180     *
24181     * This sets the scrollbar visibility policy for the given scroller.
24182     * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
24183     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
24184     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
24185     * This applies respectively for the horizontal and vertical scrollbars.
24186     *
24187     * The both are disabled by default, i.e., are set to
24188     * #ELM_SCROLLER_POLICY_OFF.
24189     *
24190     * @ingroup Diskselector
24191     */
24192    EAPI void                   elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
24193
24194    /**
24195     * Remove all diskselector's items.
24196     *
24197     * @param obj The diskselector object.
24198     *
24199     * @see elm_diskselector_item_del()
24200     * @see elm_diskselector_item_append()
24201     *
24202     * @ingroup Diskselector
24203     */
24204    EAPI void                   elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24205
24206    /**
24207     * Get a list of all the diskselector items.
24208     *
24209     * @param obj The diskselector object.
24210     * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
24211     * or @c NULL on failure.
24212     *
24213     * @see elm_diskselector_item_append()
24214     * @see elm_diskselector_item_del()
24215     * @see elm_diskselector_clear()
24216     *
24217     * @ingroup Diskselector
24218     */
24219    EAPI const Eina_List       *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24220
24221    /**
24222     * Appends a new item to the diskselector object.
24223     *
24224     * @param obj The diskselector object.
24225     * @param label The label of the diskselector item.
24226     * @param icon The icon object to use at left side of the item. An
24227     * icon can be any Evas object, but usually it is an icon created
24228     * with elm_icon_add().
24229     * @param func The function to call when the item is selected.
24230     * @param data The data to associate with the item for related callbacks.
24231     *
24232     * @return The created item or @c NULL upon failure.
24233     *
24234     * A new item will be created and appended to the diskselector, i.e., will
24235     * be set as last item. Also, if there is no selected item, it will
24236     * be selected. This will always happens for the first appended item.
24237     *
24238     * If no icon is set, label will be centered on item position, otherwise
24239     * the icon will be placed at left of the label, that will be shifted
24240     * to the right.
24241     *
24242     * Items created with this method can be deleted with
24243     * elm_diskselector_item_del().
24244     *
24245     * Associated @p data can be properly freed when item is deleted if a
24246     * callback function is set with elm_diskselector_item_del_cb_set().
24247     *
24248     * If a function is passed as argument, it will be called everytime this item
24249     * is selected, i.e., the user stops the diskselector with this
24250     * item on center position. If such function isn't needed, just passing
24251     * @c NULL as @p func is enough. The same should be done for @p data.
24252     *
24253     * Simple example (with no function callback or data associated):
24254     * @code
24255     * disk = elm_diskselector_add(win);
24256     * ic = elm_icon_add(win);
24257     * elm_icon_file_set(ic, "path/to/image", NULL);
24258     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
24259     * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
24260     * @endcode
24261     *
24262     * @see elm_diskselector_item_del()
24263     * @see elm_diskselector_item_del_cb_set()
24264     * @see elm_diskselector_clear()
24265     * @see elm_icon_add()
24266     *
24267     * @ingroup Diskselector
24268     */
24269    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);
24270
24271
24272    /**
24273     * Delete them item from the diskselector.
24274     *
24275     * @param it The item of diskselector to be deleted.
24276     *
24277     * If deleting all diskselector items is required, elm_diskselector_clear()
24278     * should be used instead of getting items list and deleting each one.
24279     *
24280     * @see elm_diskselector_clear()
24281     * @see elm_diskselector_item_append()
24282     * @see elm_diskselector_item_del_cb_set()
24283     *
24284     * @ingroup Diskselector
24285     */
24286    EAPI void                   elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24287
24288    /**
24289     * Set the function called when a diskselector item is freed.
24290     *
24291     * @param it The item to set the callback on
24292     * @param func The function called
24293     *
24294     * If there is a @p func, then it will be called prior item's memory release.
24295     * That will be called with the following arguments:
24296     * @li item's data;
24297     * @li item's Evas object;
24298     * @li item itself;
24299     *
24300     * This way, a data associated to a diskselector item could be properly
24301     * freed.
24302     *
24303     * @ingroup Diskselector
24304     */
24305    EAPI void                   elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
24306
24307    /**
24308     * Get the data associated to the item.
24309     *
24310     * @param it The diskselector item
24311     * @return The data associated to @p it
24312     *
24313     * The return value is a pointer to data associated to @p item when it was
24314     * created, with function elm_diskselector_item_append(). If no data
24315     * was passed as argument, it will return @c NULL.
24316     *
24317     * @see elm_diskselector_item_append()
24318     *
24319     * @ingroup Diskselector
24320     */
24321    EAPI void                  *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24322
24323    /**
24324     * Set the icon associated to the item.
24325     *
24326     * @param it The diskselector item
24327     * @param icon The icon object to associate with @p it
24328     *
24329     * The icon object to use at left side of the item. An
24330     * icon can be any Evas object, but usually it is an icon created
24331     * with elm_icon_add().
24332     *
24333     * Once the icon object is set, a previously set one will be deleted.
24334     * @warning Setting the same icon for two items will cause the icon to
24335     * dissapear from the first item.
24336     *
24337     * If an icon was passed as argument on item creation, with function
24338     * elm_diskselector_item_append(), it will be already
24339     * associated to the item.
24340     *
24341     * @see elm_diskselector_item_append()
24342     * @see elm_diskselector_item_icon_get()
24343     *
24344     * @ingroup Diskselector
24345     */
24346    EAPI void                   elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
24347
24348    /**
24349     * Get the icon associated to the item.
24350     *
24351     * @param it The diskselector item
24352     * @return The icon associated to @p it
24353     *
24354     * The return value is a pointer to the icon associated to @p item when it was
24355     * created, with function elm_diskselector_item_append(), or later
24356     * with function elm_diskselector_item_icon_set. If no icon
24357     * was passed as argument, it will return @c NULL.
24358     *
24359     * @see elm_diskselector_item_append()
24360     * @see elm_diskselector_item_icon_set()
24361     *
24362     * @ingroup Diskselector
24363     */
24364    EAPI Evas_Object           *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24365
24366    /**
24367     * Set the label of item.
24368     *
24369     * @param it The item of diskselector.
24370     * @param label The label of item.
24371     *
24372     * The label to be displayed by the item.
24373     *
24374     * If no icon is set, label will be centered on item position, otherwise
24375     * the icon will be placed at left of the label, that will be shifted
24376     * to the right.
24377     *
24378     * An item with label "January" would be displayed on side position as
24379     * "Jan" if max length is set to 3 with function
24380     * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
24381     * is set to 4.
24382     *
24383     * When this @p item is selected, the entire label will be displayed,
24384     * except for width restrictions.
24385     * In this case label will be cropped and "..." will be concatenated,
24386     * but only for display purposes. It will keep the entire string, so
24387     * if diskselector is resized the remaining characters will be displayed.
24388     *
24389     * If a label was passed as argument on item creation, with function
24390     * elm_diskselector_item_append(), it will be already
24391     * displayed by the item.
24392     *
24393     * @see elm_diskselector_side_label_lenght_set()
24394     * @see elm_diskselector_item_label_get()
24395     * @see elm_diskselector_item_append()
24396     *
24397     * @ingroup Diskselector
24398     */
24399    EAPI void                   elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
24400
24401    /**
24402     * Get the label of item.
24403     *
24404     * @param it The item of diskselector.
24405     * @return The label of item.
24406     *
24407     * The return value is a pointer to the label associated to @p item when it was
24408     * created, with function elm_diskselector_item_append(), or later
24409     * with function elm_diskselector_item_label_set. If no label
24410     * was passed as argument, it will return @c NULL.
24411     *
24412     * @see elm_diskselector_item_label_set() for more details.
24413     * @see elm_diskselector_item_append()
24414     *
24415     * @ingroup Diskselector
24416     */
24417    EAPI const char            *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24418
24419    /**
24420     * Get the selected item.
24421     *
24422     * @param obj The diskselector object.
24423     * @return The selected diskselector item.
24424     *
24425     * The selected item can be unselected with function
24426     * elm_diskselector_item_selected_set(), and the first item of
24427     * diskselector will be selected.
24428     *
24429     * The selected item always will be centered on diskselector, with
24430     * full label displayed, i.e., max lenght set to side labels won't
24431     * apply on the selected item. More details on
24432     * elm_diskselector_side_label_length_set().
24433     *
24434     * @ingroup Diskselector
24435     */
24436    EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24437
24438    /**
24439     * Set the selected state of an item.
24440     *
24441     * @param it The diskselector item
24442     * @param selected The selected state
24443     *
24444     * This sets the selected state of the given item @p it.
24445     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
24446     *
24447     * If a new item is selected the previosly selected will be unselected.
24448     * Previoulsy selected item can be get with function
24449     * elm_diskselector_selected_item_get().
24450     *
24451     * If the item @p it is unselected, the first item of diskselector will
24452     * be selected.
24453     *
24454     * Selected items will be visible on center position of diskselector.
24455     * So if it was on another position before selected, or was invisible,
24456     * diskselector will animate items until the selected item reaches center
24457     * position.
24458     *
24459     * @see elm_diskselector_item_selected_get()
24460     * @see elm_diskselector_selected_item_get()
24461     *
24462     * @ingroup Diskselector
24463     */
24464    EAPI void                   elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
24465
24466    /*
24467     * Get whether the @p item is selected or not.
24468     *
24469     * @param it The diskselector item.
24470     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
24471     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
24472     *
24473     * @see elm_diskselector_selected_item_set() for details.
24474     * @see elm_diskselector_item_selected_get()
24475     *
24476     * @ingroup Diskselector
24477     */
24478    EAPI Eina_Bool              elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24479
24480    /**
24481     * Get the first item of the diskselector.
24482     *
24483     * @param obj The diskselector object.
24484     * @return The first item, or @c NULL if none.
24485     *
24486     * The list of items follows append order. So it will return the first
24487     * item appended to the widget that wasn't deleted.
24488     *
24489     * @see elm_diskselector_item_append()
24490     * @see elm_diskselector_items_get()
24491     *
24492     * @ingroup Diskselector
24493     */
24494    EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24495
24496    /**
24497     * Get the last item of the diskselector.
24498     *
24499     * @param obj The diskselector object.
24500     * @return The last item, or @c NULL if none.
24501     *
24502     * The list of items follows append order. So it will return last first
24503     * item appended to the widget that wasn't deleted.
24504     *
24505     * @see elm_diskselector_item_append()
24506     * @see elm_diskselector_items_get()
24507     *
24508     * @ingroup Diskselector
24509     */
24510    EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24511
24512    /**
24513     * Get the item before @p item in diskselector.
24514     *
24515     * @param it The diskselector item.
24516     * @return The item before @p item, or @c NULL if none or on failure.
24517     *
24518     * The list of items follows append order. So it will return item appended
24519     * just before @p item and that wasn't deleted.
24520     *
24521     * If it is the first item, @c NULL will be returned.
24522     * First item can be get by elm_diskselector_first_item_get().
24523     *
24524     * @see elm_diskselector_item_append()
24525     * @see elm_diskselector_items_get()
24526     *
24527     * @ingroup Diskselector
24528     */
24529    EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24530
24531    /**
24532     * Get the item after @p item in diskselector.
24533     *
24534     * @param it The diskselector item.
24535     * @return The item after @p item, or @c NULL if none or on failure.
24536     *
24537     * The list of items follows append order. So it will return item appended
24538     * just after @p item and that wasn't deleted.
24539     *
24540     * If it is the last item, @c NULL will be returned.
24541     * Last item can be get by elm_diskselector_last_item_get().
24542     *
24543     * @see elm_diskselector_item_append()
24544     * @see elm_diskselector_items_get()
24545     *
24546     * @ingroup Diskselector
24547     */
24548    EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24549
24550    /**
24551     * Set the text to be shown in the diskselector item.
24552     *
24553     * @param item Target item
24554     * @param text The text to set in the content
24555     *
24556     * Setup the text as tooltip to object. The item can have only one tooltip,
24557     * so any previous tooltip data is removed.
24558     *
24559     * @see elm_object_tooltip_text_set() for more details.
24560     *
24561     * @ingroup Diskselector
24562     */
24563    EAPI void                   elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
24564
24565    /**
24566     * Set the content to be shown in the tooltip item.
24567     *
24568     * Setup the tooltip to item. The item can have only one tooltip,
24569     * so any previous tooltip data is removed. @p func(with @p data) will
24570     * be called every time that need show the tooltip and it should
24571     * return a valid Evas_Object. This object is then managed fully by
24572     * tooltip system and is deleted when the tooltip is gone.
24573     *
24574     * @param item the diskselector item being attached a tooltip.
24575     * @param func the function used to create the tooltip contents.
24576     * @param data what to provide to @a func as callback data/context.
24577     * @param del_cb called when data is not needed anymore, either when
24578     *        another callback replaces @p func, the tooltip is unset with
24579     *        elm_diskselector_item_tooltip_unset() or the owner @a item
24580     *        dies. This callback receives as the first parameter the
24581     *        given @a data, and @c event_info is the item.
24582     *
24583     * @see elm_object_tooltip_content_cb_set() for more details.
24584     *
24585     * @ingroup Diskselector
24586     */
24587    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);
24588
24589    /**
24590     * Unset tooltip from item.
24591     *
24592     * @param item diskselector item to remove previously set tooltip.
24593     *
24594     * Remove tooltip from item. The callback provided as del_cb to
24595     * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
24596     * it is not used anymore.
24597     *
24598     * @see elm_object_tooltip_unset() for more details.
24599     * @see elm_diskselector_item_tooltip_content_cb_set()
24600     *
24601     * @ingroup Diskselector
24602     */
24603    EAPI void                   elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24604
24605
24606    /**
24607     * Sets a different style for this item tooltip.
24608     *
24609     * @note before you set a style you should define a tooltip with
24610     *       elm_diskselector_item_tooltip_content_cb_set() or
24611     *       elm_diskselector_item_tooltip_text_set()
24612     *
24613     * @param item diskselector item with tooltip already set.
24614     * @param style the theme style to use (default, transparent, ...)
24615     *
24616     * @see elm_object_tooltip_style_set() for more details.
24617     *
24618     * @ingroup Diskselector
24619     */
24620    EAPI void                   elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
24621
24622    /**
24623     * Get the style for this item tooltip.
24624     *
24625     * @param item diskselector item with tooltip already set.
24626     * @return style the theme style in use, defaults to "default". If the
24627     *         object does not have a tooltip set, then NULL is returned.
24628     *
24629     * @see elm_object_tooltip_style_get() for more details.
24630     * @see elm_diskselector_item_tooltip_style_set()
24631     *
24632     * @ingroup Diskselector
24633     */
24634    EAPI const char            *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24635
24636    /**
24637     * Set the cursor to be shown when mouse is over the diskselector item
24638     *
24639     * @param item Target item
24640     * @param cursor the cursor name to be used.
24641     *
24642     * @see elm_object_cursor_set() for more details.
24643     *
24644     * @ingroup Diskselector
24645     */
24646    EAPI void                   elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
24647
24648    /**
24649     * Get the cursor to be shown when mouse is over the diskselector item
24650     *
24651     * @param item diskselector item with cursor already set.
24652     * @return the cursor name.
24653     *
24654     * @see elm_object_cursor_get() for more details.
24655     * @see elm_diskselector_cursor_set()
24656     *
24657     * @ingroup Diskselector
24658     */
24659    EAPI const char            *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24660
24661
24662    /**
24663     * Unset the cursor to be shown when mouse is over the diskselector item
24664     *
24665     * @param item Target item
24666     *
24667     * @see elm_object_cursor_unset() for more details.
24668     * @see elm_diskselector_cursor_set()
24669     *
24670     * @ingroup Diskselector
24671     */
24672    EAPI void                   elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24673
24674    /**
24675     * Sets a different style for this item cursor.
24676     *
24677     * @note before you set a style you should define a cursor with
24678     *       elm_diskselector_item_cursor_set()
24679     *
24680     * @param item diskselector item with cursor already set.
24681     * @param style the theme style to use (default, transparent, ...)
24682     *
24683     * @see elm_object_cursor_style_set() for more details.
24684     *
24685     * @ingroup Diskselector
24686     */
24687    EAPI void                   elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
24688
24689
24690    /**
24691     * Get the style for this item cursor.
24692     *
24693     * @param item diskselector item with cursor already set.
24694     * @return style the theme style in use, defaults to "default". If the
24695     *         object does not have a cursor set, then @c NULL is returned.
24696     *
24697     * @see elm_object_cursor_style_get() for more details.
24698     * @see elm_diskselector_item_cursor_style_set()
24699     *
24700     * @ingroup Diskselector
24701     */
24702    EAPI const char            *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24703
24704
24705    /**
24706     * Set if the cursor set should be searched on the theme or should use
24707     * the provided by the engine, only.
24708     *
24709     * @note before you set if should look on theme you should define a cursor
24710     * with elm_diskselector_item_cursor_set().
24711     * By default it will only look for cursors provided by the engine.
24712     *
24713     * @param item widget item with cursor already set.
24714     * @param engine_only boolean to define if cursors set with
24715     * elm_diskselector_item_cursor_set() should be searched only
24716     * between cursors provided by the engine or searched on widget's
24717     * theme as well.
24718     *
24719     * @see elm_object_cursor_engine_only_set() for more details.
24720     *
24721     * @ingroup Diskselector
24722     */
24723    EAPI void                   elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
24724
24725    /**
24726     * Get the cursor engine only usage for this item cursor.
24727     *
24728     * @param item widget item with cursor already set.
24729     * @return engine_only boolean to define it cursors should be looked only
24730     * between the provided by the engine or searched on widget's theme as well.
24731     * If the item does not have a cursor set, then @c EINA_FALSE is returned.
24732     *
24733     * @see elm_object_cursor_engine_only_get() for more details.
24734     * @see elm_diskselector_item_cursor_engine_only_set()
24735     *
24736     * @ingroup Diskselector
24737     */
24738    EAPI Eina_Bool              elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24739
24740    /**
24741     * @}
24742     */
24743
24744    /**
24745     * @defgroup Colorselector Colorselector
24746     *
24747     * @{
24748     *
24749     * @image html img/widget/colorselector/preview-00.png
24750     * @image latex img/widget/colorselector/preview-00.eps
24751     *
24752     * @brief Widget for user to select a color.
24753     *
24754     * Signals that you can add callbacks for are:
24755     * "changed" - When the color value changes(event_info is NULL).
24756     *
24757     * See @ref tutorial_colorselector.
24758     */
24759    /**
24760     * @brief Add a new colorselector to the parent
24761     *
24762     * @param parent The parent object
24763     * @return The new object or NULL if it cannot be created
24764     *
24765     * @ingroup Colorselector
24766     */
24767    EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24768    /**
24769     * Set a color for the colorselector
24770     *
24771     * @param obj   Colorselector object
24772     * @param r     r-value of color
24773     * @param g     g-value of color
24774     * @param b     b-value of color
24775     * @param a     a-value of color
24776     *
24777     * @ingroup Colorselector
24778     */
24779    EAPI void         elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
24780    /**
24781     * Get a color from the colorselector
24782     *
24783     * @param obj   Colorselector object
24784     * @param r     integer pointer for r-value of color
24785     * @param g     integer pointer for g-value of color
24786     * @param b     integer pointer for b-value of color
24787     * @param a     integer pointer for a-value of color
24788     *
24789     * @ingroup Colorselector
24790     */
24791    EAPI void         elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
24792    /**
24793     * @}
24794     */
24795
24796    /**
24797     * @defgroup Ctxpopup Ctxpopup
24798     *
24799     * @image html img/widget/ctxpopup/preview-00.png
24800     * @image latex img/widget/ctxpopup/preview-00.eps
24801     *
24802     * @brief Context popup widet.
24803     *
24804     * A ctxpopup is a widget that, when shown, pops up a list of items.
24805     * It automatically chooses an area inside its parent object's view
24806     * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
24807     * optimally fit into it. In the default theme, it will also point an
24808     * arrow to it's top left position at the time one shows it. Ctxpopup
24809     * items have a label and/or an icon. It is intended for a small
24810     * number of items (hence the use of list, not genlist).
24811     *
24812     * @note Ctxpopup is a especialization of @ref Hover.
24813     *
24814     * Signals that you can add callbacks for are:
24815     * "dismissed" - the ctxpopup was dismissed
24816     *
24817     * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
24818     * @{
24819     */
24820    typedef enum _Elm_Ctxpopup_Direction
24821      {
24822         ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
24823                                           area */
24824         ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
24825                                            the clicked area */
24826         ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
24827                                           the clicked area */
24828         ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
24829                                         area */
24830         ELM_CTXPOPUP_DIRECTION_DONT_KNOW, /**< ctxpopup does not determine it's direction yet*/
24831      } Elm_Ctxpopup_Direction;
24832
24833    /**
24834     * @brief Add a new Ctxpopup object to the parent.
24835     *
24836     * @param parent Parent object
24837     * @return New object or @c NULL, if it cannot be created
24838     */
24839    EAPI Evas_Object  *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24840    /**
24841     * @brief Set the Ctxpopup's parent
24842     *
24843     * @param obj The ctxpopup object
24844     * @param area The parent to use
24845     *
24846     * Set the parent object.
24847     *
24848     * @note elm_ctxpopup_add() will automatically call this function
24849     * with its @c parent argument.
24850     *
24851     * @see elm_ctxpopup_add()
24852     * @see elm_hover_parent_set()
24853     */
24854    EAPI void          elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
24855    /**
24856     * @brief Get the Ctxpopup's parent
24857     *
24858     * @param obj The ctxpopup object
24859     *
24860     * @see elm_ctxpopup_hover_parent_set() for more information
24861     */
24862    EAPI Evas_Object  *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24863    /**
24864     * @brief Clear all items in the given ctxpopup object.
24865     *
24866     * @param obj Ctxpopup object
24867     */
24868    EAPI void          elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24869    /**
24870     * @brief Change the ctxpopup's orientation to horizontal or vertical.
24871     *
24872     * @param obj Ctxpopup object
24873     * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
24874     */
24875    EAPI void          elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24876    /**
24877     * @brief Get the value of current ctxpopup object's orientation.
24878     *
24879     * @param obj Ctxpopup object
24880     * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
24881     *
24882     * @see elm_ctxpopup_horizontal_set()
24883     */
24884    EAPI Eina_Bool     elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24885    /**
24886     * @brief Add a new item to a ctxpopup object.
24887     *
24888     * @param obj Ctxpopup object
24889     * @param icon Icon to be set on new item
24890     * @param label The Label of the new item
24891     * @param func Convenience function called when item selected
24892     * @param data Data passed to @p func
24893     * @return A handle to the item added or @c NULL, on errors
24894     *
24895     * @warning Ctxpopup can't hold both an item list and a content at the same
24896     * time. When an item is added, any previous content will be removed.
24897     *
24898     * @see elm_ctxpopup_content_set()
24899     */
24900    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);
24901    /**
24902     * @brief Delete the given item in a ctxpopup object.
24903     *
24904     * @param it Ctxpopup item to be deleted
24905     *
24906     * @see elm_ctxpopup_item_append()
24907     */
24908    EAPI void          elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24909    /**
24910     * @brief Set the ctxpopup item's state as disabled or enabled.
24911     *
24912     * @param it Ctxpopup item to be enabled/disabled
24913     * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
24914     *
24915     * When disabled the item is greyed out to indicate it's state.
24916     */
24917    EAPI void          elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24918    /**
24919     * @brief Get the ctxpopup item's disabled/enabled state.
24920     *
24921     * @param it Ctxpopup item to be enabled/disabled
24922     * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
24923     *
24924     * @see elm_ctxpopup_item_disabled_set()
24925     */
24926    EAPI Eina_Bool     elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24927    /**
24928     * @brief Get the icon object for the given ctxpopup item.
24929     *
24930     * @param it Ctxpopup item
24931     * @return icon object or @c NULL, if the item does not have icon or an error
24932     * occurred
24933     *
24934     * @see elm_ctxpopup_item_append()
24935     * @see elm_ctxpopup_item_icon_set()
24936     */
24937    EAPI Evas_Object  *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24938    /**
24939     * @brief Sets the side icon associated with the ctxpopup item
24940     *
24941     * @param it Ctxpopup item
24942     * @param icon Icon object to be set
24943     *
24944     * Once the icon object is set, a previously set one will be deleted.
24945     * @warning Setting the same icon for two items will cause the icon to
24946     * dissapear from the first item.
24947     *
24948     * @see elm_ctxpopup_item_append()
24949     */
24950    EAPI void          elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
24951    /**
24952     * @brief Get the label for the given ctxpopup item.
24953     *
24954     * @param it Ctxpopup item
24955     * @return label string or @c NULL, if the item does not have label or an
24956     * error occured
24957     *
24958     * @see elm_ctxpopup_item_append()
24959     * @see elm_ctxpopup_item_label_set()
24960     */
24961    EAPI const char   *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24962    /**
24963     * @brief (Re)set the label on the given ctxpopup item.
24964     *
24965     * @param it Ctxpopup item
24966     * @param label String to set as label
24967     */
24968    EAPI void          elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
24969    /**
24970     * @brief Set an elm widget as the content of the ctxpopup.
24971     *
24972     * @param obj Ctxpopup object
24973     * @param content Content to be swallowed
24974     *
24975     * If the content object is already set, a previous one will bedeleted. If
24976     * you want to keep that old content object, use the
24977     * elm_ctxpopup_content_unset() function.
24978     *
24979     * @deprecated use elm_object_content_set()
24980     *
24981     * @warning Ctxpopup can't hold both a item list and a content at the same
24982     * time. When a content is set, any previous items will be removed.
24983     */
24984    EINA_DEPRECATED EAPI void          elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
24985    /**
24986     * @brief Unset the ctxpopup content
24987     *
24988     * @param obj Ctxpopup object
24989     * @return The content that was being used
24990     *
24991     * Unparent and return the content object which was set for this widget.
24992     *
24993     * @deprecated use elm_object_content_unset()
24994     *
24995     * @see elm_ctxpopup_content_set()
24996     */
24997    EINA_DEPRECATED EAPI Evas_Object  *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24998    /**
24999     * @brief Set the direction priority of a ctxpopup.
25000     *
25001     * @param obj Ctxpopup object
25002     * @param first 1st priority of direction
25003     * @param second 2nd priority of direction
25004     * @param third 3th priority of direction
25005     * @param fourth 4th priority of direction
25006     *
25007     * This functions gives a chance to user to set the priority of ctxpopup
25008     * showing direction. This doesn't guarantee the ctxpopup will appear in the
25009     * requested direction.
25010     *
25011     * @see Elm_Ctxpopup_Direction
25012     */
25013    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);
25014    /**
25015     * @brief Get the direction priority of a ctxpopup.
25016     *
25017     * @param obj Ctxpopup object
25018     * @param first 1st priority of direction to be returned
25019     * @param second 2nd priority of direction to be returned
25020     * @param third 3th priority of direction to be returned
25021     * @param fourth 4th priority of direction to be returned
25022     *
25023     * @see elm_ctxpopup_direction_priority_set() for more information.
25024     */
25025    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);
25026
25027    /**
25028     * @brief Get the current direction of a ctxpopup.
25029     *
25030     * @param obj Ctxpopup object
25031     * @return current direction of a ctxpopup
25032     *
25033     * @warning Once the ctxpopup showed up, the direction would be determined
25034     */
25035    EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25036
25037    /**
25038     * @}
25039     */
25040
25041    /* transit */
25042    /**
25043     *
25044     * @defgroup Transit Transit
25045     * @ingroup Elementary
25046     *
25047     * Transit is designed to apply various animated transition effects to @c
25048     * Evas_Object, such like translation, rotation, etc. For using these
25049     * effects, create an @ref Elm_Transit and add the desired transition effects.
25050     *
25051     * Once the effects are added into transit, they will be automatically
25052     * managed (their callback will be called until the duration is ended, and
25053     * they will be deleted on completion).
25054     *
25055     * Example:
25056     * @code
25057     * Elm_Transit *trans = elm_transit_add();
25058     * elm_transit_object_add(trans, obj);
25059     * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
25060     * elm_transit_duration_set(transit, 1);
25061     * elm_transit_auto_reverse_set(transit, EINA_TRUE);
25062     * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
25063     * elm_transit_repeat_times_set(transit, 3);
25064     * @endcode
25065     *
25066     * Some transition effects are used to change the properties of objects. They
25067     * are:
25068     * @li @ref elm_transit_effect_translation_add
25069     * @li @ref elm_transit_effect_color_add
25070     * @li @ref elm_transit_effect_rotation_add
25071     * @li @ref elm_transit_effect_wipe_add
25072     * @li @ref elm_transit_effect_zoom_add
25073     * @li @ref elm_transit_effect_resizing_add
25074     *
25075     * Other transition effects are used to make one object disappear and another
25076     * object appear on its old place. These effects are:
25077     *
25078     * @li @ref elm_transit_effect_flip_add
25079     * @li @ref elm_transit_effect_resizable_flip_add
25080     * @li @ref elm_transit_effect_fade_add
25081     * @li @ref elm_transit_effect_blend_add
25082     *
25083     * It's also possible to make a transition chain with @ref
25084     * elm_transit_chain_transit_add.
25085     *
25086     * @warning We strongly recommend to use elm_transit just when edje can not do
25087     * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
25088     * animations can be manipulated inside the theme.
25089     *
25090     * List of examples:
25091     * @li @ref transit_example_01_explained
25092     * @li @ref transit_example_02_explained
25093     * @li @ref transit_example_03_c
25094     * @li @ref transit_example_04_c
25095     *
25096     * @{
25097     */
25098
25099    /**
25100     * @enum Elm_Transit_Tween_Mode
25101     *
25102     * The type of acceleration used in the transition.
25103     */
25104    typedef enum
25105      {
25106         ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
25107         ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
25108                                              over time, then decrease again
25109                                              and stop slowly */
25110         ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
25111                                              speed over time */
25112         ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
25113                                             over time */
25114      } Elm_Transit_Tween_Mode;
25115
25116    /**
25117     * @enum Elm_Transit_Effect_Flip_Axis
25118     *
25119     * The axis where flip effect should be applied.
25120     */
25121    typedef enum
25122      {
25123         ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
25124         ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
25125      } Elm_Transit_Effect_Flip_Axis;
25126    /**
25127     * @enum Elm_Transit_Effect_Wipe_Dir
25128     *
25129     * The direction where the wipe effect should occur.
25130     */
25131    typedef enum
25132      {
25133         ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
25134         ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
25135         ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
25136         ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
25137      } Elm_Transit_Effect_Wipe_Dir;
25138    /** @enum Elm_Transit_Effect_Wipe_Type
25139     *
25140     * Whether the wipe effect should show or hide the object.
25141     */
25142    typedef enum
25143      {
25144         ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
25145                                              animation */
25146         ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
25147                                             animation */
25148      } Elm_Transit_Effect_Wipe_Type;
25149
25150    /**
25151     * @typedef Elm_Transit
25152     *
25153     * The Transit created with elm_transit_add(). This type has the information
25154     * about the objects which the transition will be applied, and the
25155     * transition effects that will be used. It also contains info about
25156     * duration, number of repetitions, auto-reverse, etc.
25157     */
25158    typedef struct _Elm_Transit Elm_Transit;
25159    typedef void Elm_Transit_Effect;
25160    /**
25161     * @typedef Elm_Transit_Effect_Transition_Cb
25162     *
25163     * Transition callback called for this effect on each transition iteration.
25164     */
25165    typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
25166    /**
25167     * Elm_Transit_Effect_End_Cb
25168     *
25169     * Transition callback called for this effect when the transition is over.
25170     */
25171    typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
25172
25173    /**
25174     * Elm_Transit_Del_Cb
25175     *
25176     * A callback called when the transit is deleted.
25177     */
25178    typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
25179
25180    /**
25181     * Add new transit.
25182     *
25183     * @note Is not necessary to delete the transit object, it will be deleted at
25184     * the end of its operation.
25185     * @note The transit will start playing when the program enter in the main loop, is not
25186     * necessary to give a start to the transit.
25187     *
25188     * @return The transit object.
25189     *
25190     * @ingroup Transit
25191     */
25192    EAPI Elm_Transit                *elm_transit_add(void);
25193
25194    /**
25195     * Stops the animation and delete the @p transit object.
25196     *
25197     * Call this function if you wants to stop the animation before the duration
25198     * time. Make sure the @p transit object is still alive with
25199     * elm_transit_del_cb_set() function.
25200     * All added effects will be deleted, calling its repective data_free_cb
25201     * functions. The function setted by elm_transit_del_cb_set() will be called.
25202     *
25203     * @see elm_transit_del_cb_set()
25204     *
25205     * @param transit The transit object to be deleted.
25206     *
25207     * @ingroup Transit
25208     * @warning Just call this function if you are sure the transit is alive.
25209     */
25210    EAPI void                        elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
25211
25212    /**
25213     * Add a new effect to the transit.
25214     *
25215     * @note The cb function and the data are the key to the effect. If you try to
25216     * add an already added effect, nothing is done.
25217     * @note After the first addition of an effect in @p transit, if its
25218     * effect list become empty again, the @p transit will be killed by
25219     * elm_transit_del(transit) function.
25220     *
25221     * Exemple:
25222     * @code
25223     * Elm_Transit *transit = elm_transit_add();
25224     * elm_transit_effect_add(transit,
25225     *                        elm_transit_effect_blend_op,
25226     *                        elm_transit_effect_blend_context_new(),
25227     *                        elm_transit_effect_blend_context_free);
25228     * @endcode
25229     *
25230     * @param transit The transit object.
25231     * @param transition_cb The operation function. It is called when the
25232     * animation begins, it is the function that actually performs the animation.
25233     * It is called with the @p data, @p transit and the time progression of the
25234     * animation (a double value between 0.0 and 1.0).
25235     * @param effect The context data of the effect.
25236     * @param end_cb The function to free the context data, it will be called
25237     * at the end of the effect, it must finalize the animation and free the
25238     * @p data.
25239     *
25240     * @ingroup Transit
25241     * @warning The transit free the context data at the and of the transition with
25242     * the data_free_cb function, do not use the context data in another transit.
25243     */
25244    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);
25245
25246    /**
25247     * Delete an added effect.
25248     *
25249     * This function will remove the effect from the @p transit, calling the
25250     * data_free_cb to free the @p data.
25251     *
25252     * @see elm_transit_effect_add()
25253     *
25254     * @note If the effect is not found, nothing is done.
25255     * @note If the effect list become empty, this function will call
25256     * elm_transit_del(transit), that is, it will kill the @p transit.
25257     *
25258     * @param transit The transit object.
25259     * @param transition_cb The operation function.
25260     * @param effect The context data of the effect.
25261     *
25262     * @ingroup Transit
25263     */
25264    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);
25265
25266    /**
25267     * Add new object to apply the effects.
25268     *
25269     * @note After the first addition of an object in @p transit, if its
25270     * object list become empty again, the @p transit will be killed by
25271     * elm_transit_del(transit) function.
25272     * @note If the @p obj belongs to another transit, the @p obj will be
25273     * removed from it and it will only belong to the @p transit. If the old
25274     * transit stays without objects, it will die.
25275     * @note When you add an object into the @p transit, its state from
25276     * evas_object_pass_events_get(obj) is saved, and it is applied when the
25277     * transit ends, if you change this state whith evas_object_pass_events_set()
25278     * after add the object, this state will change again when @p transit stops to
25279     * run.
25280     *
25281     * @param transit The transit object.
25282     * @param obj Object to be animated.
25283     *
25284     * @ingroup Transit
25285     * @warning It is not allowed to add a new object after transit begins to go.
25286     */
25287    EAPI void                        elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
25288
25289    /**
25290     * Removes an added object from the transit.
25291     *
25292     * @note If the @p obj is not in the @p transit, nothing is done.
25293     * @note If the list become empty, this function will call
25294     * elm_transit_del(transit), that is, it will kill the @p transit.
25295     *
25296     * @param transit The transit object.
25297     * @param obj Object to be removed from @p transit.
25298     *
25299     * @ingroup Transit
25300     * @warning It is not allowed to remove objects after transit begins to go.
25301     */
25302    EAPI void                        elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
25303
25304    /**
25305     * Get the objects of the transit.
25306     *
25307     * @param transit The transit object.
25308     * @return a Eina_List with the objects from the transit.
25309     *
25310     * @ingroup Transit
25311     */
25312    EAPI const Eina_List            *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25313
25314    /**
25315     * Enable/disable keeping up the objects states.
25316     * If it is not kept, the objects states will be reset when transition ends.
25317     *
25318     * @note @p transit can not be NULL.
25319     * @note One state includes geometry, color, map data.
25320     *
25321     * @param transit The transit object.
25322     * @param state_keep Keeping or Non Keeping.
25323     *
25324     * @ingroup Transit
25325     */
25326    EAPI void                        elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
25327
25328    /**
25329     * Get a value whether the objects states will be reset or not.
25330     *
25331     * @note @p transit can not be NULL
25332     *
25333     * @see elm_transit_objects_final_state_keep_set()
25334     *
25335     * @param transit The transit object.
25336     * @return EINA_TRUE means the states of the objects will be reset.
25337     * If @p transit is NULL, EINA_FALSE is returned
25338     *
25339     * @ingroup Transit
25340     */
25341    EAPI Eina_Bool                   elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25342
25343    /**
25344     * Set the event enabled when transit is operating.
25345     *
25346     * If @p enabled is EINA_TRUE, the objects of the transit will receives
25347     * events from mouse and keyboard during the animation.
25348     * @note When you add an object with elm_transit_object_add(), its state from
25349     * evas_object_pass_events_get(obj) is saved, and it is applied when the
25350     * transit ends, if you change this state with evas_object_pass_events_set()
25351     * after adding the object, this state will change again when @p transit stops
25352     * to run.
25353     *
25354     * @param transit The transit object.
25355     * @param enabled Events are received when enabled is @c EINA_TRUE, and
25356     * ignored otherwise.
25357     *
25358     * @ingroup Transit
25359     */
25360    EAPI void                        elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25361
25362    /**
25363     * Get the value of event enabled status.
25364     *
25365     * @see elm_transit_event_enabled_set()
25366     *
25367     * @param transit The Transit object
25368     * @return EINA_TRUE, when event is enabled. If @p transit is NULL
25369     * EINA_FALSE is returned
25370     *
25371     * @ingroup Transit
25372     */
25373    EAPI Eina_Bool                   elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25374
25375    /**
25376     * Set the user-callback function when the transit is deleted.
25377     *
25378     * @note Using this function twice will overwrite the first function setted.
25379     * @note the @p transit object will be deleted after call @p cb function.
25380     *
25381     * @param transit The transit object.
25382     * @param cb Callback function pointer. This function will be called before
25383     * the deletion of the transit.
25384     * @param data Callback funtion user data. It is the @p op parameter.
25385     *
25386     * @ingroup Transit
25387     */
25388    EAPI void                        elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
25389
25390    /**
25391     * Set reverse effect automatically.
25392     *
25393     * If auto reverse is setted, after running the effects with the progress
25394     * parameter from 0 to 1, it will call the effecs again with the progress
25395     * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
25396     * where the duration was setted with the function elm_transit_add and
25397     * the repeat with the function elm_transit_repeat_times_set().
25398     *
25399     * @param transit The transit object.
25400     * @param reverse EINA_TRUE means the auto_reverse is on.
25401     *
25402     * @ingroup Transit
25403     */
25404    EAPI void                        elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
25405
25406    /**
25407     * Get if the auto reverse is on.
25408     *
25409     * @see elm_transit_auto_reverse_set()
25410     *
25411     * @param transit The transit object.
25412     * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
25413     * EINA_FALSE is returned
25414     *
25415     * @ingroup Transit
25416     */
25417    EAPI Eina_Bool                   elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25418
25419    /**
25420     * Set the transit repeat count. Effect will be repeated by repeat count.
25421     *
25422     * This function sets the number of repetition the transit will run after
25423     * the first one, that is, if @p repeat is 1, the transit will run 2 times.
25424     * If the @p repeat is a negative number, it will repeat infinite times.
25425     *
25426     * @note If this function is called during the transit execution, the transit
25427     * will run @p repeat times, ignoring the times it already performed.
25428     *
25429     * @param transit The transit object
25430     * @param repeat Repeat count
25431     *
25432     * @ingroup Transit
25433     */
25434    EAPI void                        elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
25435
25436    /**
25437     * Get the transit repeat count.
25438     *
25439     * @see elm_transit_repeat_times_set()
25440     *
25441     * @param transit The Transit object.
25442     * @return The repeat count. If @p transit is NULL
25443     * 0 is returned
25444     *
25445     * @ingroup Transit
25446     */
25447    EAPI int                         elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25448
25449    /**
25450     * Set the transit animation acceleration type.
25451     *
25452     * This function sets the tween mode of the transit that can be:
25453     * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
25454     * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
25455     * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
25456     * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
25457     *
25458     * @param transit The transit object.
25459     * @param tween_mode The tween type.
25460     *
25461     * @ingroup Transit
25462     */
25463    EAPI void                        elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
25464
25465    /**
25466     * Get the transit animation acceleration type.
25467     *
25468     * @note @p transit can not be NULL
25469     *
25470     * @param transit The transit object.
25471     * @return The tween type. If @p transit is NULL
25472     * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
25473     *
25474     * @ingroup Transit
25475     */
25476    EAPI Elm_Transit_Tween_Mode      elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25477
25478    /**
25479     * Set the transit animation time
25480     *
25481     * @note @p transit can not be NULL
25482     *
25483     * @param transit The transit object.
25484     * @param duration The animation time.
25485     *
25486     * @ingroup Transit
25487     */
25488    EAPI void                        elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
25489
25490    /**
25491     * Get the transit animation time
25492     *
25493     * @note @p transit can not be NULL
25494     *
25495     * @param transit The transit object.
25496     *
25497     * @return The transit animation time.
25498     *
25499     * @ingroup Transit
25500     */
25501    EAPI double                      elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25502
25503    /**
25504     * Starts the transition.
25505     * Once this API is called, the transit begins to measure the time.
25506     *
25507     * @note @p transit can not be NULL
25508     *
25509     * @param transit The transit object.
25510     *
25511     * @ingroup Transit
25512     */
25513    EAPI void                        elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
25514
25515    /**
25516     * Pause/Resume the transition.
25517     *
25518     * If you call elm_transit_go again, the transit will be started from the
25519     * beginning, and will be unpaused.
25520     *
25521     * @note @p transit can not be NULL
25522     *
25523     * @param transit The transit object.
25524     * @param paused Whether the transition should be paused or not.
25525     *
25526     * @ingroup Transit
25527     */
25528    EAPI void                        elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
25529
25530    /**
25531     * Get the value of paused status.
25532     *
25533     * @see elm_transit_paused_set()
25534     *
25535     * @note @p transit can not be NULL
25536     *
25537     * @param transit The transit object.
25538     * @return EINA_TRUE means transition is paused. If @p transit is NULL
25539     * EINA_FALSE is returned
25540     *
25541     * @ingroup Transit
25542     */
25543    EAPI Eina_Bool                   elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25544
25545    /**
25546     * Get the time progression of the animation (a double value between 0.0 and 1.0).
25547     *
25548     * The value returned is a fraction (current time / total time). It
25549     * represents the progression position relative to the total.
25550     *
25551     * @note @p transit can not be NULL
25552     *
25553     * @param transit The transit object.
25554     *
25555     * @return The time progression value. If @p transit is NULL
25556     * 0 is returned
25557     *
25558     * @ingroup Transit
25559     */
25560    EAPI double                      elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25561
25562    /**
25563     * Makes the chain relationship between two transits.
25564     *
25565     * @note @p transit can not be NULL. Transit would have multiple chain transits.
25566     * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
25567     *
25568     * @param transit The transit object.
25569     * @param chain_transit The chain transit object. This transit will be operated
25570     *        after transit is done.
25571     *
25572     * This function adds @p chain_transit transition to a chain after the @p
25573     * transit, and will be started as soon as @p transit ends. See @ref
25574     * transit_example_02_explained for a full example.
25575     *
25576     * @ingroup Transit
25577     */
25578    EAPI void                        elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
25579
25580    /**
25581     * Cut off the chain relationship between two transits.
25582     *
25583     * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
25584     * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
25585     *
25586     * @param transit The transit object.
25587     * @param chain_transit The chain transit object.
25588     *
25589     * This function remove the @p chain_transit transition from the @p transit.
25590     *
25591     * @ingroup Transit
25592     */
25593    EAPI void                        elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
25594
25595    /**
25596     * Get the current chain transit list.
25597     *
25598     * @note @p transit can not be NULL.
25599     *
25600     * @param transit The transit object.
25601     * @return chain transit list.
25602     *
25603     * @ingroup Transit
25604     */
25605    EAPI Eina_List                  *elm_transit_chain_transits_get(const Elm_Transit *transit);
25606
25607    /**
25608     * Add the Resizing Effect to Elm_Transit.
25609     *
25610     * @note This API is one of the facades. It creates resizing effect context
25611     * and add it's required APIs to elm_transit_effect_add.
25612     *
25613     * @see elm_transit_effect_add()
25614     *
25615     * @param transit Transit object.
25616     * @param from_w Object width size when effect begins.
25617     * @param from_h Object height size when effect begins.
25618     * @param to_w Object width size when effect ends.
25619     * @param to_h Object height size when effect ends.
25620     * @return Resizing effect context data.
25621     *
25622     * @ingroup Transit
25623     */
25624    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);
25625
25626    /**
25627     * Add the Translation Effect to Elm_Transit.
25628     *
25629     * @note This API is one of the facades. It creates translation effect context
25630     * and add it's required APIs to elm_transit_effect_add.
25631     *
25632     * @see elm_transit_effect_add()
25633     *
25634     * @param transit Transit object.
25635     * @param from_dx X Position variation when effect begins.
25636     * @param from_dy Y Position variation when effect begins.
25637     * @param to_dx X Position variation when effect ends.
25638     * @param to_dy Y Position variation when effect ends.
25639     * @return Translation effect context data.
25640     *
25641     * @ingroup Transit
25642     * @warning It is highly recommended just create a transit with this effect when
25643     * the window that the objects of the transit belongs has already been created.
25644     * This is because this effect needs the geometry information about the objects,
25645     * and if the window was not created yet, it can get a wrong information.
25646     */
25647    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);
25648
25649    /**
25650     * Add the Zoom Effect to Elm_Transit.
25651     *
25652     * @note This API is one of the facades. It creates zoom effect context
25653     * and add it's required APIs to elm_transit_effect_add.
25654     *
25655     * @see elm_transit_effect_add()
25656     *
25657     * @param transit Transit object.
25658     * @param from_rate Scale rate when effect begins (1 is current rate).
25659     * @param to_rate Scale rate when effect ends.
25660     * @return Zoom effect context data.
25661     *
25662     * @ingroup Transit
25663     * @warning It is highly recommended just create a transit with this effect when
25664     * the window that the objects of the transit belongs has already been created.
25665     * This is because this effect needs the geometry information about the objects,
25666     * and if the window was not created yet, it can get a wrong information.
25667     */
25668    EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
25669
25670    /**
25671     * Add the Flip Effect to Elm_Transit.
25672     *
25673     * @note This API is one of the facades. It creates flip effect context
25674     * and add it's required APIs to elm_transit_effect_add.
25675     * @note This effect is applied to each pair of objects in the order they are listed
25676     * in the transit list of objects. The first object in the pair will be the
25677     * "front" object and the second will be the "back" object.
25678     *
25679     * @see elm_transit_effect_add()
25680     *
25681     * @param transit Transit object.
25682     * @param axis Flipping Axis(X or Y).
25683     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
25684     * @return Flip effect context data.
25685     *
25686     * @ingroup Transit
25687     * @warning It is highly recommended just create a transit with this effect when
25688     * the window that the objects of the transit belongs has already been created.
25689     * This is because this effect needs the geometry information about the objects,
25690     * and if the window was not created yet, it can get a wrong information.
25691     */
25692    EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
25693
25694    /**
25695     * Add the Resizable Flip Effect to Elm_Transit.
25696     *
25697     * @note This API is one of the facades. It creates resizable flip effect context
25698     * and add it's required APIs to elm_transit_effect_add.
25699     * @note This effect is applied to each pair of objects in the order they are listed
25700     * in the transit list of objects. The first object in the pair will be the
25701     * "front" object and the second will be the "back" object.
25702     *
25703     * @see elm_transit_effect_add()
25704     *
25705     * @param transit Transit object.
25706     * @param axis Flipping Axis(X or Y).
25707     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
25708     * @return Resizable flip effect context data.
25709     *
25710     * @ingroup Transit
25711     * @warning It is highly recommended just create a transit with this effect when
25712     * the window that the objects of the transit belongs has already been created.
25713     * This is because this effect needs the geometry information about the objects,
25714     * and if the window was not created yet, it can get a wrong information.
25715     */
25716    EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
25717
25718    /**
25719     * Add the Wipe Effect to Elm_Transit.
25720     *
25721     * @note This API is one of the facades. It creates wipe effect context
25722     * and add it's required APIs to elm_transit_effect_add.
25723     *
25724     * @see elm_transit_effect_add()
25725     *
25726     * @param transit Transit object.
25727     * @param type Wipe type. Hide or show.
25728     * @param dir Wipe Direction.
25729     * @return Wipe effect context data.
25730     *
25731     * @ingroup Transit
25732     * @warning It is highly recommended just create a transit with this effect when
25733     * the window that the objects of the transit belongs has already been created.
25734     * This is because this effect needs the geometry information about the objects,
25735     * and if the window was not created yet, it can get a wrong information.
25736     */
25737    EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
25738
25739    /**
25740     * Add the Color Effect to Elm_Transit.
25741     *
25742     * @note This API is one of the facades. It creates color effect context
25743     * and add it's required APIs to elm_transit_effect_add.
25744     *
25745     * @see elm_transit_effect_add()
25746     *
25747     * @param transit        Transit object.
25748     * @param  from_r        RGB R when effect begins.
25749     * @param  from_g        RGB G when effect begins.
25750     * @param  from_b        RGB B when effect begins.
25751     * @param  from_a        RGB A when effect begins.
25752     * @param  to_r          RGB R when effect ends.
25753     * @param  to_g          RGB G when effect ends.
25754     * @param  to_b          RGB B when effect ends.
25755     * @param  to_a          RGB A when effect ends.
25756     * @return               Color effect context data.
25757     *
25758     * @ingroup Transit
25759     */
25760    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);
25761
25762    /**
25763     * Add the Fade Effect to Elm_Transit.
25764     *
25765     * @note This API is one of the facades. It creates fade effect context
25766     * and add it's required APIs to elm_transit_effect_add.
25767     * @note This effect is applied to each pair of objects in the order they are listed
25768     * in the transit list of objects. The first object in the pair will be the
25769     * "before" object and the second will be the "after" object.
25770     *
25771     * @see elm_transit_effect_add()
25772     *
25773     * @param transit Transit object.
25774     * @return Fade effect context data.
25775     *
25776     * @ingroup Transit
25777     * @warning It is highly recommended just create a transit with this effect when
25778     * the window that the objects of the transit belongs has already been created.
25779     * This is because this effect needs the color information about the objects,
25780     * and if the window was not created yet, it can get a wrong information.
25781     */
25782    EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
25783
25784    /**
25785     * Add the Blend Effect to Elm_Transit.
25786     *
25787     * @note This API is one of the facades. It creates blend effect context
25788     * and add it's required APIs to elm_transit_effect_add.
25789     * @note This effect is applied to each pair of objects in the order they are listed
25790     * in the transit list of objects. The first object in the pair will be the
25791     * "before" object and the second will be the "after" object.
25792     *
25793     * @see elm_transit_effect_add()
25794     *
25795     * @param transit Transit object.
25796     * @return Blend effect context data.
25797     *
25798     * @ingroup Transit
25799     * @warning It is highly recommended just create a transit with this effect when
25800     * the window that the objects of the transit belongs has already been created.
25801     * This is because this effect needs the color information about the objects,
25802     * and if the window was not created yet, it can get a wrong information.
25803     */
25804    EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
25805
25806    /**
25807     * Add the Rotation Effect to Elm_Transit.
25808     *
25809     * @note This API is one of the facades. It creates rotation effect context
25810     * and add it's required APIs to elm_transit_effect_add.
25811     *
25812     * @see elm_transit_effect_add()
25813     *
25814     * @param transit Transit object.
25815     * @param from_degree Degree when effect begins.
25816     * @param to_degree Degree when effect is ends.
25817     * @return Rotation effect context data.
25818     *
25819     * @ingroup Transit
25820     * @warning It is highly recommended just create a transit with this effect when
25821     * the window that the objects of the transit belongs has already been created.
25822     * This is because this effect needs the geometry information about the objects,
25823     * and if the window was not created yet, it can get a wrong information.
25824     */
25825    EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
25826
25827    /**
25828     * Add the ImageAnimation Effect to Elm_Transit.
25829     *
25830     * @note This API is one of the facades. It creates image animation effect context
25831     * and add it's required APIs to elm_transit_effect_add.
25832     * The @p images parameter is a list images paths. This list and
25833     * its contents will be deleted at the end of the effect by
25834     * elm_transit_effect_image_animation_context_free() function.
25835     *
25836     * Example:
25837     * @code
25838     * char buf[PATH_MAX];
25839     * Eina_List *images = NULL;
25840     * Elm_Transit *transi = elm_transit_add();
25841     *
25842     * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
25843     * images = eina_list_append(images, eina_stringshare_add(buf));
25844     *
25845     * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
25846     * images = eina_list_append(images, eina_stringshare_add(buf));
25847     * elm_transit_effect_image_animation_add(transi, images);
25848     *
25849     * @endcode
25850     *
25851     * @see elm_transit_effect_add()
25852     *
25853     * @param transit Transit object.
25854     * @param images Eina_List of images file paths. This list and
25855     * its contents will be deleted at the end of the effect by
25856     * elm_transit_effect_image_animation_context_free() function.
25857     * @return Image Animation effect context data.
25858     *
25859     * @ingroup Transit
25860     */
25861    EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
25862    /**
25863     * @}
25864     */
25865
25866   typedef struct _Elm_Store                      Elm_Store;
25867   typedef struct _Elm_Store_Filesystem           Elm_Store_Filesystem;
25868   typedef struct _Elm_Store_Item                 Elm_Store_Item;
25869   typedef struct _Elm_Store_Item_Filesystem      Elm_Store_Item_Filesystem;
25870   typedef struct _Elm_Store_Item_Info            Elm_Store_Item_Info;
25871   typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
25872   typedef struct _Elm_Store_Item_Mapping         Elm_Store_Item_Mapping;
25873   typedef struct _Elm_Store_Item_Mapping_Empty   Elm_Store_Item_Mapping_Empty;
25874   typedef struct _Elm_Store_Item_Mapping_Icon    Elm_Store_Item_Mapping_Icon;
25875   typedef struct _Elm_Store_Item_Mapping_Photo   Elm_Store_Item_Mapping_Photo;
25876   typedef struct _Elm_Store_Item_Mapping_Custom  Elm_Store_Item_Mapping_Custom;
25877
25878   typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
25879   typedef void      (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
25880   typedef void      (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
25881   typedef void     *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
25882
25883   typedef enum
25884     {
25885        ELM_STORE_ITEM_MAPPING_NONE = 0,
25886        ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
25887        ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
25888        ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
25889        ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
25890        ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
25891        // can add more here as needed by common apps
25892        ELM_STORE_ITEM_MAPPING_LAST
25893     } Elm_Store_Item_Mapping_Type;
25894
25895   struct _Elm_Store_Item_Mapping_Icon
25896     {
25897        // FIXME: allow edje file icons
25898        int                   w, h;
25899        Elm_Icon_Lookup_Order lookup_order;
25900        Eina_Bool             standard_name : 1;
25901        Eina_Bool             no_scale : 1;
25902        Eina_Bool             smooth : 1;
25903        Eina_Bool             scale_up : 1;
25904        Eina_Bool             scale_down : 1;
25905     };
25906
25907   struct _Elm_Store_Item_Mapping_Empty
25908     {
25909        Eina_Bool             dummy;
25910     };
25911
25912   struct _Elm_Store_Item_Mapping_Photo
25913     {
25914        int                   size;
25915     };
25916
25917   struct _Elm_Store_Item_Mapping_Custom
25918     {
25919        Elm_Store_Item_Mapping_Cb func;
25920     };
25921
25922   struct _Elm_Store_Item_Mapping
25923     {
25924        Elm_Store_Item_Mapping_Type     type;
25925        const char                     *part;
25926        int                             offset;
25927        union
25928          {
25929             Elm_Store_Item_Mapping_Empty  empty;
25930             Elm_Store_Item_Mapping_Icon   icon;
25931             Elm_Store_Item_Mapping_Photo  photo;
25932             Elm_Store_Item_Mapping_Custom custom;
25933             // add more types here
25934          } details;
25935     };
25936
25937   struct _Elm_Store_Item_Info
25938     {
25939       Elm_Genlist_Item_Class       *item_class;
25940       const Elm_Store_Item_Mapping *mapping;
25941       void                         *data;
25942       char                         *sort_id;
25943     };
25944
25945   struct _Elm_Store_Item_Info_Filesystem
25946     {
25947       Elm_Store_Item_Info  base;
25948       char                *path;
25949     };
25950
25951 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
25952 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
25953
25954   EAPI void                    elm_store_free(Elm_Store *st);
25955
25956   EAPI Elm_Store              *elm_store_filesystem_new(void);
25957   EAPI void                    elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
25958   EAPI const char             *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25959   EAPI const char             *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25960
25961   EAPI void                    elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
25962
25963   EAPI void                    elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
25964   EAPI int                     elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25965   EAPI void                    elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25966   EAPI void                    elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25967   EAPI void                    elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
25968   EAPI Eina_Bool               elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25969
25970   EAPI void                    elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25971   EAPI void                    elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
25972   EAPI Eina_Bool               elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25973   EAPI void                    elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
25974   EAPI void                   *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25975   EAPI const Elm_Store        *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25976   EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25977
25978    /**
25979     * @defgroup SegmentControl SegmentControl
25980     * @ingroup Elementary
25981     *
25982     * @image html img/widget/segment_control/preview-00.png
25983     * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
25984     *
25985     * @image html img/segment_control.png
25986     * @image latex img/segment_control.eps width=\textwidth
25987     *
25988     * Segment control widget is a horizontal control made of multiple segment
25989     * items, each segment item functioning similar to discrete two state button.
25990     * A segment control groups the items together and provides compact
25991     * single button with multiple equal size segments.
25992     *
25993     * Segment item size is determined by base widget
25994     * size and the number of items added.
25995     * Only one segment item can be at selected state. A segment item can display
25996     * combination of Text and any Evas_Object like Images or other widget.
25997     *
25998     * Smart callbacks one can listen to:
25999     * - "changed" - When the user clicks on a segment item which is not
26000     *   previously selected and get selected. The event_info parameter is the
26001     *   segment item index.
26002     *
26003     * Available styles for it:
26004     * - @c "default"
26005     *
26006     * Here is an example on its usage:
26007     * @li @ref segment_control_example
26008     */
26009
26010    /**
26011     * @addtogroup SegmentControl
26012     * @{
26013     */
26014
26015    typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
26016
26017    /**
26018     * Add a new segment control widget to the given parent Elementary
26019     * (container) object.
26020     *
26021     * @param parent The parent object.
26022     * @return a new segment control widget handle or @c NULL, on errors.
26023     *
26024     * This function inserts a new segment control widget on the canvas.
26025     *
26026     * @ingroup SegmentControl
26027     */
26028    EAPI Evas_Object      *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26029
26030    /**
26031     * Append a new item to the segment control object.
26032     *
26033     * @param obj The segment control object.
26034     * @param icon The icon object to use for the left side of the item. An
26035     * icon can be any Evas object, but usually it is an icon created
26036     * with elm_icon_add().
26037     * @param label The label of the item.
26038     *        Note that, NULL is different from empty string "".
26039     * @return The created item or @c NULL upon failure.
26040     *
26041     * A new item will be created and appended to the segment control, i.e., will
26042     * be set as @b last item.
26043     *
26044     * If it should be inserted at another position,
26045     * elm_segment_control_item_insert_at() should be used instead.
26046     *
26047     * Items created with this function can be deleted with function
26048     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
26049     *
26050     * @note @p label set to @c NULL is different from empty string "".
26051     * If an item
26052     * only has icon, it will be displayed bigger and centered. If it has
26053     * icon and label, even that an empty string, icon will be smaller and
26054     * positioned at left.
26055     *
26056     * Simple example:
26057     * @code
26058     * sc = elm_segment_control_add(win);
26059     * ic = elm_icon_add(win);
26060     * elm_icon_file_set(ic, "path/to/image", NULL);
26061     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
26062     * elm_segment_control_item_add(sc, ic, "label");
26063     * evas_object_show(sc);
26064     * @endcode
26065     *
26066     * @see elm_segment_control_item_insert_at()
26067     * @see elm_segment_control_item_del()
26068     *
26069     * @ingroup SegmentControl
26070     */
26071    EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
26072
26073    /**
26074     * Insert a new item to the segment control object at specified position.
26075     *
26076     * @param obj The segment control object.
26077     * @param icon The icon object to use for the left side of the item. An
26078     * icon can be any Evas object, but usually it is an icon created
26079     * with elm_icon_add().
26080     * @param label The label of the item.
26081     * @param index Item position. Value should be between 0 and items count.
26082     * @return The created item or @c NULL upon failure.
26083
26084     * Index values must be between @c 0, when item will be prepended to
26085     * segment control, and items count, that can be get with
26086     * elm_segment_control_item_count_get(), case when item will be appended
26087     * to segment control, just like elm_segment_control_item_add().
26088     *
26089     * Items created with this function can be deleted with function
26090     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
26091     *
26092     * @note @p label set to @c NULL is different from empty string "".
26093     * If an item
26094     * only has icon, it will be displayed bigger and centered. If it has
26095     * icon and label, even that an empty string, icon will be smaller and
26096     * positioned at left.
26097     *
26098     * @see elm_segment_control_item_add()
26099     * @see elm_segment_control_count_get()
26100     * @see elm_segment_control_item_del()
26101     *
26102     * @ingroup SegmentControl
26103     */
26104    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);
26105
26106    /**
26107     * Remove a segment control item from its parent, deleting it.
26108     *
26109     * @param it The item to be removed.
26110     *
26111     * Items can be added with elm_segment_control_item_add() or
26112     * elm_segment_control_item_insert_at().
26113     *
26114     * @ingroup SegmentControl
26115     */
26116    EAPI void              elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26117
26118    /**
26119     * Remove a segment control item at given index from its parent,
26120     * deleting it.
26121     *
26122     * @param obj The segment control object.
26123     * @param index The position of the segment control item to be deleted.
26124     *
26125     * Items can be added with elm_segment_control_item_add() or
26126     * elm_segment_control_item_insert_at().
26127     *
26128     * @ingroup SegmentControl
26129     */
26130    EAPI void              elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26131
26132    /**
26133     * Get the Segment items count from segment control.
26134     *
26135     * @param obj The segment control object.
26136     * @return Segment items count.
26137     *
26138     * It will just return the number of items added to segment control @p obj.
26139     *
26140     * @ingroup SegmentControl
26141     */
26142    EAPI int               elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26143
26144    /**
26145     * Get the item placed at specified index.
26146     *
26147     * @param obj The segment control object.
26148     * @param index The index of the segment item.
26149     * @return The segment control item or @c NULL on failure.
26150     *
26151     * Index is the position of an item in segment control widget. Its
26152     * range is from @c 0 to <tt> count - 1 </tt>.
26153     * Count is the number of items, that can be get with
26154     * elm_segment_control_item_count_get().
26155     *
26156     * @ingroup SegmentControl
26157     */
26158    EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26159
26160    /**
26161     * Get the label of item.
26162     *
26163     * @param obj The segment control object.
26164     * @param index The index of the segment item.
26165     * @return The label of the item at @p index.
26166     *
26167     * The return value is a pointer to the label associated to the item when
26168     * it was created, with function elm_segment_control_item_add(), or later
26169     * with function elm_segment_control_item_label_set. If no label
26170     * was passed as argument, it will return @c NULL.
26171     *
26172     * @see elm_segment_control_item_label_set() for more details.
26173     * @see elm_segment_control_item_add()
26174     *
26175     * @ingroup SegmentControl
26176     */
26177    EAPI const char       *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26178
26179    /**
26180     * Set the label of item.
26181     *
26182     * @param it The item of segment control.
26183     * @param text The label of item.
26184     *
26185     * The label to be displayed by the item.
26186     * Label will be at right of the icon (if set).
26187     *
26188     * If a label was passed as argument on item creation, with function
26189     * elm_control_segment_item_add(), it will be already
26190     * displayed by the item.
26191     *
26192     * @see elm_segment_control_item_label_get()
26193     * @see elm_segment_control_item_add()
26194     *
26195     * @ingroup SegmentControl
26196     */
26197    EAPI void              elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
26198
26199    /**
26200     * Get the icon associated to the item.
26201     *
26202     * @param obj The segment control object.
26203     * @param index The index of the segment item.
26204     * @return The left side icon associated to the item at @p index.
26205     *
26206     * The return value is a pointer to the icon associated to the item when
26207     * it was created, with function elm_segment_control_item_add(), or later
26208     * with function elm_segment_control_item_icon_set(). If no icon
26209     * was passed as argument, it will return @c NULL.
26210     *
26211     * @see elm_segment_control_item_add()
26212     * @see elm_segment_control_item_icon_set()
26213     *
26214     * @ingroup SegmentControl
26215     */
26216    EAPI Evas_Object      *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26217
26218    /**
26219     * Set the icon associated to the item.
26220     *
26221     * @param it The segment control item.
26222     * @param icon The icon object to associate with @p it.
26223     *
26224     * The icon object to use at left side of the item. An
26225     * icon can be any Evas object, but usually it is an icon created
26226     * with elm_icon_add().
26227     *
26228     * Once the icon object is set, a previously set one will be deleted.
26229     * @warning Setting the same icon for two items will cause the icon to
26230     * dissapear from the first item.
26231     *
26232     * If an icon was passed as argument on item creation, with function
26233     * elm_segment_control_item_add(), it will be already
26234     * associated to the item.
26235     *
26236     * @see elm_segment_control_item_add()
26237     * @see elm_segment_control_item_icon_get()
26238     *
26239     * @ingroup SegmentControl
26240     */
26241    EAPI void              elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26242
26243    /**
26244     * Get the index of an item.
26245     *
26246     * @param it The segment control item.
26247     * @return The position of item in segment control widget.
26248     *
26249     * Index is the position of an item in segment control widget. Its
26250     * range is from @c 0 to <tt> count - 1 </tt>.
26251     * Count is the number of items, that can be get with
26252     * elm_segment_control_item_count_get().
26253     *
26254     * @ingroup SegmentControl
26255     */
26256    EAPI int               elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26257
26258    /**
26259     * Get the base object of the item.
26260     *
26261     * @param it The segment control item.
26262     * @return The base object associated with @p it.
26263     *
26264     * Base object is the @c Evas_Object that represents that item.
26265     *
26266     * @ingroup SegmentControl
26267     */
26268    EAPI Evas_Object      *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26269
26270    /**
26271     * Get the selected item.
26272     *
26273     * @param obj The segment control object.
26274     * @return The selected item or @c NULL if none of segment items is
26275     * selected.
26276     *
26277     * The selected item can be unselected with function
26278     * elm_segment_control_item_selected_set().
26279     *
26280     * The selected item always will be highlighted on segment control.
26281     *
26282     * @ingroup SegmentControl
26283     */
26284    EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26285
26286    /**
26287     * Set the selected state of an item.
26288     *
26289     * @param it The segment control item
26290     * @param select The selected state
26291     *
26292     * This sets the selected state of the given item @p it.
26293     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26294     *
26295     * If a new item is selected the previosly selected will be unselected.
26296     * Previoulsy selected item can be get with function
26297     * elm_segment_control_item_selected_get().
26298     *
26299     * The selected item always will be highlighted on segment control.
26300     *
26301     * @see elm_segment_control_item_selected_get()
26302     *
26303     * @ingroup SegmentControl
26304     */
26305    EAPI void              elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
26306
26307    /**
26308     * @}
26309     */
26310
26311    /**
26312     * @defgroup Grid Grid
26313     *
26314     * The grid is a grid layout widget that lays out a series of children as a
26315     * fixed "grid" of widgets using a given percentage of the grid width and
26316     * height each using the child object.
26317     *
26318     * The Grid uses a "Virtual resolution" that is stretched to fill the grid
26319     * widgets size itself. The default is 100 x 100, so that means the
26320     * position and sizes of children will effectively be percentages (0 to 100)
26321     * of the width or height of the grid widget
26322     *
26323     * @{
26324     */
26325
26326    /**
26327     * Add a new grid to the parent
26328     *
26329     * @param parent The parent object
26330     * @return The new object or NULL if it cannot be created
26331     *
26332     * @ingroup Grid
26333     */
26334    EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
26335
26336    /**
26337     * Set the virtual size of the grid
26338     *
26339     * @param obj The grid object
26340     * @param w The virtual width of the grid
26341     * @param h The virtual height of the grid
26342     *
26343     * @ingroup Grid
26344     */
26345    EAPI void         elm_grid_size_set(Evas_Object *obj, int w, int h);
26346
26347    /**
26348     * Get the virtual size of the grid
26349     *
26350     * @param obj The grid object
26351     * @param w Pointer to integer to store the virtual width of the grid
26352     * @param h Pointer to integer to store the virtual height of the grid
26353     *
26354     * @ingroup Grid
26355     */
26356    EAPI void         elm_grid_size_get(Evas_Object *obj, int *w, int *h);
26357
26358    /**
26359     * Pack child at given position and size
26360     *
26361     * @param obj The grid object
26362     * @param subobj The child to pack
26363     * @param x The virtual x coord at which to pack it
26364     * @param y The virtual y coord at which to pack it
26365     * @param w The virtual width at which to pack it
26366     * @param h The virtual height at which to pack it
26367     *
26368     * @ingroup Grid
26369     */
26370    EAPI void         elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
26371
26372    /**
26373     * Unpack a child from a grid object
26374     *
26375     * @param obj The grid object
26376     * @param subobj The child to unpack
26377     *
26378     * @ingroup Grid
26379     */
26380    EAPI void         elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
26381
26382    /**
26383     * Faster way to remove all child objects from a grid object.
26384     *
26385     * @param obj The grid object
26386     * @param clear If true, it will delete just removed children
26387     *
26388     * @ingroup Grid
26389     */
26390    EAPI void         elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
26391
26392    /**
26393     * Set packing of an existing child at to position and size
26394     *
26395     * @param subobj The child to set packing of
26396     * @param x The virtual x coord at which to pack it
26397     * @param y The virtual y coord at which to pack it
26398     * @param w The virtual width at which to pack it
26399     * @param h The virtual height at which to pack it
26400     *
26401     * @ingroup Grid
26402     */
26403    EAPI void         elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
26404
26405    /**
26406     * get packing of a child
26407     *
26408     * @param subobj The child to query
26409     * @param x Pointer to integer to store the virtual x coord
26410     * @param y Pointer to integer to store the virtual y coord
26411     * @param w Pointer to integer to store the virtual width
26412     * @param h Pointer to integer to store the virtual height
26413     *
26414     * @ingroup Grid
26415     */
26416    EAPI void         elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
26417
26418    /**
26419     * @}
26420     */
26421
26422    EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
26423    EAPI void         elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
26424    EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
26425    EAPI void         elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
26426    EAPI Eina_Bool    elm_factory_maxmin_mode_get(const Evas_Object *obj);
26427    EAPI void         elm_factory_maxmin_reset_set(Evas_Object *obj);
26428
26429    /**
26430     * @defgroup Video Video
26431     *
26432     * This object display an player that let you control an Elm_Video
26433     * object. It take care of updating it's content according to what is
26434     * going on inside the Emotion object. It does activate the remember
26435     * function on the linked Elm_Video object.
26436     *
26437     * Signals that you cann add callback for are :
26438     *
26439     * "forward,clicked" - the user clicked the forward button.
26440     * "info,clicked" - the user clicked the info button.
26441     * "next,clicked" - the user clicked the next button.
26442     * "pause,clicked" - the user clicked the pause button.
26443     * "play,clicked" - the user clicked the play button.
26444     * "prev,clicked" - the user clicked the prev button.
26445     * "rewind,clicked" - the user clicked the rewind button.
26446     * "stop,clicked" - the user clicked the stop button.
26447     */
26448    EAPI Evas_Object *elm_video_add(Evas_Object *parent);
26449    EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
26450    EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
26451    EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
26452    EAPI void elm_video_play(Evas_Object *video);
26453    EAPI void elm_video_pause(Evas_Object *video);
26454    EAPI void elm_video_stop(Evas_Object *video);
26455    EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
26456    EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
26457    EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
26458    EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
26459    EAPI double elm_video_audio_level_get(Evas_Object *video);
26460    EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
26461    EAPI double elm_video_play_position_get(Evas_Object *video);
26462    EAPI void elm_video_play_position_set(Evas_Object *video, double position);
26463    EAPI double elm_video_play_length_get(Evas_Object *video);
26464    EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
26465    EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
26466    EAPI const char *elm_video_title_get(Evas_Object *video);
26467
26468    EAPI Evas_Object *elm_player_add(Evas_Object *parent);
26469    EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
26470
26471   /* naviframe */
26472    EAPI Evas_Object        *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26473    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);
26474    EAPI Evas_Object        *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
26475    EAPI void                elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
26476    EAPI Eina_Bool           elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26477    EAPI void                elm_naviframe_item_title_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26478    EAPI const char         *elm_naviframe_item_title_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26479    EAPI void                elm_naviframe_item_subtitle_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26480    EAPI const char         *elm_naviframe_item_subtitle_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26481    EAPI Elm_Object_Item    *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26482    EAPI Elm_Object_Item    *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26483    EAPI void                elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
26484    EAPI const char         *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26485    EAPI void                elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
26486    EAPI Eina_Bool           elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26487
26488 #ifdef __cplusplus
26489 }
26490 #endif
26491
26492 #endif