Elm Glayer: Updated documentation
[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 set (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    /**
5316     * @}
5317     */
5318
5319    /* glview */
5320    typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5321
5322    typedef enum _Elm_GLView_Mode
5323      {
5324         ELM_GLVIEW_ALPHA   = 1,
5325         ELM_GLVIEW_DEPTH   = 2,
5326         ELM_GLVIEW_STENCIL = 4
5327      } Elm_GLView_Mode;
5328
5329    /**
5330     * Defines a policy for the glview resizing.
5331     *
5332     * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5333     */
5334    typedef enum _Elm_GLView_Resize_Policy
5335      {
5336         ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1,      /**< Resize the internal surface along with the image */
5337         ELM_GLVIEW_RESIZE_POLICY_SCALE    = 2       /**< Only reize the internal image and not the surface */
5338      } Elm_GLView_Resize_Policy;
5339
5340    typedef enum _Elm_GLView_Render_Policy
5341      {
5342         ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1,     /**< Render only when there is a need for redrawing */
5343         ELM_GLVIEW_RENDER_POLICY_ALWAYS    = 2      /**< Render always even when it is not visible */
5344      } Elm_GLView_Render_Policy;
5345
5346    /**
5347     * @defgroup GLView
5348     *
5349     * A simple GLView widget that allows GL rendering.
5350     *
5351     * Signals that you can add callbacks for are:
5352     *
5353     * @{
5354     */
5355
5356    /**
5357     * Add a new glview to the parent
5358     *
5359     * @param parent The parent object
5360     * @return The new object or NULL if it cannot be created
5361     *
5362     * @ingroup GLView
5363     */
5364    EAPI Evas_Object     *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5365
5366    /**
5367     * Sets the size of the glview
5368     *
5369     * @param obj The glview object
5370     * @param width width of the glview object
5371     * @param height height of the glview object
5372     *
5373     * @ingroup GLView
5374     */
5375    EAPI void             elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5376
5377    /**
5378     * Gets the size of the glview.
5379     *
5380     * @param obj The glview object
5381     * @param width width of the glview object
5382     * @param height height of the glview object
5383     *
5384     * Note that this function returns the actual image size of the
5385     * glview.  This means that when the scale policy is set to
5386     * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5387     * size.
5388     *
5389     * @ingroup GLView
5390     */
5391    EAPI void             elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5392
5393    /**
5394     * Gets the gl api struct for gl rendering
5395     *
5396     * @param obj The glview object
5397     * @return The api object or NULL if it cannot be created
5398     *
5399     * @ingroup GLView
5400     */
5401    EAPI Evas_GL_API     *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5402
5403    /**
5404     * Set the mode of the GLView. Supports Three simple modes.
5405     *
5406     * @param obj The glview object
5407     * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5408     * @return True if set properly.
5409     *
5410     * @ingroup GLView
5411     */
5412    EAPI Eina_Bool        elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5413
5414    /**
5415     * Set the resize policy for the glview object.
5416     *
5417     * @param obj The glview object.
5418     * @param policy The scaling policy.
5419     *
5420     * By default, the resize policy is set to
5421     * ELM_GLVIEW_RESIZE_POLICY_RECREATE.  When resize is called it
5422     * destroys the previous surface and recreates the newly specified
5423     * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5424     * however, glview only scales the image object and not the underlying
5425     * GL Surface.
5426     *
5427     * @ingroup GLView
5428     */
5429    EAPI Eina_Bool        elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5430
5431    /**
5432     * Set the render policy for the glview object.
5433     *
5434     * @param obj The glview object.
5435     * @param policy The render policy.
5436     *
5437     * By default, the render policy is set to
5438     * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND.  This policy is set such
5439     * that during the render loop, glview is only redrawn if it needs
5440     * to be redrawn. (i.e. When it is visible) If the policy is set to
5441     * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5442     * whether it is visible/need redrawing or not.
5443     *
5444     * @ingroup GLView
5445     */
5446    EAPI Eina_Bool        elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5447
5448    /**
5449     * Set the init function that runs once in the main loop.
5450     *
5451     * @param obj The glview object.
5452     * @param func The init function to be registered.
5453     *
5454     * The registered init function gets called once during the render loop.
5455     *
5456     * @ingroup GLView
5457     */
5458    EAPI void             elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5459
5460    /**
5461     * Set the render function that runs in the main loop.
5462     *
5463     * @param obj The glview object.
5464     * @param func The delete function to be registered.
5465     *
5466     * The registered del function gets called when GLView object is deleted.
5467     *
5468     * @ingroup GLView
5469     */
5470    EAPI void             elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5471
5472    /**
5473     * Set the resize function that gets called when resize happens.
5474     *
5475     * @param obj The glview object.
5476     * @param func The resize function to be registered.
5477     *
5478     * @ingroup GLView
5479     */
5480    EAPI void             elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5481
5482    /**
5483     * Set the render function that runs in the main loop.
5484     *
5485     * @param obj The glview object.
5486     * @param func The render function to be registered.
5487     *
5488     * @ingroup GLView
5489     */
5490    EAPI void             elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5491
5492    /**
5493     * Notifies that there has been changes in the GLView.
5494     *
5495     * @param obj The glview object.
5496     *
5497     * @ingroup GLView
5498     */
5499    EAPI void             elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5500
5501    /**
5502     * @}
5503     */
5504
5505    /* box */
5506    /**
5507     * @defgroup Box Box
5508     *
5509     * @image html img/widget/box/preview-00.png
5510     * @image latex img/widget/box/preview-00.eps width=\textwidth
5511     *
5512     * @image html img/box.png
5513     * @image latex img/box.eps width=\textwidth
5514     *
5515     * A box arranges objects in a linear fashion, governed by a layout function
5516     * that defines the details of this arrangement.
5517     *
5518     * By default, the box will use an internal function to set the layout to
5519     * a single row, either vertical or horizontal. This layout is affected
5520     * by a number of parameters, such as the homogeneous flag set by
5521     * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5522     * elm_box_align_set() and the hints set to each object in the box.
5523     *
5524     * For this default layout, it's possible to change the orientation with
5525     * elm_box_horizontal_set(). The box will start in the vertical orientation,
5526     * placing its elements ordered from top to bottom. When horizontal is set,
5527     * the order will go from left to right. If the box is set to be
5528     * homogeneous, every object in it will be assigned the same space, that
5529     * of the largest object. Padding can be used to set some spacing between
5530     * the cell given to each object. The alignment of the box, set with
5531     * elm_box_align_set(), determines how the bounding box of all the elements
5532     * will be placed within the space given to the box widget itself.
5533     *
5534     * The size hints of each object also affect how they are placed and sized
5535     * within the box. evas_object_size_hint_min_set() will give the minimum
5536     * size the object can have, and the box will use it as the basis for all
5537     * latter calculations. Elementary widgets set their own minimum size as
5538     * needed, so there's rarely any need to use it manually.
5539     *
5540     * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5541     * used to tell whether the object will be allocated the minimum size it
5542     * needs or if the space given to it should be expanded. It's important
5543     * to realize that expanding the size given to the object is not the same
5544     * thing as resizing the object. It could very well end being a small
5545     * widget floating in a much larger empty space. If not set, the weight
5546     * for objects will normally be 0.0 for both axis, meaning the widget will
5547     * not be expanded. To take as much space possible, set the weight to
5548     * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5549     *
5550     * Besides how much space each object is allocated, it's possible to control
5551     * how the widget will be placed within that space using
5552     * evas_object_size_hint_align_set(). By default, this value will be 0.5
5553     * for both axis, meaning the object will be centered, but any value from
5554     * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5555     * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5556     * is -1.0, means the object will be resized to fill the entire space it
5557     * was allocated.
5558     *
5559     * In addition, customized functions to define the layout can be set, which
5560     * allow the application developer to organize the objects within the box
5561     * in any number of ways.
5562     *
5563     * The special elm_box_layout_transition() function can be used
5564     * to switch from one layout to another, animating the motion of the
5565     * children of the box.
5566     *
5567     * @note Objects should not be added to box objects using _add() calls.
5568     *
5569     * Some examples on how to use boxes follow:
5570     * @li @ref box_example_01
5571     * @li @ref box_example_02
5572     *
5573     * @{
5574     */
5575    /**
5576     * @typedef Elm_Box_Transition
5577     *
5578     * Opaque handler containing the parameters to perform an animated
5579     * transition of the layout the box uses.
5580     *
5581     * @see elm_box_transition_new()
5582     * @see elm_box_layout_set()
5583     * @see elm_box_layout_transition()
5584     */
5585    typedef struct _Elm_Box_Transition Elm_Box_Transition;
5586
5587    /**
5588     * Add a new box to the parent
5589     *
5590     * By default, the box will be in vertical mode and non-homogeneous.
5591     *
5592     * @param parent The parent object
5593     * @return The new object or NULL if it cannot be created
5594     */
5595    EAPI Evas_Object        *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5596    /**
5597     * Set the horizontal orientation
5598     *
5599     * By default, box object arranges their contents vertically from top to
5600     * bottom.
5601     * By calling this function with @p horizontal as EINA_TRUE, the box will
5602     * become horizontal, arranging contents from left to right.
5603     *
5604     * @note This flag is ignored if a custom layout function is set.
5605     *
5606     * @param obj The box object
5607     * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5608     * EINA_FALSE = vertical)
5609     */
5610    EAPI void                elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5611    /**
5612     * Get the horizontal orientation
5613     *
5614     * @param obj The box object
5615     * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5616     */
5617    EAPI Eina_Bool           elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5618    /**
5619     * Set the box to arrange its children homogeneously
5620     *
5621     * If enabled, homogeneous layout makes all items the same size, according
5622     * to the size of the largest of its children.
5623     *
5624     * @note This flag is ignored if a custom layout function is set.
5625     *
5626     * @param obj The box object
5627     * @param homogeneous The homogeneous flag
5628     */
5629    EAPI void                elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5630    /**
5631     * Get whether the box is using homogeneous mode or not
5632     *
5633     * @param obj The box object
5634     * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5635     */
5636    EAPI Eina_Bool           elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5637    EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5638    EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5639    /**
5640     * Add an object to the beginning of the pack list
5641     *
5642     * Pack @p subobj into the box @p obj, placing it first in the list of
5643     * children objects. The actual position the object will get on screen
5644     * depends on the layout used. If no custom layout is set, it will be at
5645     * the top or left, depending if the box is vertical or horizontal,
5646     * respectively.
5647     *
5648     * @param obj The box object
5649     * @param subobj The object to add to the box
5650     *
5651     * @see elm_box_pack_end()
5652     * @see elm_box_pack_before()
5653     * @see elm_box_pack_after()
5654     * @see elm_box_unpack()
5655     * @see elm_box_unpack_all()
5656     * @see elm_box_clear()
5657     */
5658    EAPI void                elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5659    /**
5660     * Add an object at the end of the pack list
5661     *
5662     * Pack @p subobj into the box @p obj, placing it last in the list of
5663     * children objects. The actual position the object will get on screen
5664     * depends on the layout used. If no custom layout is set, it will be at
5665     * the bottom or right, depending if the box is vertical or horizontal,
5666     * respectively.
5667     *
5668     * @param obj The box object
5669     * @param subobj The object to add to the box
5670     *
5671     * @see elm_box_pack_start()
5672     * @see elm_box_pack_before()
5673     * @see elm_box_pack_after()
5674     * @see elm_box_unpack()
5675     * @see elm_box_unpack_all()
5676     * @see elm_box_clear()
5677     */
5678    EAPI void                elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5679    /**
5680     * Adds an object to the box before the indicated object
5681     *
5682     * This will add the @p subobj to the box indicated before the object
5683     * indicated with @p before. If @p before is not already in the box, results
5684     * are undefined. Before means either to the left of the indicated object or
5685     * above it depending on orientation.
5686     *
5687     * @param obj The box object
5688     * @param subobj The object to add to the box
5689     * @param before The object before which to add it
5690     *
5691     * @see elm_box_pack_start()
5692     * @see elm_box_pack_end()
5693     * @see elm_box_pack_after()
5694     * @see elm_box_unpack()
5695     * @see elm_box_unpack_all()
5696     * @see elm_box_clear()
5697     */
5698    EAPI void                elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5699    /**
5700     * Adds an object to the box after the indicated object
5701     *
5702     * This will add the @p subobj to the box indicated after the object
5703     * indicated with @p after. If @p after is not already in the box, results
5704     * are undefined. After means either to the right of the indicated object or
5705     * below it depending on orientation.
5706     *
5707     * @param obj The box object
5708     * @param subobj The object to add to the box
5709     * @param after The object after which to add it
5710     *
5711     * @see elm_box_pack_start()
5712     * @see elm_box_pack_end()
5713     * @see elm_box_pack_before()
5714     * @see elm_box_unpack()
5715     * @see elm_box_unpack_all()
5716     * @see elm_box_clear()
5717     */
5718    EAPI void                elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5719    /**
5720     * Clear the box of all children
5721     *
5722     * Remove all the elements contained by the box, deleting the respective
5723     * objects.
5724     *
5725     * @param obj The box object
5726     *
5727     * @see elm_box_unpack()
5728     * @see elm_box_unpack_all()
5729     */
5730    EAPI void                elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5731    /**
5732     * Unpack a box item
5733     *
5734     * Remove the object given by @p subobj from the box @p obj without
5735     * deleting it.
5736     *
5737     * @param obj The box object
5738     *
5739     * @see elm_box_unpack_all()
5740     * @see elm_box_clear()
5741     */
5742    EAPI void                elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5743    /**
5744     * Remove all items from the box, without deleting them
5745     *
5746     * Clear the box from all children, but don't delete the respective objects.
5747     * If no other references of the box children exist, the objects will never
5748     * be deleted, and thus the application will leak the memory. Make sure
5749     * when using this function that you hold a reference to all the objects
5750     * in the box @p obj.
5751     *
5752     * @param obj The box object
5753     *
5754     * @see elm_box_clear()
5755     * @see elm_box_unpack()
5756     */
5757    EAPI void                elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5758    /**
5759     * Retrieve a list of the objects packed into the box
5760     *
5761     * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5762     * The order of the list corresponds to the packing order the box uses.
5763     *
5764     * You must free this list with eina_list_free() once you are done with it.
5765     *
5766     * @param obj The box object
5767     */
5768    EAPI const Eina_List    *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5769    /**
5770     * Set the space (padding) between the box's elements.
5771     *
5772     * Extra space in pixels that will be added between a box child and its
5773     * neighbors after its containing cell has been calculated. This padding
5774     * is set for all elements in the box, besides any possible padding that
5775     * individual elements may have through their size hints.
5776     *
5777     * @param obj The box object
5778     * @param horizontal The horizontal space between elements
5779     * @param vertical The vertical space between elements
5780     */
5781    EAPI void                elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5782    /**
5783     * Get the space (padding) between the box's elements.
5784     *
5785     * @param obj The box object
5786     * @param horizontal The horizontal space between elements
5787     * @param vertical The vertical space between elements
5788     *
5789     * @see elm_box_padding_set()
5790     */
5791    EAPI void                elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5792    /**
5793     * Set the alignment of the whole bouding box of contents.
5794     *
5795     * Sets how the bounding box containing all the elements of the box, after
5796     * their sizes and position has been calculated, will be aligned within
5797     * the space given for the whole box widget.
5798     *
5799     * @param obj The box object
5800     * @param horizontal The horizontal alignment of elements
5801     * @param vertical The vertical alignment of elements
5802     */
5803    EAPI void                elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
5804    /**
5805     * Get the alignment of the whole bouding box of contents.
5806     *
5807     * @param obj The box object
5808     * @param horizontal The horizontal alignment of elements
5809     * @param vertical The vertical alignment of elements
5810     *
5811     * @see elm_box_align_set()
5812     */
5813    EAPI void                elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
5814
5815    /**
5816     * Set the layout defining function to be used by the box
5817     *
5818     * Whenever anything changes that requires the box in @p obj to recalculate
5819     * the size and position of its elements, the function @p cb will be called
5820     * to determine what the layout of the children will be.
5821     *
5822     * Once a custom function is set, everything about the children layout
5823     * is defined by it. The flags set by elm_box_horizontal_set() and
5824     * elm_box_homogeneous_set() no longer have any meaning, and the values
5825     * given by elm_box_padding_set() and elm_box_align_set() are up to this
5826     * layout function to decide if they are used and how. These last two
5827     * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
5828     * passed to @p cb. The @c Evas_Object the function receives is not the
5829     * Elementary widget, but the internal Evas Box it uses, so none of the
5830     * functions described here can be used on it.
5831     *
5832     * Any of the layout functions in @c Evas can be used here, as well as the
5833     * special elm_box_layout_transition().
5834     *
5835     * The final @p data argument received by @p cb is the same @p data passed
5836     * here, and the @p free_data function will be called to free it
5837     * whenever the box is destroyed or another layout function is set.
5838     *
5839     * Setting @p cb to NULL will revert back to the default layout function.
5840     *
5841     * @param obj The box object
5842     * @param cb The callback function used for layout
5843     * @param data Data that will be passed to layout function
5844     * @param free_data Function called to free @p data
5845     *
5846     * @see elm_box_layout_transition()
5847     */
5848    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);
5849    /**
5850     * Special layout function that animates the transition from one layout to another
5851     *
5852     * Normally, when switching the layout function for a box, this will be
5853     * reflected immediately on screen on the next render, but it's also
5854     * possible to do this through an animated transition.
5855     *
5856     * This is done by creating an ::Elm_Box_Transition and setting the box
5857     * layout to this function.
5858     *
5859     * For example:
5860     * @code
5861     * Elm_Box_Transition *t = elm_box_transition_new(1.0,
5862     *                            evas_object_box_layout_vertical, // start
5863     *                            NULL, // data for initial layout
5864     *                            NULL, // free function for initial data
5865     *                            evas_object_box_layout_horizontal, // end
5866     *                            NULL, // data for final layout
5867     *                            NULL, // free function for final data
5868     *                            anim_end, // will be called when animation ends
5869     *                            NULL); // data for anim_end function\
5870     * elm_box_layout_set(box, elm_box_layout_transition, t,
5871     *                    elm_box_transition_free);
5872     * @endcode
5873     *
5874     * @note This function can only be used with elm_box_layout_set(). Calling
5875     * it directly will not have the expected results.
5876     *
5877     * @see elm_box_transition_new
5878     * @see elm_box_transition_free
5879     * @see elm_box_layout_set
5880     */
5881    EAPI void                elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
5882    /**
5883     * Create a new ::Elm_Box_Transition to animate the switch of layouts
5884     *
5885     * If you want to animate the change from one layout to another, you need
5886     * to set the layout function of the box to elm_box_layout_transition(),
5887     * passing as user data to it an instance of ::Elm_Box_Transition with the
5888     * necessary information to perform this animation. The free function to
5889     * set for the layout is elm_box_transition_free().
5890     *
5891     * The parameters to create an ::Elm_Box_Transition sum up to how long
5892     * will it be, in seconds, a layout function to describe the initial point,
5893     * another for the final position of the children and one function to be
5894     * called when the whole animation ends. This last function is useful to
5895     * set the definitive layout for the box, usually the same as the end
5896     * layout for the animation, but could be used to start another transition.
5897     *
5898     * @param start_layout The layout function that will be used to start the animation
5899     * @param start_layout_data The data to be passed the @p start_layout function
5900     * @param start_layout_free_data Function to free @p start_layout_data
5901     * @param end_layout The layout function that will be used to end the animation
5902     * @param end_layout_free_data The data to be passed the @p end_layout function
5903     * @param end_layout_free_data Function to free @p end_layout_data
5904     * @param transition_end_cb Callback function called when animation ends
5905     * @param transition_end_data Data to be passed to @p transition_end_cb
5906     * @return An instance of ::Elm_Box_Transition
5907     *
5908     * @see elm_box_transition_new
5909     * @see elm_box_layout_transition
5910     */
5911    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);
5912    /**
5913     * Free a Elm_Box_Transition instance created with elm_box_transition_new().
5914     *
5915     * This function is mostly useful as the @c free_data parameter in
5916     * elm_box_layout_set() when elm_box_layout_transition().
5917     *
5918     * @param data The Elm_Box_Transition instance to be freed.
5919     *
5920     * @see elm_box_transition_new
5921     * @see elm_box_layout_transition
5922     */
5923    EAPI void                elm_box_transition_free(void *data);
5924    /**
5925     * @}
5926     */
5927
5928    /* button */
5929    /**
5930     * @defgroup Button Button
5931     *
5932     * @image html img/widget/button/preview-00.png
5933     * @image latex img/widget/button/preview-00.eps
5934     * @image html img/widget/button/preview-01.png
5935     * @image latex img/widget/button/preview-01.eps
5936     * @image html img/widget/button/preview-02.png
5937     * @image latex img/widget/button/preview-02.eps
5938     *
5939     * This is a push-button. Press it and run some function. It can contain
5940     * a simple label and icon object and it also has an autorepeat feature.
5941     *
5942     * This widgets emits the following signals:
5943     * @li "clicked": the user clicked the button (press/release).
5944     * @li "repeated": the user pressed the button without releasing it.
5945     * @li "pressed": button was pressed.
5946     * @li "unpressed": button was released after being pressed.
5947     * In all three cases, the @c event parameter of the callback will be
5948     * @c NULL.
5949     *
5950     * Also, defined in the default theme, the button has the following styles
5951     * available:
5952     * @li default: a normal button.
5953     * @li anchor: Like default, but the button fades away when the mouse is not
5954     * over it, leaving only the text or icon.
5955     * @li hoversel_vertical: Internally used by @ref Hoversel to give a
5956     * continuous look across its options.
5957     * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
5958     *
5959     * Follow through a complete example @ref button_example_01 "here".
5960     * @{
5961     */
5962    /**
5963     * Add a new button to the parent's canvas
5964     *
5965     * @param parent The parent object
5966     * @return The new object or NULL if it cannot be created
5967     */
5968    EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5969    /**
5970     * Set the label used in the button
5971     *
5972     * The passed @p label can be NULL to clean any existing text in it and
5973     * leave the button as an icon only object.
5974     *
5975     * @param obj The button object
5976     * @param label The text will be written on the button
5977     * @deprecated use elm_object_text_set() instead.
5978     */
5979    EINA_DEPRECATED EAPI void         elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5980    /**
5981     * Get the label set for the button
5982     *
5983     * The string returned is an internal pointer and should not be freed or
5984     * altered. It will also become invalid when the button is destroyed.
5985     * The string returned, if not NULL, is a stringshare, so if you need to
5986     * keep it around even after the button is destroyed, you can use
5987     * eina_stringshare_ref().
5988     *
5989     * @param obj The button object
5990     * @return The text set to the label, or NULL if nothing is set
5991     * @deprecated use elm_object_text_set() instead.
5992     */
5993    EINA_DEPRECATED EAPI const char  *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5994    /**
5995     * Set the icon used for the button
5996     *
5997     * Setting a new icon will delete any other that was previously set, making
5998     * any reference to them invalid. If you need to maintain the previous
5999     * object alive, unset it first with elm_button_icon_unset().
6000     *
6001     * @param obj The button object
6002     * @param icon The icon object for the button
6003     */
6004    EAPI void         elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6005    /**
6006     * Get the icon used for the button
6007     *
6008     * Return the icon object which is set for this widget. If the button is
6009     * destroyed or another icon is set, the returned object will be deleted
6010     * and any reference to it will be invalid.
6011     *
6012     * @param obj The button object
6013     * @return The icon object that is being used
6014     *
6015     * @see elm_button_icon_unset()
6016     */
6017    EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6018    /**
6019     * Remove the icon set without deleting it and return the object
6020     *
6021     * This function drops the reference the button holds of the icon object
6022     * and returns this last object. It is used in case you want to remove any
6023     * icon, or set another one, without deleting the actual object. The button
6024     * will be left without an icon set.
6025     *
6026     * @param obj The button object
6027     * @return The icon object that was being used
6028     */
6029    EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6030    /**
6031     * Turn on/off the autorepeat event generated when the button is kept pressed
6032     *
6033     * When off, no autorepeat is performed and buttons emit a normal @c clicked
6034     * signal when they are clicked.
6035     *
6036     * When on, keeping a button pressed will continuously emit a @c repeated
6037     * signal until the button is released. The time it takes until it starts
6038     * emitting the signal is given by
6039     * elm_button_autorepeat_initial_timeout_set(), and the time between each
6040     * new emission by elm_button_autorepeat_gap_timeout_set().
6041     *
6042     * @param obj The button object
6043     * @param on  A bool to turn on/off the event
6044     */
6045    EAPI void         elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6046    /**
6047     * Get whether the autorepeat feature is enabled
6048     *
6049     * @param obj The button object
6050     * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6051     *
6052     * @see elm_button_autorepeat_set()
6053     */
6054    EAPI Eina_Bool    elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6055    /**
6056     * Set the initial timeout before the autorepeat event is generated
6057     *
6058     * Sets the timeout, in seconds, since the button is pressed until the
6059     * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6060     * won't be any delay and the even will be fired the moment the button is
6061     * pressed.
6062     *
6063     * @param obj The button object
6064     * @param t   Timeout in seconds
6065     *
6066     * @see elm_button_autorepeat_set()
6067     * @see elm_button_autorepeat_gap_timeout_set()
6068     */
6069    EAPI void         elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6070    /**
6071     * Get the initial timeout before the autorepeat event is generated
6072     *
6073     * @param obj The button object
6074     * @return Timeout in seconds
6075     *
6076     * @see elm_button_autorepeat_initial_timeout_set()
6077     */
6078    EAPI double       elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6079    /**
6080     * Set the interval between each generated autorepeat event
6081     *
6082     * After the first @c repeated event is fired, all subsequent ones will
6083     * follow after a delay of @p t seconds for each.
6084     *
6085     * @param obj The button object
6086     * @param t   Interval in seconds
6087     *
6088     * @see elm_button_autorepeat_initial_timeout_set()
6089     */
6090    EAPI void         elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6091    /**
6092     * Get the interval between each generated autorepeat event
6093     *
6094     * @param obj The button object
6095     * @return Interval in seconds
6096     */
6097    EAPI double       elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6098    /**
6099     * @}
6100     */
6101
6102    /**
6103     * @defgroup File_Selector_Button File Selector Button
6104     *
6105     * @image html img/widget/fileselector_button/preview-00.png
6106     * @image latex img/widget/fileselector_button/preview-00.eps
6107     * @image html img/widget/fileselector_button/preview-01.png
6108     * @image latex img/widget/fileselector_button/preview-01.eps
6109     * @image html img/widget/fileselector_button/preview-02.png
6110     * @image latex img/widget/fileselector_button/preview-02.eps
6111     *
6112     * This is a button that, when clicked, creates an Elementary
6113     * window (or inner window) <b> with a @ref Fileselector "file
6114     * selector widget" within</b>. When a file is chosen, the (inner)
6115     * window is closed and the button emits a signal having the
6116     * selected file as it's @c event_info.
6117     *
6118     * This widget encapsulates operations on its internal file
6119     * selector on its own API. There is less control over its file
6120     * selector than that one would have instatiating one directly.
6121     *
6122     * The following styles are available for this button:
6123     * @li @c "default"
6124     * @li @c "anchor"
6125     * @li @c "hoversel_vertical"
6126     * @li @c "hoversel_vertical_entry"
6127     *
6128     * Smart callbacks one can register to:
6129     * - @c "file,chosen" - the user has selected a path, whose string
6130     *   pointer comes as the @c event_info data (a stringshared
6131     *   string)
6132     *
6133     * Here is an example on its usage:
6134     * @li @ref fileselector_button_example
6135     *
6136     * @see @ref File_Selector_Entry for a similar widget.
6137     * @{
6138     */
6139
6140    /**
6141     * Add a new file selector button widget to the given parent
6142     * Elementary (container) object
6143     *
6144     * @param parent The parent object
6145     * @return a new file selector button widget handle or @c NULL, on
6146     * errors
6147     */
6148    EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6149
6150    /**
6151     * Set the label for a given file selector button widget
6152     *
6153     * @param obj The file selector button widget
6154     * @param label The text label to be displayed on @p obj
6155     *
6156     * @deprecated use elm_object_text_set() instead.
6157     */
6158    EINA_DEPRECATED EAPI void         elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6159
6160    /**
6161     * Get the label set for a given file selector button widget
6162     *
6163     * @param obj The file selector button widget
6164     * @return The button label
6165     *
6166     * @deprecated use elm_object_text_set() instead.
6167     */
6168    EINA_DEPRECATED EAPI const char  *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6169
6170    /**
6171     * Set the icon on a given file selector button widget
6172     *
6173     * @param obj The file selector button widget
6174     * @param icon The icon object for the button
6175     *
6176     * Once the icon object is set, a previously set one will be
6177     * deleted. If you want to keep the latter, use the
6178     * elm_fileselector_button_icon_unset() function.
6179     *
6180     * @see elm_fileselector_button_icon_get()
6181     */
6182    EAPI void         elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6183
6184    /**
6185     * Get the icon set for a given file selector button widget
6186     *
6187     * @param obj The file selector button widget
6188     * @return The icon object currently set on @p obj or @c NULL, if
6189     * none is
6190     *
6191     * @see elm_fileselector_button_icon_set()
6192     */
6193    EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6194
6195    /**
6196     * Unset the icon used in a given file selector button widget
6197     *
6198     * @param obj The file selector button widget
6199     * @return The icon object that was being used on @p obj or @c
6200     * NULL, on errors
6201     *
6202     * Unparent and return the icon object which was set for this
6203     * widget.
6204     *
6205     * @see elm_fileselector_button_icon_set()
6206     */
6207    EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6208
6209    /**
6210     * Set the title for a given file selector button widget's window
6211     *
6212     * @param obj The file selector button widget
6213     * @param title The title string
6214     *
6215     * This will change the window's title, when the file selector pops
6216     * out after a click on the button. Those windows have the default
6217     * (unlocalized) value of @c "Select a file" as titles.
6218     *
6219     * @note It will only take any effect if the file selector
6220     * button widget is @b not under "inwin mode".
6221     *
6222     * @see elm_fileselector_button_window_title_get()
6223     */
6224    EAPI void         elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6225
6226    /**
6227     * Get the title set for a given file selector button widget's
6228     * window
6229     *
6230     * @param obj The file selector button widget
6231     * @return Title of the file selector button's window
6232     *
6233     * @see elm_fileselector_button_window_title_get() for more details
6234     */
6235    EAPI const char  *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6236
6237    /**
6238     * Set the size of a given file selector button widget's window,
6239     * holding the file selector itself.
6240     *
6241     * @param obj The file selector button widget
6242     * @param width The window's width
6243     * @param height The window's height
6244     *
6245     * @note it will only take any effect if the file selector button
6246     * widget is @b not under "inwin mode". The default size for the
6247     * window (when applicable) is 400x400 pixels.
6248     *
6249     * @see elm_fileselector_button_window_size_get()
6250     */
6251    EAPI void         elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6252
6253    /**
6254     * Get the size of a given file selector button widget's window,
6255     * holding the file selector itself.
6256     *
6257     * @param obj The file selector button widget
6258     * @param width Pointer into which to store the width value
6259     * @param height Pointer into which to store the height value
6260     *
6261     * @note Use @c NULL pointers on the size values you're not
6262     * interested in: they'll be ignored by the function.
6263     *
6264     * @see elm_fileselector_button_window_size_set(), for more details
6265     */
6266    EAPI void         elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6267
6268    /**
6269     * Set the initial file system path for a given file selector
6270     * button widget
6271     *
6272     * @param obj The file selector button widget
6273     * @param path The path string
6274     *
6275     * It must be a <b>directory</b> path, which will have the contents
6276     * displayed initially in the file selector's view, when invoked
6277     * from @p obj. The default initial path is the @c "HOME"
6278     * environment variable's value.
6279     *
6280     * @see elm_fileselector_button_path_get()
6281     */
6282    EAPI void         elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6283
6284    /**
6285     * Get the initial file system path set for a given file selector
6286     * button widget
6287     *
6288     * @param obj The file selector button widget
6289     * @return path The path string
6290     *
6291     * @see elm_fileselector_button_path_set() for more details
6292     */
6293    EAPI const char  *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6294
6295    /**
6296     * Enable/disable a tree view in the given file selector button
6297     * widget's internal file selector
6298     *
6299     * @param obj The file selector button widget
6300     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6301     * disable
6302     *
6303     * This has the same effect as elm_fileselector_expandable_set(),
6304     * but now applied to a file selector button's internal file
6305     * selector.
6306     *
6307     * @note There's no way to put a file selector button's internal
6308     * file selector in "grid mode", as one may do with "pure" file
6309     * selectors.
6310     *
6311     * @see elm_fileselector_expandable_get()
6312     */
6313    EAPI void         elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6314
6315    /**
6316     * Get whether tree view is enabled for the given file selector
6317     * button widget's internal file selector
6318     *
6319     * @param obj The file selector button widget
6320     * @return @c EINA_TRUE if @p obj widget's internal file selector
6321     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6322     *
6323     * @see elm_fileselector_expandable_set() for more details
6324     */
6325    EAPI Eina_Bool    elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6326
6327    /**
6328     * Set whether a given file selector button widget's internal file
6329     * selector is to display folders only or the directory contents,
6330     * as well.
6331     *
6332     * @param obj The file selector button widget
6333     * @param only @c EINA_TRUE to make @p obj widget's internal file
6334     * selector only display directories, @c EINA_FALSE to make files
6335     * to be displayed in it too
6336     *
6337     * This has the same effect as elm_fileselector_folder_only_set(),
6338     * but now applied to a file selector button's internal file
6339     * selector.
6340     *
6341     * @see elm_fileselector_folder_only_get()
6342     */
6343    EAPI void         elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6344
6345    /**
6346     * Get whether a given file selector button widget's internal file
6347     * selector is displaying folders only or the directory contents,
6348     * as well.
6349     *
6350     * @param obj The file selector button widget
6351     * @return @c EINA_TRUE if @p obj widget's internal file
6352     * selector is only displaying directories, @c EINA_FALSE if files
6353     * are being displayed in it too (and on errors)
6354     *
6355     * @see elm_fileselector_button_folder_only_set() for more details
6356     */
6357    EAPI Eina_Bool    elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6358
6359    /**
6360     * Enable/disable the file name entry box where the user can type
6361     * in a name for a file, in a given file selector button widget's
6362     * internal file selector.
6363     *
6364     * @param obj The file selector button widget
6365     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6366     * file selector a "saving dialog", @c EINA_FALSE otherwise
6367     *
6368     * This has the same effect as elm_fileselector_is_save_set(),
6369     * but now applied to a file selector button's internal file
6370     * selector.
6371     *
6372     * @see elm_fileselector_is_save_get()
6373     */
6374    EAPI void         elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6375
6376    /**
6377     * Get whether the given file selector button widget's internal
6378     * file selector is in "saving dialog" mode
6379     *
6380     * @param obj The file selector button widget
6381     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6382     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6383     * errors)
6384     *
6385     * @see elm_fileselector_button_is_save_set() for more details
6386     */
6387    EAPI Eina_Bool    elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6388
6389    /**
6390     * Set whether a given file selector button widget's internal file
6391     * selector will raise an Elementary "inner window", instead of a
6392     * dedicated Elementary window. By default, it won't.
6393     *
6394     * @param obj The file selector button widget
6395     * @param value @c EINA_TRUE to make it use an inner window, @c
6396     * EINA_TRUE to make it use a dedicated window
6397     *
6398     * @see elm_win_inwin_add() for more information on inner windows
6399     * @see elm_fileselector_button_inwin_mode_get()
6400     */
6401    EAPI void         elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6402
6403    /**
6404     * Get whether a given file selector button widget's internal file
6405     * selector will raise an Elementary "inner window", instead of a
6406     * dedicated Elementary window.
6407     *
6408     * @param obj The file selector button widget
6409     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6410     * if it will use a dedicated window
6411     *
6412     * @see elm_fileselector_button_inwin_mode_set() for more details
6413     */
6414    EAPI Eina_Bool    elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6415
6416    /**
6417     * @}
6418     */
6419
6420     /**
6421     * @defgroup File_Selector_Entry File Selector Entry
6422     *
6423     * @image html img/widget/fileselector_entry/preview-00.png
6424     * @image latex img/widget/fileselector_entry/preview-00.eps
6425     *
6426     * This is an entry made to be filled with or display a <b>file
6427     * system path string</b>. Besides the entry itself, the widget has
6428     * a @ref File_Selector_Button "file selector button" on its side,
6429     * which will raise an internal @ref Fileselector "file selector widget",
6430     * when clicked, for path selection aided by file system
6431     * navigation.
6432     *
6433     * This file selector may appear in an Elementary window or in an
6434     * inner window. When a file is chosen from it, the (inner) window
6435     * is closed and the selected file's path string is exposed both as
6436     * an smart event and as the new text on the entry.
6437     *
6438     * This widget encapsulates operations on its internal file
6439     * selector on its own API. There is less control over its file
6440     * selector than that one would have instatiating one directly.
6441     *
6442     * Smart callbacks one can register to:
6443     * - @c "changed" - The text within the entry was changed
6444     * - @c "activated" - The entry has had editing finished and
6445     *   changes are to be "committed"
6446     * - @c "press" - The entry has been clicked
6447     * - @c "longpressed" - The entry has been clicked (and held) for a
6448     *   couple seconds
6449     * - @c "clicked" - The entry has been clicked
6450     * - @c "clicked,double" - The entry has been double clicked
6451     * - @c "focused" - The entry has received focus
6452     * - @c "unfocused" - The entry has lost focus
6453     * - @c "selection,paste" - A paste action has occurred on the
6454     *   entry
6455     * - @c "selection,copy" - A copy action has occurred on the entry
6456     * - @c "selection,cut" - A cut action has occurred on the entry
6457     * - @c "unpressed" - The file selector entry's button was released
6458     *   after being pressed.
6459     * - @c "file,chosen" - The user has selected a path via the file
6460     *   selector entry's internal file selector, whose string pointer
6461     *   comes as the @c event_info data (a stringshared string)
6462     *
6463     * Here is an example on its usage:
6464     * @li @ref fileselector_entry_example
6465     *
6466     * @see @ref File_Selector_Button for a similar widget.
6467     * @{
6468     */
6469
6470    /**
6471     * Add a new file selector entry widget to the given parent
6472     * Elementary (container) object
6473     *
6474     * @param parent The parent object
6475     * @return a new file selector entry widget handle or @c NULL, on
6476     * errors
6477     */
6478    EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6479
6480    /**
6481     * Set the label for a given file selector entry widget's button
6482     *
6483     * @param obj The file selector entry widget
6484     * @param label The text label to be displayed on @p obj widget's
6485     * button
6486     *
6487     * @deprecated use elm_object_text_set() instead.
6488     */
6489    EINA_DEPRECATED EAPI void         elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6490
6491    /**
6492     * Get the label set for a given file selector entry widget's button
6493     *
6494     * @param obj The file selector entry widget
6495     * @return The widget button's label
6496     *
6497     * @deprecated use elm_object_text_set() instead.
6498     */
6499    EINA_DEPRECATED EAPI const char  *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6500
6501    /**
6502     * Set the icon on a given file selector entry widget's button
6503     *
6504     * @param obj The file selector entry widget
6505     * @param icon The icon object for the entry's button
6506     *
6507     * Once the icon object is set, a previously set one will be
6508     * deleted. If you want to keep the latter, use the
6509     * elm_fileselector_entry_button_icon_unset() function.
6510     *
6511     * @see elm_fileselector_entry_button_icon_get()
6512     */
6513    EAPI void         elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6514
6515    /**
6516     * Get the icon set for a given file selector entry widget's button
6517     *
6518     * @param obj The file selector entry widget
6519     * @return The icon object currently set on @p obj widget's button
6520     * or @c NULL, if none is
6521     *
6522     * @see elm_fileselector_entry_button_icon_set()
6523     */
6524    EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6525
6526    /**
6527     * Unset the icon used in a given file selector entry widget's
6528     * button
6529     *
6530     * @param obj The file selector entry widget
6531     * @return The icon object that was being used on @p obj widget's
6532     * button or @c NULL, on errors
6533     *
6534     * Unparent and return the icon object which was set for this
6535     * widget's button.
6536     *
6537     * @see elm_fileselector_entry_button_icon_set()
6538     */
6539    EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6540
6541    /**
6542     * Set the title for a given file selector entry widget's window
6543     *
6544     * @param obj The file selector entry widget
6545     * @param title The title string
6546     *
6547     * This will change the window's title, when the file selector pops
6548     * out after a click on the entry's button. Those windows have the
6549     * default (unlocalized) value of @c "Select a file" as titles.
6550     *
6551     * @note It will only take any effect if the file selector
6552     * entry widget is @b not under "inwin mode".
6553     *
6554     * @see elm_fileselector_entry_window_title_get()
6555     */
6556    EAPI void         elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6557
6558    /**
6559     * Get the title set for a given file selector entry widget's
6560     * window
6561     *
6562     * @param obj The file selector entry widget
6563     * @return Title of the file selector entry's window
6564     *
6565     * @see elm_fileselector_entry_window_title_get() for more details
6566     */
6567    EAPI const char  *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6568
6569    /**
6570     * Set the size of a given file selector entry widget's window,
6571     * holding the file selector itself.
6572     *
6573     * @param obj The file selector entry widget
6574     * @param width The window's width
6575     * @param height The window's height
6576     *
6577     * @note it will only take any effect if the file selector entry
6578     * widget is @b not under "inwin mode". The default size for the
6579     * window (when applicable) is 400x400 pixels.
6580     *
6581     * @see elm_fileselector_entry_window_size_get()
6582     */
6583    EAPI void         elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6584
6585    /**
6586     * Get the size of a given file selector entry widget's window,
6587     * holding the file selector itself.
6588     *
6589     * @param obj The file selector entry widget
6590     * @param width Pointer into which to store the width value
6591     * @param height Pointer into which to store the height value
6592     *
6593     * @note Use @c NULL pointers on the size values you're not
6594     * interested in: they'll be ignored by the function.
6595     *
6596     * @see elm_fileselector_entry_window_size_set(), for more details
6597     */
6598    EAPI void         elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6599
6600    /**
6601     * Set the initial file system path and the entry's path string for
6602     * a given file selector entry widget
6603     *
6604     * @param obj The file selector entry widget
6605     * @param path The path string
6606     *
6607     * It must be a <b>directory</b> path, which will have the contents
6608     * displayed initially in the file selector's view, when invoked
6609     * from @p obj. The default initial path is the @c "HOME"
6610     * environment variable's value.
6611     *
6612     * @see elm_fileselector_entry_path_get()
6613     */
6614    EAPI void         elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6615
6616    /**
6617     * Get the entry's path string for a given file selector entry
6618     * widget
6619     *
6620     * @param obj The file selector entry widget
6621     * @return path The path string
6622     *
6623     * @see elm_fileselector_entry_path_set() for more details
6624     */
6625    EAPI const char  *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6626
6627    /**
6628     * Enable/disable a tree view in the given file selector entry
6629     * widget's internal file selector
6630     *
6631     * @param obj The file selector entry widget
6632     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6633     * disable
6634     *
6635     * This has the same effect as elm_fileselector_expandable_set(),
6636     * but now applied to a file selector entry's internal file
6637     * selector.
6638     *
6639     * @note There's no way to put a file selector entry's internal
6640     * file selector in "grid mode", as one may do with "pure" file
6641     * selectors.
6642     *
6643     * @see elm_fileselector_expandable_get()
6644     */
6645    EAPI void         elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6646
6647    /**
6648     * Get whether tree view is enabled for the given file selector
6649     * entry widget's internal file selector
6650     *
6651     * @param obj The file selector entry widget
6652     * @return @c EINA_TRUE if @p obj widget's internal file selector
6653     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6654     *
6655     * @see elm_fileselector_expandable_set() for more details
6656     */
6657    EAPI Eina_Bool    elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6658
6659    /**
6660     * Set whether a given file selector entry widget's internal file
6661     * selector is to display folders only or the directory contents,
6662     * as well.
6663     *
6664     * @param obj The file selector entry widget
6665     * @param only @c EINA_TRUE to make @p obj widget's internal file
6666     * selector only display directories, @c EINA_FALSE to make files
6667     * to be displayed in it too
6668     *
6669     * This has the same effect as elm_fileselector_folder_only_set(),
6670     * but now applied to a file selector entry's internal file
6671     * selector.
6672     *
6673     * @see elm_fileselector_folder_only_get()
6674     */
6675    EAPI void         elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6676
6677    /**
6678     * Get whether a given file selector entry widget's internal file
6679     * selector is displaying folders only or the directory contents,
6680     * as well.
6681     *
6682     * @param obj The file selector entry widget
6683     * @return @c EINA_TRUE if @p obj widget's internal file
6684     * selector is only displaying directories, @c EINA_FALSE if files
6685     * are being displayed in it too (and on errors)
6686     *
6687     * @see elm_fileselector_entry_folder_only_set() for more details
6688     */
6689    EAPI Eina_Bool    elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6690
6691    /**
6692     * Enable/disable the file name entry box where the user can type
6693     * in a name for a file, in a given file selector entry widget's
6694     * internal file selector.
6695     *
6696     * @param obj The file selector entry widget
6697     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6698     * file selector a "saving dialog", @c EINA_FALSE otherwise
6699     *
6700     * This has the same effect as elm_fileselector_is_save_set(),
6701     * but now applied to a file selector entry's internal file
6702     * selector.
6703     *
6704     * @see elm_fileselector_is_save_get()
6705     */
6706    EAPI void         elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6707
6708    /**
6709     * Get whether the given file selector entry widget's internal
6710     * file selector is in "saving dialog" mode
6711     *
6712     * @param obj The file selector entry widget
6713     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6714     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6715     * errors)
6716     *
6717     * @see elm_fileselector_entry_is_save_set() for more details
6718     */
6719    EAPI Eina_Bool    elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6720
6721    /**
6722     * Set whether a given file selector entry widget's internal file
6723     * selector will raise an Elementary "inner window", instead of a
6724     * dedicated Elementary window. By default, it won't.
6725     *
6726     * @param obj The file selector entry widget
6727     * @param value @c EINA_TRUE to make it use an inner window, @c
6728     * EINA_TRUE to make it use a dedicated window
6729     *
6730     * @see elm_win_inwin_add() for more information on inner windows
6731     * @see elm_fileselector_entry_inwin_mode_get()
6732     */
6733    EAPI void         elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6734
6735    /**
6736     * Get whether a given file selector entry widget's internal file
6737     * selector will raise an Elementary "inner window", instead of a
6738     * dedicated Elementary window.
6739     *
6740     * @param obj The file selector entry widget
6741     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6742     * if it will use a dedicated window
6743     *
6744     * @see elm_fileselector_entry_inwin_mode_set() for more details
6745     */
6746    EAPI Eina_Bool    elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6747
6748    /**
6749     * Set the initial file system path for a given file selector entry
6750     * widget
6751     *
6752     * @param obj The file selector entry widget
6753     * @param path The path string
6754     *
6755     * It must be a <b>directory</b> path, which will have the contents
6756     * displayed initially in the file selector's view, when invoked
6757     * from @p obj. The default initial path is the @c "HOME"
6758     * environment variable's value.
6759     *
6760     * @see elm_fileselector_entry_path_get()
6761     */
6762    EAPI void         elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6763
6764    /**
6765     * Get the parent directory's path to the latest file selection on
6766     * a given filer selector entry widget
6767     *
6768     * @param obj The file selector object
6769     * @return The (full) path of the directory of the last selection
6770     * on @p obj widget, a @b stringshared string
6771     *
6772     * @see elm_fileselector_entry_path_set()
6773     */
6774    EAPI const char  *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6775
6776    /**
6777     * @}
6778     */
6779
6780    /**
6781     * @defgroup Scroller Scroller
6782     *
6783     * A scroller holds a single object and "scrolls it around". This means that
6784     * it allows the user to use a scrollbar (or a finger) to drag the viewable
6785     * region around, allowing to move through a much larger object that is
6786     * contained in the scroller. The scroiller will always have a small minimum
6787     * size by default as it won't be limited by the contents of the scroller.
6788     *
6789     * Signals that you can add callbacks for are:
6790     * @li "edge,left" - the left edge of the content has been reached
6791     * @li "edge,right" - the right edge of the content has been reached
6792     * @li "edge,top" - the top edge of the content has been reached
6793     * @li "edge,bottom" - the bottom edge of the content has been reached
6794     * @li "scroll" - the content has been scrolled (moved)
6795     * @li "scroll,anim,start" - scrolling animation has started
6796     * @li "scroll,anim,stop" - scrolling animation has stopped
6797     * @li "scroll,drag,start" - dragging the contents around has started
6798     * @li "scroll,drag,stop" - dragging the contents around has stopped
6799     * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
6800     * user intervetion.
6801     *
6802     * @note When Elemementary is in embedded mode the scrollbars will not be
6803     * dragable, they appear merely as indicators of how much has been scrolled.
6804     * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
6805     * fingerscroll) won't work.
6806     *
6807     * In @ref tutorial_scroller you'll find an example of how to use most of
6808     * this API.
6809     * @{
6810     */
6811    /**
6812     * @brief Type that controls when scrollbars should appear.
6813     *
6814     * @see elm_scroller_policy_set()
6815     */
6816    typedef enum _Elm_Scroller_Policy
6817      {
6818         ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
6819         ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
6820         ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
6821         ELM_SCROLLER_POLICY_LAST
6822      } Elm_Scroller_Policy;
6823    /**
6824     * @brief Add a new scroller to the parent
6825     *
6826     * @param parent The parent object
6827     * @return The new object or NULL if it cannot be created
6828     */
6829    EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6830    /**
6831     * @brief Set the content of the scroller widget (the object to be scrolled around).
6832     *
6833     * @param obj The scroller object
6834     * @param content The new content object
6835     *
6836     * Once the content object is set, a previously set one will be deleted.
6837     * If you want to keep that old content object, use the
6838     * elm_scroller_content_unset() function.
6839     */
6840    EAPI void         elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
6841    /**
6842     * @brief Get the content of the scroller widget
6843     *
6844     * @param obj The slider object
6845     * @return The content that is being used
6846     *
6847     * Return the content object which is set for this widget
6848     *
6849     * @see elm_scroller_content_set()
6850     */
6851    EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6852    /**
6853     * @brief Unset the content of the scroller widget
6854     *
6855     * @param obj The slider object
6856     * @return The content that was being used
6857     *
6858     * Unparent and return the content object which was set for this widget
6859     *
6860     * @see elm_scroller_content_set()
6861     */
6862    EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6863    /**
6864     * @brief Set custom theme elements for the scroller
6865     *
6866     * @param obj The scroller object
6867     * @param widget The widget name to use (default is "scroller")
6868     * @param base The base name to use (default is "base")
6869     */
6870    EAPI void         elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
6871    /**
6872     * @brief Make the scroller minimum size limited to the minimum size of the content
6873     *
6874     * @param obj The scroller object
6875     * @param w Enable limiting minimum size horizontally
6876     * @param h Enable limiting minimum size vertically
6877     *
6878     * By default the scroller will be as small as its design allows,
6879     * irrespective of its content. This will make the scroller minimum size the
6880     * right size horizontally and/or vertically to perfectly fit its content in
6881     * that direction.
6882     */
6883    EAPI void         elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
6884    /**
6885     * @brief Show a specific virtual region within the scroller content object
6886     *
6887     * @param obj The scroller object
6888     * @param x X coordinate of the region
6889     * @param y Y coordinate of the region
6890     * @param w Width of the region
6891     * @param h Height of the region
6892     *
6893     * This will ensure all (or part if it does not fit) of the designated
6894     * region in the virtual content object (0, 0 starting at the top-left of the
6895     * virtual content object) is shown within the scroller.
6896     */
6897    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);
6898    /**
6899     * @brief Set the scrollbar visibility policy
6900     *
6901     * @param obj The scroller object
6902     * @param policy_h Horizontal scrollbar policy
6903     * @param policy_v Vertical scrollbar policy
6904     *
6905     * This sets the scrollbar visibility policy for the given scroller.
6906     * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
6907     * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
6908     * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
6909     * respectively for the horizontal and vertical scrollbars.
6910     */
6911    EAPI void         elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
6912    /**
6913     * @brief Gets scrollbar visibility policy
6914     *
6915     * @param obj The scroller object
6916     * @param policy_h Horizontal scrollbar policy
6917     * @param policy_v Vertical scrollbar policy
6918     *
6919     * @see elm_scroller_policy_set()
6920     */
6921    EAPI void         elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
6922    /**
6923     * @brief Get the currently visible content region
6924     *
6925     * @param obj The scroller object
6926     * @param x X coordinate of the region
6927     * @param y Y coordinate of the region
6928     * @param w Width of the region
6929     * @param h Height of the region
6930     *
6931     * This gets the current region in the content object that is visible through
6932     * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
6933     * w, @p h values pointed to.
6934     *
6935     * @note All coordinates are relative to the content.
6936     *
6937     * @see elm_scroller_region_show()
6938     */
6939    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);
6940    /**
6941     * @brief Get the size of the content object
6942     *
6943     * @param obj The scroller object
6944     * @param w Width return
6945     * @param h Height return
6946     *
6947     * This gets the size of the content object of the scroller.
6948     */
6949    EAPI void         elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
6950    /**
6951     * @brief Set bouncing behavior
6952     *
6953     * @param obj The scroller object
6954     * @param h_bounce Will the scroller bounce horizontally or not
6955     * @param v_bounce Will the scroller bounce vertically or not
6956     *
6957     * When scrolling, the scroller may "bounce" when reaching an edge of the
6958     * content object. This is a visual way to indicate the end has been reached.
6959     * This is enabled by default for both axis. This will set if it is enabled
6960     * for that axis with the boolean parameters for each axis.
6961     */
6962    EAPI void         elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6963    /**
6964     * @brief Get the bounce mode
6965     *
6966     * @param obj The Scroller object
6967     * @param h_bounce Allow bounce horizontally
6968     * @param v_bounce Allow bounce vertically
6969     *
6970     * @see elm_scroller_bounce_set()
6971     */
6972    EAPI void         elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
6973    /**
6974     * @brief Set scroll page size relative to viewport size.
6975     *
6976     * @param obj The scroller object
6977     * @param h_pagerel The horizontal page relative size
6978     * @param v_pagerel The vertical page relative size
6979     *
6980     * The scroller is capable of limiting scrolling by the user to "pages". That
6981     * is to jump by and only show a "whole page" at a time as if the continuous
6982     * area of the scroller content is split into page sized pieces. This sets
6983     * the size of a page relative to the viewport of the scroller. 1.0 is "1
6984     * viewport" is size (horizontally or vertically). 0.0 turns it off in that
6985     * axis. This is mutually exclusive with page size
6986     * (see elm_scroller_page_size_set()  for more information). Likewise 0.5
6987     * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
6988     * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
6989     * the other axis.
6990     */
6991    EAPI void         elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
6992    /**
6993     * @brief Set scroll page size.
6994     *
6995     * @param obj The scroller object
6996     * @param h_pagesize The horizontal page size
6997     * @param v_pagesize The vertical page size
6998     *
6999     * This sets the page size to an absolute fixed value, with 0 turning it off
7000     * for that axis.
7001     *
7002     * @see elm_scroller_page_relative_set()
7003     */
7004    EAPI void         elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7005    /**
7006     * @brief Get scroll current page number.
7007     *
7008     * @param obj The scroller object
7009     * @param h_pagenumber The horizoptal page number
7010     * @param v_pagenumber The vertical page number
7011     *
7012     * The page number starts from 0. 0 is the first page.
7013     * Current page means the page which meet the top-left of the viewport.
7014     * If there are two or more pages in the viewport, it returns the number of page
7015     * which meet the top-left of the viewport.
7016     *
7017     * @see elm_scroller_last_page_get()
7018     * @see elm_scroller_page_show()
7019     * @see elm_scroller_page_brint_in()
7020     */
7021    EAPI void         elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7022    /**
7023     * @brief Get scroll last page number.
7024     *
7025     * @param obj The scroller object
7026     * @param h_pagenumber The horizoptal page number
7027     * @param v_pagenumber The vertical page number
7028     *
7029     * The page number starts from 0. 0 is the first page.
7030     * This returns the last page number among the pages.
7031     *
7032     * @see elm_scroller_current_page_get()
7033     * @see elm_scroller_page_show()
7034     * @see elm_scroller_page_brint_in()
7035     */
7036    EAPI void         elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7037    /**
7038     * Show a specific virtual region within the scroller content object by page number.
7039     *
7040     * @param obj The scroller object
7041     * @param h_pagenumber The horizoptal page number
7042     * @param v_pagenumber The vertical page number
7043     *
7044     * 0, 0 of the indicated page is located at the top-left of the viewport.
7045     * This will jump to the page directly without animation.
7046     *
7047     * Example of usage:
7048     *
7049     * @code
7050     * sc = elm_scroller_add(win);
7051     * elm_scroller_content_set(sc, content);
7052     * elm_scroller_page_relative_set(sc, 1, 0);
7053     * elm_scroller_current_page_get(sc, &h_page, &v_page);
7054     * elm_scroller_page_show(sc, h_page + 1, v_page);
7055     * @endcode
7056     *
7057     * @see elm_scroller_page_bring_in()
7058     */
7059    EAPI void         elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7060    /**
7061     * Show a specific virtual region within the scroller content object by page number.
7062     *
7063     * @param obj The scroller object
7064     * @param h_pagenumber The horizoptal page number
7065     * @param v_pagenumber The vertical page number
7066     *
7067     * 0, 0 of the indicated page is located at the top-left of the viewport.
7068     * This will slide to the page with animation.
7069     *
7070     * Example of usage:
7071     *
7072     * @code
7073     * sc = elm_scroller_add(win);
7074     * elm_scroller_content_set(sc, content);
7075     * elm_scroller_page_relative_set(sc, 1, 0);
7076     * elm_scroller_last_page_get(sc, &h_page, &v_page);
7077     * elm_scroller_page_bring_in(sc, h_page, v_page);
7078     * @endcode
7079     *
7080     * @see elm_scroller_page_show()
7081     */
7082    EAPI void         elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7083    /**
7084     * @brief Show a specific virtual region within the scroller content object.
7085     *
7086     * @param obj The scroller object
7087     * @param x X coordinate of the region
7088     * @param y Y coordinate of the region
7089     * @param w Width of the region
7090     * @param h Height of the region
7091     *
7092     * This will ensure all (or part if it does not fit) of the designated
7093     * region in the virtual content object (0, 0 starting at the top-left of the
7094     * virtual content object) is shown within the scroller. Unlike
7095     * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7096     * to this location (if configuration in general calls for transitions). It
7097     * may not jump immediately to the new location and make take a while and
7098     * show other content along the way.
7099     *
7100     * @see elm_scroller_region_show()
7101     */
7102    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);
7103    /**
7104     * @brief Set event propagation on a scroller
7105     *
7106     * @param obj The scroller object
7107     * @param propagation If propagation is enabled or not
7108     *
7109     * This enables or disabled event propagation from the scroller content to
7110     * the scroller and its parent. By default event propagation is disabled.
7111     */
7112    EAPI void         elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
7113    /**
7114     * @brief Get event propagation for a scroller
7115     *
7116     * @param obj The scroller object
7117     * @return The propagation state
7118     *
7119     * This gets the event propagation for a scroller.
7120     *
7121     * @see elm_scroller_propagate_events_set()
7122     */
7123    EAPI Eina_Bool    elm_scroller_propagate_events_get(const Evas_Object *obj);
7124    /**
7125     * @}
7126     */
7127
7128    /**
7129     * @defgroup Label Label
7130     *
7131     * @image html img/widget/label/preview-00.png
7132     * @image latex img/widget/label/preview-00.eps
7133     *
7134     * @brief Widget to display text, with simple html-like markup.
7135     *
7136     * The Label widget @b doesn't allow text to overflow its boundaries, if the
7137     * text doesn't fit the geometry of the label it will be ellipsized or be
7138     * cut. Elementary provides several themes for this widget:
7139     * @li default - No animation
7140     * @li marker - Centers the text in the label and make it bold by default
7141     * @li slide_long - The entire text appears from the right of the screen and
7142     * slides until it disappears in the left of the screen(reappering on the
7143     * right again).
7144     * @li slide_short - The text appears in the left of the label and slides to
7145     * the right to show the overflow. When all of the text has been shown the
7146     * position is reset.
7147     * @li slide_bounce - The text appears in the left of the label and slides to
7148     * the right to show the overflow. When all of the text has been shown the
7149     * animation reverses, moving the text to the left.
7150     *
7151     * Custom themes can of course invent new markup tags and style them any way
7152     * they like.
7153     *
7154     * See @ref tutorial_label for a demonstration of how to use a label widget.
7155     * @{
7156     */
7157    /**
7158     * @brief Add a new label to the parent
7159     *
7160     * @param parent The parent object
7161     * @return The new object or NULL if it cannot be created
7162     */
7163    EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7164    /**
7165     * @brief Set the label on the label object
7166     *
7167     * @param obj The label object
7168     * @param label The label will be used on the label object
7169     * @deprecated See elm_object_text_set()
7170     */
7171    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 */
7172    /**
7173     * @brief Get the label used on the label object
7174     *
7175     * @param obj The label object
7176     * @return The string inside the label
7177     * @deprecated See elm_object_text_get()
7178     */
7179    EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7180    /**
7181     * @brief Set the wrapping behavior of the label
7182     *
7183     * @param obj The label object
7184     * @param wrap To wrap text or not
7185     *
7186     * By default no wrapping is done. Possible values for @p wrap are:
7187     * @li ELM_WRAP_NONE - No wrapping
7188     * @li ELM_WRAP_CHAR - wrap between characters
7189     * @li ELM_WRAP_WORD - wrap between words
7190     * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7191     */
7192    EAPI void         elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7193    /**
7194     * @brief Get the wrapping behavior of the label
7195     *
7196     * @param obj The label object
7197     * @return Wrap type
7198     *
7199     * @see elm_label_line_wrap_set()
7200     */
7201    EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7202    /**
7203     * @brief Set wrap width of the label
7204     *
7205     * @param obj The label object
7206     * @param w The wrap width in pixels at a minimum where words need to wrap
7207     *
7208     * This function sets the maximum width size hint of the label.
7209     *
7210     * @warning This is only relevant if the label is inside a container.
7211     */
7212    EAPI void         elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7213    /**
7214     * @brief Get wrap width of the label
7215     *
7216     * @param obj The label object
7217     * @return The wrap width in pixels at a minimum where words need to wrap
7218     *
7219     * @see elm_label_wrap_width_set()
7220     */
7221    EAPI Evas_Coord   elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7222    /**
7223     * @brief Set wrap height of the label
7224     *
7225     * @param obj The label object
7226     * @param h The wrap height in pixels at a minimum where words need to wrap
7227     *
7228     * This function sets the maximum height size hint of the label.
7229     *
7230     * @warning This is only relevant if the label is inside a container.
7231     */
7232    EAPI void         elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7233    /**
7234     * @brief get wrap width of the label
7235     *
7236     * @param obj The label object
7237     * @return The wrap height in pixels at a minimum where words need to wrap
7238     */
7239    EAPI Evas_Coord   elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7240    /**
7241     * @brief Set the font size on the label object.
7242     *
7243     * @param obj The label object
7244     * @param size font size
7245     *
7246     * @warning NEVER use this. It is for hyper-special cases only. use styles
7247     * instead. e.g. "big", "medium", "small" - or better name them by use:
7248     * "title", "footnote", "quote" etc.
7249     */
7250    EAPI void         elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7251    /**
7252     * @brief Set the text color on the label object
7253     *
7254     * @param obj The label object
7255     * @param r Red property background color of The label object
7256     * @param g Green property background color of The label object
7257     * @param b Blue property background color of The label object
7258     * @param a Alpha property background color of The label object
7259     *
7260     * @warning NEVER use this. It is for hyper-special cases only. use styles
7261     * instead. e.g. "big", "medium", "small" - or better name them by use:
7262     * "title", "footnote", "quote" etc.
7263     */
7264    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);
7265    /**
7266     * @brief Set the text align on the label object
7267     *
7268     * @param obj The label object
7269     * @param align align mode ("left", "center", "right")
7270     *
7271     * @warning NEVER use this. It is for hyper-special cases only. use styles
7272     * instead. e.g. "big", "medium", "small" - or better name them by use:
7273     * "title", "footnote", "quote" etc.
7274     */
7275    EAPI void         elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7276    /**
7277     * @brief Set background color of the label
7278     *
7279     * @param obj The label object
7280     * @param r Red property background color of The label object
7281     * @param g Green property background color of The label object
7282     * @param b Blue property background color of The label object
7283     * @param a Alpha property background alpha of The label object
7284     *
7285     * @warning NEVER use this. It is for hyper-special cases only. use styles
7286     * instead. e.g. "big", "medium", "small" - or better name them by use:
7287     * "title", "footnote", "quote" etc.
7288     */
7289    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);
7290    /**
7291     * @brief Set the ellipsis behavior of the label
7292     *
7293     * @param obj The label object
7294     * @param ellipsis To ellipsis text or not
7295     *
7296     * If set to true and the text doesn't fit in the label an ellipsis("...")
7297     * will be shown at the end of the widget.
7298     *
7299     * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7300     * choosen wrap method was ELM_WRAP_WORD.
7301     */
7302    EAPI void         elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7303    /**
7304     * @brief Set the text slide of the label
7305     *
7306     * @param obj The label object
7307     * @param slide To start slide or stop
7308     *
7309     * If set to true the text of the label will slide throught the length of
7310     * label.
7311     *
7312     * @warning This only work with the themes "slide_short", "slide_long" and
7313     * "slide_bounce".
7314     */
7315    EAPI void         elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7316    /**
7317     * @brief Get the text slide mode of the label
7318     *
7319     * @param obj The label object
7320     * @return slide slide mode value
7321     *
7322     * @see elm_label_slide_set()
7323     */
7324    EAPI Eina_Bool    elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7325    /**
7326     * @brief Set the slide duration(speed) of the label
7327     *
7328     * @param obj The label object
7329     * @return The duration in seconds in moving text from slide begin position
7330     * to slide end position
7331     */
7332    EAPI void         elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7333    /**
7334     * @brief Get the slide duration(speed) of the label
7335     *
7336     * @param obj The label object
7337     * @return The duration time in moving text from slide begin position to slide end position
7338     *
7339     * @see elm_label_slide_duration_set()
7340     */
7341    EAPI double       elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7342    /**
7343     * @}
7344     */
7345
7346    /**
7347     * @defgroup Toggle Toggle
7348     *
7349     * @image html img/widget/toggle/preview-00.png
7350     * @image latex img/widget/toggle/preview-00.eps
7351     *
7352     * @brief A toggle is a slider which can be used to toggle between
7353     * two values.  It has two states: on and off.
7354     *
7355     * Signals that you can add callbacks for are:
7356     * @li "changed" - Whenever the toggle value has been changed.  Is not called
7357     *                 until the toggle is released by the cursor (assuming it
7358     *                 has been triggered by the cursor in the first place).
7359     *
7360     * @ref tutorial_toggle show how to use a toggle.
7361     * @{
7362     */
7363    /**
7364     * @brief Add a toggle to @p parent.
7365     *
7366     * @param parent The parent object
7367     *
7368     * @return The toggle object
7369     */
7370    EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7371    /**
7372     * @brief Sets the label to be displayed with the toggle.
7373     *
7374     * @param obj The toggle object
7375     * @param label The label to be displayed
7376     *
7377     * @deprecated use elm_object_text_set() instead.
7378     */
7379    EINA_DEPRECATED EAPI void         elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7380    /**
7381     * @brief Gets the label of the toggle
7382     *
7383     * @param obj  toggle object
7384     * @return The label of the toggle
7385     *
7386     * @deprecated use elm_object_text_get() instead.
7387     */
7388    EINA_DEPRECATED EAPI const char  *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7389    /**
7390     * @brief Set the icon used for the toggle
7391     *
7392     * @param obj The toggle object
7393     * @param icon The icon object for the button
7394     *
7395     * Once the icon object is set, a previously set one will be deleted
7396     * If you want to keep that old content object, use the
7397     * elm_toggle_icon_unset() function.
7398     */
7399    EAPI void         elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7400    /**
7401     * @brief Get the icon used for the toggle
7402     *
7403     * @param obj The toggle object
7404     * @return The icon object that is being used
7405     *
7406     * Return the icon object which is set for this widget.
7407     *
7408     * @see elm_toggle_icon_set()
7409     */
7410    EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7411    /**
7412     * @brief Unset the icon used for the toggle
7413     *
7414     * @param obj The toggle object
7415     * @return The icon object that was being used
7416     *
7417     * Unparent and return the icon object which was set for this widget.
7418     *
7419     * @see elm_toggle_icon_set()
7420     */
7421    EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7422    /**
7423     * @brief Sets the labels to be associated with the on and off states of the toggle.
7424     *
7425     * @param obj The toggle object
7426     * @param onlabel The label displayed when the toggle is in the "on" state
7427     * @param offlabel The label displayed when the toggle is in the "off" state
7428     */
7429    EAPI void         elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7430    /**
7431     * @brief Gets the labels associated with the on and off states of the toggle.
7432     *
7433     * @param obj The toggle object
7434     * @param onlabel A char** to place the onlabel of @p obj into
7435     * @param offlabel A char** to place the offlabel of @p obj into
7436     */
7437    EAPI void         elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7438    /**
7439     * @brief Sets the state of the toggle to @p state.
7440     *
7441     * @param obj The toggle object
7442     * @param state The state of @p obj
7443     */
7444    EAPI void         elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7445    /**
7446     * @brief Gets the state of the toggle to @p state.
7447     *
7448     * @param obj The toggle object
7449     * @return The state of @p obj
7450     */
7451    EAPI Eina_Bool    elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7452    /**
7453     * @brief Sets the state pointer of the toggle to @p statep.
7454     *
7455     * @param obj The toggle object
7456     * @param statep The state pointer of @p obj
7457     */
7458    EAPI void         elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7459    /**
7460     * @}
7461     */
7462
7463    /**
7464     * @defgroup Frame Frame
7465     *
7466     * @image html img/widget/frame/preview-00.png
7467     * @image latex img/widget/frame/preview-00.eps
7468     *
7469     * @brief Frame is a widget that holds some content and has a title.
7470     *
7471     * The default look is a frame with a title, but Frame supports multple
7472     * styles:
7473     * @li default
7474     * @li pad_small
7475     * @li pad_medium
7476     * @li pad_large
7477     * @li pad_huge
7478     * @li outdent_top
7479     * @li outdent_bottom
7480     *
7481     * Of all this styles only default shows the title. Frame emits no signals.
7482     *
7483     * For a detailed example see the @ref tutorial_frame.
7484     *
7485     * @{
7486     */
7487    /**
7488     * @brief Add a new frame to the parent
7489     *
7490     * @param parent The parent object
7491     * @return The new object or NULL if it cannot be created
7492     */
7493    EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7494    /**
7495     * @brief Set the frame label
7496     *
7497     * @param obj The frame object
7498     * @param label The label of this frame object
7499     *
7500     * @deprecated use elm_object_text_set() instead.
7501     */
7502    EINA_DEPRECATED EAPI void         elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7503    /**
7504     * @brief Get the frame label
7505     *
7506     * @param obj The frame object
7507     *
7508     * @return The label of this frame objet or NULL if unable to get frame
7509     *
7510     * @deprecated use elm_object_text_get() instead.
7511     */
7512    EINA_DEPRECATED EAPI const char  *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7513    /**
7514     * @brief Set the content of the frame widget
7515     *
7516     * Once the content object is set, a previously set one will be deleted.
7517     * If you want to keep that old content object, use the
7518     * elm_frame_content_unset() function.
7519     *
7520     * @param obj The frame object
7521     * @param content The content will be filled in this frame object
7522     */
7523    EAPI void         elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7524    /**
7525     * @brief Get the content of the frame widget
7526     *
7527     * Return the content object which is set for this widget
7528     *
7529     * @param obj The frame object
7530     * @return The content that is being used
7531     */
7532    EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7533    /**
7534     * @brief Unset the content of the frame widget
7535     *
7536     * Unparent and return the content object which was set for this widget
7537     *
7538     * @param obj The frame object
7539     * @return The content that was being used
7540     */
7541    EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7542    /**
7543     * @}
7544     */
7545
7546    /**
7547     * @defgroup Table Table
7548     *
7549     * A container widget to arrange other widgets in a table where items can
7550     * also span multiple columns or rows - even overlap (and then be raised or
7551     * lowered accordingly to adjust stacking if they do overlap).
7552     *
7553     * The followin are examples of how to use a table:
7554     * @li @ref tutorial_table_01
7555     * @li @ref tutorial_table_02
7556     *
7557     * @{
7558     */
7559    /**
7560     * @brief Add a new table to the parent
7561     *
7562     * @param parent The parent object
7563     * @return The new object or NULL if it cannot be created
7564     */
7565    EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7566    /**
7567     * @brief Set the homogeneous layout in the table
7568     *
7569     * @param obj The layout object
7570     * @param homogeneous A boolean to set if the layout is homogeneous in the
7571     * table (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7572     */
7573    EAPI void         elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7574    /**
7575     * @brief Get the current table homogeneous mode.
7576     *
7577     * @param obj The table object
7578     * @return A boolean to indicating if the layout is homogeneous in the table
7579     * (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7580     */
7581    EAPI Eina_Bool    elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7582    /**
7583     * @warning <b>Use elm_table_homogeneous_set() instead</b>
7584     */
7585    EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7586    /**
7587     * @warning <b>Use elm_table_homogeneous_get() instead</b>
7588     */
7589    EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7590    /**
7591     * @brief Set padding between cells.
7592     *
7593     * @param obj The layout object.
7594     * @param horizontal set the horizontal padding.
7595     * @param vertical set the vertical padding.
7596     *
7597     * Default value is 0.
7598     */
7599    EAPI void         elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7600    /**
7601     * @brief Get padding between cells.
7602     *
7603     * @param obj The layout object.
7604     * @param horizontal set the horizontal padding.
7605     * @param vertical set the vertical padding.
7606     */
7607    EAPI void         elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7608    /**
7609     * @brief Add a subobject on the table with the coordinates passed
7610     *
7611     * @param obj The table object
7612     * @param subobj The subobject to be added to the table
7613     * @param x Row number
7614     * @param y Column number
7615     * @param w rowspan
7616     * @param h colspan
7617     *
7618     * @note All positioning inside the table is relative to rows and columns, so
7619     * a value of 0 for x and y, means the top left cell of the table, and a
7620     * value of 1 for w and h means @p subobj only takes that 1 cell.
7621     */
7622    EAPI void         elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7623    /**
7624     * @brief Remove child from table.
7625     *
7626     * @param obj The table object
7627     * @param subobj The subobject
7628     */
7629    EAPI void         elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7630    /**
7631     * @brief Faster way to remove all child objects from a table object.
7632     *
7633     * @param obj The table object
7634     * @param clear If true, will delete children, else just remove from table.
7635     */
7636    EAPI void         elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7637    /**
7638     * @brief Set the packing location of an existing child of the table
7639     *
7640     * @param subobj The subobject to be modified in the table
7641     * @param x Row number
7642     * @param y Column number
7643     * @param w rowspan
7644     * @param h colspan
7645     *
7646     * Modifies the position of an object already in the table.
7647     *
7648     * @note All positioning inside the table is relative to rows and columns, so
7649     * a value of 0 for x and y, means the top left cell of the table, and a
7650     * value of 1 for w and h means @p subobj only takes that 1 cell.
7651     */
7652    EAPI void         elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7653    /**
7654     * @brief Get the packing location of an existing child of the table
7655     *
7656     * @param subobj The subobject to be modified in the table
7657     * @param x Row number
7658     * @param y Column number
7659     * @param w rowspan
7660     * @param h colspan
7661     *
7662     * @see elm_table_pack_set()
7663     */
7664    EAPI void         elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7665    /**
7666     * @}
7667     */
7668
7669    /**
7670     * @defgroup Gengrid Gengrid (Generic grid)
7671     *
7672     * This widget aims to position objects in a grid layout while
7673     * actually creating and rendering only the visible ones, using the
7674     * same idea as the @ref Genlist "genlist": the user defines a @b
7675     * class for each item, specifying functions that will be called at
7676     * object creation, deletion, etc. When those items are selected by
7677     * the user, a callback function is issued. Users may interact with
7678     * a gengrid via the mouse (by clicking on items to select them and
7679     * clicking on the grid's viewport and swiping to pan the whole
7680     * view) or via the keyboard, navigating through item with the
7681     * arrow keys.
7682     *
7683     * @section Gengrid_Layouts Gengrid layouts
7684     *
7685     * Gengrids may layout its items in one of two possible layouts:
7686     * - horizontal or
7687     * - vertical.
7688     *
7689     * When in "horizontal mode", items will be placed in @b columns,
7690     * from top to bottom and, when the space for a column is filled,
7691     * another one is started on the right, thus expanding the grid
7692     * horizontally, making for horizontal scrolling. When in "vertical
7693     * mode" , though, items will be placed in @b rows, from left to
7694     * right and, when the space for a row is filled, another one is
7695     * started below, thus expanding the grid vertically (and making
7696     * for vertical scrolling).
7697     *
7698     * @section Gengrid_Items Gengrid items
7699     *
7700     * An item in a gengrid can have 0 or more text labels (they can be
7701     * regular text or textblock Evas objects - that's up to the style
7702     * to determine), 0 or more icons (which are simply objects
7703     * swallowed into the gengrid item's theming Edje object) and 0 or
7704     * more <b>boolean states</b>, which have the behavior left to the
7705     * user to define. The Edje part names for each of these properties
7706     * will be looked up, in the theme file for the gengrid, under the
7707     * Edje (string) data items named @c "labels", @c "icons" and @c
7708     * "states", respectively. For each of those properties, if more
7709     * than one part is provided, they must have names listed separated
7710     * by spaces in the data fields. For the default gengrid item
7711     * theme, we have @b one label part (@c "elm.text"), @b two icon
7712     * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
7713     * no state parts.
7714     *
7715     * A gengrid item may be at one of several styles. Elementary
7716     * provides one by default - "default", but this can be extended by
7717     * system or application custom themes/overlays/extensions (see
7718     * @ref Theme "themes" for more details).
7719     *
7720     * @section Gengrid_Item_Class Gengrid item classes
7721     *
7722     * In order to have the ability to add and delete items on the fly,
7723     * gengrid implements a class (callback) system where the
7724     * application provides a structure with information about that
7725     * type of item (gengrid may contain multiple different items with
7726     * different classes, states and styles). Gengrid will call the
7727     * functions in this struct (methods) when an item is "realized"
7728     * (i.e., created dynamically, while the user is scrolling the
7729     * grid). All objects will simply be deleted when no longer needed
7730     * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
7731     * contains the following members:
7732     * - @c item_style - This is a constant string and simply defines
7733     * the name of the item style. It @b must be specified and the
7734     * default should be @c "default".
7735     * - @c func.label_get - This function is called when an item
7736     * object is actually created. The @c data parameter will point to
7737     * the same data passed to elm_gengrid_item_append() and related
7738     * item creation functions. The @c obj parameter is the gengrid
7739     * object itself, while the @c part one is the name string of one
7740     * of the existing text parts in the Edje group implementing the
7741     * item's theme. This function @b must return a strdup'()ed string,
7742     * as the caller will free() it when done. See
7743     * #Elm_Gengrid_Item_Label_Get_Cb.
7744     * - @c func.icon_get - This function is called when an item object
7745     * is actually created. The @c data parameter will point to the
7746     * same data passed to elm_gengrid_item_append() and related item
7747     * creation functions. The @c obj parameter is the gengrid object
7748     * itself, while the @c part one is the name string of one of the
7749     * existing (icon) swallow parts in the Edje group implementing the
7750     * item's theme. It must return @c NULL, when no icon is desired,
7751     * or a valid object handle, otherwise. The object will be deleted
7752     * by the gengrid on its deletion or when the item is "unrealized".
7753     * See #Elm_Gengrid_Item_Icon_Get_Cb.
7754     * - @c func.state_get - This function is called when an item
7755     * object is actually created. The @c data parameter will point to
7756     * the same data passed to elm_gengrid_item_append() and related
7757     * item creation functions. The @c obj parameter is the gengrid
7758     * object itself, while the @c part one is the name string of one
7759     * of the state parts in the Edje group implementing the item's
7760     * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
7761     * true/on. Gengrids will emit a signal to its theming Edje object
7762     * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
7763     * "source" arguments, respectively, when the state is true (the
7764     * default is false), where @c XXX is the name of the (state) part.
7765     * See #Elm_Gengrid_Item_State_Get_Cb.
7766     * - @c func.del - This is called when elm_gengrid_item_del() is
7767     * called on an item or elm_gengrid_clear() is called on the
7768     * gengrid. This is intended for use when gengrid items are
7769     * deleted, so any data attached to the item (e.g. its data
7770     * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
7771     *
7772     * @section Gengrid_Usage_Hints Usage hints
7773     *
7774     * If the user wants to have multiple items selected at the same
7775     * time, elm_gengrid_multi_select_set() will permit it. If the
7776     * gengrid is single-selection only (the default), then
7777     * elm_gengrid_select_item_get() will return the selected item or
7778     * @c NULL, if none is selected. If the gengrid is under
7779     * multi-selection, then elm_gengrid_selected_items_get() will
7780     * return a list (that is only valid as long as no items are
7781     * modified (added, deleted, selected or unselected) of child items
7782     * on a gengrid.
7783     *
7784     * If an item changes (internal (boolean) state, label or icon
7785     * changes), then use elm_gengrid_item_update() to have gengrid
7786     * update the item with the new state. A gengrid will re-"realize"
7787     * the item, thus calling the functions in the
7788     * #Elm_Gengrid_Item_Class set for that item.
7789     *
7790     * To programmatically (un)select an item, use
7791     * elm_gengrid_item_selected_set(). To get its selected state use
7792     * elm_gengrid_item_selected_get(). To make an item disabled
7793     * (unable to be selected and appear differently) use
7794     * elm_gengrid_item_disabled_set() to set this and
7795     * elm_gengrid_item_disabled_get() to get the disabled state.
7796     *
7797     * Grid cells will only have their selection smart callbacks called
7798     * when firstly getting selected. Any further clicks will do
7799     * nothing, unless you enable the "always select mode", with
7800     * elm_gengrid_always_select_mode_set(), thus making every click to
7801     * issue selection callbacks. elm_gengrid_no_select_mode_set() will
7802     * turn off the ability to select items entirely in the widget and
7803     * they will neither appear selected nor call the selection smart
7804     * callbacks.
7805     *
7806     * Remember that you can create new styles and add your own theme
7807     * augmentation per application with elm_theme_extension_add(). If
7808     * you absolutely must have a specific style that overrides any
7809     * theme the user or system sets up you can use
7810     * elm_theme_overlay_add() to add such a file.
7811     *
7812     * @section Gengrid_Smart_Events Gengrid smart events
7813     *
7814     * Smart events that you can add callbacks for are:
7815     * - @c "activated" - The user has double-clicked or pressed
7816     *   (enter|return|spacebar) on an item. The @c event_info parameter
7817     *   is the gengrid item that was activated.
7818     * - @c "clicked,double" - The user has double-clicked an item.
7819     *   The @c event_info parameter is the gengrid item that was double-clicked.
7820     * - @c "selected" - The user has made an item selected. The
7821     *   @c event_info parameter is the gengrid item that was selected.
7822     * - @c "unselected" - The user has made an item unselected. The
7823     *   @c event_info parameter is the gengrid item that was unselected.
7824     * - @c "realized" - This is called when the item in the gengrid
7825     *   has its implementing Evas object instantiated, de facto. @c
7826     *   event_info is the gengrid item that was created. The object
7827     *   may be deleted at any time, so it is highly advised to the
7828     *   caller @b not to use the object pointer returned from
7829     *   elm_gengrid_item_object_get(), because it may point to freed
7830     *   objects.
7831     * - @c "unrealized" - This is called when the implementing Evas
7832     *   object for this item is deleted. @c event_info is the gengrid
7833     *   item that was deleted.
7834     * - @c "changed" - Called when an item is added, removed, resized
7835     *   or moved and when the gengrid is resized or gets "horizontal"
7836     *   property changes.
7837     * - @c "scroll,anim,start" - This is called when scrolling animation has
7838     *   started.
7839     * - @c "scroll,anim,stop" - This is called when scrolling animation has
7840     *   stopped.
7841     * - @c "drag,start,up" - Called when the item in the gengrid has
7842     *   been dragged (not scrolled) up.
7843     * - @c "drag,start,down" - Called when the item in the gengrid has
7844     *   been dragged (not scrolled) down.
7845     * - @c "drag,start,left" - Called when the item in the gengrid has
7846     *   been dragged (not scrolled) left.
7847     * - @c "drag,start,right" - Called when the item in the gengrid has
7848     *   been dragged (not scrolled) right.
7849     * - @c "drag,stop" - Called when the item in the gengrid has
7850     *   stopped being dragged.
7851     * - @c "drag" - Called when the item in the gengrid is being
7852     *   dragged.
7853     * - @c "scroll" - called when the content has been scrolled
7854     *   (moved).
7855     * - @c "scroll,drag,start" - called when dragging the content has
7856     *   started.
7857     * - @c "scroll,drag,stop" - called when dragging the content has
7858     *   stopped.
7859     *
7860     * List of gendrid examples:
7861     * @li @ref gengrid_example
7862     */
7863
7864    /**
7865     * @addtogroup Gengrid
7866     * @{
7867     */
7868
7869    typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
7870    typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
7871    typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
7872    typedef char        *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
7873    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. */
7874    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. */
7875    typedef void         (*Elm_Gengrid_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
7876
7877    typedef char        *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Label_Get_Cb. */
7878    typedef Evas_Object *(*GridItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Icon_Get_Cb. */
7879    typedef Eina_Bool    (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_State_Get_Cb. */
7880    typedef void         (*GridItemDelFunc)      (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Del_Cb. */
7881
7882    /**
7883     * @struct _Elm_Gengrid_Item_Class
7884     *
7885     * Gengrid item class definition. See @ref Gengrid_Item_Class for
7886     * field details.
7887     */
7888    struct _Elm_Gengrid_Item_Class
7889      {
7890         const char             *item_style;
7891         struct _Elm_Gengrid_Item_Class_Func
7892           {
7893              Elm_Gengrid_Item_Label_Get_Cb label_get;
7894              Elm_Gengrid_Item_Icon_Get_Cb  icon_get;
7895              Elm_Gengrid_Item_State_Get_Cb state_get;
7896              Elm_Gengrid_Item_Del_Cb       del;
7897           } func;
7898      }; /**< #Elm_Gengrid_Item_Class member definitions */
7899
7900    /**
7901     * Add a new gengrid widget to the given parent Elementary
7902     * (container) object
7903     *
7904     * @param parent The parent object
7905     * @return a new gengrid widget handle or @c NULL, on errors
7906     *
7907     * This function inserts a new gengrid widget on the canvas.
7908     *
7909     * @see elm_gengrid_item_size_set()
7910     * @see elm_gengrid_horizontal_set()
7911     * @see elm_gengrid_item_append()
7912     * @see elm_gengrid_item_del()
7913     * @see elm_gengrid_clear()
7914     *
7915     * @ingroup Gengrid
7916     */
7917    EAPI Evas_Object       *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7918
7919    /**
7920     * Set the size for the items of a given gengrid widget
7921     *
7922     * @param obj The gengrid object.
7923     * @param w The items' width.
7924     * @param h The items' height;
7925     *
7926     * A gengrid, after creation, has still no information on the size
7927     * to give to each of its cells. So, you most probably will end up
7928     * with squares one @ref Fingers "finger" wide, the default
7929     * size. Use this function to force a custom size for you items,
7930     * making them as big as you wish.
7931     *
7932     * @see elm_gengrid_item_size_get()
7933     *
7934     * @ingroup Gengrid
7935     */
7936    EAPI void               elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
7937
7938    /**
7939     * Get the size set for the items of a given gengrid widget
7940     *
7941     * @param obj The gengrid object.
7942     * @param w Pointer to a variable where to store the items' width.
7943     * @param h Pointer to a variable where to store the items' height.
7944     *
7945     * @note Use @c NULL pointers on the size values you're not
7946     * interested in: they'll be ignored by the function.
7947     *
7948     * @see elm_gengrid_item_size_get() for more details
7949     *
7950     * @ingroup Gengrid
7951     */
7952    EAPI void               elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7953
7954    /**
7955     * Set the items grid's alignment within a given gengrid widget
7956     *
7957     * @param obj The gengrid object.
7958     * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
7959     * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
7960     *
7961     * This sets the alignment of the whole grid of items of a gengrid
7962     * within its given viewport. By default, those values are both
7963     * 0.5, meaning that the gengrid will have its items grid placed
7964     * exactly in the middle of its viewport.
7965     *
7966     * @note If given alignment values are out of the cited ranges,
7967     * they'll be changed to the nearest boundary values on the valid
7968     * ranges.
7969     *
7970     * @see elm_gengrid_align_get()
7971     *
7972     * @ingroup Gengrid
7973     */
7974    EAPI void               elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
7975
7976    /**
7977     * Get the items grid's alignment values within a given gengrid
7978     * widget
7979     *
7980     * @param obj The gengrid object.
7981     * @param align_x Pointer to a variable where to store the
7982     * horizontal alignment.
7983     * @param align_y Pointer to a variable where to store the vertical
7984     * alignment.
7985     *
7986     * @note Use @c NULL pointers on the alignment values you're not
7987     * interested in: they'll be ignored by the function.
7988     *
7989     * @see elm_gengrid_align_set() for more details
7990     *
7991     * @ingroup Gengrid
7992     */
7993    EAPI void               elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
7994
7995    /**
7996     * Set whether a given gengrid widget is or not able have items
7997     * @b reordered
7998     *
7999     * @param obj The gengrid object
8000     * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8001     * @c EINA_FALSE to turn it off
8002     *
8003     * If a gengrid is set to allow reordering, a click held for more
8004     * than 0.5 over a given item will highlight it specially,
8005     * signalling the gengrid has entered the reordering state. From
8006     * that time on, the user will be able to, while still holding the
8007     * mouse button down, move the item freely in the gengrid's
8008     * viewport, replacing to said item to the locations it goes to.
8009     * The replacements will be animated and, whenever the user
8010     * releases the mouse button, the item being replaced gets a new
8011     * definitive place in the grid.
8012     *
8013     * @see elm_gengrid_reorder_mode_get()
8014     *
8015     * @ingroup Gengrid
8016     */
8017    EAPI void               elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8018
8019    /**
8020     * Get whether a given gengrid widget is or not able have items
8021     * @b reordered
8022     *
8023     * @param obj The gengrid object
8024     * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8025     * off
8026     *
8027     * @see elm_gengrid_reorder_mode_set() for more details
8028     *
8029     * @ingroup Gengrid
8030     */
8031    EAPI Eina_Bool          elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8032
8033    /**
8034     * Append a new item in a given gengrid widget.
8035     *
8036     * @param obj The gengrid object.
8037     * @param gic The item class for the item.
8038     * @param data The item data.
8039     * @param func Convenience function called when the item is
8040     * selected.
8041     * @param func_data Data to be passed to @p func.
8042     * @return A handle to the item added or @c NULL, on errors.
8043     *
8044     * This adds an item to the beginning of the gengrid.
8045     *
8046     * @see elm_gengrid_item_prepend()
8047     * @see elm_gengrid_item_insert_before()
8048     * @see elm_gengrid_item_insert_after()
8049     * @see elm_gengrid_item_del()
8050     *
8051     * @ingroup Gengrid
8052     */
8053    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);
8054
8055    /**
8056     * Prepend a new item in a given gengrid widget.
8057     *
8058     * @param obj The gengrid object.
8059     * @param gic The item class for the item.
8060     * @param data The item data.
8061     * @param func Convenience function called when the item is
8062     * selected.
8063     * @param func_data Data to be passed to @p func.
8064     * @return A handle to the item added or @c NULL, on errors.
8065     *
8066     * This adds an item to the end of the gengrid.
8067     *
8068     * @see elm_gengrid_item_append()
8069     * @see elm_gengrid_item_insert_before()
8070     * @see elm_gengrid_item_insert_after()
8071     * @see elm_gengrid_item_del()
8072     *
8073     * @ingroup Gengrid
8074     */
8075    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);
8076
8077    /**
8078     * Insert an item before another in a gengrid widget
8079     *
8080     * @param obj The gengrid object.
8081     * @param gic The item class for the item.
8082     * @param data The item data.
8083     * @param relative The item to place this new one before.
8084     * @param func Convenience function called when the item is
8085     * selected.
8086     * @param func_data Data to be passed to @p func.
8087     * @return A handle to the item added or @c NULL, on errors.
8088     *
8089     * This inserts an item before another in the gengrid.
8090     *
8091     * @see elm_gengrid_item_append()
8092     * @see elm_gengrid_item_prepend()
8093     * @see elm_gengrid_item_insert_after()
8094     * @see elm_gengrid_item_del()
8095     *
8096     * @ingroup Gengrid
8097     */
8098    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);
8099
8100    /**
8101     * Insert an item after another in a gengrid widget
8102     *
8103     * @param obj The gengrid object.
8104     * @param gic The item class for the item.
8105     * @param data The item data.
8106     * @param relative The item to place this new one after.
8107     * @param func Convenience function called when the item is
8108     * selected.
8109     * @param func_data Data to be passed to @p func.
8110     * @return A handle to the item added or @c NULL, on errors.
8111     *
8112     * This inserts an item after another in the gengrid.
8113     *
8114     * @see elm_gengrid_item_append()
8115     * @see elm_gengrid_item_prepend()
8116     * @see elm_gengrid_item_insert_after()
8117     * @see elm_gengrid_item_del()
8118     *
8119     * @ingroup Gengrid
8120     */
8121    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);
8122
8123    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);
8124
8125    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);
8126
8127    /**
8128     * Set whether items on a given gengrid widget are to get their
8129     * selection callbacks issued for @b every subsequent selection
8130     * click on them or just for the first click.
8131     *
8132     * @param obj The gengrid object
8133     * @param always_select @c EINA_TRUE to make items "always
8134     * selected", @c EINA_FALSE, otherwise
8135     *
8136     * By default, grid items will only call their selection callback
8137     * function when firstly getting selected, any subsequent further
8138     * clicks will do nothing. With this call, you make those
8139     * subsequent clicks also to issue the selection callbacks.
8140     *
8141     * @note <b>Double clicks</b> will @b always be reported on items.
8142     *
8143     * @see elm_gengrid_always_select_mode_get()
8144     *
8145     * @ingroup Gengrid
8146     */
8147    EAPI void               elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8148
8149    /**
8150     * Get whether items on a given gengrid widget have their selection
8151     * callbacks issued for @b every subsequent selection click on them
8152     * or just for the first click.
8153     *
8154     * @param obj The gengrid object.
8155     * @return @c EINA_TRUE if the gengrid items are "always selected",
8156     * @c EINA_FALSE, otherwise
8157     *
8158     * @see elm_gengrid_always_select_mode_set() for more details
8159     *
8160     * @ingroup Gengrid
8161     */
8162    EAPI Eina_Bool          elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8163
8164    /**
8165     * Set whether items on a given gengrid widget can be selected or not.
8166     *
8167     * @param obj The gengrid object
8168     * @param no_select @c EINA_TRUE to make items selectable,
8169     * @c EINA_FALSE otherwise
8170     *
8171     * This will make items in @p obj selectable or not. In the latter
8172     * case, any user interacion on the gendrid items will neither make
8173     * them appear selected nor them call their selection callback
8174     * functions.
8175     *
8176     * @see elm_gengrid_no_select_mode_get()
8177     *
8178     * @ingroup Gengrid
8179     */
8180    EAPI void               elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8181
8182    /**
8183     * Get whether items on a given gengrid widget can be selected or
8184     * not.
8185     *
8186     * @param obj The gengrid object
8187     * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8188     * otherwise
8189     *
8190     * @see elm_gengrid_no_select_mode_set() for more details
8191     *
8192     * @ingroup Gengrid
8193     */
8194    EAPI Eina_Bool          elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8195
8196    /**
8197     * Enable or disable multi-selection in a given gengrid widget
8198     *
8199     * @param obj The gengrid object.
8200     * @param multi @c EINA_TRUE, to enable multi-selection,
8201     * @c EINA_FALSE to disable it.
8202     *
8203     * Multi-selection is the ability for one to have @b more than one
8204     * item selected, on a given gengrid, simultaneously. When it is
8205     * enabled, a sequence of clicks on different items will make them
8206     * all selected, progressively. A click on an already selected item
8207     * will unselect it. If interecting via the keyboard,
8208     * multi-selection is enabled while holding the "Shift" key.
8209     *
8210     * @note By default, multi-selection is @b disabled on gengrids
8211     *
8212     * @see elm_gengrid_multi_select_get()
8213     *
8214     * @ingroup Gengrid
8215     */
8216    EAPI void               elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8217
8218    /**
8219     * Get whether multi-selection is enabled or disabled for a given
8220     * gengrid widget
8221     *
8222     * @param obj The gengrid object.
8223     * @return @c EINA_TRUE, if multi-selection is enabled, @c
8224     * EINA_FALSE otherwise
8225     *
8226     * @see elm_gengrid_multi_select_set() for more details
8227     *
8228     * @ingroup Gengrid
8229     */
8230    EAPI Eina_Bool          elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8231
8232    /**
8233     * Enable or disable bouncing effect for a given gengrid widget
8234     *
8235     * @param obj The gengrid object
8236     * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8237     * @c EINA_FALSE to disable it
8238     * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8239     * @c EINA_FALSE to disable it
8240     *
8241     * The bouncing effect occurs whenever one reaches the gengrid's
8242     * edge's while panning it -- it will scroll past its limits a
8243     * little bit and return to the edge again, in a animated for,
8244     * automatically.
8245     *
8246     * @note By default, gengrids have bouncing enabled on both axis
8247     *
8248     * @see elm_gengrid_bounce_get()
8249     *
8250     * @ingroup Gengrid
8251     */
8252    EAPI void               elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8253
8254    /**
8255     * Get whether bouncing effects are enabled or disabled, for a
8256     * given gengrid widget, on each axis
8257     *
8258     * @param obj The gengrid object
8259     * @param h_bounce Pointer to a variable where to store the
8260     * horizontal bouncing flag.
8261     * @param v_bounce Pointer to a variable where to store the
8262     * vertical bouncing flag.
8263     *
8264     * @see elm_gengrid_bounce_set() for more details
8265     *
8266     * @ingroup Gengrid
8267     */
8268    EAPI void               elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8269
8270    /**
8271     * Set a given gengrid widget's scrolling page size, relative to
8272     * its viewport size.
8273     *
8274     * @param obj The gengrid object
8275     * @param h_pagerel The horizontal page (relative) size
8276     * @param v_pagerel The vertical page (relative) size
8277     *
8278     * The gengrid's scroller is capable of binding scrolling by the
8279     * user to "pages". It means that, while scrolling and, specially
8280     * after releasing the mouse button, the grid will @b snap to the
8281     * nearest displaying page's area. When page sizes are set, the
8282     * grid's continuous content area is split into (equal) page sized
8283     * pieces.
8284     *
8285     * This function sets the size of a page <b>relatively to the
8286     * viewport dimensions</b> of the gengrid, for each axis. A value
8287     * @c 1.0 means "the exact viewport's size", in that axis, while @c
8288     * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8289     * a viewport". Sane usable values are, than, between @c 0.0 and @c
8290     * 1.0. Values beyond those will make it behave behave
8291     * inconsistently. If you only want one axis to snap to pages, use
8292     * the value @c 0.0 for the other one.
8293     *
8294     * There is a function setting page size values in @b absolute
8295     * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8296     * is mutually exclusive to this one.
8297     *
8298     * @see elm_gengrid_page_relative_get()
8299     *
8300     * @ingroup Gengrid
8301     */
8302    EAPI void               elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8303
8304    /**
8305     * Get a given gengrid widget's scrolling page size, relative to
8306     * its viewport size.
8307     *
8308     * @param obj The gengrid object
8309     * @param h_pagerel Pointer to a variable where to store the
8310     * horizontal page (relative) size
8311     * @param v_pagerel Pointer to a variable where to store the
8312     * vertical page (relative) size
8313     *
8314     * @see elm_gengrid_page_relative_set() for more details
8315     *
8316     * @ingroup Gengrid
8317     */
8318    EAPI void               elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8319
8320    /**
8321     * Set a given gengrid widget's scrolling page size
8322     *
8323     * @param obj The gengrid object
8324     * @param h_pagerel The horizontal page size, in pixels
8325     * @param v_pagerel The vertical page size, in pixels
8326     *
8327     * The gengrid's scroller is capable of binding scrolling by the
8328     * user to "pages". It means that, while scrolling and, specially
8329     * after releasing the mouse button, the grid will @b snap to the
8330     * nearest displaying page's area. When page sizes are set, the
8331     * grid's continuous content area is split into (equal) page sized
8332     * pieces.
8333     *
8334     * This function sets the size of a page of the gengrid, in pixels,
8335     * for each axis. Sane usable values are, between @c 0 and the
8336     * dimensions of @p obj, for each axis. Values beyond those will
8337     * make it behave behave inconsistently. If you only want one axis
8338     * to snap to pages, use the value @c 0 for the other one.
8339     *
8340     * There is a function setting page size values in @b relative
8341     * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8342     * use is mutually exclusive to this one.
8343     *
8344     * @ingroup Gengrid
8345     */
8346    EAPI void               elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8347
8348    /**
8349     * Set for what direction a given gengrid widget will expand while
8350     * placing its items.
8351     *
8352     * @param obj The gengrid object.
8353     * @param setting @c EINA_TRUE to make the gengrid expand
8354     * horizontally, @c EINA_FALSE to expand vertically.
8355     *
8356     * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8357     * in @b columns, from top to bottom and, when the space for a
8358     * column is filled, another one is started on the right, thus
8359     * expanding the grid horizontally. When in "vertical mode"
8360     * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8361     * to right and, when the space for a row is filled, another one is
8362     * started below, thus expanding the grid vertically.
8363     *
8364     * @see elm_gengrid_horizontal_get()
8365     *
8366     * @ingroup Gengrid
8367     */
8368    EAPI void               elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8369
8370    /**
8371     * Get for what direction a given gengrid widget will expand while
8372     * placing its items.
8373     *
8374     * @param obj The gengrid object.
8375     * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8376     * @c EINA_FALSE if it's set to expand vertically.
8377     *
8378     * @see elm_gengrid_horizontal_set() for more detais
8379     *
8380     * @ingroup Gengrid
8381     */
8382    EAPI Eina_Bool          elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8383
8384    /**
8385     * Get the first item in a given gengrid widget
8386     *
8387     * @param obj The gengrid object
8388     * @return The first item's handle or @c NULL, if there are no
8389     * items in @p obj (and on errors)
8390     *
8391     * This returns the first item in the @p obj's internal list of
8392     * items.
8393     *
8394     * @see elm_gengrid_last_item_get()
8395     *
8396     * @ingroup Gengrid
8397     */
8398    EAPI Elm_Gengrid_Item  *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8399
8400    /**
8401     * Get the last item in a given gengrid widget
8402     *
8403     * @param obj The gengrid object
8404     * @return The last item's handle or @c NULL, if there are no
8405     * items in @p obj (and on errors)
8406     *
8407     * This returns the last item in the @p obj's internal list of
8408     * items.
8409     *
8410     * @see elm_gengrid_first_item_get()
8411     *
8412     * @ingroup Gengrid
8413     */
8414    EAPI Elm_Gengrid_Item  *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8415
8416    /**
8417     * Get the @b next item in a gengrid widget's internal list of items,
8418     * given a handle to one of those items.
8419     *
8420     * @param item The gengrid item to fetch next from
8421     * @return The item after @p item, or @c NULL if there's none (and
8422     * on errors)
8423     *
8424     * This returns the item placed after the @p item, on the container
8425     * gengrid.
8426     *
8427     * @see elm_gengrid_item_prev_get()
8428     *
8429     * @ingroup Gengrid
8430     */
8431    EAPI Elm_Gengrid_Item  *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8432
8433    /**
8434     * Get the @b previous item in a gengrid widget's internal list of items,
8435     * given a handle to one of those items.
8436     *
8437     * @param item The gengrid item to fetch previous from
8438     * @return The item before @p item, or @c NULL if there's none (and
8439     * on errors)
8440     *
8441     * This returns the item placed before the @p item, on the container
8442     * gengrid.
8443     *
8444     * @see elm_gengrid_item_next_get()
8445     *
8446     * @ingroup Gengrid
8447     */
8448    EAPI Elm_Gengrid_Item  *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8449
8450    /**
8451     * Get the gengrid object's handle which contains a given gengrid
8452     * item
8453     *
8454     * @param item The item to fetch the container from
8455     * @return The gengrid (parent) object
8456     *
8457     * This returns the gengrid object itself that an item belongs to.
8458     *
8459     * @ingroup Gengrid
8460     */
8461    EAPI Evas_Object       *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8462
8463    /**
8464     * Remove a gengrid item from the its parent, deleting it.
8465     *
8466     * @param item The item to be removed.
8467     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8468     *
8469     * @see elm_gengrid_clear(), to remove all items in a gengrid at
8470     * once.
8471     *
8472     * @ingroup Gengrid
8473     */
8474    EAPI void               elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8475
8476    /**
8477     * Update the contents of a given gengrid item
8478     *
8479     * @param item The gengrid item
8480     *
8481     * This updates an item by calling all the item class functions
8482     * again to get the icons, labels and states. Use this when the
8483     * original item data has changed and you want thta changes to be
8484     * reflected.
8485     *
8486     * @ingroup Gengrid
8487     */
8488    EAPI void               elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8489    EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8490    EAPI void               elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8491
8492    /**
8493     * Return the data associated to a given gengrid item
8494     *
8495     * @param item The gengrid item.
8496     * @return the data associated to this item.
8497     *
8498     * This returns the @c data value passed on the
8499     * elm_gengrid_item_append() and related item addition calls.
8500     *
8501     * @see elm_gengrid_item_append()
8502     * @see elm_gengrid_item_data_set()
8503     *
8504     * @ingroup Gengrid
8505     */
8506    EAPI void              *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8507
8508    /**
8509     * Set the data associated to a given gengrid item
8510     *
8511     * @param item The gengrid item
8512     * @param data The new data pointer to set on it
8513     *
8514     * This @b overrides the @c data value passed on the
8515     * elm_gengrid_item_append() and related item addition calls. This
8516     * function @b won't call elm_gengrid_item_update() automatically,
8517     * so you'd issue it afterwards if you want to hove the item
8518     * updated to reflect the that new data.
8519     *
8520     * @see elm_gengrid_item_data_get()
8521     *
8522     * @ingroup Gengrid
8523     */
8524    EAPI void               elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8525
8526    /**
8527     * Get a given gengrid item's position, relative to the whole
8528     * gengrid's grid area.
8529     *
8530     * @param item The Gengrid item.
8531     * @param x Pointer to variable where to store the item's <b>row
8532     * number</b>.
8533     * @param y Pointer to variable where to store the item's <b>column
8534     * number</b>.
8535     *
8536     * This returns the "logical" position of the item whithin the
8537     * gengrid. For example, @c (0, 1) would stand for first row,
8538     * second column.
8539     *
8540     * @ingroup Gengrid
8541     */
8542    EAPI void               elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
8543
8544    /**
8545     * Set whether a given gengrid item is selected or not
8546     *
8547     * @param item The gengrid item
8548     * @param selected Use @c EINA_TRUE, to make it selected, @c
8549     * EINA_FALSE to make it unselected
8550     *
8551     * This sets the selected state of an item. If multi selection is
8552     * not enabled on the containing gengrid and @p selected is @c
8553     * EINA_TRUE, any other previously selected items will get
8554     * unselected in favor of this new one.
8555     *
8556     * @see elm_gengrid_item_selected_get()
8557     *
8558     * @ingroup Gengrid
8559     */
8560    EAPI void               elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
8561
8562    /**
8563     * Get whether a given gengrid item is selected or not
8564     *
8565     * @param item The gengrid item
8566     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
8567     *
8568     * @see elm_gengrid_item_selected_set() for more details
8569     *
8570     * @ingroup Gengrid
8571     */
8572    EAPI Eina_Bool          elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8573
8574    /**
8575     * Get the real Evas object created to implement the view of a
8576     * given gengrid item
8577     *
8578     * @param item The gengrid item.
8579     * @return the Evas object implementing this item's view.
8580     *
8581     * This returns the actual Evas object used to implement the
8582     * specified gengrid item's view. This may be @c NULL, as it may
8583     * not have been created or may have been deleted, at any time, by
8584     * the gengrid. <b>Do not modify this object</b> (move, resize,
8585     * show, hide, etc.), as the gengrid is controlling it. This
8586     * function is for querying, emitting custom signals or hooking
8587     * lower level callbacks for events on that object. Do not delete
8588     * this object under any circumstances.
8589     *
8590     * @see elm_gengrid_item_data_get()
8591     *
8592     * @ingroup Gengrid
8593     */
8594    EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8595
8596    /**
8597     * Show the portion of a gengrid's internal grid containing a given
8598     * item, @b immediately.
8599     *
8600     * @param item The item to display
8601     *
8602     * This causes gengrid to @b redraw its viewport's contents to the
8603     * region contining the given @p item item, if it is not fully
8604     * visible.
8605     *
8606     * @see elm_gengrid_item_bring_in()
8607     *
8608     * @ingroup Gengrid
8609     */
8610    EAPI void               elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8611
8612    /**
8613     * Animatedly bring in, to the visible are of a gengrid, a given
8614     * item on it.
8615     *
8616     * @param item The gengrid item to display
8617     *
8618     * This causes gengrig to jump to the given @p item item and show
8619     * it (by scrolling), if it is not fully visible. This will use
8620     * animation to do so and take a period of time to complete.
8621     *
8622     * @see elm_gengrid_item_show()
8623     *
8624     * @ingroup Gengrid
8625     */
8626    EAPI void               elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8627
8628    /**
8629     * Set whether a given gengrid item is disabled or not.
8630     *
8631     * @param item The gengrid item
8632     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
8633     * to enable it back.
8634     *
8635     * A disabled item cannot be selected or unselected. It will also
8636     * change its appearance, to signal the user it's disabled.
8637     *
8638     * @see elm_gengrid_item_disabled_get()
8639     *
8640     * @ingroup Gengrid
8641     */
8642    EAPI void               elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8643
8644    /**
8645     * Get whether a given gengrid item is disabled or not.
8646     *
8647     * @param item The gengrid item
8648     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
8649     * (and on errors).
8650     *
8651     * @see elm_gengrid_item_disabled_set() for more details
8652     *
8653     * @ingroup Gengrid
8654     */
8655    EAPI Eina_Bool          elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8656
8657    /**
8658     * Set the text to be shown in a given gengrid item's tooltips.
8659     *
8660     * @param item The gengrid item
8661     * @param text The text to set in the content
8662     *
8663     * This call will setup the text to be used as tooltip to that item
8664     * (analogous to elm_object_tooltip_text_set(), but being item
8665     * tooltips with higher precedence than object tooltips). It can
8666     * have only one tooltip at a time, so any previous tooltip data
8667     * will get removed.
8668     *
8669     * @ingroup Gengrid
8670     */
8671    EAPI void               elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
8672
8673    /**
8674     * Set the content to be shown in a given gengrid item's tooltips
8675     *
8676     * @param item The gengrid item.
8677     * @param func The function returning the tooltip contents.
8678     * @param data What to provide to @a func as callback data/context.
8679     * @param del_cb Called when data is not needed anymore, either when
8680     *        another callback replaces @p func, the tooltip is unset with
8681     *        elm_gengrid_item_tooltip_unset() or the owner @p item
8682     *        dies. This callback receives as its first parameter the
8683     *        given @p data, being @c event_info the item handle.
8684     *
8685     * This call will setup the tooltip's contents to @p item
8686     * (analogous to elm_object_tooltip_content_cb_set(), but being
8687     * item tooltips with higher precedence than object tooltips). It
8688     * can have only one tooltip at a time, so any previous tooltip
8689     * content will get removed. @p func (with @p data) will be called
8690     * every time Elementary needs to show the tooltip and it should
8691     * return a valid Evas object, which will be fully managed by the
8692     * tooltip system, getting deleted when the tooltip is gone.
8693     *
8694     * @ingroup Gengrid
8695     */
8696    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);
8697
8698    /**
8699     * Unset a tooltip from a given gengrid item
8700     *
8701     * @param item gengrid item to remove a previously set tooltip from.
8702     *
8703     * This call removes any tooltip set on @p item. The callback
8704     * provided as @c del_cb to
8705     * elm_gengrid_item_tooltip_content_cb_set() will be called to
8706     * notify it is not used anymore (and have resources cleaned, if
8707     * need be).
8708     *
8709     * @see elm_gengrid_item_tooltip_content_cb_set()
8710     *
8711     * @ingroup Gengrid
8712     */
8713    EAPI void               elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8714
8715    /**
8716     * Set a different @b style for a given gengrid item's tooltip.
8717     *
8718     * @param item gengrid item with tooltip set
8719     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
8720     * "default", @c "transparent", etc)
8721     *
8722     * Tooltips can have <b>alternate styles</b> to be displayed on,
8723     * which are defined by the theme set on Elementary. This function
8724     * works analogously as elm_object_tooltip_style_set(), but here
8725     * applied only to gengrid item objects. The default style for
8726     * tooltips is @c "default".
8727     *
8728     * @note before you set a style you should define a tooltip with
8729     *       elm_gengrid_item_tooltip_content_cb_set() or
8730     *       elm_gengrid_item_tooltip_text_set()
8731     *
8732     * @see elm_gengrid_item_tooltip_style_get()
8733     *
8734     * @ingroup Gengrid
8735     */
8736    EAPI void               elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8737
8738    /**
8739     * Get the style set a given gengrid item's tooltip.
8740     *
8741     * @param item gengrid item with tooltip already set on.
8742     * @return style the theme style in use, which defaults to
8743     *         "default". If the object does not have a tooltip set,
8744     *         then @c NULL is returned.
8745     *
8746     * @see elm_gengrid_item_tooltip_style_set() for more details
8747     *
8748     * @ingroup Gengrid
8749     */
8750    EAPI const char        *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8751    /**
8752     * @brief Disable size restrictions on an object's tooltip
8753     * @param item The tooltip's anchor object
8754     * @param disable If EINA_TRUE, size restrictions are disabled
8755     * @return EINA_FALSE on failure, EINA_TRUE on success
8756     *
8757     * This function allows a tooltip to expand beyond its parant window's canvas.
8758     * It will instead be limited only by the size of the display.
8759     */
8760    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
8761    /**
8762     * @brief Retrieve size restriction state of an object's tooltip
8763     * @param item The tooltip's anchor object
8764     * @return If EINA_TRUE, size restrictions are disabled
8765     *
8766     * This function returns whether a tooltip is allowed to expand beyond
8767     * its parant window's canvas.
8768     * It will instead be limited only by the size of the display.
8769     */
8770    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
8771    /**
8772     * Set the type of mouse pointer/cursor decoration to be shown,
8773     * when the mouse pointer is over the given gengrid widget item
8774     *
8775     * @param item gengrid item to customize cursor on
8776     * @param cursor the cursor type's name
8777     *
8778     * This function works analogously as elm_object_cursor_set(), but
8779     * here the cursor's changing area is restricted to the item's
8780     * area, and not the whole widget's. Note that that item cursors
8781     * have precedence over widget cursors, so that a mouse over @p
8782     * item will always show cursor @p type.
8783     *
8784     * If this function is called twice for an object, a previously set
8785     * cursor will be unset on the second call.
8786     *
8787     * @see elm_object_cursor_set()
8788     * @see elm_gengrid_item_cursor_get()
8789     * @see elm_gengrid_item_cursor_unset()
8790     *
8791     * @ingroup Gengrid
8792     */
8793    EAPI void               elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
8794
8795    /**
8796     * Get the type of mouse pointer/cursor decoration set to be shown,
8797     * when the mouse pointer is over the given gengrid widget item
8798     *
8799     * @param item gengrid item with custom cursor set
8800     * @return the cursor type's name or @c NULL, if no custom cursors
8801     * were set to @p item (and on errors)
8802     *
8803     * @see elm_object_cursor_get()
8804     * @see elm_gengrid_item_cursor_set() for more details
8805     * @see elm_gengrid_item_cursor_unset()
8806     *
8807     * @ingroup Gengrid
8808     */
8809    EAPI const char        *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8810
8811    /**
8812     * Unset any custom mouse pointer/cursor decoration set to be
8813     * shown, when the mouse pointer is over the given gengrid widget
8814     * item, thus making it show the @b default cursor again.
8815     *
8816     * @param item a gengrid item
8817     *
8818     * Use this call to undo any custom settings on this item's cursor
8819     * decoration, bringing it back to defaults (no custom style set).
8820     *
8821     * @see elm_object_cursor_unset()
8822     * @see elm_gengrid_item_cursor_set() for more details
8823     *
8824     * @ingroup Gengrid
8825     */
8826    EAPI void               elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8827
8828    /**
8829     * Set a different @b style for a given custom cursor set for a
8830     * gengrid item.
8831     *
8832     * @param item gengrid item with custom cursor set
8833     * @param style the <b>theme style</b> to use (e.g. @c "default",
8834     * @c "transparent", etc)
8835     *
8836     * This function only makes sense when one is using custom mouse
8837     * cursor decorations <b>defined in a theme file</b> , which can
8838     * have, given a cursor name/type, <b>alternate styles</b> on
8839     * it. It works analogously as elm_object_cursor_style_set(), but
8840     * here applied only to gengrid item objects.
8841     *
8842     * @warning Before you set a cursor style you should have defined a
8843     *       custom cursor previously on the item, with
8844     *       elm_gengrid_item_cursor_set()
8845     *
8846     * @see elm_gengrid_item_cursor_engine_only_set()
8847     * @see elm_gengrid_item_cursor_style_get()
8848     *
8849     * @ingroup Gengrid
8850     */
8851    EAPI void               elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8852
8853    /**
8854     * Get the current @b style set for a given gengrid item's custom
8855     * cursor
8856     *
8857     * @param item gengrid item with custom cursor set.
8858     * @return style the cursor style in use. If the object does not
8859     *         have a cursor set, then @c NULL is returned.
8860     *
8861     * @see elm_gengrid_item_cursor_style_set() for more details
8862     *
8863     * @ingroup Gengrid
8864     */
8865    EAPI const char        *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8866
8867    /**
8868     * Set if the (custom) cursor for a given gengrid item should be
8869     * searched in its theme, also, or should only rely on the
8870     * rendering engine.
8871     *
8872     * @param item item with custom (custom) cursor already set on
8873     * @param engine_only Use @c EINA_TRUE to have cursors looked for
8874     * only on those provided by the rendering engine, @c EINA_FALSE to
8875     * have them searched on the widget's theme, as well.
8876     *
8877     * @note This call is of use only if you've set a custom cursor
8878     * for gengrid items, with elm_gengrid_item_cursor_set().
8879     *
8880     * @note By default, cursors will only be looked for between those
8881     * provided by the rendering engine.
8882     *
8883     * @ingroup Gengrid
8884     */
8885    EAPI void               elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
8886
8887    /**
8888     * Get if the (custom) cursor for a given gengrid item is being
8889     * searched in its theme, also, or is only relying on the rendering
8890     * engine.
8891     *
8892     * @param item a gengrid item
8893     * @return @c EINA_TRUE, if cursors are being looked for only on
8894     * those provided by the rendering engine, @c EINA_FALSE if they
8895     * are being searched on the widget's theme, as well.
8896     *
8897     * @see elm_gengrid_item_cursor_engine_only_set(), for more details
8898     *
8899     * @ingroup Gengrid
8900     */
8901    EAPI Eina_Bool          elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8902
8903    /**
8904     * Remove all items from a given gengrid widget
8905     *
8906     * @param obj The gengrid object.
8907     *
8908     * This removes (and deletes) all items in @p obj, leaving it
8909     * empty.
8910     *
8911     * @see elm_gengrid_item_del(), to remove just one item.
8912     *
8913     * @ingroup Gengrid
8914     */
8915    EAPI void               elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
8916
8917    /**
8918     * Get the selected item in a given gengrid widget
8919     *
8920     * @param obj The gengrid object.
8921     * @return The selected item's handleor @c NULL, if none is
8922     * selected at the moment (and on errors)
8923     *
8924     * This returns the selected item in @p obj. If multi selection is
8925     * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
8926     * the first item in the list is selected, which might not be very
8927     * useful. For that case, see elm_gengrid_selected_items_get().
8928     *
8929     * @ingroup Gengrid
8930     */
8931    EAPI Elm_Gengrid_Item  *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8932
8933    /**
8934     * Get <b>a list</b> of selected items in a given gengrid
8935     *
8936     * @param obj The gengrid object.
8937     * @return The list of selected items or @c NULL, if none is
8938     * selected at the moment (and on errors)
8939     *
8940     * This returns a list of the selected items, in the order that
8941     * they appear in the grid. This list is only valid as long as no
8942     * more items are selected or unselected (or unselected implictly
8943     * by deletion). The list contains #Elm_Gengrid_Item pointers as
8944     * data, naturally.
8945     *
8946     * @see elm_gengrid_selected_item_get()
8947     *
8948     * @ingroup Gengrid
8949     */
8950    EAPI const Eina_List   *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8951
8952    /**
8953     * @}
8954     */
8955
8956    /**
8957     * @defgroup Clock Clock
8958     *
8959     * @image html img/widget/clock/preview-00.png
8960     * @image latex img/widget/clock/preview-00.eps
8961     *
8962     * This is a @b digital clock widget. In its default theme, it has a
8963     * vintage "flipping numbers clock" appearance, which will animate
8964     * sheets of individual algarisms individually as time goes by.
8965     *
8966     * A newly created clock will fetch system's time (already
8967     * considering local time adjustments) to start with, and will tick
8968     * accondingly. It may or may not show seconds.
8969     *
8970     * Clocks have an @b edition mode. When in it, the sheets will
8971     * display extra arrow indications on the top and bottom and the
8972     * user may click on them to raise or lower the time values. After
8973     * it's told to exit edition mode, it will keep ticking with that
8974     * new time set (it keeps the difference from local time).
8975     *
8976     * Also, when under edition mode, user clicks on the cited arrows
8977     * which are @b held for some time will make the clock to flip the
8978     * sheet, thus editing the time, continuosly and automatically for
8979     * the user. The interval between sheet flips will keep growing in
8980     * time, so that it helps the user to reach a time which is distant
8981     * from the one set.
8982     *
8983     * The time display is, by default, in military mode (24h), but an
8984     * am/pm indicator may be optionally shown, too, when it will
8985     * switch to 12h.
8986     *
8987     * Smart callbacks one can register to:
8988     * - "changed" - the clock's user changed the time
8989     *
8990     * Here is an example on its usage:
8991     * @li @ref clock_example
8992     */
8993
8994    /**
8995     * @addtogroup Clock
8996     * @{
8997     */
8998
8999    /**
9000     * Identifiers for which clock digits should be editable, when a
9001     * clock widget is in edition mode. Values may be ORed together to
9002     * make a mask, naturally.
9003     *
9004     * @see elm_clock_edit_set()
9005     * @see elm_clock_digit_edit_set()
9006     */
9007    typedef enum _Elm_Clock_Digedit
9008      {
9009         ELM_CLOCK_NONE         = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9010         ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9011         ELM_CLOCK_HOUR_UNIT    = 1 << 1, /**< Unit algarism of hours value should be editable */
9012         ELM_CLOCK_MIN_DECIMAL  = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9013         ELM_CLOCK_MIN_UNIT     = 1 << 3, /**< Unit algarism of minutes value should be editable */
9014         ELM_CLOCK_SEC_DECIMAL  = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9015         ELM_CLOCK_SEC_UNIT     = 1 << 5, /**< Unit algarism of seconds value should be editable */
9016         ELM_CLOCK_ALL          = (1 << 6) - 1 /**< All digits should be editable */
9017      } Elm_Clock_Digedit;
9018
9019    /**
9020     * Add a new clock widget to the given parent Elementary
9021     * (container) object
9022     *
9023     * @param parent The parent object
9024     * @return a new clock widget handle or @c NULL, on errors
9025     *
9026     * This function inserts a new clock widget on the canvas.
9027     *
9028     * @ingroup Clock
9029     */
9030    EAPI Evas_Object      *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9031
9032    /**
9033     * Set a clock widget's time, programmatically
9034     *
9035     * @param obj The clock widget object
9036     * @param hrs The hours to set
9037     * @param min The minutes to set
9038     * @param sec The secondes to set
9039     *
9040     * This function updates the time that is showed by the clock
9041     * widget.
9042     *
9043     *  Values @b must be set within the following ranges:
9044     * - 0 - 23, for hours
9045     * - 0 - 59, for minutes
9046     * - 0 - 59, for seconds,
9047     *
9048     * even if the clock is not in "military" mode.
9049     *
9050     * @warning The behavior for values set out of those ranges is @b
9051     * indefined.
9052     *
9053     * @ingroup Clock
9054     */
9055    EAPI void              elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9056
9057    /**
9058     * Get a clock widget's time values
9059     *
9060     * @param obj The clock object
9061     * @param[out] hrs Pointer to the variable to get the hours value
9062     * @param[out] min Pointer to the variable to get the minutes value
9063     * @param[out] sec Pointer to the variable to get the seconds value
9064     *
9065     * This function gets the time set for @p obj, returning
9066     * it on the variables passed as the arguments to function
9067     *
9068     * @note Use @c NULL pointers on the time values you're not
9069     * interested in: they'll be ignored by the function.
9070     *
9071     * @ingroup Clock
9072     */
9073    EAPI void              elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9074
9075    /**
9076     * Set whether a given clock widget is under <b>edition mode</b> or
9077     * under (default) displaying-only mode.
9078     *
9079     * @param obj The clock object
9080     * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9081     * put it back to "displaying only" mode
9082     *
9083     * This function makes a clock's time to be editable or not <b>by
9084     * user interaction</b>. When in edition mode, clocks @b stop
9085     * ticking, until one brings them back to canonical mode. The
9086     * elm_clock_digit_edit_set() function will influence which digits
9087     * of the clock will be editable. By default, all of them will be
9088     * (#ELM_CLOCK_NONE).
9089     *
9090     * @note am/pm sheets, if being shown, will @b always be editable
9091     * under edition mode.
9092     *
9093     * @see elm_clock_edit_get()
9094     *
9095     * @ingroup Clock
9096     */
9097    EAPI void              elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9098
9099    /**
9100     * Retrieve whether a given clock widget is under <b>edition
9101     * mode</b> or under (default) displaying-only mode.
9102     *
9103     * @param obj The clock object
9104     * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9105     * otherwise
9106     *
9107     * This function retrieves whether the clock's time can be edited
9108     * or not by user interaction.
9109     *
9110     * @see elm_clock_edit_set() for more details
9111     *
9112     * @ingroup Clock
9113     */
9114    EAPI Eina_Bool         elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9115
9116    /**
9117     * Set what digits of the given clock widget should be editable
9118     * when in edition mode.
9119     *
9120     * @param obj The clock object
9121     * @param digedit Bit mask indicating the digits to be editable
9122     * (values in #Elm_Clock_Digedit).
9123     *
9124     * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9125     * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9126     * EINA_FALSE).
9127     *
9128     * @see elm_clock_digit_edit_get()
9129     *
9130     * @ingroup Clock
9131     */
9132    EAPI void              elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9133
9134    /**
9135     * Retrieve what digits of the given clock widget should be
9136     * editable when in edition mode.
9137     *
9138     * @param obj The clock object
9139     * @return Bit mask indicating the digits to be editable
9140     * (values in #Elm_Clock_Digedit).
9141     *
9142     * @see elm_clock_digit_edit_set() for more details
9143     *
9144     * @ingroup Clock
9145     */
9146    EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9147
9148    /**
9149     * Set if the given clock widget must show hours in military or
9150     * am/pm mode
9151     *
9152     * @param obj The clock object
9153     * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9154     * to military mode
9155     *
9156     * This function sets if the clock must show hours in military or
9157     * am/pm mode. In some countries like Brazil the military mode
9158     * (00-24h-format) is used, in opposition to the USA, where the
9159     * am/pm mode is more commonly used.
9160     *
9161     * @see elm_clock_show_am_pm_get()
9162     *
9163     * @ingroup Clock
9164     */
9165    EAPI void              elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9166
9167    /**
9168     * Get if the given clock widget shows hours in military or am/pm
9169     * mode
9170     *
9171     * @param obj The clock object
9172     * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9173     * military
9174     *
9175     * This function gets if the clock shows hours in military or am/pm
9176     * mode.
9177     *
9178     * @see elm_clock_show_am_pm_set() for more details
9179     *
9180     * @ingroup Clock
9181     */
9182    EAPI Eina_Bool         elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9183
9184    /**
9185     * Set if the given clock widget must show time with seconds or not
9186     *
9187     * @param obj The clock object
9188     * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9189     *
9190     * This function sets if the given clock must show or not elapsed
9191     * seconds. By default, they are @b not shown.
9192     *
9193     * @see elm_clock_show_seconds_get()
9194     *
9195     * @ingroup Clock
9196     */
9197    EAPI void              elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9198
9199    /**
9200     * Get whether the given clock widget is showing time with seconds
9201     * or not
9202     *
9203     * @param obj The clock object
9204     * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9205     *
9206     * This function gets whether @p obj is showing or not the elapsed
9207     * seconds.
9208     *
9209     * @see elm_clock_show_seconds_set()
9210     *
9211     * @ingroup Clock
9212     */
9213    EAPI Eina_Bool         elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9214
9215    /**
9216     * Set the interval on time updates for an user mouse button hold
9217     * on clock widgets' time edition.
9218     *
9219     * @param obj The clock object
9220     * @param interval The (first) interval value in seconds
9221     *
9222     * This interval value is @b decreased while the user holds the
9223     * mouse pointer either incrementing or decrementing a given the
9224     * clock digit's value.
9225     *
9226     * This helps the user to get to a given time distant from the
9227     * current one easier/faster, as it will start to flip quicker and
9228     * quicker on mouse button holds.
9229     *
9230     * The calculation for the next flip interval value, starting from
9231     * the one set with this call, is the previous interval divided by
9232     * 1.05, so it decreases a little bit.
9233     *
9234     * The default starting interval value for automatic flips is
9235     * @b 0.85 seconds.
9236     *
9237     * @see elm_clock_interval_get()
9238     *
9239     * @ingroup Clock
9240     */
9241    EAPI void              elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9242
9243    /**
9244     * Get the interval on time updates for an user mouse button hold
9245     * on clock widgets' time edition.
9246     *
9247     * @param obj The clock object
9248     * @return The (first) interval value, in seconds, set on it
9249     *
9250     * @see elm_clock_interval_set() for more details
9251     *
9252     * @ingroup Clock
9253     */
9254    EAPI double            elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9255
9256    /**
9257     * @}
9258     */
9259
9260    /**
9261     * @defgroup Layout Layout
9262     *
9263     * @image html img/widget/layout/preview-00.png
9264     * @image latex img/widget/layout/preview-00.eps width=\textwidth
9265     *
9266     * @image html img/layout-predefined.png
9267     * @image latex img/layout-predefined.eps width=\textwidth
9268     *
9269     * This is a container widget that takes a standard Edje design file and
9270     * wraps it very thinly in a widget.
9271     *
9272     * An Edje design (theme) file has a very wide range of possibilities to
9273     * describe the behavior of elements added to the Layout. Check out the Edje
9274     * documentation and the EDC reference to get more information about what can
9275     * be done with Edje.
9276     *
9277     * Just like @ref List, @ref Box, and other container widgets, any
9278     * object added to the Layout will become its child, meaning that it will be
9279     * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9280     *
9281     * The Layout widget can contain as many Contents, Boxes or Tables as
9282     * described in its theme file. For instance, objects can be added to
9283     * different Tables by specifying the respective Table part names. The same
9284     * is valid for Content and Box.
9285     *
9286     * The objects added as child of the Layout will behave as described in the
9287     * part description where they were added. There are 3 possible types of
9288     * parts where a child can be added:
9289     *
9290     * @section secContent Content (SWALLOW part)
9291     *
9292     * Only one object can be added to the @c SWALLOW part (but you still can
9293     * have many @c SWALLOW parts and one object on each of them). Use the @c
9294     * elm_layout_content_* set of functions to set, retrieve and unset objects
9295     * as content of the @c SWALLOW. After being set to this part, the object
9296     * size, position, visibility, clipping and other description properties
9297     * will be totally controled by the description of the given part (inside
9298     * the Edje theme file).
9299     *
9300     * One can use @c evas_object_size_hint_* functions on the child to have some
9301     * kind of control over its behavior, but the resulting behavior will still
9302     * depend heavily on the @c SWALLOW part description.
9303     *
9304     * The Edje theme also can change the part description, based on signals or
9305     * scripts running inside the theme. This change can also be animated. All of
9306     * this will affect the child object set as content accordingly. The object
9307     * size will be changed if the part size is changed, it will animate move if
9308     * the part is moving, and so on.
9309     *
9310     * The following picture demonstrates a Layout widget with a child object
9311     * added to its @c SWALLOW:
9312     *
9313     * @image html layout_swallow.png
9314     * @image latex layout_swallow.eps width=\textwidth
9315     *
9316     * @section secBox Box (BOX part)
9317     *
9318     * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9319     * allows one to add objects to the box and have them distributed along its
9320     * area, accordingly to the specified @a layout property (now by @a layout we
9321     * mean the chosen layouting design of the Box, not the Layout widget
9322     * itself).
9323     *
9324     * A similar effect for having a box with its position, size and other things
9325     * controled by the Layout theme would be to create an Elementary @ref Box
9326     * widget and add it as a Content in the @c SWALLOW part.
9327     *
9328     * The main difference of using the Layout Box is that its behavior, the box
9329     * properties like layouting format, padding, align, etc. will be all
9330     * controled by the theme. This means, for example, that a signal could be
9331     * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9332     * handled the signal by changing the box padding, or align, or both. Using
9333     * the Elementary @ref Box widget is not necessarily harder or easier, it
9334     * just depends on the circunstances and requirements.
9335     *
9336     * The Layout Box can be used through the @c elm_layout_box_* set of
9337     * functions.
9338     *
9339     * The following picture demonstrates a Layout widget with many child objects
9340     * added to its @c BOX part:
9341     *
9342     * @image html layout_box.png
9343     * @image latex layout_box.eps width=\textwidth
9344     *
9345     * @section secTable Table (TABLE part)
9346     *
9347     * Just like the @ref secBox, the Layout Table is very similar to the
9348     * Elementary @ref Table widget. It allows one to add objects to the Table
9349     * specifying the row and column where the object should be added, and any
9350     * column or row span if necessary.
9351     *
9352     * Again, we could have this design by adding a @ref Table widget to the @c
9353     * SWALLOW part using elm_layout_content_set(). The same difference happens
9354     * here when choosing to use the Layout Table (a @c TABLE part) instead of
9355     * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9356     *
9357     * The Layout Table can be used through the @c elm_layout_table_* set of
9358     * functions.
9359     *
9360     * The following picture demonstrates a Layout widget with many child objects
9361     * added to its @c TABLE part:
9362     *
9363     * @image html layout_table.png
9364     * @image latex layout_table.eps width=\textwidth
9365     *
9366     * @section secPredef Predefined Layouts
9367     *
9368     * Another interesting thing about the Layout widget is that it offers some
9369     * predefined themes that come with the default Elementary theme. These
9370     * themes can be set by the call elm_layout_theme_set(), and provide some
9371     * basic functionality depending on the theme used.
9372     *
9373     * Most of them already send some signals, some already provide a toolbar or
9374     * back and next buttons.
9375     *
9376     * These are available predefined theme layouts. All of them have class = @c
9377     * layout, group = @c application, and style = one of the following options:
9378     *
9379     * @li @c toolbar-content - application with toolbar and main content area
9380     * @li @c toolbar-content-back - application with toolbar and main content
9381     * area with a back button and title area
9382     * @li @c toolbar-content-back-next - application with toolbar and main
9383     * content area with a back and next buttons and title area
9384     * @li @c content-back - application with a main content area with a back
9385     * button and title area
9386     * @li @c content-back-next - application with a main content area with a
9387     * back and next buttons and title area
9388     * @li @c toolbar-vbox - application with toolbar and main content area as a
9389     * vertical box
9390     * @li @c toolbar-table - application with toolbar and main content area as a
9391     * table
9392     *
9393     * @section secExamples Examples
9394     *
9395     * Some examples of the Layout widget can be found here:
9396     * @li @ref layout_example_01
9397     * @li @ref layout_example_02
9398     * @li @ref layout_example_03
9399     * @li @ref layout_example_edc
9400     *
9401     */
9402
9403    /**
9404     * Add a new layout to the parent
9405     *
9406     * @param parent The parent object
9407     * @return The new object or NULL if it cannot be created
9408     *
9409     * @see elm_layout_file_set()
9410     * @see elm_layout_theme_set()
9411     *
9412     * @ingroup Layout
9413     */
9414    EAPI Evas_Object       *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9415    /**
9416     * Set the file that will be used as layout
9417     *
9418     * @param obj The layout object
9419     * @param file The path to file (edj) that will be used as layout
9420     * @param group The group that the layout belongs in edje file
9421     *
9422     * @return (1 = success, 0 = error)
9423     *
9424     * @ingroup Layout
9425     */
9426    EAPI Eina_Bool          elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9427    /**
9428     * Set the edje group from the elementary theme that will be used as layout
9429     *
9430     * @param obj The layout object
9431     * @param clas the clas of the group
9432     * @param group the group
9433     * @param style the style to used
9434     *
9435     * @return (1 = success, 0 = error)
9436     *
9437     * @ingroup Layout
9438     */
9439    EAPI Eina_Bool          elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9440    /**
9441     * Set the layout content.
9442     *
9443     * @param obj The layout object
9444     * @param swallow The swallow part name in the edje file
9445     * @param content The child that will be added in this layout object
9446     *
9447     * Once the content object is set, a previously set one will be deleted.
9448     * If you want to keep that old content object, use the
9449     * elm_layout_content_unset() function.
9450     *
9451     * @note In an Edje theme, the part used as a content container is called @c
9452     * SWALLOW. This is why the parameter name is called @p swallow, but it is
9453     * expected to be a part name just like the second parameter of
9454     * elm_layout_box_append().
9455     *
9456     * @see elm_layout_box_append()
9457     * @see elm_layout_content_get()
9458     * @see elm_layout_content_unset()
9459     * @see @ref secBox
9460     *
9461     * @ingroup Layout
9462     */
9463    EAPI void               elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9464    /**
9465     * Get the child object in the given content part.
9466     *
9467     * @param obj The layout object
9468     * @param swallow The SWALLOW part to get its content
9469     *
9470     * @return The swallowed object or NULL if none or an error occurred
9471     *
9472     * @see elm_layout_content_set()
9473     *
9474     * @ingroup Layout
9475     */
9476    EAPI Evas_Object       *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9477    /**
9478     * Unset the layout content.
9479     *
9480     * @param obj The layout object
9481     * @param swallow The swallow part name in the edje file
9482     * @return The content that was being used
9483     *
9484     * Unparent and return the content object which was set for this part.
9485     *
9486     * @see elm_layout_content_set()
9487     *
9488     * @ingroup Layout
9489     */
9490     EAPI Evas_Object       *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9491    /**
9492     * Set the text of the given part
9493     *
9494     * @param obj The layout object
9495     * @param part The TEXT part where to set the text
9496     * @param text The text to set
9497     *
9498     * @ingroup Layout
9499     * @deprecated use elm_object_text_* instead.
9500     */
9501    EINA_DEPRECATED EAPI void               elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9502    /**
9503     * Get the text set in the given part
9504     *
9505     * @param obj The layout object
9506     * @param part The TEXT part to retrieve the text off
9507     *
9508     * @return The text set in @p part
9509     *
9510     * @ingroup Layout
9511     * @deprecated use elm_object_text_* instead.
9512     */
9513    EINA_DEPRECATED EAPI const char        *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9514    /**
9515     * Append child to layout box part.
9516     *
9517     * @param obj the layout object
9518     * @param part the box part to which the object will be appended.
9519     * @param child the child object to append to box.
9520     *
9521     * Once the object is appended, it will become child of the layout. Its
9522     * lifetime will be bound to the layout, whenever the layout dies the child
9523     * will be deleted automatically. One should use elm_layout_box_remove() to
9524     * make this layout forget about the object.
9525     *
9526     * @see elm_layout_box_prepend()
9527     * @see elm_layout_box_insert_before()
9528     * @see elm_layout_box_insert_at()
9529     * @see elm_layout_box_remove()
9530     *
9531     * @ingroup Layout
9532     */
9533    EAPI void               elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9534    /**
9535     * Prepend child to layout box part.
9536     *
9537     * @param obj the layout object
9538     * @param part the box part to prepend.
9539     * @param child the child object to prepend to box.
9540     *
9541     * Once the object is prepended, it will become child of the layout. Its
9542     * lifetime will be bound to the layout, whenever the layout dies the child
9543     * will be deleted automatically. One should use elm_layout_box_remove() to
9544     * make this layout forget about the object.
9545     *
9546     * @see elm_layout_box_append()
9547     * @see elm_layout_box_insert_before()
9548     * @see elm_layout_box_insert_at()
9549     * @see elm_layout_box_remove()
9550     *
9551     * @ingroup Layout
9552     */
9553    EAPI void               elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9554    /**
9555     * Insert child to layout box part before a reference object.
9556     *
9557     * @param obj the layout object
9558     * @param part the box part to insert.
9559     * @param child the child object to insert into box.
9560     * @param reference another reference object to insert before in box.
9561     *
9562     * Once the object is inserted, it will become child of the layout. Its
9563     * lifetime will be bound to the layout, whenever the layout dies the child
9564     * will be deleted automatically. One should use elm_layout_box_remove() to
9565     * make this layout forget about the object.
9566     *
9567     * @see elm_layout_box_append()
9568     * @see elm_layout_box_prepend()
9569     * @see elm_layout_box_insert_before()
9570     * @see elm_layout_box_remove()
9571     *
9572     * @ingroup Layout
9573     */
9574    EAPI void               elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
9575    /**
9576     * Insert child to layout box part at a given position.
9577     *
9578     * @param obj the layout object
9579     * @param part the box part to insert.
9580     * @param child the child object to insert into box.
9581     * @param pos the numeric position >=0 to insert the child.
9582     *
9583     * Once the object is inserted, it will become child of the layout. Its
9584     * lifetime will be bound to the layout, whenever the layout dies the child
9585     * will be deleted automatically. One should use elm_layout_box_remove() to
9586     * make this layout forget about the object.
9587     *
9588     * @see elm_layout_box_append()
9589     * @see elm_layout_box_prepend()
9590     * @see elm_layout_box_insert_before()
9591     * @see elm_layout_box_remove()
9592     *
9593     * @ingroup Layout
9594     */
9595    EAPI void               elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
9596    /**
9597     * Remove a child of the given part box.
9598     *
9599     * @param obj The layout object
9600     * @param part The box part name to remove child.
9601     * @param child The object to remove from box.
9602     * @return The object that was being used, or NULL if not found.
9603     *
9604     * The object will be removed from the box part and its lifetime will
9605     * not be handled by the layout anymore. This is equivalent to
9606     * elm_layout_content_unset() for box.
9607     *
9608     * @see elm_layout_box_append()
9609     * @see elm_layout_box_remove_all()
9610     *
9611     * @ingroup Layout
9612     */
9613    EAPI Evas_Object       *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
9614    /**
9615     * Remove all child of the given part box.
9616     *
9617     * @param obj The layout object
9618     * @param part The box part name to remove child.
9619     * @param clear If EINA_TRUE, then all objects will be deleted as
9620     *        well, otherwise they will just be removed and will be
9621     *        dangling on the canvas.
9622     *
9623     * The objects will be removed from the box part and their lifetime will
9624     * not be handled by the layout anymore. This is equivalent to
9625     * elm_layout_box_remove() for all box children.
9626     *
9627     * @see elm_layout_box_append()
9628     * @see elm_layout_box_remove()
9629     *
9630     * @ingroup Layout
9631     */
9632    EAPI void               elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9633    /**
9634     * Insert child to layout table part.
9635     *
9636     * @param obj the layout object
9637     * @param part the box part to pack child.
9638     * @param child_obj the child object to pack into table.
9639     * @param col the column to which the child should be added. (>= 0)
9640     * @param row the row to which the child should be added. (>= 0)
9641     * @param colspan how many columns should be used to store this object. (>=
9642     *        1)
9643     * @param rowspan how many rows should be used to store this object. (>= 1)
9644     *
9645     * Once the object is inserted, it will become child of the table. Its
9646     * lifetime will be bound to the layout, and whenever the layout dies the
9647     * child will be deleted automatically. One should use
9648     * elm_layout_table_remove() to make this layout forget about the object.
9649     *
9650     * If @p colspan or @p rowspan are bigger than 1, that object will occupy
9651     * more space than a single cell. For instance, the following code:
9652     * @code
9653     * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
9654     * @endcode
9655     *
9656     * Would result in an object being added like the following picture:
9657     *
9658     * @image html layout_colspan.png
9659     * @image latex layout_colspan.eps width=\textwidth
9660     *
9661     * @see elm_layout_table_unpack()
9662     * @see elm_layout_table_clear()
9663     *
9664     * @ingroup Layout
9665     */
9666    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);
9667    /**
9668     * Unpack (remove) a child of the given part table.
9669     *
9670     * @param obj The layout object
9671     * @param part The table part name to remove child.
9672     * @param child_obj The object to remove from table.
9673     * @return The object that was being used, or NULL if not found.
9674     *
9675     * The object will be unpacked from the table part and its lifetime
9676     * will not be handled by the layout anymore. This is equivalent to
9677     * elm_layout_content_unset() for table.
9678     *
9679     * @see elm_layout_table_pack()
9680     * @see elm_layout_table_clear()
9681     *
9682     * @ingroup Layout
9683     */
9684    EAPI Evas_Object       *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
9685    /**
9686     * Remove all child of the given part table.
9687     *
9688     * @param obj The layout object
9689     * @param part The table part name to remove child.
9690     * @param clear If EINA_TRUE, then all objects will be deleted as
9691     *        well, otherwise they will just be removed and will be
9692     *        dangling on the canvas.
9693     *
9694     * The objects will be removed from the table part and their lifetime will
9695     * not be handled by the layout anymore. This is equivalent to
9696     * elm_layout_table_unpack() for all table children.
9697     *
9698     * @see elm_layout_table_pack()
9699     * @see elm_layout_table_unpack()
9700     *
9701     * @ingroup Layout
9702     */
9703    EAPI void               elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9704    /**
9705     * Get the edje layout
9706     *
9707     * @param obj The layout object
9708     *
9709     * @return A Evas_Object with the edje layout settings loaded
9710     * with function elm_layout_file_set
9711     *
9712     * This returns the edje object. It is not expected to be used to then
9713     * swallow objects via edje_object_part_swallow() for example. Use
9714     * elm_layout_content_set() instead so child object handling and sizing is
9715     * done properly.
9716     *
9717     * @note This function should only be used if you really need to call some
9718     * low level Edje function on this edje object. All the common stuff (setting
9719     * text, emitting signals, hooking callbacks to signals, etc.) can be done
9720     * with proper elementary functions.
9721     *
9722     * @see elm_object_signal_callback_add()
9723     * @see elm_object_signal_emit()
9724     * @see elm_object_text_part_set()
9725     * @see elm_layout_content_set()
9726     * @see elm_layout_box_append()
9727     * @see elm_layout_table_pack()
9728     * @see elm_layout_data_get()
9729     *
9730     * @ingroup Layout
9731     */
9732    EAPI Evas_Object       *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9733    /**
9734     * Get the edje data from the given layout
9735     *
9736     * @param obj The layout object
9737     * @param key The data key
9738     *
9739     * @return The edje data string
9740     *
9741     * This function fetches data specified inside the edje theme of this layout.
9742     * This function return NULL if data is not found.
9743     *
9744     * In EDC this comes from a data block within the group block that @p
9745     * obj was loaded from. E.g.
9746     *
9747     * @code
9748     * collections {
9749     *   group {
9750     *     name: "a_group";
9751     *     data {
9752     *       item: "key1" "value1";
9753     *       item: "key2" "value2";
9754     *     }
9755     *   }
9756     * }
9757     * @endcode
9758     *
9759     * @ingroup Layout
9760     */
9761    EAPI const char        *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
9762    /**
9763     * Eval sizing
9764     *
9765     * @param obj The layout object
9766     *
9767     * Manually forces a sizing re-evaluation. This is useful when the minimum
9768     * size required by the edje theme of this layout has changed. The change on
9769     * the minimum size required by the edje theme is not immediately reported to
9770     * the elementary layout, so one needs to call this function in order to tell
9771     * the widget (layout) that it needs to reevaluate its own size.
9772     *
9773     * The minimum size of the theme is calculated based on minimum size of
9774     * parts, the size of elements inside containers like box and table, etc. All
9775     * of this can change due to state changes, and that's when this function
9776     * should be called.
9777     *
9778     * Also note that a standard signal of "size,eval" "elm" emitted from the
9779     * edje object will cause this to happen too.
9780     *
9781     * @ingroup Layout
9782     */
9783    EAPI void               elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
9784
9785    /**
9786     * Sets a specific cursor for an edje part.
9787     *
9788     * @param obj The layout object.
9789     * @param part_name a part from loaded edje group.
9790     * @param cursor cursor name to use, see Elementary_Cursor.h
9791     *
9792     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9793     *         part not exists or it has "mouse_events: 0".
9794     *
9795     * @ingroup Layout
9796     */
9797    EAPI Eina_Bool          elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
9798
9799    /**
9800     * Get the cursor to be shown when mouse is over an edje part
9801     *
9802     * @param obj The layout object.
9803     * @param part_name a part from loaded edje group.
9804     * @return the cursor name.
9805     *
9806     * @ingroup Layout
9807     */
9808    EAPI const char        *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9809
9810    /**
9811     * Unsets a cursor previously set with elm_layout_part_cursor_set().
9812     *
9813     * @param obj The layout object.
9814     * @param part_name a part from loaded edje group, that had a cursor set
9815     *        with elm_layout_part_cursor_set().
9816     *
9817     * @ingroup Layout
9818     */
9819    EAPI void               elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9820
9821    /**
9822     * Sets a specific cursor style for an edje part.
9823     *
9824     * @param obj The layout object.
9825     * @param part_name a part from loaded edje group.
9826     * @param style the theme style to use (default, transparent, ...)
9827     *
9828     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9829     *         part not exists or it did not had a cursor set.
9830     *
9831     * @ingroup Layout
9832     */
9833    EAPI Eina_Bool          elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
9834
9835    /**
9836     * Gets a specific cursor style for an edje part.
9837     *
9838     * @param obj The layout object.
9839     * @param part_name a part from loaded edje group.
9840     *
9841     * @return the theme style in use, defaults to "default". If the
9842     *         object does not have a cursor set, then NULL is returned.
9843     *
9844     * @ingroup Layout
9845     */
9846    EAPI const char        *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9847
9848    /**
9849     * Sets if the cursor set should be searched on the theme or should use
9850     * the provided by the engine, only.
9851     *
9852     * @note before you set if should look on theme you should define a
9853     * cursor with elm_layout_part_cursor_set(). By default it will only
9854     * look for cursors provided by the engine.
9855     *
9856     * @param obj The layout object.
9857     * @param part_name a part from loaded edje group.
9858     * @param engine_only if cursors should be just provided by the engine
9859     *        or should also search on widget's theme as well
9860     *
9861     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9862     *         part not exists or it did not had a cursor set.
9863     *
9864     * @ingroup Layout
9865     */
9866    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);
9867
9868    /**
9869     * Gets a specific cursor engine_only for an edje part.
9870     *
9871     * @param obj The layout object.
9872     * @param part_name a part from loaded edje group.
9873     *
9874     * @return whenever the cursor is just provided by engine or also from theme.
9875     *
9876     * @ingroup Layout
9877     */
9878    EAPI Eina_Bool          elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9879
9880 /**
9881  * @def elm_layout_icon_set
9882  * Convienience macro to set the icon object in a layout that follows the
9883  * Elementary naming convention for its parts.
9884  *
9885  * @ingroup Layout
9886  */
9887 #define elm_layout_icon_set(_ly, _obj) \
9888   do { \
9889     const char *sig; \
9890     elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
9891     if ((_obj)) sig = "elm,state,icon,visible"; \
9892     else sig = "elm,state,icon,hidden"; \
9893     elm_object_signal_emit((_ly), sig, "elm"); \
9894   } while (0)
9895
9896 /**
9897  * @def elm_layout_icon_get
9898  * Convienience macro to get the icon object from a layout that follows the
9899  * Elementary naming convention for its parts.
9900  *
9901  * @ingroup Layout
9902  */
9903 #define elm_layout_icon_get(_ly) \
9904   elm_layout_content_get((_ly), "elm.swallow.icon")
9905
9906 /**
9907  * @def elm_layout_end_set
9908  * Convienience macro to set the end object in a layout that follows the
9909  * Elementary naming convention for its parts.
9910  *
9911  * @ingroup Layout
9912  */
9913 #define elm_layout_end_set(_ly, _obj) \
9914   do { \
9915     const char *sig; \
9916     elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
9917     if ((_obj)) sig = "elm,state,end,visible"; \
9918     else sig = "elm,state,end,hidden"; \
9919     elm_object_signal_emit((_ly), sig, "elm"); \
9920   } while (0)
9921
9922 /**
9923  * @def elm_layout_end_get
9924  * Convienience macro to get the end object in a layout that follows the
9925  * Elementary naming convention for its parts.
9926  *
9927  * @ingroup Layout
9928  */
9929 #define elm_layout_end_get(_ly) \
9930   elm_layout_content_get((_ly), "elm.swallow.end")
9931
9932 /**
9933  * @def elm_layout_label_set
9934  * Convienience macro to set the label in a layout that follows the
9935  * Elementary naming convention for its parts.
9936  *
9937  * @ingroup Layout
9938  * @deprecated use elm_object_text_* instead.
9939  */
9940 #define elm_layout_label_set(_ly, _txt) \
9941   elm_layout_text_set((_ly), "elm.text", (_txt))
9942
9943 /**
9944  * @def elm_layout_label_get
9945  * Convienience macro to get the label in a layout that follows the
9946  * Elementary naming convention for its parts.
9947  *
9948  * @ingroup Layout
9949  * @deprecated use elm_object_text_* instead.
9950  */
9951 #define elm_layout_label_get(_ly) \
9952   elm_layout_text_get((_ly), "elm.text")
9953
9954    /* smart callbacks called:
9955     * "theme,changed" - when elm theme is changed.
9956     */
9957
9958    /**
9959     * @defgroup Notify Notify
9960     *
9961     * @image html img/widget/notify/preview-00.png
9962     * @image latex img/widget/notify/preview-00.eps
9963     *
9964     * Display a container in a particular region of the parent(top, bottom,
9965     * etc.  A timeout can be set to automatically hide the notify. This is so
9966     * that, after an evas_object_show() on a notify object, if a timeout was set
9967     * on it, it will @b automatically get hidden after that time.
9968     *
9969     * Signals that you can add callbacks for are:
9970     * @li "timeout" - when timeout happens on notify and it's hidden
9971     * @li "block,clicked" - when a click outside of the notify happens
9972     *
9973     * @ref tutorial_notify show usage of the API.
9974     *
9975     * @{
9976     */
9977    /**
9978     * @brief Possible orient values for notify.
9979     *
9980     * This values should be used in conjunction to elm_notify_orient_set() to
9981     * set the position in which the notify should appear(relative to its parent)
9982     * and in conjunction with elm_notify_orient_get() to know where the notify
9983     * is appearing.
9984     */
9985    typedef enum _Elm_Notify_Orient
9986      {
9987         ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
9988         ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
9989         ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
9990         ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
9991         ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
9992         ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
9993         ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
9994         ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
9995         ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
9996         ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
9997      } Elm_Notify_Orient;
9998    /**
9999     * @brief Add a new notify to the parent
10000     *
10001     * @param parent The parent object
10002     * @return The new object or NULL if it cannot be created
10003     */
10004    EAPI Evas_Object      *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10005    /**
10006     * @brief Set the content of the notify widget
10007     *
10008     * @param obj The notify object
10009     * @param content The content will be filled in this notify object
10010     *
10011     * Once the content object is set, a previously set one will be deleted. If
10012     * you want to keep that old content object, use the
10013     * elm_notify_content_unset() function.
10014     */
10015    EAPI void              elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10016    /**
10017     * @brief Unset the content of the notify widget
10018     *
10019     * @param obj The notify object
10020     * @return The content that was being used
10021     *
10022     * Unparent and return the content object which was set for this widget
10023     *
10024     * @see elm_notify_content_set()
10025     */
10026    EAPI Evas_Object      *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10027    /**
10028     * @brief Return the content of the notify widget
10029     *
10030     * @param obj The notify object
10031     * @return The content that is being used
10032     *
10033     * @see elm_notify_content_set()
10034     */
10035    EAPI Evas_Object      *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10036    /**
10037     * @brief Set the notify parent
10038     *
10039     * @param obj The notify object
10040     * @param content The new parent
10041     *
10042     * Once the parent object is set, a previously set one will be disconnected
10043     * and replaced.
10044     */
10045    EAPI void              elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10046    /**
10047     * @brief Get the notify parent
10048     *
10049     * @param obj The notify object
10050     * @return The parent
10051     *
10052     * @see elm_notify_parent_set()
10053     */
10054    EAPI Evas_Object      *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10055    /**
10056     * @brief Set the orientation
10057     *
10058     * @param obj The notify object
10059     * @param orient The new orientation
10060     *
10061     * Sets the position in which the notify will appear in its parent.
10062     *
10063     * @see @ref Elm_Notify_Orient for possible values.
10064     */
10065    EAPI void              elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10066    /**
10067     * @brief Return the orientation
10068     * @param obj The notify object
10069     * @return The orientation of the notification
10070     *
10071     * @see elm_notify_orient_set()
10072     * @see Elm_Notify_Orient
10073     */
10074    EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10075    /**
10076     * @brief Set the time interval after which the notify window is going to be
10077     * hidden.
10078     *
10079     * @param obj The notify object
10080     * @param time The timeout in seconds
10081     *
10082     * This function sets a timeout and starts the timer controlling when the
10083     * notify is hidden. Since calling evas_object_show() on a notify restarts
10084     * the timer controlling when the notify is hidden, setting this before the
10085     * notify is shown will in effect mean starting the timer when the notify is
10086     * shown.
10087     *
10088     * @note Set a value <= 0.0 to disable a running timer.
10089     *
10090     * @note If the value > 0.0 and the notify is previously visible, the
10091     * timer will be started with this value, canceling any running timer.
10092     */
10093    EAPI void              elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10094    /**
10095     * @brief Return the timeout value (in seconds)
10096     * @param obj the notify object
10097     *
10098     * @see elm_notify_timeout_set()
10099     */
10100    EAPI double            elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10101    /**
10102     * @brief Sets whether events should be passed to by a click outside
10103     * its area.
10104     *
10105     * @param obj The notify object
10106     * @param repeats EINA_TRUE Events are repeats, else no
10107     *
10108     * When true if the user clicks outside the window the events will be caught
10109     * by the others widgets, else the events are blocked.
10110     *
10111     * @note The default value is EINA_TRUE.
10112     */
10113    EAPI void              elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10114    /**
10115     * @brief Return true if events are repeat below the notify object
10116     * @param obj the notify object
10117     *
10118     * @see elm_notify_repeat_events_set()
10119     */
10120    EAPI Eina_Bool         elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10121    /**
10122     * @}
10123     */
10124
10125    /**
10126     * @defgroup Hover Hover
10127     *
10128     * @image html img/widget/hover/preview-00.png
10129     * @image latex img/widget/hover/preview-00.eps
10130     *
10131     * A Hover object will hover over its @p parent object at the @p target
10132     * location. Anything in the background will be given a darker coloring to
10133     * indicate that the hover object is on top (at the default theme). When the
10134     * hover is clicked it is dismissed(hidden), if the contents of the hover are
10135     * clicked that @b doesn't cause the hover to be dismissed.
10136     *
10137     * @note The hover object will take up the entire space of @p target
10138     * object.
10139     *
10140     * Elementary has the following styles for the hover widget:
10141     * @li default
10142     * @li popout
10143     * @li menu
10144     * @li hoversel_vertical
10145     *
10146     * The following are the available position for content:
10147     * @li left
10148     * @li top-left
10149     * @li top
10150     * @li top-right
10151     * @li right
10152     * @li bottom-right
10153     * @li bottom
10154     * @li bottom-left
10155     * @li middle
10156     * @li smart
10157     *
10158     * Signals that you can add callbacks for are:
10159     * @li "clicked" - the user clicked the empty space in the hover to dismiss
10160     * @li "smart,changed" - a content object placed under the "smart"
10161     *                   policy was replaced to a new slot direction.
10162     *
10163     * See @ref tutorial_hover for more information.
10164     *
10165     * @{
10166     */
10167    typedef enum _Elm_Hover_Axis
10168      {
10169         ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10170         ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10171         ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10172         ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10173      } Elm_Hover_Axis;
10174    /**
10175     * @brief Adds a hover object to @p parent
10176     *
10177     * @param parent The parent object
10178     * @return The hover object or NULL if one could not be created
10179     */
10180    EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10181    /**
10182     * @brief Sets the target object for the hover.
10183     *
10184     * @param obj The hover object
10185     * @param target The object to center the hover onto. The hover
10186     *
10187     * This function will cause the hover to be centered on the target object.
10188     */
10189    EAPI void         elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10190    /**
10191     * @brief Gets the target object for the hover.
10192     *
10193     * @param obj The hover object
10194     * @param parent The object to locate the hover over.
10195     *
10196     * @see elm_hover_target_set()
10197     */
10198    EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10199    /**
10200     * @brief Sets the parent object for the hover.
10201     *
10202     * @param obj The hover object
10203     * @param parent The object to locate the hover over.
10204     *
10205     * This function will cause the hover to take up the entire space that the
10206     * parent object fills.
10207     */
10208    EAPI void         elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10209    /**
10210     * @brief Gets the parent object for the hover.
10211     *
10212     * @param obj The hover object
10213     * @return The parent object to locate the hover over.
10214     *
10215     * @see elm_hover_parent_set()
10216     */
10217    EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10218    /**
10219     * @brief Sets the content of the hover object and the direction in which it
10220     * will pop out.
10221     *
10222     * @param obj The hover object
10223     * @param swallow The direction that the object will be displayed
10224     * at. Accepted values are "left", "top-left", "top", "top-right",
10225     * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10226     * "smart".
10227     * @param content The content to place at @p swallow
10228     *
10229     * Once the content object is set for a given direction, a previously
10230     * set one (on the same direction) will be deleted. If you want to
10231     * keep that old content object, use the elm_hover_content_unset()
10232     * function.
10233     *
10234     * All directions may have contents at the same time, except for
10235     * "smart". This is a special placement hint and its use case
10236     * independs of the calculations coming from
10237     * elm_hover_best_content_location_get(). Its use is for cases when
10238     * one desires only one hover content, but with a dinamic special
10239     * placement within the hover area. The content's geometry, whenever
10240     * it changes, will be used to decide on a best location not
10241     * extrapolating the hover's parent object view to show it in (still
10242     * being the hover's target determinant of its medium part -- move and
10243     * resize it to simulate finger sizes, for example). If one of the
10244     * directions other than "smart" are used, a previously content set
10245     * using it will be deleted, and vice-versa.
10246     */
10247    EAPI void         elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10248    /**
10249     * @brief Get the content of the hover object, in a given direction.
10250     *
10251     * Return the content object which was set for this widget in the
10252     * @p swallow direction.
10253     *
10254     * @param obj The hover object
10255     * @param swallow The direction that the object was display at.
10256     * @return The content that was being used
10257     *
10258     * @see elm_hover_content_set()
10259     */
10260    EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10261    /**
10262     * @brief Unset the content of the hover object, in a given direction.
10263     *
10264     * Unparent and return the content object set at @p swallow direction.
10265     *
10266     * @param obj The hover object
10267     * @param swallow The direction that the object was display at.
10268     * @return The content that was being used.
10269     *
10270     * @see elm_hover_content_set()
10271     */
10272    EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10273    /**
10274     * @brief Returns the best swallow location for content in the hover.
10275     *
10276     * @param obj The hover object
10277     * @param pref_axis The preferred orientation axis for the hover object to use
10278     * @return The edje location to place content into the hover or @c
10279     *         NULL, on errors.
10280     *
10281     * Best is defined here as the location at which there is the most available
10282     * space.
10283     *
10284     * @p pref_axis may be one of
10285     * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10286     * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10287     * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10288     * - @c ELM_HOVER_AXIS_BOTH -- both
10289     *
10290     * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10291     * nescessarily be along the horizontal axis("left" or "right"). If
10292     * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10293     * be along the vertical axis("top" or "bottom"). Chossing
10294     * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10295     * returned position may be in either axis.
10296     *
10297     * @see elm_hover_content_set()
10298     */
10299    EAPI const char  *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10300    /**
10301     * @}
10302     */
10303
10304    /* entry */
10305    /**
10306     * @defgroup Entry Entry
10307     *
10308     * @image html img/widget/entry/preview-00.png
10309     * @image latex img/widget/entry/preview-00.eps width=\textwidth
10310     * @image html img/widget/entry/preview-01.png
10311     * @image latex img/widget/entry/preview-01.eps width=\textwidth
10312     * @image html img/widget/entry/preview-02.png
10313     * @image latex img/widget/entry/preview-02.eps width=\textwidth
10314     * @image html img/widget/entry/preview-03.png
10315     * @image latex img/widget/entry/preview-03.eps width=\textwidth
10316     *
10317     * An entry is a convenience widget which shows a box that the user can
10318     * enter text into. Entries by default don't scroll, so they grow to
10319     * accomodate the entire text, resizing the parent window as needed. This
10320     * can be changed with the elm_entry_scrollable_set() function.
10321     *
10322     * They can also be single line or multi line (the default) and when set
10323     * to multi line mode they support text wrapping in any of the modes
10324     * indicated by #Elm_Wrap_Type.
10325     *
10326     * Other features include password mode, filtering of inserted text with
10327     * elm_entry_text_filter_append() and related functions, inline "items" and
10328     * formatted markup text.
10329     *
10330     * @section entry-markup Formatted text
10331     *
10332     * The markup tags supported by the Entry are defined by the theme, but
10333     * even when writing new themes or extensions it's a good idea to stick to
10334     * a sane default, to maintain coherency and avoid application breakages.
10335     * Currently defined by the default theme are the following tags:
10336     * @li \<br\>: Inserts a line break.
10337     * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10338     * breaks.
10339     * @li \<tab\>: Inserts a tab.
10340     * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10341     * enclosed text.
10342     * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10343     * @li \<link\>...\</link\>: Underlines the enclosed text.
10344     * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10345     *
10346     * @section entry-special Special markups
10347     *
10348     * Besides those used to format text, entries support two special markup
10349     * tags used to insert clickable portions of text or items inlined within
10350     * the text.
10351     *
10352     * @subsection entry-anchors Anchors
10353     *
10354     * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10355     * \</a\> tags and an event will be generated when this text is clicked,
10356     * like this:
10357     *
10358     * @code
10359     * This text is outside <a href=anc-01>but this one is an anchor</a>
10360     * @endcode
10361     *
10362     * The @c href attribute in the opening tag gives the name that will be
10363     * used to identify the anchor and it can be any valid utf8 string.
10364     *
10365     * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10366     * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10367     * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10368     * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10369     * an anchor.
10370     *
10371     * @subsection entry-items Items
10372     *
10373     * Inlined in the text, any other @c Evas_Object can be inserted by using
10374     * \<item\> tags this way:
10375     *
10376     * @code
10377     * <item size=16x16 vsize=full href=emoticon/haha></item>
10378     * @endcode
10379     *
10380     * Just like with anchors, the @c href identifies each item, but these need,
10381     * in addition, to indicate their size, which is done using any one of
10382     * @c size, @c absize or @c relsize attributes. These attributes take their
10383     * value in the WxH format, where W is the width and H the height of the
10384     * item.
10385     *
10386     * @li absize: Absolute pixel size for the item. Whatever value is set will
10387     * be the item's size regardless of any scale value the object may have
10388     * been set to. The final line height will be adjusted to fit larger items.
10389     * @li size: Similar to @c absize, but it's adjusted to the scale value set
10390     * for the object.
10391     * @li relsize: Size is adjusted for the item to fit within the current
10392     * line height.
10393     *
10394     * Besides their size, items are specificed a @c vsize value that affects
10395     * how their final size and position are calculated. The possible values
10396     * are:
10397     * @li ascent: Item will be placed within the line's baseline and its
10398     * ascent. That is, the height between the line where all characters are
10399     * positioned and the highest point in the line. For @c size and @c absize
10400     * items, the descent value will be added to the total line height to make
10401     * them fit. @c relsize items will be adjusted to fit within this space.
10402     * @li full: Items will be placed between the descent and ascent, or the
10403     * lowest point in the line and its highest.
10404     *
10405     * The next image shows different configurations of items and how they
10406     * are the previously mentioned options affect their sizes. In all cases,
10407     * the green line indicates the ascent, blue for the baseline and red for
10408     * the descent.
10409     *
10410     * @image html entry_item.png
10411     * @image latex entry_item.eps width=\textwidth
10412     *
10413     * And another one to show how size differs from absize. In the first one,
10414     * the scale value is set to 1.0, while the second one is using one of 2.0.
10415     *
10416     * @image html entry_item_scale.png
10417     * @image latex entry_item_scale.eps width=\textwidth
10418     *
10419     * After the size for an item is calculated, the entry will request an
10420     * object to place in its space. For this, the functions set with
10421     * elm_entry_item_provider_append() and related functions will be called
10422     * in order until one of them returns a @c non-NULL value. If no providers
10423     * are available, or all of them return @c NULL, then the entry falls back
10424     * to one of the internal defaults, provided the name matches with one of
10425     * them.
10426     *
10427     * All of the following are currently supported:
10428     *
10429     * - emoticon/angry
10430     * - emoticon/angry-shout
10431     * - emoticon/crazy-laugh
10432     * - emoticon/evil-laugh
10433     * - emoticon/evil
10434     * - emoticon/goggle-smile
10435     * - emoticon/grumpy
10436     * - emoticon/grumpy-smile
10437     * - emoticon/guilty
10438     * - emoticon/guilty-smile
10439     * - emoticon/haha
10440     * - emoticon/half-smile
10441     * - emoticon/happy-panting
10442     * - emoticon/happy
10443     * - emoticon/indifferent
10444     * - emoticon/kiss
10445     * - emoticon/knowing-grin
10446     * - emoticon/laugh
10447     * - emoticon/little-bit-sorry
10448     * - emoticon/love-lots
10449     * - emoticon/love
10450     * - emoticon/minimal-smile
10451     * - emoticon/not-happy
10452     * - emoticon/not-impressed
10453     * - emoticon/omg
10454     * - emoticon/opensmile
10455     * - emoticon/smile
10456     * - emoticon/sorry
10457     * - emoticon/squint-laugh
10458     * - emoticon/surprised
10459     * - emoticon/suspicious
10460     * - emoticon/tongue-dangling
10461     * - emoticon/tongue-poke
10462     * - emoticon/uh
10463     * - emoticon/unhappy
10464     * - emoticon/very-sorry
10465     * - emoticon/what
10466     * - emoticon/wink
10467     * - emoticon/worried
10468     * - emoticon/wtf
10469     *
10470     * Alternatively, an item may reference an image by its path, using
10471     * the URI form @c file:///path/to/an/image.png and the entry will then
10472     * use that image for the item.
10473     *
10474     * @section entry-files Loading and saving files
10475     *
10476     * Entries have convinience functions to load text from a file and save
10477     * changes back to it after a short delay. The automatic saving is enabled
10478     * by default, but can be disabled with elm_entry_autosave_set() and files
10479     * can be loaded directly as plain text or have any markup in them
10480     * recognized. See elm_entry_file_set() for more details.
10481     *
10482     * @section entry-signals Emitted signals
10483     *
10484     * This widget emits the following signals:
10485     *
10486     * @li "changed": The text within the entry was changed.
10487     * @li "changed,user": The text within the entry was changed because of user interaction.
10488     * @li "activated": The enter key was pressed on a single line entry.
10489     * @li "press": A mouse button has been pressed on the entry.
10490     * @li "longpressed": A mouse button has been pressed and held for a couple
10491     * seconds.
10492     * @li "clicked": The entry has been clicked (mouse press and release).
10493     * @li "clicked,double": The entry has been double clicked.
10494     * @li "clicked,triple": The entry has been triple clicked.
10495     * @li "focused": The entry has received focus.
10496     * @li "unfocused": The entry has lost focus.
10497     * @li "selection,paste": A paste of the clipboard contents was requested.
10498     * @li "selection,copy": A copy of the selected text into the clipboard was
10499     * requested.
10500     * @li "selection,cut": A cut of the selected text into the clipboard was
10501     * requested.
10502     * @li "selection,start": A selection has begun and no previous selection
10503     * existed.
10504     * @li "selection,changed": The current selection has changed.
10505     * @li "selection,cleared": The current selection has been cleared.
10506     * @li "cursor,changed": The cursor has changed position.
10507     * @li "anchor,clicked": An anchor has been clicked. The event_info
10508     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10509     * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10510     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10511     * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10512     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10513     * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10514     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10515     * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10516     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10517     * @li "preedit,changed": The preedit string has changed.
10518     *
10519     * @section entry-examples
10520     *
10521     * An overview of the Entry API can be seen in @ref entry_example_01
10522     *
10523     * @{
10524     */
10525    /**
10526     * @typedef Elm_Entry_Anchor_Info
10527     *
10528     * The info sent in the callback for the "anchor,clicked" signals emitted
10529     * by entries.
10530     */
10531    typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10532    /**
10533     * @struct _Elm_Entry_Anchor_Info
10534     *
10535     * The info sent in the callback for the "anchor,clicked" signals emitted
10536     * by entries.
10537     */
10538    struct _Elm_Entry_Anchor_Info
10539      {
10540         const char *name; /**< The name of the anchor, as stated in its href */
10541         int         button; /**< The mouse button used to click on it */
10542         Evas_Coord  x, /**< Anchor geometry, relative to canvas */
10543                     y, /**< Anchor geometry, relative to canvas */
10544                     w, /**< Anchor geometry, relative to canvas */
10545                     h; /**< Anchor geometry, relative to canvas */
10546      };
10547    /**
10548     * @typedef Elm_Entry_Filter_Cb
10549     * This callback type is used by entry filters to modify text.
10550     * @param data The data specified as the last param when adding the filter
10551     * @param entry The entry object
10552     * @param text A pointer to the location of the text being filtered. This data can be modified,
10553     * but any additional allocations must be managed by the user.
10554     * @see elm_entry_text_filter_append
10555     * @see elm_entry_text_filter_prepend
10556     */
10557    typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
10558
10559    /**
10560     * This adds an entry to @p parent object.
10561     *
10562     * By default, entries are:
10563     * @li not scrolled
10564     * @li multi-line
10565     * @li word wrapped
10566     * @li autosave is enabled
10567     *
10568     * @param parent The parent object
10569     * @return The new object or NULL if it cannot be created
10570     */
10571    EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10572    /**
10573     * Sets the entry to single line mode.
10574     *
10575     * In single line mode, entries don't ever wrap when the text reaches the
10576     * edge, and instead they keep growing horizontally. Pressing the @c Enter
10577     * key will generate an @c "activate" event instead of adding a new line.
10578     *
10579     * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
10580     * and pressing enter will break the text into a different line
10581     * without generating any events.
10582     *
10583     * @param obj The entry object
10584     * @param single_line If true, the text in the entry
10585     * will be on a single line.
10586     */
10587    EAPI void         elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
10588    /**
10589     * Gets whether the entry is set to be single line.
10590     *
10591     * @param obj The entry object
10592     * @return single_line If true, the text in the entry is set to display
10593     * on a single line.
10594     *
10595     * @see elm_entry_single_line_set()
10596     */
10597    EAPI Eina_Bool    elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10598    /**
10599     * Sets the entry to password mode.
10600     *
10601     * In password mode, entries are implicitly single line and the display of
10602     * any text in them is replaced with asterisks (*).
10603     *
10604     * @param obj The entry object
10605     * @param password If true, password mode is enabled.
10606     */
10607    EAPI void         elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
10608    /**
10609     * Gets whether the entry is set to password mode.
10610     *
10611     * @param obj The entry object
10612     * @return If true, the entry is set to display all characters
10613     * as asterisks (*).
10614     *
10615     * @see elm_entry_password_set()
10616     */
10617    EAPI Eina_Bool    elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10618    /**
10619     * This sets the text displayed within the entry to @p entry.
10620     *
10621     * @param obj The entry object
10622     * @param entry The text to be displayed
10623     *
10624     * @deprecated Use elm_object_text_set() instead.
10625     */
10626    EAPI void         elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10627    /**
10628     * This returns the text currently shown in object @p entry.
10629     * See also elm_entry_entry_set().
10630     *
10631     * @param obj The entry object
10632     * @return The currently displayed text or NULL on failure
10633     *
10634     * @deprecated Use elm_object_text_get() instead.
10635     */
10636    EAPI const char  *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10637    /**
10638     * Appends @p entry to the text of the entry.
10639     *
10640     * Adds the text in @p entry to the end of any text already present in the
10641     * widget.
10642     *
10643     * The appended text is subject to any filters set for the widget.
10644     *
10645     * @param obj The entry object
10646     * @param entry The text to be displayed
10647     *
10648     * @see elm_entry_text_filter_append()
10649     */
10650    EAPI void         elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10651    /**
10652     * Gets whether the entry is empty.
10653     *
10654     * Empty means no text at all. If there are any markup tags, like an item
10655     * tag for which no provider finds anything, and no text is displayed, this
10656     * function still returns EINA_FALSE.
10657     *
10658     * @param obj The entry object
10659     * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
10660     */
10661    EAPI Eina_Bool    elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10662    /**
10663     * Gets any selected text within the entry.
10664     *
10665     * If there's any selected text in the entry, this function returns it as
10666     * a string in markup format. NULL is returned if no selection exists or
10667     * if an error occurred.
10668     *
10669     * The returned value points to an internal string and should not be freed
10670     * or modified in any way. If the @p entry object is deleted or its
10671     * contents are changed, the returned pointer should be considered invalid.
10672     *
10673     * @param obj The entry object
10674     * @return The selected text within the entry or NULL on failure
10675     */
10676    EAPI const char  *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10677    /**
10678     * Inserts the given text into the entry at the current cursor position.
10679     *
10680     * This inserts text at the cursor position as if it was typed
10681     * by the user (note that this also allows markup which a user
10682     * can't just "type" as it would be converted to escaped text, so this
10683     * call can be used to insert things like emoticon items or bold push/pop
10684     * tags, other font and color change tags etc.)
10685     *
10686     * If any selection exists, it will be replaced by the inserted text.
10687     *
10688     * The inserted text is subject to any filters set for the widget.
10689     *
10690     * @param obj The entry object
10691     * @param entry The text to insert
10692     *
10693     * @see elm_entry_text_filter_append()
10694     */
10695    EAPI void         elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10696    /**
10697     * Set the line wrap type to use on multi-line entries.
10698     *
10699     * Sets the wrap type used by the entry to any of the specified in
10700     * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
10701     * line (without inserting a line break or paragraph separator) when it
10702     * reaches the far edge of the widget.
10703     *
10704     * Note that this only makes sense for multi-line entries. A widget set
10705     * to be single line will never wrap.
10706     *
10707     * @param obj The entry object
10708     * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
10709     */
10710    EAPI void         elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
10711    /**
10712     * Gets the wrap mode the entry was set to use.
10713     *
10714     * @param obj The entry object
10715     * @return Wrap type
10716     *
10717     * @see also elm_entry_line_wrap_set()
10718     */
10719    EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10720    /**
10721     * Sets if the entry is to be editable or not.
10722     *
10723     * By default, entries are editable and when focused, any text input by the
10724     * user will be inserted at the current cursor position. But calling this
10725     * function with @p editable as EINA_FALSE will prevent the user from
10726     * inputting text into the entry.
10727     *
10728     * The only way to change the text of a non-editable entry is to use
10729     * elm_object_text_set(), elm_entry_entry_insert() and other related
10730     * functions.
10731     *
10732     * @param obj The entry object
10733     * @param editable If EINA_TRUE, user input will be inserted in the entry,
10734     * if not, the entry is read-only and no user input is allowed.
10735     */
10736    EAPI void         elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
10737    /**
10738     * Gets whether the entry is editable or not.
10739     *
10740     * @param obj The entry object
10741     * @return If true, the entry is editable by the user.
10742     * If false, it is not editable by the user
10743     *
10744     * @see elm_entry_editable_set()
10745     */
10746    EAPI Eina_Bool    elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10747    /**
10748     * This drops any existing text selection within the entry.
10749     *
10750     * @param obj The entry object
10751     */
10752    EAPI void         elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
10753    /**
10754     * This selects all text within the entry.
10755     *
10756     * @param obj The entry object
10757     */
10758    EAPI void         elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
10759    /**
10760     * This moves the cursor one place to the right within the entry.
10761     *
10762     * @param obj The entry object
10763     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10764     */
10765    EAPI Eina_Bool    elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
10766    /**
10767     * This moves the cursor one place to the left within the entry.
10768     *
10769     * @param obj The entry object
10770     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10771     */
10772    EAPI Eina_Bool    elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
10773    /**
10774     * This moves the cursor one line up within the entry.
10775     *
10776     * @param obj The entry object
10777     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10778     */
10779    EAPI Eina_Bool    elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
10780    /**
10781     * This moves the cursor one line down within the entry.
10782     *
10783     * @param obj The entry object
10784     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10785     */
10786    EAPI Eina_Bool    elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
10787    /**
10788     * This moves the cursor to the beginning of the entry.
10789     *
10790     * @param obj The entry object
10791     */
10792    EAPI void         elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10793    /**
10794     * This moves the cursor to the end of the entry.
10795     *
10796     * @param obj The entry object
10797     */
10798    EAPI void         elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10799    /**
10800     * This moves the cursor to the beginning of the current line.
10801     *
10802     * @param obj The entry object
10803     */
10804    EAPI void         elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10805    /**
10806     * This moves the cursor to the end of the current line.
10807     *
10808     * @param obj The entry object
10809     */
10810    EAPI void         elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10811    /**
10812     * This begins a selection within the entry as though
10813     * the user were holding down the mouse button to make a selection.
10814     *
10815     * @param obj The entry object
10816     */
10817    EAPI void         elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
10818    /**
10819     * This ends a selection within the entry as though
10820     * the user had just released the mouse button while making a selection.
10821     *
10822     * @param obj The entry object
10823     */
10824    EAPI void         elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
10825    /**
10826     * Gets whether a format node exists at the current cursor position.
10827     *
10828     * A format node is anything that defines how the text is rendered. It can
10829     * be a visible format node, such as a line break or a paragraph separator,
10830     * or an invisible one, such as bold begin or end tag.
10831     * This function returns whether any format node exists at the current
10832     * cursor position.
10833     *
10834     * @param obj The entry object
10835     * @return EINA_TRUE if the current cursor position contains a format node,
10836     * EINA_FALSE otherwise.
10837     *
10838     * @see elm_entry_cursor_is_visible_format_get()
10839     */
10840    EAPI Eina_Bool    elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10841    /**
10842     * Gets if the current cursor position holds a visible format node.
10843     *
10844     * @param obj The entry object
10845     * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
10846     * if it's an invisible one or no format exists.
10847     *
10848     * @see elm_entry_cursor_is_format_get()
10849     */
10850    EAPI Eina_Bool    elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10851    /**
10852     * Gets the character pointed by the cursor at its current position.
10853     *
10854     * This function returns a string with the utf8 character stored at the
10855     * current cursor position.
10856     * Only the text is returned, any format that may exist will not be part
10857     * of the return value.
10858     *
10859     * @param obj The entry object
10860     * @return The text pointed by the cursors.
10861     */
10862    EAPI const char  *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10863    /**
10864     * This function returns the geometry of the cursor.
10865     *
10866     * It's useful if you want to draw something on the cursor (or where it is),
10867     * or for example in the case of scrolled entry where you want to show the
10868     * cursor.
10869     *
10870     * @param obj The entry object
10871     * @param x returned geometry
10872     * @param y returned geometry
10873     * @param w returned geometry
10874     * @param h returned geometry
10875     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10876     */
10877    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);
10878    /**
10879     * Sets the cursor position in the entry to the given value
10880     *
10881     * The value in @p pos is the index of the character position within the
10882     * contents of the string as returned by elm_entry_cursor_pos_get().
10883     *
10884     * @param obj The entry object
10885     * @param pos The position of the cursor
10886     */
10887    EAPI void         elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
10888    /**
10889     * Retrieves the current position of the cursor in the entry
10890     *
10891     * @param obj The entry object
10892     * @return The cursor position
10893     */
10894    EAPI int          elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10895    /**
10896     * This executes a "cut" action on the selected text in the entry.
10897     *
10898     * @param obj The entry object
10899     */
10900    EAPI void         elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
10901    /**
10902     * This executes a "copy" action on the selected text in the entry.
10903     *
10904     * @param obj The entry object
10905     */
10906    EAPI void         elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
10907    /**
10908     * This executes a "paste" action in the entry.
10909     *
10910     * @param obj The entry object
10911     */
10912    EAPI void         elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
10913    /**
10914     * This clears and frees the items in a entry's contextual (longpress)
10915     * menu.
10916     *
10917     * @param obj The entry object
10918     *
10919     * @see elm_entry_context_menu_item_add()
10920     */
10921    EAPI void         elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
10922    /**
10923     * This adds an item to the entry's contextual menu.
10924     *
10925     * A longpress on an entry will make the contextual menu show up, if this
10926     * hasn't been disabled with elm_entry_context_menu_disabled_set().
10927     * By default, this menu provides a few options like enabling selection mode,
10928     * which is useful on embedded devices that need to be explicit about it,
10929     * and when a selection exists it also shows the copy and cut actions.
10930     *
10931     * With this function, developers can add other options to this menu to
10932     * perform any action they deem necessary.
10933     *
10934     * @param obj The entry object
10935     * @param label The item's text label
10936     * @param icon_file The item's icon file
10937     * @param icon_type The item's icon type
10938     * @param func The callback to execute when the item is clicked
10939     * @param data The data to associate with the item for related functions
10940     */
10941    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);
10942    /**
10943     * This disables the entry's contextual (longpress) menu.
10944     *
10945     * @param obj The entry object
10946     * @param disabled If true, the menu is disabled
10947     */
10948    EAPI void         elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
10949    /**
10950     * This returns whether the entry's contextual (longpress) menu is
10951     * disabled.
10952     *
10953     * @param obj The entry object
10954     * @return If true, the menu is disabled
10955     */
10956    EAPI Eina_Bool    elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10957    /**
10958     * This appends a custom item provider to the list for that entry
10959     *
10960     * This appends the given callback. The list is walked from beginning to end
10961     * with each function called given the item href string in the text. If the
10962     * function returns an object handle other than NULL (it should create an
10963     * object to do this), then this object is used to replace that item. If
10964     * not the next provider is called until one provides an item object, or the
10965     * default provider in entry does.
10966     *
10967     * @param obj The entry object
10968     * @param func The function called to provide the item object
10969     * @param data The data passed to @p func
10970     *
10971     * @see @ref entry-items
10972     */
10973    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);
10974    /**
10975     * This prepends a custom item provider to the list for that entry
10976     *
10977     * This prepends the given callback. See elm_entry_item_provider_append() for
10978     * more information
10979     *
10980     * @param obj The entry object
10981     * @param func The function called to provide the item object
10982     * @param data The data passed to @p func
10983     */
10984    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);
10985    /**
10986     * This removes a custom item provider to the list for that entry
10987     *
10988     * This removes the given callback. See elm_entry_item_provider_append() for
10989     * more information
10990     *
10991     * @param obj The entry object
10992     * @param func The function called to provide the item object
10993     * @param data The data passed to @p func
10994     */
10995    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);
10996    /**
10997     * Append a filter function for text inserted in the entry
10998     *
10999     * Append the given callback to the list. This functions will be called
11000     * whenever any text is inserted into the entry, with the text to be inserted
11001     * as a parameter. The callback function is free to alter the text in any way
11002     * it wants, but it must remember to free the given pointer and update it.
11003     * If the new text is to be discarded, the function can free it and set its
11004     * text parameter to NULL. This will also prevent any following filters from
11005     * being called.
11006     *
11007     * @param obj The entry object
11008     * @param func The function to use as text filter
11009     * @param data User data to pass to @p func
11010     */
11011    EAPI void         elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11012    /**
11013     * Prepend a filter function for text insdrted in the entry
11014     *
11015     * Prepend the given callback to the list. See elm_entry_text_filter_append()
11016     * for more information
11017     *
11018     * @param obj The entry object
11019     * @param func The function to use as text filter
11020     * @param data User data to pass to @p func
11021     */
11022    EAPI void         elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11023    /**
11024     * Remove a filter from the list
11025     *
11026     * Removes the given callback from the filter list. See
11027     * elm_entry_text_filter_append() for more information.
11028     *
11029     * @param obj The entry object
11030     * @param func The filter function to remove
11031     * @param data The user data passed when adding the function
11032     */
11033    EAPI void         elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11034    /**
11035     * This converts a markup (HTML-like) string into UTF-8.
11036     *
11037     * The returned string is a malloc'ed buffer and it should be freed when
11038     * not needed anymore.
11039     *
11040     * @param s The string (in markup) to be converted
11041     * @return The converted string (in UTF-8). It should be freed.
11042     */
11043    EAPI char        *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11044    /**
11045     * This converts a UTF-8 string into markup (HTML-like).
11046     *
11047     * The returned string is a malloc'ed buffer and it should be freed when
11048     * not needed anymore.
11049     *
11050     * @param s The string (in UTF-8) to be converted
11051     * @return The converted string (in markup). It should be freed.
11052     */
11053    EAPI char        *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11054    /**
11055     * This sets the file (and implicitly loads it) for the text to display and
11056     * then edit. All changes are written back to the file after a short delay if
11057     * the entry object is set to autosave (which is the default).
11058     *
11059     * If the entry had any other file set previously, any changes made to it
11060     * will be saved if the autosave feature is enabled, otherwise, the file
11061     * will be silently discarded and any non-saved changes will be lost.
11062     *
11063     * @param obj The entry object
11064     * @param file The path to the file to load and save
11065     * @param format The file format
11066     */
11067    EAPI void         elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11068    /**
11069     * Gets the file being edited by the entry.
11070     *
11071     * This function can be used to retrieve any file set on the entry for
11072     * edition, along with the format used to load and save it.
11073     *
11074     * @param obj The entry object
11075     * @param file The path to the file to load and save
11076     * @param format The file format
11077     */
11078    EAPI void         elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11079    /**
11080     * This function writes any changes made to the file set with
11081     * elm_entry_file_set()
11082     *
11083     * @param obj The entry object
11084     */
11085    EAPI void         elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11086    /**
11087     * This sets the entry object to 'autosave' the loaded text file or not.
11088     *
11089     * @param obj The entry object
11090     * @param autosave Autosave the loaded file or not
11091     *
11092     * @see elm_entry_file_set()
11093     */
11094    EAPI void         elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11095    /**
11096     * This gets the entry object's 'autosave' status.
11097     *
11098     * @param obj The entry object
11099     * @return Autosave the loaded file or not
11100     *
11101     * @see elm_entry_file_set()
11102     */
11103    EAPI Eina_Bool    elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11104    /**
11105     * Control pasting of text and images for the widget.
11106     *
11107     * Normally the entry allows both text and images to be pasted.  By setting
11108     * textonly to be true, this prevents images from being pasted.
11109     *
11110     * Note this only changes the behaviour of text.
11111     *
11112     * @param obj The entry object
11113     * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11114     * text+image+other.
11115     */
11116    EAPI void         elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11117    /**
11118     * Getting elm_entry text paste/drop mode.
11119     *
11120     * In textonly mode, only text may be pasted or dropped into the widget.
11121     *
11122     * @param obj The entry object
11123     * @return If the widget only accepts text from pastes.
11124     */
11125    EAPI Eina_Bool    elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11126    /**
11127     * Enable or disable scrolling in entry
11128     *
11129     * Normally the entry is not scrollable unless you enable it with this call.
11130     *
11131     * @param obj The entry object
11132     * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11133     */
11134    EAPI void         elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11135    /**
11136     * Get the scrollable state of the entry
11137     *
11138     * Normally the entry is not scrollable. This gets the scrollable state
11139     * of the entry. See elm_entry_scrollable_set() for more information.
11140     *
11141     * @param obj The entry object
11142     * @return The scrollable state
11143     */
11144    EAPI Eina_Bool    elm_entry_scrollable_get(const Evas_Object *obj);
11145    /**
11146     * This sets a widget to be displayed to the left of a scrolled entry.
11147     *
11148     * @param obj The scrolled entry object
11149     * @param icon The widget to display on the left side of the scrolled
11150     * entry.
11151     *
11152     * @note A previously set widget will be destroyed.
11153     * @note If the object being set does not have minimum size hints set,
11154     * it won't get properly displayed.
11155     *
11156     * @see elm_entry_end_set()
11157     */
11158    EAPI void         elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11159    /**
11160     * Gets the leftmost widget of the scrolled entry. This object is
11161     * owned by the scrolled entry and should not be modified.
11162     *
11163     * @param obj The scrolled entry object
11164     * @return the left widget inside the scroller
11165     */
11166    EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11167    /**
11168     * Unset the leftmost widget of the scrolled entry, unparenting and
11169     * returning it.
11170     *
11171     * @param obj The scrolled entry object
11172     * @return the previously set icon sub-object of this entry, on
11173     * success.
11174     *
11175     * @see elm_entry_icon_set()
11176     */
11177    EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11178    /**
11179     * Sets the visibility of the left-side widget of the scrolled entry,
11180     * set by elm_entry_icon_set().
11181     *
11182     * @param obj The scrolled entry object
11183     * @param setting EINA_TRUE if the object should be displayed,
11184     * EINA_FALSE if not.
11185     */
11186    EAPI void         elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11187    /**
11188     * This sets a widget to be displayed to the end of a scrolled entry.
11189     *
11190     * @param obj The scrolled entry object
11191     * @param end The widget to display on the right side of the scrolled
11192     * entry.
11193     *
11194     * @note A previously set widget will be destroyed.
11195     * @note If the object being set does not have minimum size hints set,
11196     * it won't get properly displayed.
11197     *
11198     * @see elm_entry_icon_set
11199     */
11200    EAPI void         elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11201    /**
11202     * Gets the endmost widget of the scrolled entry. This object is owned
11203     * by the scrolled entry and should not be modified.
11204     *
11205     * @param obj The scrolled entry object
11206     * @return the right widget inside the scroller
11207     */
11208    EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11209    /**
11210     * Unset the endmost widget of the scrolled entry, unparenting and
11211     * returning it.
11212     *
11213     * @param obj The scrolled entry object
11214     * @return the previously set icon sub-object of this entry, on
11215     * success.
11216     *
11217     * @see elm_entry_icon_set()
11218     */
11219    EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11220    /**
11221     * Sets the visibility of the end widget of the scrolled entry, set by
11222     * elm_entry_end_set().
11223     *
11224     * @param obj The scrolled entry object
11225     * @param setting EINA_TRUE if the object should be displayed,
11226     * EINA_FALSE if not.
11227     */
11228    EAPI void         elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11229    /**
11230     * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11231     * them).
11232     *
11233     * Setting an entry to single-line mode with elm_entry_single_line_set()
11234     * will automatically disable the display of scrollbars when the entry
11235     * moves inside its scroller.
11236     *
11237     * @param obj The scrolled entry object
11238     * @param h The horizontal scrollbar policy to apply
11239     * @param v The vertical scrollbar policy to apply
11240     */
11241    EAPI void         elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11242    /**
11243     * This enables/disables bouncing within the entry.
11244     *
11245     * This function sets whether the entry will bounce when scrolling reaches
11246     * the end of the contained entry.
11247     *
11248     * @param obj The scrolled entry object
11249     * @param h The horizontal bounce state
11250     * @param v The vertical bounce state
11251     */
11252    EAPI void         elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11253    /**
11254     * Get the bounce mode
11255     *
11256     * @param obj The Entry object
11257     * @param h_bounce Allow bounce horizontally
11258     * @param v_bounce Allow bounce vertically
11259     */
11260    EAPI void         elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11261
11262    /* pre-made filters for entries */
11263    /**
11264     * @typedef Elm_Entry_Filter_Limit_Size
11265     *
11266     * Data for the elm_entry_filter_limit_size() entry filter.
11267     */
11268    typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11269    /**
11270     * @struct _Elm_Entry_Filter_Limit_Size
11271     *
11272     * Data for the elm_entry_filter_limit_size() entry filter.
11273     */
11274    struct _Elm_Entry_Filter_Limit_Size
11275      {
11276         int max_char_count; /**< The maximum number of characters allowed. */
11277         int max_byte_count; /**< The maximum number of bytes allowed*/
11278      };
11279    /**
11280     * Filter inserted text based on user defined character and byte limits
11281     *
11282     * Add this filter to an entry to limit the characters that it will accept
11283     * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11284     * The funtion works on the UTF-8 representation of the string, converting
11285     * it from the set markup, thus not accounting for any format in it.
11286     *
11287     * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11288     * it as data when setting the filter. In it, it's possible to set limits
11289     * by character count or bytes (any of them is disabled if 0), and both can
11290     * be set at the same time. In that case, it first checks for characters,
11291     * then bytes.
11292     *
11293     * The function will cut the inserted text in order to allow only the first
11294     * number of characters that are still allowed. The cut is made in
11295     * characters, even when limiting by bytes, in order to always contain
11296     * valid ones and avoid half unicode characters making it in.
11297     *
11298     * This filter, like any others, does not apply when setting the entry text
11299     * directly with elm_object_text_set() (or the deprecated
11300     * elm_entry_entry_set()).
11301     */
11302    EAPI void         elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11303    /**
11304     * @typedef Elm_Entry_Filter_Accept_Set
11305     *
11306     * Data for the elm_entry_filter_accept_set() entry filter.
11307     */
11308    typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11309    /**
11310     * @struct _Elm_Entry_Filter_Accept_Set
11311     *
11312     * Data for the elm_entry_filter_accept_set() entry filter.
11313     */
11314    struct _Elm_Entry_Filter_Accept_Set
11315      {
11316         const char *accepted; /**< Set of characters accepted in the entry. */
11317         const char *rejected; /**< Set of characters rejected from the entry. */
11318      };
11319    /**
11320     * Filter inserted text based on accepted or rejected sets of characters
11321     *
11322     * Add this filter to an entry to restrict the set of accepted characters
11323     * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11324     * This structure contains both accepted and rejected sets, but they are
11325     * mutually exclusive.
11326     *
11327     * The @c accepted set takes preference, so if it is set, the filter will
11328     * only work based on the accepted characters, ignoring anything in the
11329     * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11330     *
11331     * In both cases, the function filters by matching utf8 characters to the
11332     * raw markup text, so it can be used to remove formatting tags.
11333     *
11334     * This filter, like any others, does not apply when setting the entry text
11335     * directly with elm_object_text_set() (or the deprecated
11336     * elm_entry_entry_set()).
11337     */
11338    EAPI void         elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11339    /**
11340     * Set the input panel layout of the entry
11341     *
11342     * @param obj The entry object
11343     * @param layout layout type
11344     */
11345    EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11346    /**
11347     * Get the input panel layout of the entry
11348     *
11349     * @param obj The entry object
11350     * @return layout type
11351     *
11352     * @see elm_entry_input_panel_layout_set
11353     */
11354    EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11355    /**
11356     * @}
11357     */
11358
11359    /* composite widgets - these basically put together basic widgets above
11360     * in convenient packages that do more than basic stuff */
11361
11362    /* anchorview */
11363    /**
11364     * @defgroup Anchorview Anchorview
11365     *
11366     * @image html img/widget/anchorview/preview-00.png
11367     * @image latex img/widget/anchorview/preview-00.eps
11368     *
11369     * Anchorview is for displaying text that contains markup with anchors
11370     * like <c>\<a href=1234\>something\</\></c> in it.
11371     *
11372     * Besides being styled differently, the anchorview widget provides the
11373     * necessary functionality so that clicking on these anchors brings up a
11374     * popup with user defined content such as "call", "add to contacts" or
11375     * "open web page". This popup is provided using the @ref Hover widget.
11376     *
11377     * This widget is very similar to @ref Anchorblock, so refer to that
11378     * widget for an example. The only difference Anchorview has is that the
11379     * widget is already provided with scrolling functionality, so if the
11380     * text set to it is too large to fit in the given space, it will scroll,
11381     * whereas the @ref Anchorblock widget will keep growing to ensure all the
11382     * text can be displayed.
11383     *
11384     * This widget emits the following signals:
11385     * @li "anchor,clicked": will be called when an anchor is clicked. The
11386     * @p event_info parameter on the callback will be a pointer of type
11387     * ::Elm_Entry_Anchorview_Info.
11388     *
11389     * See @ref Anchorblock for an example on how to use both of them.
11390     *
11391     * @see Anchorblock
11392     * @see Entry
11393     * @see Hover
11394     *
11395     * @{
11396     */
11397    /**
11398     * @typedef Elm_Entry_Anchorview_Info
11399     *
11400     * The info sent in the callback for "anchor,clicked" signals emitted by
11401     * the Anchorview widget.
11402     */
11403    typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11404    /**
11405     * @struct _Elm_Entry_Anchorview_Info
11406     *
11407     * The info sent in the callback for "anchor,clicked" signals emitted by
11408     * the Anchorview widget.
11409     */
11410    struct _Elm_Entry_Anchorview_Info
11411      {
11412         const char     *name; /**< Name of the anchor, as indicated in its href
11413                                    attribute */
11414         int             button; /**< The mouse button used to click on it */
11415         Evas_Object    *hover; /**< The hover object to use for the popup */
11416         struct {
11417              Evas_Coord    x, y, w, h;
11418         } anchor, /**< Geometry selection of text used as anchor */
11419           hover_parent; /**< Geometry of the object used as parent by the
11420                              hover */
11421         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
11422                                              for content on the left side of
11423                                              the hover. Before calling the
11424                                              callback, the widget will make the
11425                                              necessary calculations to check
11426                                              which sides are fit to be set with
11427                                              content, based on the position the
11428                                              hover is activated and its distance
11429                                              to the edges of its parent object
11430                                              */
11431         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
11432                                               the right side of the hover.
11433                                               See @ref hover_left */
11434         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
11435                                             of the hover. See @ref hover_left */
11436         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
11437                                                below the hover. See @ref
11438                                                hover_left */
11439      };
11440    /**
11441     * Add a new Anchorview object
11442     *
11443     * @param parent The parent object
11444     * @return The new object or NULL if it cannot be created
11445     */
11446    EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11447    /**
11448     * Set the text to show in the anchorview
11449     *
11450     * Sets the text of the anchorview to @p text. This text can include markup
11451     * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11452     * text that will be specially styled and react to click events, ended with
11453     * either of \</a\> or \</\>. When clicked, the anchor will emit an
11454     * "anchor,clicked" signal that you can attach a callback to with
11455     * evas_object_smart_callback_add(). The name of the anchor given in the
11456     * event info struct will be the one set in the href attribute, in this
11457     * case, anchorname.
11458     *
11459     * Other markup can be used to style the text in different ways, but it's
11460     * up to the style defined in the theme which tags do what.
11461     * @deprecated use elm_object_text_set() instead.
11462     */
11463    EINA_DEPRECATED EAPI void         elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11464    /**
11465     * Get the markup text set for the anchorview
11466     *
11467     * Retrieves the text set on the anchorview, with markup tags included.
11468     *
11469     * @param obj The anchorview object
11470     * @return The markup text set or @c NULL if nothing was set or an error
11471     * occurred
11472     * @deprecated use elm_object_text_set() instead.
11473     */
11474    EINA_DEPRECATED EAPI const char  *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11475    /**
11476     * Set the parent of the hover popup
11477     *
11478     * Sets the parent object to use by the hover created by the anchorview
11479     * when an anchor is clicked. See @ref Hover for more details on this.
11480     * If no parent is set, the same anchorview object will be used.
11481     *
11482     * @param obj The anchorview object
11483     * @param parent The object to use as parent for the hover
11484     */
11485    EAPI void         elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11486    /**
11487     * Get the parent of the hover popup
11488     *
11489     * Get the object used as parent for the hover created by the anchorview
11490     * widget. See @ref Hover for more details on this.
11491     *
11492     * @param obj The anchorview object
11493     * @return The object used as parent for the hover, NULL if none is set.
11494     */
11495    EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11496    /**
11497     * Set the style that the hover should use
11498     *
11499     * When creating the popup hover, anchorview will request that it's
11500     * themed according to @p style.
11501     *
11502     * @param obj The anchorview object
11503     * @param style The style to use for the underlying hover
11504     *
11505     * @see elm_object_style_set()
11506     */
11507    EAPI void         elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11508    /**
11509     * Get the style that the hover should use
11510     *
11511     * Get the style the hover created by anchorview will use.
11512     *
11513     * @param obj The anchorview object
11514     * @return The style to use by the hover. NULL means the default is used.
11515     *
11516     * @see elm_object_style_set()
11517     */
11518    EAPI const char  *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11519    /**
11520     * Ends the hover popup in the anchorview
11521     *
11522     * When an anchor is clicked, the anchorview widget will create a hover
11523     * object to use as a popup with user provided content. This function
11524     * terminates this popup, returning the anchorview to its normal state.
11525     *
11526     * @param obj The anchorview object
11527     */
11528    EAPI void         elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11529    /**
11530     * Set bouncing behaviour when the scrolled content reaches an edge
11531     *
11532     * Tell the internal scroller object whether it should bounce or not
11533     * when it reaches the respective edges for each axis.
11534     *
11535     * @param obj The anchorview object
11536     * @param h_bounce Whether to bounce or not in the horizontal axis
11537     * @param v_bounce Whether to bounce or not in the vertical axis
11538     *
11539     * @see elm_scroller_bounce_set()
11540     */
11541    EAPI void         elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
11542    /**
11543     * Get the set bouncing behaviour of the internal scroller
11544     *
11545     * Get whether the internal scroller should bounce when the edge of each
11546     * axis is reached scrolling.
11547     *
11548     * @param obj The anchorview object
11549     * @param h_bounce Pointer where to store the bounce state of the horizontal
11550     *                 axis
11551     * @param v_bounce Pointer where to store the bounce state of the vertical
11552     *                 axis
11553     *
11554     * @see elm_scroller_bounce_get()
11555     */
11556    EAPI void         elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
11557    /**
11558     * Appends a custom item provider to the given anchorview
11559     *
11560     * Appends the given function to the list of items providers. This list is
11561     * called, one function at a time, with the given @p data pointer, the
11562     * anchorview object and, in the @p item parameter, the item name as
11563     * referenced in its href string. Following functions in the list will be
11564     * called in order until one of them returns something different to NULL,
11565     * which should be an Evas_Object which will be used in place of the item
11566     * element.
11567     *
11568     * Items in the markup text take the form \<item relsize=16x16 vsize=full
11569     * href=item/name\>\</item\>
11570     *
11571     * @param obj The anchorview object
11572     * @param func The function to add to the list of providers
11573     * @param data User data that will be passed to the callback function
11574     *
11575     * @see elm_entry_item_provider_append()
11576     */
11577    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);
11578    /**
11579     * Prepend a custom item provider to the given anchorview
11580     *
11581     * Like elm_anchorview_item_provider_append(), but it adds the function
11582     * @p func to the beginning of the list, instead of the end.
11583     *
11584     * @param obj The anchorview object
11585     * @param func The function to add to the list of providers
11586     * @param data User data that will be passed to the callback function
11587     */
11588    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);
11589    /**
11590     * Remove a custom item provider from the list of the given anchorview
11591     *
11592     * Removes the function and data pairing that matches @p func and @p data.
11593     * That is, unless the same function and same user data are given, the
11594     * function will not be removed from the list. This allows us to add the
11595     * same callback several times, with different @p data pointers and be
11596     * able to remove them later without conflicts.
11597     *
11598     * @param obj The anchorview object
11599     * @param func The function to remove from the list
11600     * @param data The data matching the function to remove from the list
11601     */
11602    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);
11603    /**
11604     * @}
11605     */
11606
11607    /* anchorblock */
11608    /**
11609     * @defgroup Anchorblock Anchorblock
11610     *
11611     * @image html img/widget/anchorblock/preview-00.png
11612     * @image latex img/widget/anchorblock/preview-00.eps
11613     *
11614     * Anchorblock is for displaying text that contains markup with anchors
11615     * like <c>\<a href=1234\>something\</\></c> in it.
11616     *
11617     * Besides being styled differently, the anchorblock widget provides the
11618     * necessary functionality so that clicking on these anchors brings up a
11619     * popup with user defined content such as "call", "add to contacts" or
11620     * "open web page". This popup is provided using the @ref Hover widget.
11621     *
11622     * This widget emits the following signals:
11623     * @li "anchor,clicked": will be called when an anchor is clicked. The
11624     * @p event_info parameter on the callback will be a pointer of type
11625     * ::Elm_Entry_Anchorblock_Info.
11626     *
11627     * @see Anchorview
11628     * @see Entry
11629     * @see Hover
11630     *
11631     * Since examples are usually better than plain words, we might as well
11632     * try @ref tutorial_anchorblock_example "one".
11633     */
11634    /**
11635     * @addtogroup Anchorblock
11636     * @{
11637     */
11638    /**
11639     * @typedef Elm_Entry_Anchorblock_Info
11640     *
11641     * The info sent in the callback for "anchor,clicked" signals emitted by
11642     * the Anchorblock widget.
11643     */
11644    typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
11645    /**
11646     * @struct _Elm_Entry_Anchorblock_Info
11647     *
11648     * The info sent in the callback for "anchor,clicked" signals emitted by
11649     * the Anchorblock widget.
11650     */
11651    struct _Elm_Entry_Anchorblock_Info
11652      {
11653         const char     *name; /**< Name of the anchor, as indicated in its href
11654                                    attribute */
11655         int             button; /**< The mouse button used to click on it */
11656         Evas_Object    *hover; /**< The hover object to use for the popup */
11657         struct {
11658              Evas_Coord    x, y, w, h;
11659         } anchor, /**< Geometry selection of text used as anchor */
11660           hover_parent; /**< Geometry of the object used as parent by the
11661                              hover */
11662         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
11663                                              for content on the left side of
11664                                              the hover. Before calling the
11665                                              callback, the widget will make the
11666                                              necessary calculations to check
11667                                              which sides are fit to be set with
11668                                              content, based on the position the
11669                                              hover is activated and its distance
11670                                              to the edges of its parent object
11671                                              */
11672         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
11673                                               the right side of the hover.
11674                                               See @ref hover_left */
11675         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
11676                                             of the hover. See @ref hover_left */
11677         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
11678                                                below the hover. See @ref
11679                                                hover_left */
11680      };
11681    /**
11682     * Add a new Anchorblock object
11683     *
11684     * @param parent The parent object
11685     * @return The new object or NULL if it cannot be created
11686     */
11687    EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11688    /**
11689     * Set the text to show in the anchorblock
11690     *
11691     * Sets the text of the anchorblock to @p text. This text can include markup
11692     * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
11693     * of text that will be specially styled and react to click events, ended
11694     * with either of \</a\> or \</\>. When clicked, the anchor will emit an
11695     * "anchor,clicked" signal that you can attach a callback to with
11696     * evas_object_smart_callback_add(). The name of the anchor given in the
11697     * event info struct will be the one set in the href attribute, in this
11698     * case, anchorname.
11699     *
11700     * Other markup can be used to style the text in different ways, but it's
11701     * up to the style defined in the theme which tags do what.
11702     * @deprecated use elm_object_text_set() instead.
11703     */
11704    EINA_DEPRECATED EAPI void         elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11705    /**
11706     * Get the markup text set for the anchorblock
11707     *
11708     * Retrieves the text set on the anchorblock, with markup tags included.
11709     *
11710     * @param obj The anchorblock object
11711     * @return The markup text set or @c NULL if nothing was set or an error
11712     * occurred
11713     * @deprecated use elm_object_text_set() instead.
11714     */
11715    EINA_DEPRECATED EAPI const char  *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11716    /**
11717     * Set the parent of the hover popup
11718     *
11719     * Sets the parent object to use by the hover created by the anchorblock
11720     * when an anchor is clicked. See @ref Hover for more details on this.
11721     *
11722     * @param obj The anchorblock object
11723     * @param parent The object to use as parent for the hover
11724     */
11725    EAPI void         elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11726    /**
11727     * Get the parent of the hover popup
11728     *
11729     * Get the object used as parent for the hover created by the anchorblock
11730     * widget. See @ref Hover for more details on this.
11731     * If no parent is set, the same anchorblock object will be used.
11732     *
11733     * @param obj The anchorblock object
11734     * @return The object used as parent for the hover, NULL if none is set.
11735     */
11736    EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11737    /**
11738     * Set the style that the hover should use
11739     *
11740     * When creating the popup hover, anchorblock will request that it's
11741     * themed according to @p style.
11742     *
11743     * @param obj The anchorblock object
11744     * @param style The style to use for the underlying hover
11745     *
11746     * @see elm_object_style_set()
11747     */
11748    EAPI void         elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11749    /**
11750     * Get the style that the hover should use
11751     *
11752     * Get the style the hover created by anchorblock will use.
11753     *
11754     * @param obj The anchorblock object
11755     * @return The style to use by the hover. NULL means the default is used.
11756     *
11757     * @see elm_object_style_set()
11758     */
11759    EAPI const char  *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11760    /**
11761     * Ends the hover popup in the anchorblock
11762     *
11763     * When an anchor is clicked, the anchorblock widget will create a hover
11764     * object to use as a popup with user provided content. This function
11765     * terminates this popup, returning the anchorblock to its normal state.
11766     *
11767     * @param obj The anchorblock object
11768     */
11769    EAPI void         elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11770    /**
11771     * Appends a custom item provider to the given anchorblock
11772     *
11773     * Appends the given function to the list of items providers. This list is
11774     * called, one function at a time, with the given @p data pointer, the
11775     * anchorblock object and, in the @p item parameter, the item name as
11776     * referenced in its href string. Following functions in the list will be
11777     * called in order until one of them returns something different to NULL,
11778     * which should be an Evas_Object which will be used in place of the item
11779     * element.
11780     *
11781     * Items in the markup text take the form \<item relsize=16x16 vsize=full
11782     * href=item/name\>\</item\>
11783     *
11784     * @param obj The anchorblock object
11785     * @param func The function to add to the list of providers
11786     * @param data User data that will be passed to the callback function
11787     *
11788     * @see elm_entry_item_provider_append()
11789     */
11790    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);
11791    /**
11792     * Prepend a custom item provider to the given anchorblock
11793     *
11794     * Like elm_anchorblock_item_provider_append(), but it adds the function
11795     * @p func to the beginning of the list, instead of the end.
11796     *
11797     * @param obj The anchorblock object
11798     * @param func The function to add to the list of providers
11799     * @param data User data that will be passed to the callback function
11800     */
11801    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);
11802    /**
11803     * Remove a custom item provider from the list of the given anchorblock
11804     *
11805     * Removes the function and data pairing that matches @p func and @p data.
11806     * That is, unless the same function and same user data are given, the
11807     * function will not be removed from the list. This allows us to add the
11808     * same callback several times, with different @p data pointers and be
11809     * able to remove them later without conflicts.
11810     *
11811     * @param obj The anchorblock object
11812     * @param func The function to remove from the list
11813     * @param data The data matching the function to remove from the list
11814     */
11815    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);
11816    /**
11817     * @}
11818     */
11819
11820    /**
11821     * @defgroup Bubble Bubble
11822     *
11823     * @image html img/widget/bubble/preview-00.png
11824     * @image latex img/widget/bubble/preview-00.eps
11825     * @image html img/widget/bubble/preview-01.png
11826     * @image latex img/widget/bubble/preview-01.eps
11827     * @image html img/widget/bubble/preview-02.png
11828     * @image latex img/widget/bubble/preview-02.eps
11829     *
11830     * @brief The Bubble is a widget to show text similarly to how speech is
11831     * represented in comics.
11832     *
11833     * The bubble widget contains 5 important visual elements:
11834     * @li The frame is a rectangle with rounded rectangles and an "arrow".
11835     * @li The @p icon is an image to which the frame's arrow points to.
11836     * @li The @p label is a text which appears to the right of the icon if the
11837     * corner is "top_left" or "bottom_left" and is right aligned to the frame
11838     * otherwise.
11839     * @li The @p info is a text which appears to the right of the label. Info's
11840     * font is of a ligther color than label.
11841     * @li The @p content is an evas object that is shown inside the frame.
11842     *
11843     * The position of the arrow, icon, label and info depends on which corner is
11844     * selected. The four available corners are:
11845     * @li "top_left" - Default
11846     * @li "top_right"
11847     * @li "bottom_left"
11848     * @li "bottom_right"
11849     *
11850     * Signals that you can add callbacks for are:
11851     * @li "clicked" - This is called when a user has clicked the bubble.
11852     *
11853     * For an example of using a buble see @ref bubble_01_example_page "this".
11854     *
11855     * @{
11856     */
11857    /**
11858     * Add a new bubble to the parent
11859     *
11860     * @param parent The parent object
11861     * @return The new object or NULL if it cannot be created
11862     *
11863     * This function adds a text bubble to the given parent evas object.
11864     */
11865    EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11866    /**
11867     * Set the label of the bubble
11868     *
11869     * @param obj The bubble object
11870     * @param label The string to set in the label
11871     *
11872     * This function sets the title of the bubble. Where this appears depends on
11873     * the selected corner.
11874     * @deprecated use elm_object_text_set() instead.
11875     */
11876    EINA_DEPRECATED EAPI void         elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
11877    /**
11878     * Get the label of the bubble
11879     *
11880     * @param obj The bubble object
11881     * @return The string of set in the label
11882     *
11883     * This function gets the title of the bubble.
11884     * @deprecated use elm_object_text_get() instead.
11885     */
11886    EINA_DEPRECATED EAPI const char  *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11887    /**
11888     * Set the info of the bubble
11889     *
11890     * @param obj The bubble object
11891     * @param info The given info about the bubble
11892     *
11893     * This function sets the info of the bubble. Where this appears depends on
11894     * the selected corner.
11895     * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
11896     */
11897    EINA_DEPRECATED EAPI void         elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
11898    /**
11899     * Get the info of the bubble
11900     *
11901     * @param obj The bubble object
11902     *
11903     * @return The "info" string of the bubble
11904     *
11905     * This function gets the info text.
11906     * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
11907     */
11908    EINA_DEPRECATED EAPI const char  *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11909    /**
11910     * Set the content to be shown in the bubble
11911     *
11912     * Once the content object is set, a previously set one will be deleted.
11913     * If you want to keep the old content object, use the
11914     * elm_bubble_content_unset() function.
11915     *
11916     * @param obj The bubble object
11917     * @param content The given content of the bubble
11918     *
11919     * This function sets the content shown on the middle of the bubble.
11920     */
11921    EAPI void         elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
11922    /**
11923     * Get the content shown in the bubble
11924     *
11925     * Return the content object which is set for this widget.
11926     *
11927     * @param obj The bubble object
11928     * @return The content that is being used
11929     */
11930    EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11931    /**
11932     * Unset the content shown in the bubble
11933     *
11934     * Unparent and return the content object which was set for this widget.
11935     *
11936     * @param obj The bubble object
11937     * @return The content that was being used
11938     */
11939    EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11940    /**
11941     * Set the icon of the bubble
11942     *
11943     * Once the icon object is set, a previously set one will be deleted.
11944     * If you want to keep the old content object, use the
11945     * elm_icon_content_unset() function.
11946     *
11947     * @param obj The bubble object
11948     * @param icon The given icon for the bubble
11949     */
11950    EAPI void         elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
11951    /**
11952     * Get the icon of the bubble
11953     *
11954     * @param obj The bubble object
11955     * @return The icon for the bubble
11956     *
11957     * This function gets the icon shown on the top left of bubble.
11958     */
11959    EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11960    /**
11961     * Unset the icon of the bubble
11962     *
11963     * Unparent and return the icon object which was set for this widget.
11964     *
11965     * @param obj The bubble object
11966     * @return The icon that was being used
11967     */
11968    EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11969    /**
11970     * Set the corner of the bubble
11971     *
11972     * @param obj The bubble object.
11973     * @param corner The given corner for the bubble.
11974     *
11975     * This function sets the corner of the bubble. The corner will be used to
11976     * determine where the arrow in the frame points to and where label, icon and
11977     * info arre shown.
11978     *
11979     * Possible values for corner are:
11980     * @li "top_left" - Default
11981     * @li "top_right"
11982     * @li "bottom_left"
11983     * @li "bottom_right"
11984     */
11985    EAPI void         elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
11986    /**
11987     * Get the corner of the bubble
11988     *
11989     * @param obj The bubble object.
11990     * @return The given corner for the bubble.
11991     *
11992     * This function gets the selected corner of the bubble.
11993     */
11994    EAPI const char  *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11995    /**
11996     * @}
11997     */
11998
11999    /**
12000     * @defgroup Photo Photo
12001     *
12002     * For displaying the photo of a person (contact). Simple yet
12003     * with a very specific purpose.
12004     *
12005     * Signals that you can add callbacks for are:
12006     *
12007     * "clicked" - This is called when a user has clicked the photo
12008     * "drag,start" - Someone started dragging the image out of the object
12009     * "drag,end" - Dragged item was dropped (somewhere)
12010     *
12011     * @{
12012     */
12013
12014    /**
12015     * Add a new photo to the parent
12016     *
12017     * @param parent The parent object
12018     * @return The new object or NULL if it cannot be created
12019     *
12020     * @ingroup Photo
12021     */
12022    EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12023
12024    /**
12025     * Set the file that will be used as photo
12026     *
12027     * @param obj The photo object
12028     * @param file The path to file that will be used as photo
12029     *
12030     * @return (1 = success, 0 = error)
12031     *
12032     * @ingroup Photo
12033     */
12034    EAPI Eina_Bool    elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12035
12036     /**
12037     * Set the file that will be used as thumbnail in the photo.
12038     *
12039     * @param obj The photo object.
12040     * @param file The path to file that will be used as thumb.
12041     * @param group The key used in case of an EET file.
12042     *
12043     * @ingroup Photo
12044     */
12045    EAPI void         elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12046
12047    /**
12048     * Set the size that will be used on the photo
12049     *
12050     * @param obj The photo object
12051     * @param size The size that the photo will be
12052     *
12053     * @ingroup Photo
12054     */
12055    EAPI void         elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12056
12057    /**
12058     * Set if the photo should be completely visible or not.
12059     *
12060     * @param obj The photo object
12061     * @param fill if true the photo will be completely visible
12062     *
12063     * @ingroup Photo
12064     */
12065    EAPI void         elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12066
12067    /**
12068     * Set editability of the photo.
12069     *
12070     * An editable photo can be dragged to or from, and can be cut or
12071     * pasted too.  Note that pasting an image or dropping an item on
12072     * the image will delete the existing content.
12073     *
12074     * @param obj The photo object.
12075     * @param set To set of clear editablity.
12076     */
12077    EAPI void         elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12078
12079    /**
12080     * @}
12081     */
12082
12083    /* gesture layer */
12084    /**
12085     * @defgroup Elm_Gesture_Layer Gesture Layer
12086     * Gesture Layer Usage:
12087     *
12088     * Use Gesture Layer to detect gestures.
12089     * The advantage is that you don't have to implement
12090     * gesture detection, just set callbacks of gesture state.
12091     * By using gesture layer we make standard interface.
12092     *
12093     * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12094     * with a parent object parameter.
12095     * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12096     * call. Usually with same object as target (2nd parameter).
12097     *
12098     * Now you need to tell gesture layer what gestures you follow.
12099     * This is done with @ref elm_gesture_layer_cb_set call.
12100     * By setting the callback you actually saying to gesture layer:
12101     * I would like to know when the gesture @ref Elm_Gesture_Types
12102     * switches to state @ref Elm_Gesture_State.
12103     *
12104     * Next, you need to implement the actual action that follows the input
12105     * in your callback.
12106     *
12107     * Note that if you like to stop being reported about a gesture, just set
12108     * all callbacks referring this gesture to NULL.
12109     * (again with @ref elm_gesture_layer_cb_set)
12110     *
12111     * The information reported by gesture layer to your callback is depending
12112     * on @ref Elm_Gesture_Types:
12113     * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12114     * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12115     * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12116     *
12117     * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12118     * @ref ELM_GESTURE_MOMENTUM.
12119     *
12120     * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12121     * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12122     * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12123     * Note that we consider a flick as a line-gesture that should be completed
12124     * in flick-time-limit as defined in @ref Config.
12125     *
12126     * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12127     *
12128     * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12129     *
12130     *
12131     * Gesture Layer Tweaks:
12132     *
12133     * Note that line, flick, gestures can start without the need to remove fingers from surface.
12134     * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12135     *
12136     * Setting glayer_continues_enable to false in @ref Config will change this behavior
12137     * so gesture starts when user touches (a *DOWN event) touch-surface
12138     * and ends when no fingers touches surface (a *UP event).
12139     */
12140
12141    /**
12142     * @enum _Elm_Gesture_Types
12143     * Enum of supported gesture types.
12144     * @ingroup Elm_Gesture_Layer
12145     */
12146    enum _Elm_Gesture_Types
12147      {
12148         ELM_GESTURE_FIRST = 0,
12149
12150         ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12151         ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12152         ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12153         ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12154
12155         ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12156
12157         ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12158         ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12159
12160         ELM_GESTURE_ZOOM, /**< Zoom */
12161         ELM_GESTURE_ROTATE, /**< Rotate */
12162
12163         ELM_GESTURE_LAST
12164      };
12165
12166    /**
12167     * @typedef Elm_Gesture_Types
12168     * gesture types enum
12169     * @ingroup Elm_Gesture_Layer
12170     */
12171    typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12172
12173    /**
12174     * @enum _Elm_Gesture_State
12175     * Enum of gesture states.
12176     * @ingroup Elm_Gesture_Layer
12177     */
12178    enum _Elm_Gesture_State
12179      {
12180         ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12181         ELM_GESTURE_STATE_START,          /**< Gesture STARTed     */
12182         ELM_GESTURE_STATE_MOVE,           /**< Gesture is ongoing  */
12183         ELM_GESTURE_STATE_END,            /**< Gesture completed   */
12184         ELM_GESTURE_STATE_ABORT    /**< Onging gesture was ABORTed */
12185      };
12186
12187    /**
12188     * @typedef Elm_Gesture_State
12189     * gesture states enum
12190     * @ingroup Elm_Gesture_Layer
12191     */
12192    typedef enum _Elm_Gesture_State Elm_Gesture_State;
12193
12194    /**
12195     * @struct _Elm_Gesture_Taps_Info
12196     * Struct holds taps info for user
12197     * @ingroup Elm_Gesture_Layer
12198     */
12199    struct _Elm_Gesture_Taps_Info
12200      {
12201         Evas_Coord x, y;         /**< Holds center point between fingers */
12202         unsigned int n;          /**< Number of fingers tapped           */
12203         unsigned int timestamp;  /**< event timestamp       */
12204      };
12205
12206    /**
12207     * @typedef Elm_Gesture_Taps_Info
12208     * holds taps info for user
12209     * @ingroup Elm_Gesture_Layer
12210     */
12211    typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12212
12213    /**
12214     * @struct _Elm_Gesture_Momentum_Info
12215     * Struct holds momentum info for user
12216     * x1 and y1 are not necessarily in sync
12217     * x1 holds x value of x direction starting point
12218     * and same holds for y1.
12219     * This is noticeable when doing V-shape movement
12220     * @ingroup Elm_Gesture_Layer
12221     */
12222    struct _Elm_Gesture_Momentum_Info
12223      {  /* Report line ends, timestamps, and momentum computed        */
12224         Evas_Coord x1; /**< Final-swipe direction starting point on X */
12225         Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12226         Evas_Coord x2; /**< Final-swipe direction ending point on X   */
12227         Evas_Coord y2; /**< Final-swipe direction ending point on Y   */
12228
12229         unsigned int tx; /**< Timestamp of start of final x-swipe */
12230         unsigned int ty; /**< Timestamp of start of final y-swipe */
12231
12232         Evas_Coord mx; /**< Momentum on X */
12233         Evas_Coord my; /**< Momentum on Y */
12234      };
12235
12236    /**
12237     * @typedef Elm_Gesture_Momentum_Info
12238     * holds momentum info for user
12239     * @ingroup Elm_Gesture_Layer
12240     */
12241     typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12242
12243    /**
12244     * @struct _Elm_Gesture_Line_Info
12245     * Struct holds line info for user
12246     * @ingroup Elm_Gesture_Layer
12247     */
12248    struct _Elm_Gesture_Line_Info
12249      {  /* Report line ends, timestamps, and momentum computed      */
12250         Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12251         unsigned int n;            /**< Number of fingers (lines)   */
12252         /* FIXME should be radians, bot degrees */
12253         double angle;              /**< Angle (direction) of lines  */
12254      };
12255
12256    /**
12257     * @typedef Elm_Gesture_Line_Info
12258     * Holds line info for user
12259     * @ingroup Elm_Gesture_Layer
12260     */
12261     typedef struct  _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12262
12263    /**
12264     * @struct _Elm_Gesture_Zoom_Info
12265     * Struct holds zoom info for user
12266     * @ingroup Elm_Gesture_Layer
12267     */
12268    struct _Elm_Gesture_Zoom_Info
12269      {
12270         Evas_Coord x, y;       /**< Holds zoom center point reported to user  */
12271         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12272         double zoom;            /**< Zoom value: 1.0 means no zoom             */
12273         double momentum;        /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12274      };
12275
12276    /**
12277     * @typedef Elm_Gesture_Zoom_Info
12278     * Holds zoom info for user
12279     * @ingroup Elm_Gesture_Layer
12280     */
12281    typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12282
12283    /**
12284     * @struct _Elm_Gesture_Rotate_Info
12285     * Struct holds rotation info for user
12286     * @ingroup Elm_Gesture_Layer
12287     */
12288    struct _Elm_Gesture_Rotate_Info
12289      {
12290         Evas_Coord x, y;   /**< Holds zoom center point reported to user      */
12291         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12292         double base_angle; /**< Holds start-angle */
12293         double angle;      /**< Rotation value: 0.0 means no rotation         */
12294         double momentum;   /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12295      };
12296
12297    /**
12298     * @typedef Elm_Gesture_Rotate_Info
12299     * Holds rotation info for user
12300     * @ingroup Elm_Gesture_Layer
12301     */
12302    typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12303
12304    /**
12305     * @typedef Elm_Gesture_Event_Cb
12306     * User callback used to stream gesture info from gesture layer
12307     * @param data user data
12308     * @param event_info gesture report info
12309     * Returns a flag field to be applied on the causing event.
12310     * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12311     * upon the event, in an irreversible way.
12312     *
12313     * @ingroup Elm_Gesture_Layer
12314     */
12315    typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12316
12317    /**
12318     * Use function to set callbacks to be notified about
12319     * change of state of gesture.
12320     * When a user registers a callback with this function
12321     * this means this gesture has to be tested.
12322     *
12323     * When ALL callbacks for a gesture are set to NULL
12324     * it means user isn't interested in gesture-state
12325     * and it will not be tested.
12326     *
12327     * @param obj Pointer to gesture-layer.
12328     * @param idx The gesture you would like to track its state.
12329     * @param cb callback function pointer.
12330     * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12331     * @param data user info to be sent to callback (usually, Smart Data)
12332     *
12333     * @ingroup Elm_Gesture_Layer
12334     */
12335    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);
12336
12337    /**
12338     * Call this function to get repeat-events settings.
12339     *
12340     * @param obj Pointer to gesture-layer.
12341     *
12342     * @return repeat events settings.
12343     * @see elm_gesture_layer_hold_events_set()
12344     * @ingroup Elm_Gesture_Layer
12345     */
12346    EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12347
12348    /**
12349     * This function called in order to make gesture-layer repeat events.
12350     * Set this of you like to get the raw events only if gestures were not detected.
12351     * Clear this if you like gesture layer to fwd events as testing gestures.
12352     *
12353     * @param obj Pointer to gesture-layer.
12354     * @param r Repeat: TRUE/FALSE
12355     *
12356     * @ingroup Elm_Gesture_Layer
12357     */
12358    EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12359
12360    /**
12361     * This function sets step-value for zoom action.
12362     * Set step to any positive value.
12363     * Cancel step setting by setting to 0.0
12364     *
12365     * @param obj Pointer to gesture-layer.
12366     * @param s new zoom step value.
12367     *
12368     * @ingroup Elm_Gesture_Layer
12369     */
12370    EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12371
12372    /**
12373     * This function sets step-value for rotate action.
12374     * Set step to any positive value.
12375     * Cancel step setting by setting to 0.0
12376     *
12377     * @param obj Pointer to gesture-layer.
12378     * @param s new roatate step value.
12379     *
12380     * @ingroup Elm_Gesture_Layer
12381     */
12382    EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12383
12384    /**
12385     * This function called to attach gesture-layer to an Evas_Object.
12386     * @param obj Pointer to gesture-layer.
12387     * @param t Pointer to underlying object (AKA Target)
12388     *
12389     * @return TRUE, FALSE on success, failure.
12390     *
12391     * @ingroup Elm_Gesture_Layer
12392     */
12393    EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12394
12395    /**
12396     * Call this function to construct a new gesture-layer object.
12397     * This does not activate the gesture layer. You have to
12398     * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12399     *
12400     * @param parent the parent object.
12401     *
12402     * @return Pointer to new gesture-layer object.
12403     *
12404     * @ingroup Elm_Gesture_Layer
12405     */
12406    EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12407
12408    /**
12409     * @defgroup Thumb Thumb
12410     *
12411     * @image html img/widget/thumb/preview-00.png
12412     * @image latex img/widget/thumb/preview-00.eps
12413     *
12414     * A thumb object is used for displaying the thumbnail of an image or video.
12415     * You must have compiled Elementary with Ethumb_Client support and the DBus
12416     * service must be present and auto-activated in order to have thumbnails to
12417     * be generated.
12418     *
12419     * Once the thumbnail object becomes visible, it will check if there is a
12420     * previously generated thumbnail image for the file set on it. If not, it
12421     * will start generating this thumbnail.
12422     *
12423     * Different config settings will cause different thumbnails to be generated
12424     * even on the same file.
12425     *
12426     * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12427     * Ethumb documentation to change this path, and to see other configuration
12428     * options.
12429     *
12430     * Signals that you can add callbacks for are:
12431     *
12432     * - "clicked" - This is called when a user has clicked the thumb without dragging
12433     *             around.
12434     * - "clicked,double" - This is called when a user has double-clicked the thumb.
12435     * - "press" - This is called when a user has pressed down the thumb.
12436     * - "generate,start" - The thumbnail generation started.
12437     * - "generate,stop" - The generation process stopped.
12438     * - "generate,error" - The generation failed.
12439     * - "load,error" - The thumbnail image loading failed.
12440     *
12441     * available styles:
12442     * - default
12443     * - noframe
12444     *
12445     * An example of use of thumbnail:
12446     *
12447     * - @ref thumb_example_01
12448     */
12449
12450    /**
12451     * @addtogroup Thumb
12452     * @{
12453     */
12454
12455    /**
12456     * @enum _Elm_Thumb_Animation_Setting
12457     * @typedef Elm_Thumb_Animation_Setting
12458     *
12459     * Used to set if a video thumbnail is animating or not.
12460     *
12461     * @ingroup Thumb
12462     */
12463    typedef enum _Elm_Thumb_Animation_Setting
12464      {
12465         ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12466         ELM_THUMB_ANIMATION_LOOP,      /**< Keep playing animation until stop is requested */
12467         ELM_THUMB_ANIMATION_STOP,      /**< Stop playing the animation */
12468         ELM_THUMB_ANIMATION_LAST
12469      } Elm_Thumb_Animation_Setting;
12470
12471    /**
12472     * Add a new thumb object to the parent.
12473     *
12474     * @param parent The parent object.
12475     * @return The new object or NULL if it cannot be created.
12476     *
12477     * @see elm_thumb_file_set()
12478     * @see elm_thumb_ethumb_client_get()
12479     *
12480     * @ingroup Thumb
12481     */
12482    EAPI Evas_Object                 *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12483    /**
12484     * Reload thumbnail if it was generated before.
12485     *
12486     * @param obj The thumb object to reload
12487     *
12488     * This is useful if the ethumb client configuration changed, like its
12489     * size, aspect or any other property one set in the handle returned
12490     * by elm_thumb_ethumb_client_get().
12491     *
12492     * If the options didn't change, the thumbnail won't be generated again, but
12493     * the old one will still be used.
12494     *
12495     * @see elm_thumb_file_set()
12496     *
12497     * @ingroup Thumb
12498     */
12499    EAPI void                         elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
12500    /**
12501     * Set the file that will be used as thumbnail.
12502     *
12503     * @param obj The thumb object.
12504     * @param file The path to file that will be used as thumb.
12505     * @param key The key used in case of an EET file.
12506     *
12507     * The file can be an image or a video (in that case, acceptable extensions are:
12508     * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
12509     * function elm_thumb_animate().
12510     *
12511     * @see elm_thumb_file_get()
12512     * @see elm_thumb_reload()
12513     * @see elm_thumb_animate()
12514     *
12515     * @ingroup Thumb
12516     */
12517    EAPI void                         elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
12518    /**
12519     * Get the image or video path and key used to generate the thumbnail.
12520     *
12521     * @param obj The thumb object.
12522     * @param file Pointer to filename.
12523     * @param key Pointer to key.
12524     *
12525     * @see elm_thumb_file_set()
12526     * @see elm_thumb_path_get()
12527     *
12528     * @ingroup Thumb
12529     */
12530    EAPI void                         elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12531    /**
12532     * Get the path and key to the image or video generated by ethumb.
12533     *
12534     * One just need to make sure that the thumbnail was generated before getting
12535     * its path; otherwise, the path will be NULL. One way to do that is by asking
12536     * for the path when/after the "generate,stop" smart callback is called.
12537     *
12538     * @param obj The thumb object.
12539     * @param file Pointer to thumb path.
12540     * @param key Pointer to thumb key.
12541     *
12542     * @see elm_thumb_file_get()
12543     *
12544     * @ingroup Thumb
12545     */
12546    EAPI void                         elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12547    /**
12548     * Set the animation state for the thumb object. If its content is an animated
12549     * video, you may start/stop the animation or tell it to play continuously and
12550     * looping.
12551     *
12552     * @param obj The thumb object.
12553     * @param setting The animation setting.
12554     *
12555     * @see elm_thumb_file_set()
12556     *
12557     * @ingroup Thumb
12558     */
12559    EAPI void                         elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
12560    /**
12561     * Get the animation state for the thumb object.
12562     *
12563     * @param obj The thumb object.
12564     * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
12565     * on errors.
12566     *
12567     * @see elm_thumb_animate_set()
12568     *
12569     * @ingroup Thumb
12570     */
12571    EAPI Elm_Thumb_Animation_Setting  elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12572    /**
12573     * Get the ethumb_client handle so custom configuration can be made.
12574     *
12575     * @return Ethumb_Client instance or NULL.
12576     *
12577     * This must be called before the objects are created to be sure no object is
12578     * visible and no generation started.
12579     *
12580     * Example of usage:
12581     *
12582     * @code
12583     * #include <Elementary.h>
12584     * #ifndef ELM_LIB_QUICKLAUNCH
12585     * EAPI_MAIN int
12586     * elm_main(int argc, char **argv)
12587     * {
12588     *    Ethumb_Client *client;
12589     *
12590     *    elm_need_ethumb();
12591     *
12592     *    // ... your code
12593     *
12594     *    client = elm_thumb_ethumb_client_get();
12595     *    if (!client)
12596     *      {
12597     *         ERR("could not get ethumb_client");
12598     *         return 1;
12599     *      }
12600     *    ethumb_client_size_set(client, 100, 100);
12601     *    ethumb_client_crop_align_set(client, 0.5, 0.5);
12602     *    // ... your code
12603     *
12604     *    // Create elm_thumb objects here
12605     *
12606     *    elm_run();
12607     *    elm_shutdown();
12608     *    return 0;
12609     * }
12610     * #endif
12611     * ELM_MAIN()
12612     * @endcode
12613     *
12614     * @note There's only one client handle for Ethumb, so once a configuration
12615     * change is done to it, any other request for thumbnails (for any thumbnail
12616     * object) will use that configuration. Thus, this configuration is global.
12617     *
12618     * @ingroup Thumb
12619     */
12620    EAPI void                        *elm_thumb_ethumb_client_get(void);
12621    /**
12622     * Get the ethumb_client connection state.
12623     *
12624     * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
12625     * otherwise.
12626     */
12627    EAPI Eina_Bool                    elm_thumb_ethumb_client_connected(void);
12628    /**
12629     * Make the thumbnail 'editable'.
12630     *
12631     * @param obj Thumb object.
12632     * @param set Turn on or off editability. Default is @c EINA_FALSE.
12633     *
12634     * This means the thumbnail is a valid drag target for drag and drop, and can be
12635     * cut or pasted too.
12636     *
12637     * @see elm_thumb_editable_get()
12638     *
12639     * @ingroup Thumb
12640     */
12641    EAPI Eina_Bool                    elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
12642    /**
12643     * Make the thumbnail 'editable'.
12644     *
12645     * @param obj Thumb object.
12646     * @return Editability.
12647     *
12648     * This means the thumbnail is a valid drag target for drag and drop, and can be
12649     * cut or pasted too.
12650     *
12651     * @see elm_thumb_editable_set()
12652     *
12653     * @ingroup Thumb
12654     */
12655    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12656
12657    /**
12658     * @}
12659     */
12660
12661    /**
12662     * @defgroup Hoversel Hoversel
12663     *
12664     * @image html img/widget/hoversel/preview-00.png
12665     * @image latex img/widget/hoversel/preview-00.eps
12666     *
12667     * A hoversel is a button that pops up a list of items (automatically
12668     * choosing the direction to display) that have a label and, optionally, an
12669     * icon to select from. It is a convenience widget to avoid the need to do
12670     * all the piecing together yourself. It is intended for a small number of
12671     * items in the hoversel menu (no more than 8), though is capable of many
12672     * more.
12673     *
12674     * Signals that you can add callbacks for are:
12675     * "clicked" - the user clicked the hoversel button and popped up the sel
12676     * "selected" - an item in the hoversel list is selected. event_info is the item
12677     * "dismissed" - the hover is dismissed
12678     *
12679     * See @ref tutorial_hoversel for an example.
12680     * @{
12681     */
12682    typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
12683    /**
12684     * @brief Add a new Hoversel object
12685     *
12686     * @param parent The parent object
12687     * @return The new object or NULL if it cannot be created
12688     */
12689    EAPI Evas_Object       *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12690    /**
12691     * @brief This sets the hoversel to expand horizontally.
12692     *
12693     * @param obj The hoversel object
12694     * @param horizontal If true, the hover will expand horizontally to the
12695     * right.
12696     *
12697     * @note The initial button will display horizontally regardless of this
12698     * setting.
12699     */
12700    EAPI void               elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
12701    /**
12702     * @brief This returns whether the hoversel is set to expand horizontally.
12703     *
12704     * @param obj The hoversel object
12705     * @return If true, the hover will expand horizontally to the right.
12706     *
12707     * @see elm_hoversel_horizontal_set()
12708     */
12709    EAPI Eina_Bool          elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12710    /**
12711     * @brief Set the Hover parent
12712     *
12713     * @param obj The hoversel object
12714     * @param parent The parent to use
12715     *
12716     * Sets the hover parent object, the area that will be darkened when the
12717     * hoversel is clicked. Should probably be the window that the hoversel is
12718     * in. See @ref Hover objects for more information.
12719     */
12720    EAPI void               elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12721    /**
12722     * @brief Get the Hover parent
12723     *
12724     * @param obj The hoversel object
12725     * @return The used parent
12726     *
12727     * Gets the hover parent object.
12728     *
12729     * @see elm_hoversel_hover_parent_set()
12730     */
12731    EAPI Evas_Object       *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12732    /**
12733     * @brief Set the hoversel button label
12734     *
12735     * @param obj The hoversel object
12736     * @param label The label text.
12737     *
12738     * This sets the label of the button that is always visible (before it is
12739     * clicked and expanded).
12740     *
12741     * @deprecated elm_object_text_set()
12742     */
12743    EINA_DEPRECATED EAPI void               elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12744    /**
12745     * @brief Get the hoversel button label
12746     *
12747     * @param obj The hoversel object
12748     * @return The label text.
12749     *
12750     * @deprecated elm_object_text_get()
12751     */
12752    EINA_DEPRECATED EAPI const char        *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12753    /**
12754     * @brief Set the icon of the hoversel button
12755     *
12756     * @param obj The hoversel object
12757     * @param icon The icon object
12758     *
12759     * Sets the icon of the button that is always visible (before it is clicked
12760     * and expanded).  Once the icon object is set, a previously set one will be
12761     * deleted, if you want to keep that old content object, use the
12762     * elm_hoversel_icon_unset() function.
12763     *
12764     * @see elm_button_icon_set()
12765     */
12766    EAPI void               elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12767    /**
12768     * @brief Get the icon of the hoversel button
12769     *
12770     * @param obj The hoversel object
12771     * @return The icon object
12772     *
12773     * Get the icon of the button that is always visible (before it is clicked
12774     * and expanded). Also see elm_button_icon_get().
12775     *
12776     * @see elm_hoversel_icon_set()
12777     */
12778    EAPI Evas_Object       *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12779    /**
12780     * @brief Get and unparent the icon of the hoversel button
12781     *
12782     * @param obj The hoversel object
12783     * @return The icon object that was being used
12784     *
12785     * Unparent and return the icon of the button that is always visible
12786     * (before it is clicked and expanded).
12787     *
12788     * @see elm_hoversel_icon_set()
12789     * @see elm_button_icon_unset()
12790     */
12791    EAPI Evas_Object       *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12792    /**
12793     * @brief This triggers the hoversel popup from code, the same as if the user
12794     * had clicked the button.
12795     *
12796     * @param obj The hoversel object
12797     */
12798    EAPI void               elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
12799    /**
12800     * @brief This dismisses the hoversel popup as if the user had clicked
12801     * outside the hover.
12802     *
12803     * @param obj The hoversel object
12804     */
12805    EAPI void               elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12806    /**
12807     * @brief Returns whether the hoversel is expanded.
12808     *
12809     * @param obj The hoversel object
12810     * @return  This will return EINA_TRUE if the hoversel is expanded or
12811     * EINA_FALSE if it is not expanded.
12812     */
12813    EAPI Eina_Bool          elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12814    /**
12815     * @brief This will remove all the children items from the hoversel.
12816     *
12817     * @param obj The hoversel object
12818     *
12819     * @warning Should @b not be called while the hoversel is active; use
12820     * elm_hoversel_expanded_get() to check first.
12821     *
12822     * @see elm_hoversel_item_del_cb_set()
12823     * @see elm_hoversel_item_del()
12824     */
12825    EAPI void               elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
12826    /**
12827     * @brief Get the list of items within the given hoversel.
12828     *
12829     * @param obj The hoversel object
12830     * @return Returns a list of Elm_Hoversel_Item*
12831     *
12832     * @see elm_hoversel_item_add()
12833     */
12834    EAPI const Eina_List   *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12835    /**
12836     * @brief Add an item to the hoversel button
12837     *
12838     * @param obj The hoversel object
12839     * @param label The text label to use for the item (NULL if not desired)
12840     * @param icon_file An image file path on disk to use for the icon or standard
12841     * icon name (NULL if not desired)
12842     * @param icon_type The icon type if relevant
12843     * @param func Convenience function to call when this item is selected
12844     * @param data Data to pass to item-related functions
12845     * @return A handle to the item added.
12846     *
12847     * This adds an item to the hoversel to show when it is clicked. Note: if you
12848     * need to use an icon from an edje file then use
12849     * elm_hoversel_item_icon_set() right after the this function, and set
12850     * icon_file to NULL here.
12851     *
12852     * For more information on what @p icon_file and @p icon_type are see the
12853     * @ref Icon "icon documentation".
12854     */
12855    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);
12856    /**
12857     * @brief Delete an item from the hoversel
12858     *
12859     * @param item The item to delete
12860     *
12861     * This deletes the item from the hoversel (should not be called while the
12862     * hoversel is active; use elm_hoversel_expanded_get() to check first).
12863     *
12864     * @see elm_hoversel_item_add()
12865     * @see elm_hoversel_item_del_cb_set()
12866     */
12867    EAPI void               elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
12868    /**
12869     * @brief Set the function to be called when an item from the hoversel is
12870     * freed.
12871     *
12872     * @param item The item to set the callback on
12873     * @param func The function called
12874     *
12875     * That function will receive these parameters:
12876     * @li void *item_data
12877     * @li Evas_Object *the_item_object
12878     * @li Elm_Hoversel_Item *the_object_struct
12879     *
12880     * @see elm_hoversel_item_add()
12881     */
12882    EAPI void               elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
12883    /**
12884     * @brief This returns the data pointer supplied with elm_hoversel_item_add()
12885     * that will be passed to associated function callbacks.
12886     *
12887     * @param item The item to get the data from
12888     * @return The data pointer set with elm_hoversel_item_add()
12889     *
12890     * @see elm_hoversel_item_add()
12891     */
12892    EAPI void              *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
12893    /**
12894     * @brief This returns the label text of the given hoversel item.
12895     *
12896     * @param item The item to get the label
12897     * @return The label text of the hoversel item
12898     *
12899     * @see elm_hoversel_item_add()
12900     */
12901    EAPI const char        *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
12902    /**
12903     * @brief This sets the icon for the given hoversel item.
12904     *
12905     * @param item The item to set the icon
12906     * @param icon_file An image file path on disk to use for the icon or standard
12907     * icon name
12908     * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
12909     * to NULL if the icon is not an edje file
12910     * @param icon_type The icon type
12911     *
12912     * The icon can be loaded from the standard set, from an image file, or from
12913     * an edje file.
12914     *
12915     * @see elm_hoversel_item_add()
12916     */
12917    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);
12918    /**
12919     * @brief Get the icon object of the hoversel item
12920     *
12921     * @param item The item to get the icon from
12922     * @param icon_file The image file path on disk used for the icon or standard
12923     * icon name
12924     * @param icon_group The edje group used if @p icon_file is an edje file. NULL
12925     * if the icon is not an edje file
12926     * @param icon_type The icon type
12927     *
12928     * @see elm_hoversel_item_icon_set()
12929     * @see elm_hoversel_item_add()
12930     */
12931    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);
12932    /**
12933     * @}
12934     */
12935
12936    /**
12937     * @defgroup Toolbar Toolbar
12938     * @ingroup Elementary
12939     *
12940     * @image html img/widget/toolbar/preview-00.png
12941     * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
12942     *
12943     * @image html img/toolbar.png
12944     * @image latex img/toolbar.eps width=\textwidth
12945     *
12946     * A toolbar is a widget that displays a list of items inside
12947     * a box. It can be scrollable, show a menu with items that don't fit
12948     * to toolbar size or even crop them.
12949     *
12950     * Only one item can be selected at a time.
12951     *
12952     * Items can have multiple states, or show menus when selected by the user.
12953     *
12954     * Smart callbacks one can listen to:
12955     * - "clicked" - when the user clicks on a toolbar item and becomes selected.
12956     *
12957     * Available styles for it:
12958     * - @c "default"
12959     * - @c "transparent" - no background or shadow, just show the content
12960     *
12961     * List of examples:
12962     * @li @ref toolbar_example_01
12963     * @li @ref toolbar_example_02
12964     * @li @ref toolbar_example_03
12965     */
12966
12967    /**
12968     * @addtogroup Toolbar
12969     * @{
12970     */
12971
12972    /**
12973     * @enum _Elm_Toolbar_Shrink_Mode
12974     * @typedef Elm_Toolbar_Shrink_Mode
12975     *
12976     * Set toolbar's items display behavior, it can be scrollabel,
12977     * show a menu with exceeding items, or simply hide them.
12978     *
12979     * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
12980     * from elm config.
12981     *
12982     * Values <b> don't </b> work as bitmask, only one can be choosen.
12983     *
12984     * @see elm_toolbar_mode_shrink_set()
12985     * @see elm_toolbar_mode_shrink_get()
12986     *
12987     * @ingroup Toolbar
12988     */
12989    typedef enum _Elm_Toolbar_Shrink_Mode
12990      {
12991         ELM_TOOLBAR_SHRINK_NONE,   /**< Set toolbar minimun size to fit all the items. */
12992         ELM_TOOLBAR_SHRINK_HIDE,   /**< Hide exceeding items. */
12993         ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
12994         ELM_TOOLBAR_SHRINK_MENU    /**< Inserts a button to pop up a menu with exceeding items. */
12995      } Elm_Toolbar_Shrink_Mode;
12996
12997    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(). */
12998
12999    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(). */
13000
13001    /**
13002     * Add a new toolbar widget to the given parent Elementary
13003     * (container) object.
13004     *
13005     * @param parent The parent object.
13006     * @return a new toolbar widget handle or @c NULL, on errors.
13007     *
13008     * This function inserts a new toolbar widget on the canvas.
13009     *
13010     * @ingroup Toolbar
13011     */
13012    EAPI Evas_Object            *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13013
13014    /**
13015     * Set the icon size, in pixels, to be used by toolbar items.
13016     *
13017     * @param obj The toolbar object
13018     * @param icon_size The icon size in pixels
13019     *
13020     * @note Default value is @c 32. It reads value from elm config.
13021     *
13022     * @see elm_toolbar_icon_size_get()
13023     *
13024     * @ingroup Toolbar
13025     */
13026    EAPI void                    elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
13027
13028    /**
13029     * Get the icon size, in pixels, to be used by toolbar items.
13030     *
13031     * @param obj The toolbar object.
13032     * @return The icon size in pixels.
13033     *
13034     * @see elm_toolbar_icon_size_set() for details.
13035     *
13036     * @ingroup Toolbar
13037     */
13038    EAPI int                     elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13039
13040    /**
13041     * Sets icon lookup order, for toolbar items' icons.
13042     *
13043     * @param obj The toolbar object.
13044     * @param order The icon lookup order.
13045     *
13046     * Icons added before calling this function will not be affected.
13047     * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
13048     *
13049     * @see elm_toolbar_icon_order_lookup_get()
13050     *
13051     * @ingroup Toolbar
13052     */
13053    EAPI void                    elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
13054
13055    /**
13056     * Gets the icon lookup order.
13057     *
13058     * @param obj The toolbar object.
13059     * @return The icon lookup order.
13060     *
13061     * @see elm_toolbar_icon_order_lookup_set() for details.
13062     *
13063     * @ingroup Toolbar
13064     */
13065    EAPI Elm_Icon_Lookup_Order   elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13066
13067    /**
13068     * Set whether the toolbar items' should be selected by the user or not.
13069     *
13070     * @param obj The toolbar object.
13071     * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
13072     * enable it.
13073     *
13074     * This will turn off the ability to select items entirely and they will
13075     * neither appear selected nor emit selected signals. The clicked
13076     * callback function will still be called.
13077     *
13078     * Selection is enabled by default.
13079     *
13080     * @see elm_toolbar_no_select_mode_get().
13081     *
13082     * @ingroup Toolbar
13083     */
13084    EAPI void                    elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
13085
13086    /**
13087     * Set whether the toolbar items' should be selected by the user or not.
13088     *
13089     * @param obj The toolbar object.
13090     * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
13091     * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
13092     *
13093     * @see elm_toolbar_no_select_mode_set() for details.
13094     *
13095     * @ingroup Toolbar
13096     */
13097    EAPI Eina_Bool               elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13098
13099    /**
13100     * Append item to the toolbar.
13101     *
13102     * @param obj The toolbar object.
13103     * @param icon A string with icon name or the absolute path of an image file.
13104     * @param label The label of the item.
13105     * @param func The function to call when the item is clicked.
13106     * @param data The data to associate with the item for related callbacks.
13107     * @return The created item or @c NULL upon failure.
13108     *
13109     * A new item will be created and appended to the toolbar, i.e., will
13110     * be set as @b last item.
13111     *
13112     * Items created with this method can be deleted with
13113     * elm_toolbar_item_del().
13114     *
13115     * Associated @p data can be properly freed when item is deleted if a
13116     * callback function is set with elm_toolbar_item_del_cb_set().
13117     *
13118     * If a function is passed as argument, it will be called everytime this item
13119     * is selected, i.e., the user clicks over an unselected item.
13120     * If such function isn't needed, just passing
13121     * @c NULL as @p func is enough. The same should be done for @p data.
13122     *
13123     * Toolbar will load icon image from fdo or current theme.
13124     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13125     * If an absolute path is provided it will load it direct from a file.
13126     *
13127     * @see elm_toolbar_item_icon_set()
13128     * @see elm_toolbar_item_del()
13129     * @see elm_toolbar_item_del_cb_set()
13130     *
13131     * @ingroup Toolbar
13132     */
13133    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);
13134
13135    /**
13136     * Prepend item to the toolbar.
13137     *
13138     * @param obj The toolbar object.
13139     * @param icon A string with icon name or the absolute path of an image file.
13140     * @param label The label of the item.
13141     * @param func The function to call when the item is clicked.
13142     * @param data The data to associate with the item for related callbacks.
13143     * @return The created item or @c NULL upon failure.
13144     *
13145     * A new item will be created and prepended to the toolbar, i.e., will
13146     * be set as @b first item.
13147     *
13148     * Items created with this method can be deleted with
13149     * elm_toolbar_item_del().
13150     *
13151     * Associated @p data can be properly freed when item is deleted if a
13152     * callback function is set with elm_toolbar_item_del_cb_set().
13153     *
13154     * If a function is passed as argument, it will be called everytime this item
13155     * is selected, i.e., the user clicks over an unselected item.
13156     * If such function isn't needed, just passing
13157     * @c NULL as @p func is enough. The same should be done for @p data.
13158     *
13159     * Toolbar will load icon image from fdo or current theme.
13160     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13161     * If an absolute path is provided it will load it direct from a file.
13162     *
13163     * @see elm_toolbar_item_icon_set()
13164     * @see elm_toolbar_item_del()
13165     * @see elm_toolbar_item_del_cb_set()
13166     *
13167     * @ingroup Toolbar
13168     */
13169    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);
13170
13171    /**
13172     * Insert a new item into the toolbar object before item @p before.
13173     *
13174     * @param obj The toolbar object.
13175     * @param before The toolbar item to insert before.
13176     * @param icon A string with icon name or the absolute path of an image file.
13177     * @param label The label of the item.
13178     * @param func The function to call when the item is clicked.
13179     * @param data The data to associate with the item for related callbacks.
13180     * @return The created item or @c NULL upon failure.
13181     *
13182     * A new item will be created and added to the toolbar. Its position in
13183     * this toolbar will be just before item @p before.
13184     *
13185     * Items created with this method can be deleted with
13186     * elm_toolbar_item_del().
13187     *
13188     * Associated @p data can be properly freed when item is deleted if a
13189     * callback function is set with elm_toolbar_item_del_cb_set().
13190     *
13191     * If a function is passed as argument, it will be called everytime this item
13192     * is selected, i.e., the user clicks over an unselected item.
13193     * If such function isn't needed, just passing
13194     * @c NULL as @p func is enough. The same should be done for @p data.
13195     *
13196     * Toolbar will load icon image from fdo or current theme.
13197     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13198     * If an absolute path is provided it will load it direct from a file.
13199     *
13200     * @see elm_toolbar_item_icon_set()
13201     * @see elm_toolbar_item_del()
13202     * @see elm_toolbar_item_del_cb_set()
13203     *
13204     * @ingroup Toolbar
13205     */
13206    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);
13207
13208    /**
13209     * Insert a new item into the toolbar object after item @p after.
13210     *
13211     * @param obj The toolbar object.
13212     * @param before The toolbar item to insert before.
13213     * @param icon A string with icon name or the absolute path of an image file.
13214     * @param label The label of the item.
13215     * @param func The function to call when the item is clicked.
13216     * @param data The data to associate with the item for related callbacks.
13217     * @return The created item or @c NULL upon failure.
13218     *
13219     * A new item will be created and added to the toolbar. Its position in
13220     * this toolbar will be just after item @p after.
13221     *
13222     * Items created with this method can be deleted with
13223     * elm_toolbar_item_del().
13224     *
13225     * Associated @p data can be properly freed when item is deleted if a
13226     * callback function is set with elm_toolbar_item_del_cb_set().
13227     *
13228     * If a function is passed as argument, it will be called everytime this item
13229     * is selected, i.e., the user clicks over an unselected item.
13230     * If such function isn't needed, just passing
13231     * @c NULL as @p func is enough. The same should be done for @p data.
13232     *
13233     * Toolbar will load icon image from fdo or current theme.
13234     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13235     * If an absolute path is provided it will load it direct from a file.
13236     *
13237     * @see elm_toolbar_item_icon_set()
13238     * @see elm_toolbar_item_del()
13239     * @see elm_toolbar_item_del_cb_set()
13240     *
13241     * @ingroup Toolbar
13242     */
13243    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);
13244
13245    /**
13246     * Get the first item in the given toolbar widget's list of
13247     * items.
13248     *
13249     * @param obj The toolbar object
13250     * @return The first item or @c NULL, if it has no items (and on
13251     * errors)
13252     *
13253     * @see elm_toolbar_item_append()
13254     * @see elm_toolbar_last_item_get()
13255     *
13256     * @ingroup Toolbar
13257     */
13258    EAPI Elm_Toolbar_Item       *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13259
13260    /**
13261     * Get the last item in the given toolbar widget's list of
13262     * items.
13263     *
13264     * @param obj The toolbar object
13265     * @return The last item or @c NULL, if it has no items (and on
13266     * errors)
13267     *
13268     * @see elm_toolbar_item_prepend()
13269     * @see elm_toolbar_first_item_get()
13270     *
13271     * @ingroup Toolbar
13272     */
13273    EAPI Elm_Toolbar_Item       *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13274
13275    /**
13276     * Get the item after @p item in toolbar.
13277     *
13278     * @param item The toolbar item.
13279     * @return The item after @p item, or @c NULL if none or on failure.
13280     *
13281     * @note If it is the last item, @c NULL will be returned.
13282     *
13283     * @see elm_toolbar_item_append()
13284     *
13285     * @ingroup Toolbar
13286     */
13287    EAPI Elm_Toolbar_Item       *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13288
13289    /**
13290     * Get the item before @p item in toolbar.
13291     *
13292     * @param item The toolbar item.
13293     * @return The item before @p item, or @c NULL if none or on failure.
13294     *
13295     * @note If it is the first item, @c NULL will be returned.
13296     *
13297     * @see elm_toolbar_item_prepend()
13298     *
13299     * @ingroup Toolbar
13300     */
13301    EAPI Elm_Toolbar_Item       *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13302
13303    /**
13304     * Get the toolbar object from an item.
13305     *
13306     * @param item The item.
13307     * @return The toolbar object.
13308     *
13309     * This returns the toolbar object itself that an item belongs to.
13310     *
13311     * @ingroup Toolbar
13312     */
13313    EAPI Evas_Object            *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13314
13315    /**
13316     * Set the priority of a toolbar item.
13317     *
13318     * @param item The toolbar item.
13319     * @param priority The item priority. The default is zero.
13320     *
13321     * This is used only when the toolbar shrink mode is set to
13322     * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
13323     * When space is less than required, items with low priority
13324     * will be removed from the toolbar and added to a dynamically-created menu,
13325     * while items with higher priority will remain on the toolbar,
13326     * with the same order they were added.
13327     *
13328     * @see elm_toolbar_item_priority_get()
13329     *
13330     * @ingroup Toolbar
13331     */
13332    EAPI void                    elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
13333
13334    /**
13335     * Get the priority of a toolbar item.
13336     *
13337     * @param item The toolbar item.
13338     * @return The @p item priority, or @c 0 on failure.
13339     *
13340     * @see elm_toolbar_item_priority_set() for details.
13341     *
13342     * @ingroup Toolbar
13343     */
13344    EAPI int                     elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13345
13346    /**
13347     * Get the label of item.
13348     *
13349     * @param item The item of toolbar.
13350     * @return The label of item.
13351     *
13352     * The return value is a pointer to the label associated to @p item when
13353     * it was created, with function elm_toolbar_item_append() or similar,
13354     * or later,
13355     * with function elm_toolbar_item_label_set. If no label
13356     * was passed as argument, it will return @c NULL.
13357     *
13358     * @see elm_toolbar_item_label_set() for more details.
13359     * @see elm_toolbar_item_append()
13360     *
13361     * @ingroup Toolbar
13362     */
13363    EAPI const char             *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13364
13365    /**
13366     * Set the label of item.
13367     *
13368     * @param item The item of toolbar.
13369     * @param text The label of item.
13370     *
13371     * The label to be displayed by the item.
13372     * Label will be placed at icons bottom (if set).
13373     *
13374     * If a label was passed as argument on item creation, with function
13375     * elm_toolbar_item_append() or similar, it will be already
13376     * displayed by the item.
13377     *
13378     * @see elm_toolbar_item_label_get()
13379     * @see elm_toolbar_item_append()
13380     *
13381     * @ingroup Toolbar
13382     */
13383    EAPI void                    elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
13384
13385    /**
13386     * Return the data associated with a given toolbar widget item.
13387     *
13388     * @param item The toolbar widget item handle.
13389     * @return The data associated with @p item.
13390     *
13391     * @see elm_toolbar_item_data_set()
13392     *
13393     * @ingroup Toolbar
13394     */
13395    EAPI void                   *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13396
13397    /**
13398     * Set the data associated with a given toolbar widget item.
13399     *
13400     * @param item The toolbar widget item handle.
13401     * @param data The new data pointer to set to @p item.
13402     *
13403     * This sets new item data on @p item.
13404     *
13405     * @warning The old data pointer won't be touched by this function, so
13406     * the user had better to free that old data himself/herself.
13407     *
13408     * @ingroup Toolbar
13409     */
13410    EAPI void                    elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
13411
13412    /**
13413     * Returns a pointer to a toolbar item by its label.
13414     *
13415     * @param obj The toolbar object.
13416     * @param label The label of the item to find.
13417     *
13418     * @return The pointer to the toolbar item matching @p label or @c NULL
13419     * on failure.
13420     *
13421     * @ingroup Toolbar
13422     */
13423    EAPI Elm_Toolbar_Item       *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13424
13425    /*
13426     * Get whether the @p item is selected or not.
13427     *
13428     * @param item The toolbar item.
13429     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
13430     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
13431     *
13432     * @see elm_toolbar_selected_item_set() for details.
13433     * @see elm_toolbar_item_selected_get()
13434     *
13435     * @ingroup Toolbar
13436     */
13437    EAPI Eina_Bool               elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13438
13439    /**
13440     * Set the selected state of an item.
13441     *
13442     * @param item The toolbar item
13443     * @param selected The selected state
13444     *
13445     * This sets the selected state of the given item @p it.
13446     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
13447     *
13448     * If a new item is selected the previosly selected will be unselected.
13449     * Previoulsy selected item can be get with function
13450     * elm_toolbar_selected_item_get().
13451     *
13452     * Selected items will be highlighted.
13453     *
13454     * @see elm_toolbar_item_selected_get()
13455     * @see elm_toolbar_selected_item_get()
13456     *
13457     * @ingroup Toolbar
13458     */
13459    EAPI void                    elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
13460
13461    /**
13462     * Get the selected item.
13463     *
13464     * @param obj The toolbar object.
13465     * @return The selected toolbar item.
13466     *
13467     * The selected item can be unselected with function
13468     * elm_toolbar_item_selected_set().
13469     *
13470     * The selected item always will be highlighted on toolbar.
13471     *
13472     * @see elm_toolbar_selected_items_get()
13473     *
13474     * @ingroup Toolbar
13475     */
13476    EAPI Elm_Toolbar_Item       *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13477
13478    /**
13479     * Set the icon associated with @p item.
13480     *
13481     * @param obj The parent of this item.
13482     * @param item The toolbar item.
13483     * @param icon A string with icon name or the absolute path of an image file.
13484     *
13485     * Toolbar will load icon image from fdo or current theme.
13486     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13487     * If an absolute path is provided it will load it direct from a file.
13488     *
13489     * @see elm_toolbar_icon_order_lookup_set()
13490     * @see elm_toolbar_icon_order_lookup_get()
13491     *
13492     * @ingroup Toolbar
13493     */
13494    EAPI void                    elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
13495
13496    /**
13497     * Get the string used to set the icon of @p item.
13498     *
13499     * @param item The toolbar item.
13500     * @return The string associated with the icon object.
13501     *
13502     * @see elm_toolbar_item_icon_set() for details.
13503     *
13504     * @ingroup Toolbar
13505     */
13506    EAPI const char             *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13507
13508    /**
13509     * Delete them item from the toolbar.
13510     *
13511     * @param item The item of toolbar to be deleted.
13512     *
13513     * @see elm_toolbar_item_append()
13514     * @see elm_toolbar_item_del_cb_set()
13515     *
13516     * @ingroup Toolbar
13517     */
13518    EAPI void                    elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13519
13520    /**
13521     * Set the function called when a toolbar item is freed.
13522     *
13523     * @param item The item to set the callback on.
13524     * @param func The function called.
13525     *
13526     * If there is a @p func, then it will be called prior item's memory release.
13527     * That will be called with the following arguments:
13528     * @li item's data;
13529     * @li item's Evas object;
13530     * @li item itself;
13531     *
13532     * This way, a data associated to a toolbar item could be properly freed.
13533     *
13534     * @ingroup Toolbar
13535     */
13536    EAPI void                    elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
13537
13538    /**
13539     * Get a value whether toolbar item is disabled or not.
13540     *
13541     * @param item The item.
13542     * @return The disabled state.
13543     *
13544     * @see elm_toolbar_item_disabled_set() for more details.
13545     *
13546     * @ingroup Toolbar
13547     */
13548    EAPI Eina_Bool               elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13549
13550    /**
13551     * Sets the disabled/enabled state of a toolbar item.
13552     *
13553     * @param item The item.
13554     * @param disabled The disabled state.
13555     *
13556     * A disabled item cannot be selected or unselected. It will also
13557     * change its appearance (generally greyed out). This sets the
13558     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
13559     * enabled).
13560     *
13561     * @ingroup Toolbar
13562     */
13563    EAPI void                    elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
13564
13565    /**
13566     * Set or unset item as a separator.
13567     *
13568     * @param item The toolbar item.
13569     * @param setting @c EINA_TRUE to set item @p item as separator or
13570     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
13571     *
13572     * Items aren't set as separator by default.
13573     *
13574     * If set as separator it will display separator theme, so won't display
13575     * icons or label.
13576     *
13577     * @see elm_toolbar_item_separator_get()
13578     *
13579     * @ingroup Toolbar
13580     */
13581    EAPI void                    elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
13582
13583    /**
13584     * Get a value whether item is a separator or not.
13585     *
13586     * @param item The toolbar item.
13587     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
13588     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
13589     *
13590     * @see elm_toolbar_item_separator_set() for details.
13591     *
13592     * @ingroup Toolbar
13593     */
13594    EAPI Eina_Bool               elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13595
13596    /**
13597     * Set the shrink state of toolbar @p obj.
13598     *
13599     * @param obj The toolbar object.
13600     * @param shrink_mode Toolbar's items display behavior.
13601     *
13602     * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
13603     * but will enforce a minimun size so all the items will fit, won't scroll
13604     * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
13605     * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
13606     * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
13607     *
13608     * @ingroup Toolbar
13609     */
13610    EAPI void                    elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
13611
13612    /**
13613     * Get the shrink mode of toolbar @p obj.
13614     *
13615     * @param obj The toolbar object.
13616     * @return Toolbar's items display behavior.
13617     *
13618     * @see elm_toolbar_mode_shrink_set() for details.
13619     *
13620     * @ingroup Toolbar
13621     */
13622    EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13623
13624    /**
13625     * Enable/disable homogenous mode.
13626     *
13627     * @param obj The toolbar object
13628     * @param homogeneous Assume the items within the toolbar are of the
13629     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
13630     *
13631     * This will enable the homogeneous mode where items are of the same size.
13632     * @see elm_toolbar_homogeneous_get()
13633     *
13634     * @ingroup Toolbar
13635     */
13636    EAPI void                    elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
13637
13638    /**
13639     * Get whether the homogenous mode is enabled.
13640     *
13641     * @param obj The toolbar object.
13642     * @return Assume the items within the toolbar are of the same height
13643     * and width (EINA_TRUE = on, EINA_FALSE = off).
13644     *
13645     * @see elm_toolbar_homogeneous_set()
13646     *
13647     * @ingroup Toolbar
13648     */
13649    EAPI Eina_Bool               elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13650
13651    /**
13652     * Enable/disable homogenous mode.
13653     *
13654     * @param obj The toolbar object
13655     * @param homogeneous Assume the items within the toolbar are of the
13656     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
13657     *
13658     * This will enable the homogeneous mode where items are of the same size.
13659     * @see elm_toolbar_homogeneous_get()
13660     *
13661     * @deprecated use elm_toolbar_homogeneous_set() instead.
13662     *
13663     * @ingroup Toolbar
13664     */
13665    EINA_DEPRECATED EAPI void    elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
13666
13667    /**
13668     * Get whether the homogenous mode is enabled.
13669     *
13670     * @param obj The toolbar object.
13671     * @return Assume the items within the toolbar are of the same height
13672     * and width (EINA_TRUE = on, EINA_FALSE = off).
13673     *
13674     * @see elm_toolbar_homogeneous_set()
13675     * @deprecated use elm_toolbar_homogeneous_get() instead.
13676     *
13677     * @ingroup Toolbar
13678     */
13679    EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13680
13681    /**
13682     * Set the parent object of the toolbar items' menus.
13683     *
13684     * @param obj The toolbar object.
13685     * @param parent The parent of the menu objects.
13686     *
13687     * Each item can be set as item menu, with elm_toolbar_item_menu_set().
13688     *
13689     * For more details about setting the parent for toolbar menus, see
13690     * elm_menu_parent_set().
13691     *
13692     * @see elm_menu_parent_set() for details.
13693     * @see elm_toolbar_item_menu_set() for details.
13694     *
13695     * @ingroup Toolbar
13696     */
13697    EAPI void                    elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
13698
13699    /**
13700     * Get the parent object of the toolbar items' menus.
13701     *
13702     * @param obj The toolbar object.
13703     * @return The parent of the menu objects.
13704     *
13705     * @see elm_toolbar_menu_parent_set() for details.
13706     *
13707     * @ingroup Toolbar
13708     */
13709    EAPI Evas_Object            *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13710
13711    /**
13712     * Set the alignment of the items.
13713     *
13714     * @param obj The toolbar object.
13715     * @param align The new alignment, a float between <tt> 0.0 </tt>
13716     * and <tt> 1.0 </tt>.
13717     *
13718     * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
13719     * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
13720     * items.
13721     *
13722     * Centered items by default.
13723     *
13724     * @see elm_toolbar_align_get()
13725     *
13726     * @ingroup Toolbar
13727     */
13728    EAPI void                    elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
13729
13730    /**
13731     * Get the alignment of the items.
13732     *
13733     * @param obj The toolbar object.
13734     * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
13735     * <tt> 1.0 </tt>.
13736     *
13737     * @see elm_toolbar_align_set() for details.
13738     *
13739     * @ingroup Toolbar
13740     */
13741    EAPI double                  elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13742
13743    /**
13744     * Set whether the toolbar item opens a menu.
13745     *
13746     * @param item The toolbar item.
13747     * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
13748     *
13749     * A toolbar item can be set to be a menu, using this function.
13750     *
13751     * Once it is set to be a menu, it can be manipulated through the
13752     * menu-like function elm_toolbar_menu_parent_set() and the other
13753     * elm_menu functions, using the Evas_Object @c menu returned by
13754     * elm_toolbar_item_menu_get().
13755     *
13756     * So, items to be displayed in this item's menu should be added with
13757     * elm_menu_item_add().
13758     *
13759     * The following code exemplifies the most basic usage:
13760     * @code
13761     * tb = elm_toolbar_add(win)
13762     * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
13763     * elm_toolbar_item_menu_set(item, EINA_TRUE);
13764     * elm_toolbar_menu_parent_set(tb, win);
13765     * menu = elm_toolbar_item_menu_get(item);
13766     * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
13767     * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
13768     * NULL);
13769     * @endcode
13770     *
13771     * @see elm_toolbar_item_menu_get()
13772     *
13773     * @ingroup Toolbar
13774     */
13775    EAPI void                    elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
13776
13777    /**
13778     * Get toolbar item's menu.
13779     *
13780     * @param item The toolbar item.
13781     * @return Item's menu object or @c NULL on failure.
13782     *
13783     * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
13784     * this function will set it.
13785     *
13786     * @see elm_toolbar_item_menu_set() for details.
13787     *
13788     * @ingroup Toolbar
13789     */
13790    EAPI Evas_Object            *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13791
13792    /**
13793     * Add a new state to @p item.
13794     *
13795     * @param item The item.
13796     * @param icon A string with icon name or the absolute path of an image file.
13797     * @param label The label of the new state.
13798     * @param func The function to call when the item is clicked when this
13799     * state is selected.
13800     * @param data The data to associate with the state.
13801     * @return The toolbar item state, or @c NULL upon failure.
13802     *
13803     * Toolbar will load icon image from fdo or current theme.
13804     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13805     * If an absolute path is provided it will load it direct from a file.
13806     *
13807     * States created with this function can be removed with
13808     * elm_toolbar_item_state_del().
13809     *
13810     * @see elm_toolbar_item_state_del()
13811     * @see elm_toolbar_item_state_sel()
13812     * @see elm_toolbar_item_state_get()
13813     *
13814     * @ingroup Toolbar
13815     */
13816    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);
13817
13818    /**
13819     * Delete a previoulsy added state to @p item.
13820     *
13821     * @param item The toolbar item.
13822     * @param state The state to be deleted.
13823     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
13824     *
13825     * @see elm_toolbar_item_state_add()
13826     */
13827    EAPI Eina_Bool               elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
13828
13829    /**
13830     * Set @p state as the current state of @p it.
13831     *
13832     * @param it The item.
13833     * @param state The state to use.
13834     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
13835     *
13836     * If @p state is @c NULL, it won't select any state and the default item's
13837     * icon and label will be used. It's the same behaviour than
13838     * elm_toolbar_item_state_unser().
13839     *
13840     * @see elm_toolbar_item_state_unset()
13841     *
13842     * @ingroup Toolbar
13843     */
13844    EAPI Eina_Bool               elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
13845
13846    /**
13847     * Unset the state of @p it.
13848     *
13849     * @param it The item.
13850     *
13851     * The default icon and label from this item will be displayed.
13852     *
13853     * @see elm_toolbar_item_state_set() for more details.
13854     *
13855     * @ingroup Toolbar
13856     */
13857    EAPI void                    elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13858
13859    /**
13860     * Get the current state of @p it.
13861     *
13862     * @param item The item.
13863     * @return The selected state or @c NULL if none is selected or on failure.
13864     *
13865     * @see elm_toolbar_item_state_set() for details.
13866     * @see elm_toolbar_item_state_unset()
13867     * @see elm_toolbar_item_state_add()
13868     *
13869     * @ingroup Toolbar
13870     */
13871    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13872
13873    /**
13874     * Get the state after selected state in toolbar's @p item.
13875     *
13876     * @param it The toolbar item to change state.
13877     * @return The state after current state, or @c NULL on failure.
13878     *
13879     * If last state is selected, this function will return first state.
13880     *
13881     * @see elm_toolbar_item_state_set()
13882     * @see elm_toolbar_item_state_add()
13883     *
13884     * @ingroup Toolbar
13885     */
13886    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13887
13888    /**
13889     * Get the state before selected state in toolbar's @p item.
13890     *
13891     * @param it The toolbar item to change state.
13892     * @return The state before current state, or @c NULL on failure.
13893     *
13894     * If first state is selected, this function will return last state.
13895     *
13896     * @see elm_toolbar_item_state_set()
13897     * @see elm_toolbar_item_state_add()
13898     *
13899     * @ingroup Toolbar
13900     */
13901    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13902
13903    /**
13904     * Set the text to be shown in a given toolbar item's tooltips.
13905     *
13906     * @param item Target item.
13907     * @param text The text to set in the content.
13908     *
13909     * Setup the text as tooltip to object. The item can have only one tooltip,
13910     * so any previous tooltip data - set with this function or
13911     * elm_toolbar_item_tooltip_content_cb_set() - is removed.
13912     *
13913     * @see elm_object_tooltip_text_set() for more details.
13914     *
13915     * @ingroup Toolbar
13916     */
13917    EAPI void             elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
13918
13919    /**
13920     * Set the content to be shown in the tooltip item.
13921     *
13922     * Setup the tooltip to item. The item can have only one tooltip,
13923     * so any previous tooltip data is removed. @p func(with @p data) will
13924     * be called every time that need show the tooltip and it should
13925     * return a valid Evas_Object. This object is then managed fully by
13926     * tooltip system and is deleted when the tooltip is gone.
13927     *
13928     * @param item the toolbar item being attached a tooltip.
13929     * @param func the function used to create the tooltip contents.
13930     * @param data what to provide to @a func as callback data/context.
13931     * @param del_cb called when data is not needed anymore, either when
13932     *        another callback replaces @a func, the tooltip is unset with
13933     *        elm_toolbar_item_tooltip_unset() or the owner @a item
13934     *        dies. This callback receives as the first parameter the
13935     *        given @a data, and @c event_info is the item.
13936     *
13937     * @see elm_object_tooltip_content_cb_set() for more details.
13938     *
13939     * @ingroup Toolbar
13940     */
13941    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);
13942
13943    /**
13944     * Unset tooltip from item.
13945     *
13946     * @param item toolbar item to remove previously set tooltip.
13947     *
13948     * Remove tooltip from item. The callback provided as del_cb to
13949     * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
13950     * it is not used anymore.
13951     *
13952     * @see elm_object_tooltip_unset() for more details.
13953     * @see elm_toolbar_item_tooltip_content_cb_set()
13954     *
13955     * @ingroup Toolbar
13956     */
13957    EAPI void             elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13958
13959    /**
13960     * Sets a different style for this item tooltip.
13961     *
13962     * @note before you set a style you should define a tooltip with
13963     *       elm_toolbar_item_tooltip_content_cb_set() or
13964     *       elm_toolbar_item_tooltip_text_set()
13965     *
13966     * @param item toolbar item with tooltip already set.
13967     * @param style the theme style to use (default, transparent, ...)
13968     *
13969     * @see elm_object_tooltip_style_set() for more details.
13970     *
13971     * @ingroup Toolbar
13972     */
13973    EAPI void             elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
13974
13975    /**
13976     * Get the style for this item tooltip.
13977     *
13978     * @param item toolbar item with tooltip already set.
13979     * @return style the theme style in use, defaults to "default". If the
13980     *         object does not have a tooltip set, then NULL is returned.
13981     *
13982     * @see elm_object_tooltip_style_get() for more details.
13983     * @see elm_toolbar_item_tooltip_style_set()
13984     *
13985     * @ingroup Toolbar
13986     */
13987    EAPI const char      *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13988
13989    /**
13990     * Set the type of mouse pointer/cursor decoration to be shown,
13991     * when the mouse pointer is over the given toolbar widget item
13992     *
13993     * @param item toolbar item to customize cursor on
13994     * @param cursor the cursor type's name
13995     *
13996     * This function works analogously as elm_object_cursor_set(), but
13997     * here the cursor's changing area is restricted to the item's
13998     * area, and not the whole widget's. Note that that item cursors
13999     * have precedence over widget cursors, so that a mouse over an
14000     * item with custom cursor set will always show @b that cursor.
14001     *
14002     * If this function is called twice for an object, a previously set
14003     * cursor will be unset on the second call.
14004     *
14005     * @see elm_object_cursor_set()
14006     * @see elm_toolbar_item_cursor_get()
14007     * @see elm_toolbar_item_cursor_unset()
14008     *
14009     * @ingroup Toolbar
14010     */
14011    EAPI void             elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
14012
14013    /*
14014     * Get the type of mouse pointer/cursor decoration set to be shown,
14015     * when the mouse pointer is over the given toolbar widget item
14016     *
14017     * @param item toolbar item with custom cursor set
14018     * @return the cursor type's name or @c NULL, if no custom cursors
14019     * were set to @p item (and on errors)
14020     *
14021     * @see elm_object_cursor_get()
14022     * @see elm_toolbar_item_cursor_set()
14023     * @see elm_toolbar_item_cursor_unset()
14024     *
14025     * @ingroup Toolbar
14026     */
14027    EAPI const char      *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14028
14029    /**
14030     * Unset any custom mouse pointer/cursor decoration set to be
14031     * shown, when the mouse pointer is over the given toolbar widget
14032     * item, thus making it show the @b default cursor again.
14033     *
14034     * @param item a toolbar item
14035     *
14036     * Use this call to undo any custom settings on this item's cursor
14037     * decoration, bringing it back to defaults (no custom style set).
14038     *
14039     * @see elm_object_cursor_unset()
14040     * @see elm_toolbar_item_cursor_set()
14041     *
14042     * @ingroup Toolbar
14043     */
14044    EAPI void             elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14045
14046    /**
14047     * Set a different @b style for a given custom cursor set for a
14048     * toolbar item.
14049     *
14050     * @param item toolbar item with custom cursor set
14051     * @param style the <b>theme style</b> to use (e.g. @c "default",
14052     * @c "transparent", etc)
14053     *
14054     * This function only makes sense when one is using custom mouse
14055     * cursor decorations <b>defined in a theme file</b>, which can have,
14056     * given a cursor name/type, <b>alternate styles</b> on it. It
14057     * works analogously as elm_object_cursor_style_set(), but here
14058     * applyed only to toolbar item objects.
14059     *
14060     * @warning Before you set a cursor style you should have definen a
14061     *       custom cursor previously on the item, with
14062     *       elm_toolbar_item_cursor_set()
14063     *
14064     * @see elm_toolbar_item_cursor_engine_only_set()
14065     * @see elm_toolbar_item_cursor_style_get()
14066     *
14067     * @ingroup Toolbar
14068     */
14069    EAPI void             elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
14070
14071    /**
14072     * Get the current @b style set for a given toolbar item's custom
14073     * cursor
14074     *
14075     * @param item toolbar item with custom cursor set.
14076     * @return style the cursor style in use. If the object does not
14077     *         have a cursor set, then @c NULL is returned.
14078     *
14079     * @see elm_toolbar_item_cursor_style_set() for more details
14080     *
14081     * @ingroup Toolbar
14082     */
14083    EAPI const char      *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14084
14085    /**
14086     * Set if the (custom)cursor for a given toolbar item should be
14087     * searched in its theme, also, or should only rely on the
14088     * rendering engine.
14089     *
14090     * @param item item with custom (custom) cursor already set on
14091     * @param engine_only Use @c EINA_TRUE to have cursors looked for
14092     * only on those provided by the rendering engine, @c EINA_FALSE to
14093     * have them searched on the widget's theme, as well.
14094     *
14095     * @note This call is of use only if you've set a custom cursor
14096     * for toolbar items, with elm_toolbar_item_cursor_set().
14097     *
14098     * @note By default, cursors will only be looked for between those
14099     * provided by the rendering engine.
14100     *
14101     * @ingroup Toolbar
14102     */
14103    EAPI void             elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
14104
14105    /**
14106     * Get if the (custom) cursor for a given toolbar item is being
14107     * searched in its theme, also, or is only relying on the rendering
14108     * engine.
14109     *
14110     * @param item a toolbar item
14111     * @return @c EINA_TRUE, if cursors are being looked for only on
14112     * those provided by the rendering engine, @c EINA_FALSE if they
14113     * are being searched on the widget's theme, as well.
14114     *
14115     * @see elm_toolbar_item_cursor_engine_only_set(), for more details
14116     *
14117     * @ingroup Toolbar
14118     */
14119    EAPI Eina_Bool        elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14120
14121    /**
14122     * Change a toolbar's orientation
14123     * @param obj The toolbar object
14124     * @param vertical If @c EINA_TRUE, the toolbar is vertical
14125     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
14126     * @ingroup Toolbar
14127     */
14128    EAPI void             elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
14129
14130    /**
14131     * Get a toolbar's orientation
14132     * @param obj The toolbar object
14133     * @return If @c EINA_TRUE, the toolbar is vertical
14134     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
14135     * @ingroup Toolbar
14136     */
14137    EAPI Eina_Bool        elm_toolbar_orientation_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
14138
14139    /**
14140     * @}
14141     */
14142
14143    /**
14144     * @defgroup Tooltips Tooltips
14145     *
14146     * The Tooltip is an (internal, for now) smart object used to show a
14147     * content in a frame on mouse hover of objects(or widgets), with
14148     * tips/information about them.
14149     *
14150     * @{
14151     */
14152
14153    EAPI double       elm_tooltip_delay_get(void);
14154    EAPI Eina_Bool    elm_tooltip_delay_set(double delay);
14155    EAPI void         elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
14156    EAPI void         elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
14157    EAPI void         elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
14158    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);
14159    EAPI void         elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14160    EAPI void         elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
14161    EAPI const char  *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14162    EAPI Eina_Bool    elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
14163    EAPI Eina_Bool    elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
14164
14165    /**
14166     * @}
14167     */
14168
14169    /**
14170     * @defgroup Cursors Cursors
14171     *
14172     * The Elementary cursor is an internal smart object used to
14173     * customize the mouse cursor displayed over objects (or
14174     * widgets). In the most common scenario, the cursor decoration
14175     * comes from the graphical @b engine Elementary is running
14176     * on. Those engines may provide different decorations for cursors,
14177     * and Elementary provides functions to choose them (think of X11
14178     * cursors, as an example).
14179     *
14180     * There's also the possibility of, besides using engine provided
14181     * cursors, also use ones coming from Edje theming files. Both
14182     * globally and per widget, Elementary makes it possible for one to
14183     * make the cursors lookup to be held on engines only or on
14184     * Elementary's theme file, too.
14185     *
14186     * @{
14187     */
14188
14189    /**
14190     * Set the cursor to be shown when mouse is over the object
14191     *
14192     * Set the cursor that will be displayed when mouse is over the
14193     * object. The object can have only one cursor set to it, so if
14194     * this function is called twice for an object, the previous set
14195     * will be unset.
14196     * If using X cursors, a definition of all the valid cursor names
14197     * is listed on Elementary_Cursors.h. If an invalid name is set
14198     * the default cursor will be used.
14199     *
14200     * @param obj the object being set a cursor.
14201     * @param cursor the cursor name to be used.
14202     *
14203     * @ingroup Cursors
14204     */
14205    EAPI void         elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
14206
14207    /**
14208     * Get the cursor to be shown when mouse is over the object
14209     *
14210     * @param obj an object with cursor already set.
14211     * @return the cursor name.
14212     *
14213     * @ingroup Cursors
14214     */
14215    EAPI const char  *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14216
14217    /**
14218     * Unset cursor for object
14219     *
14220     * Unset cursor for object, and set the cursor to default if the mouse
14221     * was over this object.
14222     *
14223     * @param obj Target object
14224     * @see elm_object_cursor_set()
14225     *
14226     * @ingroup Cursors
14227     */
14228    EAPI void         elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14229
14230    /**
14231     * Sets a different style for this object cursor.
14232     *
14233     * @note before you set a style you should define a cursor with
14234     *       elm_object_cursor_set()
14235     *
14236     * @param obj an object with cursor already set.
14237     * @param style the theme style to use (default, transparent, ...)
14238     *
14239     * @ingroup Cursors
14240     */
14241    EAPI void         elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
14242
14243    /**
14244     * Get the style for this object cursor.
14245     *
14246     * @param obj an object with cursor already set.
14247     * @return style the theme style in use, defaults to "default". If the
14248     *         object does not have a cursor set, then NULL is returned.
14249     *
14250     * @ingroup Cursors
14251     */
14252    EAPI const char  *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14253
14254    /**
14255     * Set if the cursor set should be searched on the theme or should use
14256     * the provided by the engine, only.
14257     *
14258     * @note before you set if should look on theme you should define a cursor
14259     * with elm_object_cursor_set(). By default it will only look for cursors
14260     * provided by the engine.
14261     *
14262     * @param obj an object with cursor already set.
14263     * @param engine_only boolean to define it cursors should be looked only
14264     * between the provided by the engine or searched on widget's theme as well.
14265     *
14266     * @ingroup Cursors
14267     */
14268    EAPI void         elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
14269
14270    /**
14271     * Get the cursor engine only usage for this object cursor.
14272     *
14273     * @param obj an object with cursor already set.
14274     * @return engine_only boolean to define it cursors should be
14275     * looked only between the provided by the engine or searched on
14276     * widget's theme as well. If the object does not have a cursor
14277     * set, then EINA_FALSE is returned.
14278     *
14279     * @ingroup Cursors
14280     */
14281    EAPI Eina_Bool    elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14282
14283    /**
14284     * Get the configured cursor engine only usage
14285     *
14286     * This gets the globally configured exclusive usage of engine cursors.
14287     *
14288     * @return 1 if only engine cursors should be used
14289     * @ingroup Cursors
14290     */
14291    EAPI int          elm_cursor_engine_only_get(void);
14292
14293    /**
14294     * Set the configured cursor engine only usage
14295     *
14296     * This sets the globally configured exclusive usage of engine cursors.
14297     * It won't affect cursors set before changing this value.
14298     *
14299     * @param engine_only If 1 only engine cursors will be enabled, if 0 will
14300     * look for them on theme before.
14301     * @return EINA_TRUE if value is valid and setted (0 or 1)
14302     * @ingroup Cursors
14303     */
14304    EAPI Eina_Bool    elm_cursor_engine_only_set(int engine_only);
14305
14306    /**
14307     * @}
14308     */
14309
14310    /**
14311     * @defgroup Menu Menu
14312     *
14313     * @image html img/widget/menu/preview-00.png
14314     * @image latex img/widget/menu/preview-00.eps
14315     *
14316     * A menu is a list of items displayed above its parent. When the menu is
14317     * showing its parent is darkened. Each item can have a sub-menu. The menu
14318     * object can be used to display a menu on a right click event, in a toolbar,
14319     * anywhere.
14320     *
14321     * Signals that you can add callbacks for are:
14322     * @li "clicked" - the user clicked the empty space in the menu to dismiss.
14323     *             event_info is NULL.
14324     *
14325     * @see @ref tutorial_menu
14326     * @{
14327     */
14328    typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
14329    /**
14330     * @brief Add a new menu to the parent
14331     *
14332     * @param parent The parent object.
14333     * @return The new object or NULL if it cannot be created.
14334     */
14335    EAPI Evas_Object       *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14336    /**
14337     * @brief Set the parent for the given menu widget
14338     *
14339     * @param obj The menu object.
14340     * @param parent The new parent.
14341     */
14342    EAPI void               elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14343    /**
14344     * @brief Get the parent for the given menu widget
14345     *
14346     * @param obj The menu object.
14347     * @return The parent.
14348     *
14349     * @see elm_menu_parent_set()
14350     */
14351    EAPI Evas_Object       *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14352    /**
14353     * @brief Move the menu to a new position
14354     *
14355     * @param obj The menu object.
14356     * @param x The new position.
14357     * @param y The new position.
14358     *
14359     * Sets the top-left position of the menu to (@p x,@p y).
14360     *
14361     * @note @p x and @p y coordinates are relative to parent.
14362     */
14363    EAPI void               elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
14364    /**
14365     * @brief Close a opened menu
14366     *
14367     * @param obj the menu object
14368     * @return void
14369     *
14370     * Hides the menu and all it's sub-menus.
14371     */
14372    EAPI void               elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
14373    /**
14374     * @brief Returns a list of @p item's items.
14375     *
14376     * @param obj The menu object
14377     * @return An Eina_List* of @p item's items
14378     */
14379    EAPI const Eina_List   *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14380    /**
14381     * @brief Get the Evas_Object of an Elm_Menu_Item
14382     *
14383     * @param item The menu item object.
14384     * @return The edje object containing the swallowed content
14385     *
14386     * @warning Don't manipulate this object!
14387     */
14388    EAPI Evas_Object       *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14389    /**
14390     * @brief Add an item at the end of the given menu widget
14391     *
14392     * @param obj The menu object.
14393     * @param parent The parent menu item (optional)
14394     * @param icon A icon display on the item. The icon will be destryed by the menu.
14395     * @param label The label of the item.
14396     * @param func Function called when the user select the item.
14397     * @param data Data sent by the callback.
14398     * @return Returns the new item.
14399     */
14400    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);
14401    /**
14402     * @brief Add an object swallowed in an item at the end of the given menu
14403     * widget
14404     *
14405     * @param obj The menu object.
14406     * @param parent The parent menu item (optional)
14407     * @param subobj The object to swallow
14408     * @param func Function called when the user select the item.
14409     * @param data Data sent by the callback.
14410     * @return Returns the new item.
14411     *
14412     * Add an evas object as an item to the menu.
14413     */
14414    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);
14415    /**
14416     * @brief Set the label of a menu item
14417     *
14418     * @param item The menu item object.
14419     * @param label The label to set for @p item
14420     *
14421     * @warning Don't use this funcion on items created with
14422     * elm_menu_item_add_object() or elm_menu_item_separator_add().
14423     */
14424    EAPI void               elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
14425    /**
14426     * @brief Get the label of a menu item
14427     *
14428     * @param item The menu item object.
14429     * @return The label of @p item
14430     */
14431    EAPI const char        *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14432    /**
14433     * @brief Set the icon of a menu item to the standard icon with name @p icon
14434     *
14435     * @param item The menu item object.
14436     * @param icon The icon object to set for the content of @p item
14437     *
14438     * Once this icon is set, any previously set icon will be deleted.
14439     */
14440    EAPI void               elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
14441    /**
14442     * @brief Get the string representation from the icon of a menu item
14443     *
14444     * @param item The menu item object.
14445     * @return The string representation of @p item's icon or NULL
14446     *
14447     * @see elm_menu_item_object_icon_name_set()
14448     */
14449    EAPI const char        *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14450    /**
14451     * @brief Set the content object of a menu item
14452     *
14453     * @param item The menu item object
14454     * @param The content object or NULL
14455     * @return EINA_TRUE on success, else EINA_FALSE
14456     *
14457     * Use this function to change the object swallowed by a menu item, deleting
14458     * any previously swallowed object.
14459     */
14460    EAPI Eina_Bool          elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
14461    /**
14462     * @brief Get the content object of a menu item
14463     *
14464     * @param item The menu item object
14465     * @return The content object or NULL
14466     * @note If @p item was added with elm_menu_item_add_object, this
14467     * function will return the object passed, else it will return the
14468     * icon object.
14469     *
14470     * @see elm_menu_item_object_content_set()
14471     */
14472    EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14473    /**
14474     * @brief Set the selected state of @p item.
14475     *
14476     * @param item The menu item object.
14477     * @param selected The selected/unselected state of the item
14478     */
14479    EAPI void               elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14480    /**
14481     * @brief Get the selected state of @p item.
14482     *
14483     * @param item The menu item object.
14484     * @return The selected/unselected state of the item
14485     *
14486     * @see elm_menu_item_selected_set()
14487     */
14488    EAPI Eina_Bool          elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14489    /**
14490     * @brief Set the disabled state of @p item.
14491     *
14492     * @param item The menu item object.
14493     * @param disabled The enabled/disabled state of the item
14494     */
14495    EAPI void               elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14496    /**
14497     * @brief Get the disabled state of @p item.
14498     *
14499     * @param item The menu item object.
14500     * @return The enabled/disabled state of the item
14501     *
14502     * @see elm_menu_item_disabled_set()
14503     */
14504    EAPI Eina_Bool          elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14505    /**
14506     * @brief Add a separator item to menu @p obj under @p parent.
14507     *
14508     * @param obj The menu object
14509     * @param parent The item to add the separator under
14510     * @return The created item or NULL on failure
14511     *
14512     * This is item is a @ref Separator.
14513     */
14514    EAPI Elm_Menu_Item     *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
14515    /**
14516     * @brief Returns whether @p item is a separator.
14517     *
14518     * @param item The item to check
14519     * @return If true, @p item is a separator
14520     *
14521     * @see elm_menu_item_separator_add()
14522     */
14523    EAPI Eina_Bool          elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14524    /**
14525     * @brief Deletes an item from the menu.
14526     *
14527     * @param item The item to delete.
14528     *
14529     * @see elm_menu_item_add()
14530     */
14531    EAPI void               elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14532    /**
14533     * @brief Set the function called when a menu item is deleted.
14534     *
14535     * @param item The item to set the callback on
14536     * @param func The function called
14537     *
14538     * @see elm_menu_item_add()
14539     * @see elm_menu_item_del()
14540     */
14541    EAPI void               elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14542    /**
14543     * @brief Returns the data associated with menu item @p item.
14544     *
14545     * @param item The item
14546     * @return The data associated with @p item or NULL if none was set.
14547     *
14548     * This is the data set with elm_menu_add() or elm_menu_item_data_set().
14549     */
14550    EAPI void              *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14551    /**
14552     * @brief Sets the data to be associated with menu item @p item.
14553     *
14554     * @param item The item
14555     * @param data The data to be associated with @p item
14556     */
14557    EAPI void               elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
14558    /**
14559     * @brief Returns a list of @p item's subitems.
14560     *
14561     * @param item The item
14562     * @return An Eina_List* of @p item's subitems
14563     *
14564     * @see elm_menu_add()
14565     */
14566    EAPI const Eina_List   *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14567    /**
14568     * @brief Get the position of a menu item
14569     *
14570     * @param item The menu item
14571     * @return The item's index
14572     *
14573     * This function returns the index position of a menu item in a menu.
14574     * For a sub-menu, this number is relative to the first item in the sub-menu.
14575     *
14576     * @note Index values begin with 0
14577     */
14578    EAPI unsigned int       elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
14579    /**
14580     * @brief @brief Return a menu item's owner menu
14581     *
14582     * @param item The menu item
14583     * @return The menu object owning @p item, or NULL on failure
14584     *
14585     * Use this function to get the menu object owning an item.
14586     */
14587    EAPI Evas_Object       *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
14588    /**
14589     * @brief Get the selected item in the menu
14590     *
14591     * @param obj The menu object
14592     * @return The selected item, or NULL if none
14593     *
14594     * @see elm_menu_item_selected_get()
14595     * @see elm_menu_item_selected_set()
14596     */
14597    EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14598    /**
14599     * @brief Get the last item in the menu
14600     *
14601     * @param obj The menu object
14602     * @return The last item, or NULL if none
14603     */
14604    EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14605    /**
14606     * @brief Get the first item in the menu
14607     *
14608     * @param obj The menu object
14609     * @return The first item, or NULL if none
14610     */
14611    EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14612    /**
14613     * @brief Get the next item in the menu.
14614     *
14615     * @param item The menu item object.
14616     * @return The item after it, or NULL if none
14617     */
14618    EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14619    /**
14620     * @brief Get the previous item in the menu.
14621     *
14622     * @param item The menu item object.
14623     * @return The item before it, or NULL if none
14624     */
14625    EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14626    /**
14627     * @}
14628     */
14629
14630    /**
14631     * @defgroup List List
14632     * @ingroup Elementary
14633     *
14634     * @image html img/widget/list/preview-00.png
14635     * @image latex img/widget/list/preview-00.eps width=\textwidth
14636     *
14637     * @image html img/list.png
14638     * @image latex img/list.eps width=\textwidth
14639     *
14640     * A list widget is a container whose children are displayed vertically or
14641     * horizontally, in order, and can be selected.
14642     * The list can accept only one or multiple items selection. Also has many
14643     * modes of items displaying.
14644     *
14645     * A list is a very simple type of list widget.  For more robust
14646     * lists, @ref Genlist should probably be used.
14647     *
14648     * Smart callbacks one can listen to:
14649     * - @c "activated" - The user has double-clicked or pressed
14650     *   (enter|return|spacebar) on an item. The @c event_info parameter
14651     *   is the item that was activated.
14652     * - @c "clicked,double" - The user has double-clicked an item.
14653     *   The @c event_info parameter is the item that was double-clicked.
14654     * - "selected" - when the user selected an item
14655     * - "unselected" - when the user unselected an item
14656     * - "longpressed" - an item in the list is long-pressed
14657     * - "scroll,edge,top" - the list is scrolled until the top edge
14658     * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
14659     * - "scroll,edge,left" - the list is scrolled until the left edge
14660     * - "scroll,edge,right" - the list is scrolled until the right edge
14661     *
14662     * Available styles for it:
14663     * - @c "default"
14664     *
14665     * List of examples:
14666     * @li @ref list_example_01
14667     * @li @ref list_example_02
14668     * @li @ref list_example_03
14669     */
14670
14671    /**
14672     * @addtogroup List
14673     * @{
14674     */
14675
14676    /**
14677     * @enum _Elm_List_Mode
14678     * @typedef Elm_List_Mode
14679     *
14680     * Set list's resize behavior, transverse axis scroll and
14681     * items cropping. See each mode's description for more details.
14682     *
14683     * @note Default value is #ELM_LIST_SCROLL.
14684     *
14685     * Values <b> don't </b> work as bitmask, only one can be choosen.
14686     *
14687     * @see elm_list_mode_set()
14688     * @see elm_list_mode_get()
14689     *
14690     * @ingroup List
14691     */
14692    typedef enum _Elm_List_Mode
14693      {
14694         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. */
14695         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). */
14696         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. */
14697         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. */
14698         ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
14699      } Elm_List_Mode;
14700
14701    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().  */
14702
14703    /**
14704     * Add a new list widget to the given parent Elementary
14705     * (container) object.
14706     *
14707     * @param parent The parent object.
14708     * @return a new list widget handle or @c NULL, on errors.
14709     *
14710     * This function inserts a new list widget on the canvas.
14711     *
14712     * @ingroup List
14713     */
14714    EAPI Evas_Object     *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14715
14716    /**
14717     * Starts the list.
14718     *
14719     * @param obj The list object
14720     *
14721     * @note Call before running show() on the list object.
14722     * @warning If not called, it won't display the list properly.
14723     *
14724     * @code
14725     * li = elm_list_add(win);
14726     * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
14727     * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
14728     * elm_list_go(li);
14729     * evas_object_show(li);
14730     * @endcode
14731     *
14732     * @ingroup List
14733     */
14734    EAPI void             elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
14735
14736    /**
14737     * Enable or disable multiple items selection on the list object.
14738     *
14739     * @param obj The list object
14740     * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
14741     * disable it.
14742     *
14743     * Disabled by default. If disabled, the user can select a single item of
14744     * the list each time. Selected items are highlighted on list.
14745     * If enabled, many items can be selected.
14746     *
14747     * If a selected item is selected again, it will be unselected.
14748     *
14749     * @see elm_list_multi_select_get()
14750     *
14751     * @ingroup List
14752     */
14753    EAPI void             elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
14754
14755    /**
14756     * Get a value whether multiple items selection is enabled or not.
14757     *
14758     * @see elm_list_multi_select_set() for details.
14759     *
14760     * @param obj The list object.
14761     * @return @c EINA_TRUE means multiple items selection is enabled.
14762     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14763     * @c EINA_FALSE is returned.
14764     *
14765     * @ingroup List
14766     */
14767    EAPI Eina_Bool        elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14768
14769    /**
14770     * Set which mode to use for the list object.
14771     *
14772     * @param obj The list object
14773     * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
14774     * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
14775     *
14776     * Set list's resize behavior, transverse axis scroll and
14777     * items cropping. See each mode's description for more details.
14778     *
14779     * @note Default value is #ELM_LIST_SCROLL.
14780     *
14781     * Only one can be set, if a previous one was set, it will be changed
14782     * by the new mode set. Bitmask won't work as well.
14783     *
14784     * @see elm_list_mode_get()
14785     *
14786     * @ingroup List
14787     */
14788    EAPI void             elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
14789
14790    /**
14791     * Get the mode the list is at.
14792     *
14793     * @param obj The list object
14794     * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
14795     * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
14796     *
14797     * @note see elm_list_mode_set() for more information.
14798     *
14799     * @ingroup List
14800     */
14801    EAPI Elm_List_Mode    elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14802
14803    /**
14804     * Enable or disable horizontal mode on the list object.
14805     *
14806     * @param obj The list object.
14807     * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
14808     * disable it, i.e., to enable vertical mode.
14809     *
14810     * @note Vertical mode is set by default.
14811     *
14812     * On horizontal mode items are displayed on list from left to right,
14813     * instead of from top to bottom. Also, the list will scroll horizontally.
14814     * Each item will presents left icon on top and right icon, or end, at
14815     * the bottom.
14816     *
14817     * @see elm_list_horizontal_get()
14818     *
14819     * @ingroup List
14820     */
14821    EAPI void             elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14822
14823    /**
14824     * Get a value whether horizontal mode is enabled or not.
14825     *
14826     * @param obj The list object.
14827     * @return @c EINA_TRUE means horizontal mode selection is enabled.
14828     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14829     * @c EINA_FALSE is returned.
14830     *
14831     * @see elm_list_horizontal_set() for details.
14832     *
14833     * @ingroup List
14834     */
14835    EAPI Eina_Bool        elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14836
14837    /**
14838     * Enable or disable always select mode on the list object.
14839     *
14840     * @param obj The list object
14841     * @param always_select @c EINA_TRUE to enable always select mode or
14842     * @c EINA_FALSE to disable it.
14843     *
14844     * @note Always select mode is disabled by default.
14845     *
14846     * Default behavior of list items is to only call its callback function
14847     * the first time it's pressed, i.e., when it is selected. If a selected
14848     * item is pressed again, and multi-select is disabled, it won't call
14849     * this function (if multi-select is enabled it will unselect the item).
14850     *
14851     * If always select is enabled, it will call the callback function
14852     * everytime a item is pressed, so it will call when the item is selected,
14853     * and again when a selected item is pressed.
14854     *
14855     * @see elm_list_always_select_mode_get()
14856     * @see elm_list_multi_select_set()
14857     *
14858     * @ingroup List
14859     */
14860    EAPI void             elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14861
14862    /**
14863     * Get a value whether always select mode is enabled or not, meaning that
14864     * an item will always call its callback function, even if already selected.
14865     *
14866     * @param obj The list object
14867     * @return @c EINA_TRUE means horizontal mode selection is enabled.
14868     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14869     * @c EINA_FALSE is returned.
14870     *
14871     * @see elm_list_always_select_mode_set() for details.
14872     *
14873     * @ingroup List
14874     */
14875    EAPI Eina_Bool        elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14876
14877    /**
14878     * Set bouncing behaviour when the scrolled content reaches an edge.
14879     *
14880     * Tell the internal scroller object whether it should bounce or not
14881     * when it reaches the respective edges for each axis.
14882     *
14883     * @param obj The list object
14884     * @param h_bounce Whether to bounce or not in the horizontal axis.
14885     * @param v_bounce Whether to bounce or not in the vertical axis.
14886     *
14887     * @see elm_scroller_bounce_set()
14888     *
14889     * @ingroup List
14890     */
14891    EAPI void             elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
14892
14893    /**
14894     * Get the bouncing behaviour of the internal scroller.
14895     *
14896     * Get whether the internal scroller should bounce when the edge of each
14897     * axis is reached scrolling.
14898     *
14899     * @param obj The list object.
14900     * @param h_bounce Pointer where to store the bounce state of the horizontal
14901     * axis.
14902     * @param v_bounce Pointer where to store the bounce state of the vertical
14903     * axis.
14904     *
14905     * @see elm_scroller_bounce_get()
14906     * @see elm_list_bounce_set()
14907     *
14908     * @ingroup List
14909     */
14910    EAPI void             elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
14911
14912    /**
14913     * Set the scrollbar policy.
14914     *
14915     * @param obj The list object
14916     * @param policy_h Horizontal scrollbar policy.
14917     * @param policy_v Vertical scrollbar policy.
14918     *
14919     * This sets the scrollbar visibility policy for the given scroller.
14920     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
14921     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
14922     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
14923     * This applies respectively for the horizontal and vertical scrollbars.
14924     *
14925     * The both are disabled by default, i.e., are set to
14926     * #ELM_SCROLLER_POLICY_OFF.
14927     *
14928     * @ingroup List
14929     */
14930    EAPI void             elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
14931
14932    /**
14933     * Get the scrollbar policy.
14934     *
14935     * @see elm_list_scroller_policy_get() for details.
14936     *
14937     * @param obj The list object.
14938     * @param policy_h Pointer where to store horizontal scrollbar policy.
14939     * @param policy_v Pointer where to store vertical scrollbar policy.
14940     *
14941     * @ingroup List
14942     */
14943    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);
14944
14945    /**
14946     * Append a new item to the list object.
14947     *
14948     * @param obj The list object.
14949     * @param label The label of the list item.
14950     * @param icon The icon object to use for the left side of the item. An
14951     * icon can be any Evas object, but usually it is an icon created
14952     * with elm_icon_add().
14953     * @param end The icon object to use for the right side of the item. An
14954     * icon can be any Evas object.
14955     * @param func The function to call when the item is clicked.
14956     * @param data The data to associate with the item for related callbacks.
14957     *
14958     * @return The created item or @c NULL upon failure.
14959     *
14960     * A new item will be created and appended to the list, i.e., will
14961     * be set as @b last item.
14962     *
14963     * Items created with this method can be deleted with
14964     * elm_list_item_del().
14965     *
14966     * Associated @p data can be properly freed when item is deleted if a
14967     * callback function is set with elm_list_item_del_cb_set().
14968     *
14969     * If a function is passed as argument, it will be called everytime this item
14970     * is selected, i.e., the user clicks over an unselected item.
14971     * If always select is enabled it will call this function every time
14972     * user clicks over an item (already selected or not).
14973     * If such function isn't needed, just passing
14974     * @c NULL as @p func is enough. The same should be done for @p data.
14975     *
14976     * Simple example (with no function callback or data associated):
14977     * @code
14978     * li = elm_list_add(win);
14979     * ic = elm_icon_add(win);
14980     * elm_icon_file_set(ic, "path/to/image", NULL);
14981     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
14982     * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
14983     * elm_list_go(li);
14984     * evas_object_show(li);
14985     * @endcode
14986     *
14987     * @see elm_list_always_select_mode_set()
14988     * @see elm_list_item_del()
14989     * @see elm_list_item_del_cb_set()
14990     * @see elm_list_clear()
14991     * @see elm_icon_add()
14992     *
14993     * @ingroup List
14994     */
14995    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);
14996
14997    /**
14998     * Prepend a new item to the list object.
14999     *
15000     * @param obj The list object.
15001     * @param label The label of the list item.
15002     * @param icon The icon object to use for the left side of the item. An
15003     * icon can be any Evas object, but usually it is an icon created
15004     * with elm_icon_add().
15005     * @param end The icon object to use for the right side of the item. An
15006     * icon can be any Evas object.
15007     * @param func The function to call when the item is clicked.
15008     * @param data The data to associate with the item for related callbacks.
15009     *
15010     * @return The created item or @c NULL upon failure.
15011     *
15012     * A new item will be created and prepended to the list, i.e., will
15013     * be set as @b first item.
15014     *
15015     * Items created with this method can be deleted with
15016     * elm_list_item_del().
15017     *
15018     * Associated @p data can be properly freed when item is deleted if a
15019     * callback function is set with elm_list_item_del_cb_set().
15020     *
15021     * If a function is passed as argument, it will be called everytime this item
15022     * is selected, i.e., the user clicks over an unselected item.
15023     * If always select is enabled it will call this function every time
15024     * user clicks over an item (already selected or not).
15025     * If such function isn't needed, just passing
15026     * @c NULL as @p func is enough. The same should be done for @p data.
15027     *
15028     * @see elm_list_item_append() for a simple code example.
15029     * @see elm_list_always_select_mode_set()
15030     * @see elm_list_item_del()
15031     * @see elm_list_item_del_cb_set()
15032     * @see elm_list_clear()
15033     * @see elm_icon_add()
15034     *
15035     * @ingroup List
15036     */
15037    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);
15038
15039    /**
15040     * Insert a new item into the list object before item @p before.
15041     *
15042     * @param obj The list object.
15043     * @param before The list item to insert before.
15044     * @param label The label of the list item.
15045     * @param icon The icon object to use for the left side of the item. An
15046     * icon can be any Evas object, but usually it is an icon created
15047     * with elm_icon_add().
15048     * @param end The icon object to use for the right side of the item. An
15049     * icon can be any Evas object.
15050     * @param func The function to call when the item is clicked.
15051     * @param data The data to associate with the item for related callbacks.
15052     *
15053     * @return The created item or @c NULL upon failure.
15054     *
15055     * A new item will be created and added to the list. Its position in
15056     * this list will be just before item @p before.
15057     *
15058     * Items created with this method can be deleted with
15059     * elm_list_item_del().
15060     *
15061     * Associated @p data can be properly freed when item is deleted if a
15062     * callback function is set with elm_list_item_del_cb_set().
15063     *
15064     * If a function is passed as argument, it will be called everytime this item
15065     * is selected, i.e., the user clicks over an unselected item.
15066     * If always select is enabled it will call this function every time
15067     * user clicks over an item (already selected or not).
15068     * If such function isn't needed, just passing
15069     * @c NULL as @p func is enough. The same should be done for @p data.
15070     *
15071     * @see elm_list_item_append() for a simple code example.
15072     * @see elm_list_always_select_mode_set()
15073     * @see elm_list_item_del()
15074     * @see elm_list_item_del_cb_set()
15075     * @see elm_list_clear()
15076     * @see elm_icon_add()
15077     *
15078     * @ingroup List
15079     */
15080    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);
15081
15082    /**
15083     * Insert a new item into the list object after item @p after.
15084     *
15085     * @param obj The list object.
15086     * @param after The list item to insert after.
15087     * @param label The label of the list item.
15088     * @param icon The icon object to use for the left side of the item. An
15089     * icon can be any Evas object, but usually it is an icon created
15090     * with elm_icon_add().
15091     * @param end The icon object to use for the right side of the item. An
15092     * icon can be any Evas object.
15093     * @param func The function to call when the item is clicked.
15094     * @param data The data to associate with the item for related callbacks.
15095     *
15096     * @return The created item or @c NULL upon failure.
15097     *
15098     * A new item will be created and added to the list. Its position in
15099     * this list will be just after item @p after.
15100     *
15101     * Items created with this method can be deleted with
15102     * elm_list_item_del().
15103     *
15104     * Associated @p data can be properly freed when item is deleted if a
15105     * callback function is set with elm_list_item_del_cb_set().
15106     *
15107     * If a function is passed as argument, it will be called everytime this item
15108     * is selected, i.e., the user clicks over an unselected item.
15109     * If always select is enabled it will call this function every time
15110     * user clicks over an item (already selected or not).
15111     * If such function isn't needed, just passing
15112     * @c NULL as @p func is enough. The same should be done for @p data.
15113     *
15114     * @see elm_list_item_append() for a simple code example.
15115     * @see elm_list_always_select_mode_set()
15116     * @see elm_list_item_del()
15117     * @see elm_list_item_del_cb_set()
15118     * @see elm_list_clear()
15119     * @see elm_icon_add()
15120     *
15121     * @ingroup List
15122     */
15123    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);
15124
15125    /**
15126     * Insert a new item into the sorted list object.
15127     *
15128     * @param obj The list object.
15129     * @param label The label of the list item.
15130     * @param icon The icon object to use for the left side of the item. An
15131     * icon can be any Evas object, but usually it is an icon created
15132     * with elm_icon_add().
15133     * @param end The icon object to use for the right side of the item. An
15134     * icon can be any Evas object.
15135     * @param func The function to call when the item is clicked.
15136     * @param data The data to associate with the item for related callbacks.
15137     * @param cmp_func The comparing function to be used to sort list
15138     * items <b>by #Elm_List_Item item handles</b>. This function will
15139     * receive two items and compare them, returning a non-negative integer
15140     * if the second item should be place after the first, or negative value
15141     * if should be placed before.
15142     *
15143     * @return The created item or @c NULL upon failure.
15144     *
15145     * @note This function inserts values into a list object assuming it was
15146     * sorted and the result will be sorted.
15147     *
15148     * A new item will be created and added to the list. Its position in
15149     * this list will be found comparing the new item with previously inserted
15150     * items using function @p cmp_func.
15151     *
15152     * Items created with this method can be deleted with
15153     * elm_list_item_del().
15154     *
15155     * Associated @p data can be properly freed when item is deleted if a
15156     * callback function is set with elm_list_item_del_cb_set().
15157     *
15158     * If a function is passed as argument, it will be called everytime this item
15159     * is selected, i.e., the user clicks over an unselected item.
15160     * If always select is enabled it will call this function every time
15161     * user clicks over an item (already selected or not).
15162     * If such function isn't needed, just passing
15163     * @c NULL as @p func is enough. The same should be done for @p data.
15164     *
15165     * @see elm_list_item_append() for a simple code example.
15166     * @see elm_list_always_select_mode_set()
15167     * @see elm_list_item_del()
15168     * @see elm_list_item_del_cb_set()
15169     * @see elm_list_clear()
15170     * @see elm_icon_add()
15171     *
15172     * @ingroup List
15173     */
15174    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);
15175
15176    /**
15177     * Remove all list's items.
15178     *
15179     * @param obj The list object
15180     *
15181     * @see elm_list_item_del()
15182     * @see elm_list_item_append()
15183     *
15184     * @ingroup List
15185     */
15186    EAPI void             elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
15187
15188    /**
15189     * Get a list of all the list items.
15190     *
15191     * @param obj The list object
15192     * @return An @c Eina_List of list items, #Elm_List_Item,
15193     * or @c NULL on failure.
15194     *
15195     * @see elm_list_item_append()
15196     * @see elm_list_item_del()
15197     * @see elm_list_clear()
15198     *
15199     * @ingroup List
15200     */
15201    EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15202
15203    /**
15204     * Get the selected item.
15205     *
15206     * @param obj The list object.
15207     * @return The selected list item.
15208     *
15209     * The selected item can be unselected with function
15210     * elm_list_item_selected_set().
15211     *
15212     * The selected item always will be highlighted on list.
15213     *
15214     * @see elm_list_selected_items_get()
15215     *
15216     * @ingroup List
15217     */
15218    EAPI Elm_List_Item   *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15219
15220    /**
15221     * Return a list of the currently selected list items.
15222     *
15223     * @param obj The list object.
15224     * @return An @c Eina_List of list items, #Elm_List_Item,
15225     * or @c NULL on failure.
15226     *
15227     * Multiple items can be selected if multi select is enabled. It can be
15228     * done with elm_list_multi_select_set().
15229     *
15230     * @see elm_list_selected_item_get()
15231     * @see elm_list_multi_select_set()
15232     *
15233     * @ingroup List
15234     */
15235    EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15236
15237    /**
15238     * Set the selected state of an item.
15239     *
15240     * @param item The list item
15241     * @param selected The selected state
15242     *
15243     * This sets the selected state of the given item @p it.
15244     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
15245     *
15246     * If a new item is selected the previosly selected will be unselected,
15247     * unless multiple selection is enabled with elm_list_multi_select_set().
15248     * Previoulsy selected item can be get with function
15249     * elm_list_selected_item_get().
15250     *
15251     * Selected items will be highlighted.
15252     *
15253     * @see elm_list_item_selected_get()
15254     * @see elm_list_selected_item_get()
15255     * @see elm_list_multi_select_set()
15256     *
15257     * @ingroup List
15258     */
15259    EAPI void             elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15260
15261    /*
15262     * Get whether the @p item is selected or not.
15263     *
15264     * @param item The list item.
15265     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
15266     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
15267     *
15268     * @see elm_list_selected_item_set() for details.
15269     * @see elm_list_item_selected_get()
15270     *
15271     * @ingroup List
15272     */
15273    EAPI Eina_Bool        elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15274
15275    /**
15276     * Set or unset item as a separator.
15277     *
15278     * @param it The list item.
15279     * @param setting @c EINA_TRUE to set item @p it as separator or
15280     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15281     *
15282     * Items aren't set as separator by default.
15283     *
15284     * If set as separator it will display separator theme, so won't display
15285     * icons or label.
15286     *
15287     * @see elm_list_item_separator_get()
15288     *
15289     * @ingroup List
15290     */
15291    EAPI void             elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
15292
15293    /**
15294     * Get a value whether item is a separator or not.
15295     *
15296     * @see elm_list_item_separator_set() for details.
15297     *
15298     * @param it The list item.
15299     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15300     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15301     *
15302     * @ingroup List
15303     */
15304    EAPI Eina_Bool        elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15305
15306    /**
15307     * Show @p item in the list view.
15308     *
15309     * @param item The list item to be shown.
15310     *
15311     * It won't animate list until item is visible. If such behavior is wanted,
15312     * use elm_list_bring_in() intead.
15313     *
15314     * @ingroup List
15315     */
15316    EAPI void             elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15317
15318    /**
15319     * Bring in the given item to list view.
15320     *
15321     * @param item The item.
15322     *
15323     * This causes list to jump to the given item @p item and show it
15324     * (by scrolling), if it is not fully visible.
15325     *
15326     * This may use animation to do so and take a period of time.
15327     *
15328     * If animation isn't wanted, elm_list_item_show() can be used.
15329     *
15330     * @ingroup List
15331     */
15332    EAPI void             elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15333
15334    /**
15335     * Delete them item from the list.
15336     *
15337     * @param item The item of list to be deleted.
15338     *
15339     * If deleting all list items is required, elm_list_clear()
15340     * should be used instead of getting items list and deleting each one.
15341     *
15342     * @see elm_list_clear()
15343     * @see elm_list_item_append()
15344     * @see elm_list_item_del_cb_set()
15345     *
15346     * @ingroup List
15347     */
15348    EAPI void             elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15349
15350    /**
15351     * Set the function called when a list item is freed.
15352     *
15353     * @param item The item to set the callback on
15354     * @param func The function called
15355     *
15356     * If there is a @p func, then it will be called prior item's memory release.
15357     * That will be called with the following arguments:
15358     * @li item's data;
15359     * @li item's Evas object;
15360     * @li item itself;
15361     *
15362     * This way, a data associated to a list item could be properly freed.
15363     *
15364     * @ingroup List
15365     */
15366    EAPI void             elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15367
15368    /**
15369     * Get the data associated to the item.
15370     *
15371     * @param item The list item
15372     * @return The data associated to @p item
15373     *
15374     * The return value is a pointer to data associated to @p item when it was
15375     * created, with function elm_list_item_append() or similar. If no data
15376     * was passed as argument, it will return @c NULL.
15377     *
15378     * @see elm_list_item_append()
15379     *
15380     * @ingroup List
15381     */
15382    EAPI void            *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15383
15384    /**
15385     * Get the left side icon associated to the item.
15386     *
15387     * @param item The list item
15388     * @return The left side icon associated to @p item
15389     *
15390     * The return value is a pointer to the icon associated to @p item when
15391     * it was
15392     * created, with function elm_list_item_append() or similar, or later
15393     * with function elm_list_item_icon_set(). If no icon
15394     * was passed as argument, it will return @c NULL.
15395     *
15396     * @see elm_list_item_append()
15397     * @see elm_list_item_icon_set()
15398     *
15399     * @ingroup List
15400     */
15401    EAPI Evas_Object     *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15402
15403    /**
15404     * Set the left side icon associated to the item.
15405     *
15406     * @param item The list item
15407     * @param icon The left side icon object to associate with @p item
15408     *
15409     * The icon object to use at left side of the item. An
15410     * icon can be any Evas object, but usually it is an icon created
15411     * with elm_icon_add().
15412     *
15413     * Once the icon object is set, a previously set one will be deleted.
15414     * @warning Setting the same icon for two items will cause the icon to
15415     * dissapear from the first item.
15416     *
15417     * If an icon was passed as argument on item creation, with function
15418     * elm_list_item_append() or similar, it will be already
15419     * associated to the item.
15420     *
15421     * @see elm_list_item_append()
15422     * @see elm_list_item_icon_get()
15423     *
15424     * @ingroup List
15425     */
15426    EAPI void             elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
15427
15428    /**
15429     * Get the right side icon associated to the item.
15430     *
15431     * @param item The list item
15432     * @return The right side icon associated to @p item
15433     *
15434     * The return value is a pointer to the icon associated to @p item when
15435     * it was
15436     * created, with function elm_list_item_append() or similar, or later
15437     * with function elm_list_item_icon_set(). If no icon
15438     * was passed as argument, it will return @c NULL.
15439     *
15440     * @see elm_list_item_append()
15441     * @see elm_list_item_icon_set()
15442     *
15443     * @ingroup List
15444     */
15445    EAPI Evas_Object     *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15446
15447    /**
15448     * Set the right side icon associated to the item.
15449     *
15450     * @param item The list item
15451     * @param end The right side icon object to associate with @p item
15452     *
15453     * The icon object to use at right side of the item. An
15454     * icon can be any Evas object, but usually it is an icon created
15455     * with elm_icon_add().
15456     *
15457     * Once the icon object is set, a previously set one will be deleted.
15458     * @warning Setting the same icon for two items will cause the icon to
15459     * dissapear from the first item.
15460     *
15461     * If an icon was passed as argument on item creation, with function
15462     * elm_list_item_append() or similar, it will be already
15463     * associated to the item.
15464     *
15465     * @see elm_list_item_append()
15466     * @see elm_list_item_end_get()
15467     *
15468     * @ingroup List
15469     */
15470    EAPI void             elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
15471
15472    /**
15473     * Gets the base object of the item.
15474     *
15475     * @param item The list item
15476     * @return The base object associated with @p item
15477     *
15478     * Base object is the @c Evas_Object that represents that item.
15479     *
15480     * @ingroup List
15481     */
15482    EAPI Evas_Object     *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15483    EINA_DEPRECATED EAPI Evas_Object     *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15484
15485    /**
15486     * Get the label of item.
15487     *
15488     * @param item The item of list.
15489     * @return The label of item.
15490     *
15491     * The return value is a pointer to the label associated to @p item when
15492     * it was created, with function elm_list_item_append(), or later
15493     * with function elm_list_item_label_set. If no label
15494     * was passed as argument, it will return @c NULL.
15495     *
15496     * @see elm_list_item_label_set() for more details.
15497     * @see elm_list_item_append()
15498     *
15499     * @ingroup List
15500     */
15501    EAPI const char      *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15502
15503    /**
15504     * Set the label of item.
15505     *
15506     * @param item The item of list.
15507     * @param text The label of item.
15508     *
15509     * The label to be displayed by the item.
15510     * Label will be placed between left and right side icons (if set).
15511     *
15512     * If a label was passed as argument on item creation, with function
15513     * elm_list_item_append() or similar, it will be already
15514     * displayed by the item.
15515     *
15516     * @see elm_list_item_label_get()
15517     * @see elm_list_item_append()
15518     *
15519     * @ingroup List
15520     */
15521    EAPI void             elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
15522
15523
15524    /**
15525     * Get the item before @p it in list.
15526     *
15527     * @param it The list item.
15528     * @return The item before @p it, or @c NULL if none or on failure.
15529     *
15530     * @note If it is the first item, @c NULL will be returned.
15531     *
15532     * @see elm_list_item_append()
15533     * @see elm_list_items_get()
15534     *
15535     * @ingroup List
15536     */
15537    EAPI Elm_List_Item   *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15538
15539    /**
15540     * Get the item after @p it in list.
15541     *
15542     * @param it The list item.
15543     * @return The item after @p it, or @c NULL if none or on failure.
15544     *
15545     * @note If it is the last item, @c NULL will be returned.
15546     *
15547     * @see elm_list_item_append()
15548     * @see elm_list_items_get()
15549     *
15550     * @ingroup List
15551     */
15552    EAPI Elm_List_Item   *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15553
15554    /**
15555     * Sets the disabled/enabled state of a list item.
15556     *
15557     * @param it The item.
15558     * @param disabled The disabled state.
15559     *
15560     * A disabled item cannot be selected or unselected. It will also
15561     * change its appearance (generally greyed out). This sets the
15562     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15563     * enabled).
15564     *
15565     * @ingroup List
15566     */
15567    EAPI void             elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15568
15569    /**
15570     * Get a value whether list item is disabled or not.
15571     *
15572     * @param it The item.
15573     * @return The disabled state.
15574     *
15575     * @see elm_list_item_disabled_set() for more details.
15576     *
15577     * @ingroup List
15578     */
15579    EAPI Eina_Bool        elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15580
15581    /**
15582     * Set the text to be shown in a given list item's tooltips.
15583     *
15584     * @param item Target item.
15585     * @param text The text to set in the content.
15586     *
15587     * Setup the text as tooltip to object. The item can have only one tooltip,
15588     * so any previous tooltip data - set with this function or
15589     * elm_list_item_tooltip_content_cb_set() - is removed.
15590     *
15591     * @see elm_object_tooltip_text_set() for more details.
15592     *
15593     * @ingroup List
15594     */
15595    EAPI void             elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
15596
15597
15598    /**
15599     * @brief Disable size restrictions on an object's tooltip
15600     * @param item The tooltip's anchor object
15601     * @param disable If EINA_TRUE, size restrictions are disabled
15602     * @return EINA_FALSE on failure, EINA_TRUE on success
15603     *
15604     * This function allows a tooltip to expand beyond its parant window's canvas.
15605     * It will instead be limited only by the size of the display.
15606     */
15607    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
15608    /**
15609     * @brief Retrieve size restriction state of an object's tooltip
15610     * @param obj The tooltip's anchor object
15611     * @return If EINA_TRUE, size restrictions are disabled
15612     *
15613     * This function returns whether a tooltip is allowed to expand beyond
15614     * its parant window's canvas.
15615     * It will instead be limited only by the size of the display.
15616     */
15617    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15618
15619    /**
15620     * Set the content to be shown in the tooltip item.
15621     *
15622     * Setup the tooltip to item. The item can have only one tooltip,
15623     * so any previous tooltip data is removed. @p func(with @p data) will
15624     * be called every time that need show the tooltip and it should
15625     * return a valid Evas_Object. This object is then managed fully by
15626     * tooltip system and is deleted when the tooltip is gone.
15627     *
15628     * @param item the list item being attached a tooltip.
15629     * @param func the function used to create the tooltip contents.
15630     * @param data what to provide to @a func as callback data/context.
15631     * @param del_cb called when data is not needed anymore, either when
15632     *        another callback replaces @a func, the tooltip is unset with
15633     *        elm_list_item_tooltip_unset() or the owner @a item
15634     *        dies. This callback receives as the first parameter the
15635     *        given @a data, and @c event_info is the item.
15636     *
15637     * @see elm_object_tooltip_content_cb_set() for more details.
15638     *
15639     * @ingroup List
15640     */
15641    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);
15642
15643    /**
15644     * Unset tooltip from item.
15645     *
15646     * @param item list item to remove previously set tooltip.
15647     *
15648     * Remove tooltip from item. The callback provided as del_cb to
15649     * elm_list_item_tooltip_content_cb_set() will be called to notify
15650     * it is not used anymore.
15651     *
15652     * @see elm_object_tooltip_unset() for more details.
15653     * @see elm_list_item_tooltip_content_cb_set()
15654     *
15655     * @ingroup List
15656     */
15657    EAPI void             elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15658
15659    /**
15660     * Sets a different style for this item tooltip.
15661     *
15662     * @note before you set a style you should define a tooltip with
15663     *       elm_list_item_tooltip_content_cb_set() or
15664     *       elm_list_item_tooltip_text_set()
15665     *
15666     * @param item list item with tooltip already set.
15667     * @param style the theme style to use (default, transparent, ...)
15668     *
15669     * @see elm_object_tooltip_style_set() for more details.
15670     *
15671     * @ingroup List
15672     */
15673    EAPI void             elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
15674
15675    /**
15676     * Get the style for this item tooltip.
15677     *
15678     * @param item list item with tooltip already set.
15679     * @return style the theme style in use, defaults to "default". If the
15680     *         object does not have a tooltip set, then NULL is returned.
15681     *
15682     * @see elm_object_tooltip_style_get() for more details.
15683     * @see elm_list_item_tooltip_style_set()
15684     *
15685     * @ingroup List
15686     */
15687    EAPI const char      *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15688
15689    /**
15690     * Set the type of mouse pointer/cursor decoration to be shown,
15691     * when the mouse pointer is over the given list widget item
15692     *
15693     * @param item list item to customize cursor on
15694     * @param cursor the cursor type's name
15695     *
15696     * This function works analogously as elm_object_cursor_set(), but
15697     * here the cursor's changing area is restricted to the item's
15698     * area, and not the whole widget's. Note that that item cursors
15699     * have precedence over widget cursors, so that a mouse over an
15700     * item with custom cursor set will always show @b that cursor.
15701     *
15702     * If this function is called twice for an object, a previously set
15703     * cursor will be unset on the second call.
15704     *
15705     * @see elm_object_cursor_set()
15706     * @see elm_list_item_cursor_get()
15707     * @see elm_list_item_cursor_unset()
15708     *
15709     * @ingroup List
15710     */
15711    EAPI void             elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15712
15713    /*
15714     * Get the type of mouse pointer/cursor decoration set to be shown,
15715     * when the mouse pointer is over the given list widget item
15716     *
15717     * @param item list item with custom cursor set
15718     * @return the cursor type's name or @c NULL, if no custom cursors
15719     * were set to @p item (and on errors)
15720     *
15721     * @see elm_object_cursor_get()
15722     * @see elm_list_item_cursor_set()
15723     * @see elm_list_item_cursor_unset()
15724     *
15725     * @ingroup List
15726     */
15727    EAPI const char      *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15728
15729    /**
15730     * Unset any custom mouse pointer/cursor decoration set to be
15731     * shown, when the mouse pointer is over the given list widget
15732     * item, thus making it show the @b default cursor again.
15733     *
15734     * @param item a list item
15735     *
15736     * Use this call to undo any custom settings on this item's cursor
15737     * decoration, bringing it back to defaults (no custom style set).
15738     *
15739     * @see elm_object_cursor_unset()
15740     * @see elm_list_item_cursor_set()
15741     *
15742     * @ingroup List
15743     */
15744    EAPI void             elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15745
15746    /**
15747     * Set a different @b style for a given custom cursor set for a
15748     * list item.
15749     *
15750     * @param item list item with custom cursor set
15751     * @param style the <b>theme style</b> to use (e.g. @c "default",
15752     * @c "transparent", etc)
15753     *
15754     * This function only makes sense when one is using custom mouse
15755     * cursor decorations <b>defined in a theme file</b>, which can have,
15756     * given a cursor name/type, <b>alternate styles</b> on it. It
15757     * works analogously as elm_object_cursor_style_set(), but here
15758     * applyed only to list item objects.
15759     *
15760     * @warning Before you set a cursor style you should have definen a
15761     *       custom cursor previously on the item, with
15762     *       elm_list_item_cursor_set()
15763     *
15764     * @see elm_list_item_cursor_engine_only_set()
15765     * @see elm_list_item_cursor_style_get()
15766     *
15767     * @ingroup List
15768     */
15769    EAPI void             elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
15770
15771    /**
15772     * Get the current @b style set for a given list item's custom
15773     * cursor
15774     *
15775     * @param item list item with custom cursor set.
15776     * @return style the cursor style in use. If the object does not
15777     *         have a cursor set, then @c NULL is returned.
15778     *
15779     * @see elm_list_item_cursor_style_set() for more details
15780     *
15781     * @ingroup List
15782     */
15783    EAPI const char      *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15784
15785    /**
15786     * Set if the (custom)cursor for a given list item should be
15787     * searched in its theme, also, or should only rely on the
15788     * rendering engine.
15789     *
15790     * @param item item with custom (custom) cursor already set on
15791     * @param engine_only Use @c EINA_TRUE to have cursors looked for
15792     * only on those provided by the rendering engine, @c EINA_FALSE to
15793     * have them searched on the widget's theme, as well.
15794     *
15795     * @note This call is of use only if you've set a custom cursor
15796     * for list items, with elm_list_item_cursor_set().
15797     *
15798     * @note By default, cursors will only be looked for between those
15799     * provided by the rendering engine.
15800     *
15801     * @ingroup List
15802     */
15803    EAPI void             elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15804
15805    /**
15806     * Get if the (custom) cursor for a given list item is being
15807     * searched in its theme, also, or is only relying on the rendering
15808     * engine.
15809     *
15810     * @param item a list item
15811     * @return @c EINA_TRUE, if cursors are being looked for only on
15812     * those provided by the rendering engine, @c EINA_FALSE if they
15813     * are being searched on the widget's theme, as well.
15814     *
15815     * @see elm_list_item_cursor_engine_only_set(), for more details
15816     *
15817     * @ingroup List
15818     */
15819    EAPI Eina_Bool        elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15820
15821    /**
15822     * @}
15823     */
15824
15825    /**
15826     * @defgroup Slider Slider
15827     * @ingroup Elementary
15828     *
15829     * @image html img/widget/slider/preview-00.png
15830     * @image latex img/widget/slider/preview-00.eps width=\textwidth
15831     *
15832     * The slider adds a dragable “slider” widget for selecting the value of
15833     * something within a range.
15834     *
15835     * A slider can be horizontal or vertical. It can contain an Icon and has a
15836     * primary label as well as a units label (that is formatted with floating
15837     * point values and thus accepts a printf-style format string, like
15838     * “%1.2f units”. There is also an indicator string that may be somewhere
15839     * else (like on the slider itself) that also accepts a format string like
15840     * units. Label, Icon Unit and Indicator strings/objects are optional.
15841     *
15842     * A slider may be inverted which means values invert, with high vales being
15843     * on the left or top and low values on the right or bottom (as opposed to
15844     * normally being low on the left or top and high on the bottom and right).
15845     *
15846     * The slider should have its minimum and maximum values set by the
15847     * application with  elm_slider_min_max_set() and value should also be set by
15848     * the application before use with  elm_slider_value_set(). The span of the
15849     * slider is its length (horizontally or vertically). This will be scaled by
15850     * the object or applications scaling factor. At any point code can query the
15851     * slider for its value with elm_slider_value_get().
15852     *
15853     * Smart callbacks one can listen to:
15854     * - "changed" - Whenever the slider value is changed by the user.
15855     * - "slider,drag,start" - dragging the slider indicator around has started.
15856     * - "slider,drag,stop" - dragging the slider indicator around has stopped.
15857     * - "delay,changed" - A short time after the value is changed by the user.
15858     * This will be called only when the user stops dragging for
15859     * a very short period or when they release their
15860     * finger/mouse, so it avoids possibly expensive reactions to
15861     * the value change.
15862     *
15863     * Available styles for it:
15864     * - @c "default"
15865     *
15866     * Here is an example on its usage:
15867     * @li @ref slider_example
15868     */
15869
15870    /**
15871     * @addtogroup Slider
15872     * @{
15873     */
15874
15875    /**
15876     * Add a new slider widget to the given parent Elementary
15877     * (container) object.
15878     *
15879     * @param parent The parent object.
15880     * @return a new slider widget handle or @c NULL, on errors.
15881     *
15882     * This function inserts a new slider widget on the canvas.
15883     *
15884     * @ingroup Slider
15885     */
15886    EAPI Evas_Object       *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15887
15888    /**
15889     * Set the label of a given slider widget
15890     *
15891     * @param obj The progress bar object
15892     * @param label The text label string, in UTF-8
15893     *
15894     * @ingroup Slider
15895     * @deprecated use elm_object_text_set() instead.
15896     */
15897    EINA_DEPRECATED EAPI void               elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15898
15899    /**
15900     * Get the label of a given slider widget
15901     *
15902     * @param obj The progressbar object
15903     * @return The text label string, in UTF-8
15904     *
15905     * @ingroup Slider
15906     * @deprecated use elm_object_text_get() instead.
15907     */
15908    EINA_DEPRECATED EAPI const char        *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15909
15910    /**
15911     * Set the icon object of the slider object.
15912     *
15913     * @param obj The slider object.
15914     * @param icon The icon object.
15915     *
15916     * On horizontal mode, icon is placed at left, and on vertical mode,
15917     * placed at top.
15918     *
15919     * @note Once the icon object is set, a previously set one will be deleted.
15920     * If you want to keep that old content object, use the
15921     * elm_slider_icon_unset() function.
15922     *
15923     * @warning If the object being set does not have minimum size hints set,
15924     * it won't get properly displayed.
15925     *
15926     * @ingroup Slider
15927     */
15928    EAPI void               elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
15929
15930    /**
15931     * Unset an icon set on a given slider widget.
15932     *
15933     * @param obj The slider object.
15934     * @return The icon object that was being used, if any was set, or
15935     * @c NULL, otherwise (and on errors).
15936     *
15937     * On horizontal mode, icon is placed at left, and on vertical mode,
15938     * placed at top.
15939     *
15940     * This call will unparent and return the icon object which was set
15941     * for this widget, previously, on success.
15942     *
15943     * @see elm_slider_icon_set() for more details
15944     * @see elm_slider_icon_get()
15945     *
15946     * @ingroup Slider
15947     */
15948    EAPI Evas_Object       *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15949
15950    /**
15951     * Retrieve the icon object set for a given slider widget.
15952     *
15953     * @param obj The slider object.
15954     * @return The icon object's handle, if @p obj had one set, or @c NULL,
15955     * otherwise (and on errors).
15956     *
15957     * On horizontal mode, icon is placed at left, and on vertical mode,
15958     * placed at top.
15959     *
15960     * @see elm_slider_icon_set() for more details
15961     * @see elm_slider_icon_unset()
15962     *
15963     * @ingroup Slider
15964     */
15965    EAPI Evas_Object       *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15966
15967    /**
15968     * Set the end object of the slider object.
15969     *
15970     * @param obj The slider object.
15971     * @param end The end object.
15972     *
15973     * On horizontal mode, end is placed at left, and on vertical mode,
15974     * placed at bottom.
15975     *
15976     * @note Once the icon object is set, a previously set one will be deleted.
15977     * If you want to keep that old content object, use the
15978     * elm_slider_end_unset() function.
15979     *
15980     * @warning If the object being set does not have minimum size hints set,
15981     * it won't get properly displayed.
15982     *
15983     * @ingroup Slider
15984     */
15985    EAPI void               elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
15986
15987    /**
15988     * Unset an end object set on a given slider widget.
15989     *
15990     * @param obj The slider object.
15991     * @return The end object that was being used, if any was set, or
15992     * @c NULL, otherwise (and on errors).
15993     *
15994     * On horizontal mode, end is placed at left, and on vertical mode,
15995     * placed at bottom.
15996     *
15997     * This call will unparent and return the icon object which was set
15998     * for this widget, previously, on success.
15999     *
16000     * @see elm_slider_end_set() for more details.
16001     * @see elm_slider_end_get()
16002     *
16003     * @ingroup Slider
16004     */
16005    EAPI Evas_Object       *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16006
16007    /**
16008     * Retrieve the end object set for a given slider widget.
16009     *
16010     * @param obj The slider object.
16011     * @return The end object's handle, if @p obj had one set, or @c NULL,
16012     * otherwise (and on errors).
16013     *
16014     * On horizontal mode, icon is placed at right, and on vertical mode,
16015     * placed at bottom.
16016     *
16017     * @see elm_slider_end_set() for more details.
16018     * @see elm_slider_end_unset()
16019     *
16020     * @ingroup Slider
16021     */
16022    EAPI Evas_Object       *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16023
16024    /**
16025     * Set the (exact) length of the bar region of a given slider widget.
16026     *
16027     * @param obj The slider object.
16028     * @param size The length of the slider's bar region.
16029     *
16030     * This sets the minimum width (when in horizontal mode) or height
16031     * (when in vertical mode) of the actual bar area of the slider
16032     * @p obj. This in turn affects the object's minimum size. Use
16033     * this when you're not setting other size hints expanding on the
16034     * given direction (like weight and alignment hints) and you would
16035     * like it to have a specific size.
16036     *
16037     * @note Icon, end, label, indicator and unit text around @p obj
16038     * will require their
16039     * own space, which will make @p obj to require more the @p size,
16040     * actually.
16041     *
16042     * @see elm_slider_span_size_get()
16043     *
16044     * @ingroup Slider
16045     */
16046    EAPI void               elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
16047
16048    /**
16049     * Get the length set for the bar region of a given slider widget
16050     *
16051     * @param obj The slider object.
16052     * @return The length of the slider's bar region.
16053     *
16054     * If that size was not set previously, with
16055     * elm_slider_span_size_set(), this call will return @c 0.
16056     *
16057     * @ingroup Slider
16058     */
16059    EAPI Evas_Coord         elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16060
16061    /**
16062     * Set the format string for the unit label.
16063     *
16064     * @param obj The slider object.
16065     * @param format The format string for the unit display.
16066     *
16067     * Unit label is displayed all the time, if set, after slider's bar.
16068     * In horizontal mode, at right and in vertical mode, at bottom.
16069     *
16070     * If @c NULL, unit label won't be visible. If not it sets the format
16071     * string for the label text. To the label text is provided a floating point
16072     * value, so the label text can display up to 1 floating point value.
16073     * Note that this is optional.
16074     *
16075     * Use a format string such as "%1.2f meters" for example, and it will
16076     * display values like: "3.14 meters" for a value equal to 3.14159.
16077     *
16078     * Default is unit label disabled.
16079     *
16080     * @see elm_slider_indicator_format_get()
16081     *
16082     * @ingroup Slider
16083     */
16084    EAPI void               elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
16085
16086    /**
16087     * Get the unit label format of the slider.
16088     *
16089     * @param obj The slider object.
16090     * @return The unit label format string in UTF-8.
16091     *
16092     * Unit label is displayed all the time, if set, after slider's bar.
16093     * In horizontal mode, at right and in vertical mode, at bottom.
16094     *
16095     * @see elm_slider_unit_format_set() for more
16096     * information on how this works.
16097     *
16098     * @ingroup Slider
16099     */
16100    EAPI const char        *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16101
16102    /**
16103     * Set the format string for the indicator label.
16104     *
16105     * @param obj The slider object.
16106     * @param indicator The format string for the indicator display.
16107     *
16108     * The slider may display its value somewhere else then unit label,
16109     * for example, above the slider knob that is dragged around. This function
16110     * sets the format string used for this.
16111     *
16112     * If @c NULL, indicator label won't be visible. If not it sets the format
16113     * string for the label text. To the label text is provided a floating point
16114     * value, so the label text can display up to 1 floating point value.
16115     * Note that this is optional.
16116     *
16117     * Use a format string such as "%1.2f meters" for example, and it will
16118     * display values like: "3.14 meters" for a value equal to 3.14159.
16119     *
16120     * Default is indicator label disabled.
16121     *
16122     * @see elm_slider_indicator_format_get()
16123     *
16124     * @ingroup Slider
16125     */
16126    EAPI void               elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
16127
16128    /**
16129     * Get the indicator label format of the slider.
16130     *
16131     * @param obj The slider object.
16132     * @return The indicator label format string in UTF-8.
16133     *
16134     * The slider may display its value somewhere else then unit label,
16135     * for example, above the slider knob that is dragged around. This function
16136     * gets the format string used for this.
16137     *
16138     * @see elm_slider_indicator_format_set() for more
16139     * information on how this works.
16140     *
16141     * @ingroup Slider
16142     */
16143    EAPI const char        *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16144
16145    /**
16146     * Set the format function pointer for the indicator label
16147     *
16148     * @param obj The slider object.
16149     * @param func The indicator format function.
16150     * @param free_func The freeing function for the format string.
16151     *
16152     * Set the callback function to format the indicator string.
16153     *
16154     * @see elm_slider_indicator_format_set() for more info on how this works.
16155     *
16156     * @ingroup Slider
16157     */
16158   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);
16159
16160   /**
16161    * Set the format function pointer for the units label
16162    *
16163    * @param obj The slider object.
16164    * @param func The units format function.
16165    * @param free_func The freeing function for the format string.
16166    *
16167    * Set the callback function to format the indicator string.
16168    *
16169    * @see elm_slider_units_format_set() for more info on how this works.
16170    *
16171    * @ingroup Slider
16172    */
16173   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);
16174
16175   /**
16176    * Set the orientation of a given slider widget.
16177    *
16178    * @param obj The slider object.
16179    * @param horizontal Use @c EINA_TRUE to make @p obj to be
16180    * @b horizontal, @c EINA_FALSE to make it @b vertical.
16181    *
16182    * Use this function to change how your slider is to be
16183    * disposed: vertically or horizontally.
16184    *
16185    * By default it's displayed horizontally.
16186    *
16187    * @see elm_slider_horizontal_get()
16188    *
16189    * @ingroup Slider
16190    */
16191    EAPI void               elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16192
16193    /**
16194     * Retrieve the orientation of a given slider widget
16195     *
16196     * @param obj The slider object.
16197     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
16198     * @c EINA_FALSE if it's @b vertical (and on errors).
16199     *
16200     * @see elm_slider_horizontal_set() for more details.
16201     *
16202     * @ingroup Slider
16203     */
16204    EAPI Eina_Bool          elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16205
16206    /**
16207     * Set the minimum and maximum values for the slider.
16208     *
16209     * @param obj The slider object.
16210     * @param min The minimum value.
16211     * @param max The maximum value.
16212     *
16213     * Define the allowed range of values to be selected by the user.
16214     *
16215     * If actual value is less than @p min, it will be updated to @p min. If it
16216     * is bigger then @p max, will be updated to @p max. Actual value can be
16217     * get with elm_slider_value_get().
16218     *
16219     * By default, min is equal to 0.0, and max is equal to 1.0.
16220     *
16221     * @warning Maximum must be greater than minimum, otherwise behavior
16222     * is undefined.
16223     *
16224     * @see elm_slider_min_max_get()
16225     *
16226     * @ingroup Slider
16227     */
16228    EAPI void               elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
16229
16230    /**
16231     * Get the minimum and maximum values of the slider.
16232     *
16233     * @param obj The slider object.
16234     * @param min Pointer where to store the minimum value.
16235     * @param max Pointer where to store the maximum value.
16236     *
16237     * @note If only one value is needed, the other pointer can be passed
16238     * as @c NULL.
16239     *
16240     * @see elm_slider_min_max_set() for details.
16241     *
16242     * @ingroup Slider
16243     */
16244    EAPI void               elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
16245
16246    /**
16247     * Set the value the slider displays.
16248     *
16249     * @param obj The slider object.
16250     * @param val The value to be displayed.
16251     *
16252     * Value will be presented on the unit label following format specified with
16253     * elm_slider_unit_format_set() and on indicator with
16254     * elm_slider_indicator_format_set().
16255     *
16256     * @warning The value must to be between min and max values. This values
16257     * are set by elm_slider_min_max_set().
16258     *
16259     * @see elm_slider_value_get()
16260     * @see elm_slider_unit_format_set()
16261     * @see elm_slider_indicator_format_set()
16262     * @see elm_slider_min_max_set()
16263     *
16264     * @ingroup Slider
16265     */
16266    EAPI void               elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
16267
16268    /**
16269     * Get the value displayed by the spinner.
16270     *
16271     * @param obj The spinner object.
16272     * @return The value displayed.
16273     *
16274     * @see elm_spinner_value_set() for details.
16275     *
16276     * @ingroup Slider
16277     */
16278    EAPI double             elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16279
16280    /**
16281     * Invert a given slider widget's displaying values order
16282     *
16283     * @param obj The slider object.
16284     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
16285     * @c EINA_FALSE to bring it back to default, non-inverted values.
16286     *
16287     * A slider may be @b inverted, in which state it gets its
16288     * values inverted, with high vales being on the left or top and
16289     * low values on the right or bottom, as opposed to normally have
16290     * the low values on the former and high values on the latter,
16291     * respectively, for horizontal and vertical modes.
16292     *
16293     * @see elm_slider_inverted_get()
16294     *
16295     * @ingroup Slider
16296     */
16297    EAPI void               elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
16298
16299    /**
16300     * Get whether a given slider widget's displaying values are
16301     * inverted or not.
16302     *
16303     * @param obj The slider object.
16304     * @return @c EINA_TRUE, if @p obj has inverted values,
16305     * @c EINA_FALSE otherwise (and on errors).
16306     *
16307     * @see elm_slider_inverted_set() for more details.
16308     *
16309     * @ingroup Slider
16310     */
16311    EAPI Eina_Bool          elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16312
16313    /**
16314     * Set whether to enlarge slider indicator (augmented knob) or not.
16315     *
16316     * @param obj The slider object.
16317     * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
16318     * let the knob always at default size.
16319     *
16320     * By default, indicator will be bigger while dragged by the user.
16321     *
16322     * @warning It won't display values set with
16323     * elm_slider_indicator_format_set() if you disable indicator.
16324     *
16325     * @ingroup Slider
16326     */
16327    EAPI void               elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
16328
16329    /**
16330     * Get whether a given slider widget's enlarging indicator or not.
16331     *
16332     * @param obj The slider object.
16333     * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
16334     * @c EINA_FALSE otherwise (and on errors).
16335     *
16336     * @see elm_slider_indicator_show_set() for details.
16337     *
16338     * @ingroup Slider
16339     */
16340    EAPI Eina_Bool          elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16341
16342    /**
16343     * @}
16344     */
16345
16346    /**
16347     * @addtogroup Actionslider Actionslider
16348     *
16349     * @image html img/widget/actionslider/preview-00.png
16350     * @image latex img/widget/actionslider/preview-00.eps
16351     *
16352     * A actionslider is a switcher for 2 or 3 labels with customizable magnet
16353     * properties. The indicator is the element the user drags to choose a label.
16354     * When the position is set with magnet, when released the indicator will be
16355     * moved to it if it's nearest the magnetized position.
16356     *
16357     * @note By default all positions are set as enabled.
16358     *
16359     * Signals that you can add callbacks for are:
16360     *
16361     * "selected" - when user selects an enabled position (the label is passed
16362     *              as event info)".
16363     * @n
16364     * "pos_changed" - when the indicator reaches any of the positions("left",
16365     *                 "right" or "center").
16366     *
16367     * See an example of actionslider usage @ref actionslider_example_page "here"
16368     * @{
16369     */
16370    typedef enum _Elm_Actionslider_Pos
16371      {
16372         ELM_ACTIONSLIDER_NONE = 0,
16373         ELM_ACTIONSLIDER_LEFT = 1 << 0,
16374         ELM_ACTIONSLIDER_CENTER = 1 << 1,
16375         ELM_ACTIONSLIDER_RIGHT = 1 << 2,
16376         ELM_ACTIONSLIDER_ALL = (1 << 3) -1
16377      } Elm_Actionslider_Pos;
16378
16379    /**
16380     * Add a new actionslider to the parent.
16381     *
16382     * @param parent The parent object
16383     * @return The new actionslider object or NULL if it cannot be created
16384     */
16385    EAPI Evas_Object          *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16386    /**
16387     * Set actionslider labels.
16388     *
16389     * @param obj The actionslider object
16390     * @param left_label The label to be set on the left.
16391     * @param center_label The label to be set on the center.
16392     * @param right_label The label to be set on the right.
16393     * @deprecated use elm_object_text_set() instead.
16394     */
16395    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);
16396    /**
16397     * Get actionslider labels.
16398     *
16399     * @param obj The actionslider object
16400     * @param left_label A char** to place the left_label of @p obj into.
16401     * @param center_label A char** to place the center_label of @p obj into.
16402     * @param right_label A char** to place the right_label of @p obj into.
16403     * @deprecated use elm_object_text_set() instead.
16404     */
16405    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);
16406    /**
16407     * Get actionslider selected label.
16408     *
16409     * @param obj The actionslider object
16410     * @return The selected label
16411     */
16412    EAPI const char           *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16413    /**
16414     * Set actionslider indicator position.
16415     *
16416     * @param obj The actionslider object.
16417     * @param pos The position of the indicator.
16418     */
16419    EAPI void                  elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16420    /**
16421     * Get actionslider indicator position.
16422     *
16423     * @param obj The actionslider object.
16424     * @return The position of the indicator.
16425     */
16426    EAPI Elm_Actionslider_Pos  elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16427    /**
16428     * Set actionslider magnet position. To make multiple positions magnets @c or
16429     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
16430     *
16431     * @param obj The actionslider object.
16432     * @param pos Bit mask indicating the magnet positions.
16433     */
16434    EAPI void                  elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16435    /**
16436     * Get actionslider magnet position.
16437     *
16438     * @param obj The actionslider object.
16439     * @return The positions with magnet property.
16440     */
16441    EAPI Elm_Actionslider_Pos  elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16442    /**
16443     * Set actionslider enabled position. To set multiple positions as enabled @c or
16444     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
16445     *
16446     * @note All the positions are enabled by default.
16447     *
16448     * @param obj The actionslider object.
16449     * @param pos Bit mask indicating the enabled positions.
16450     */
16451    EAPI void                  elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16452    /**
16453     * Get actionslider enabled position.
16454     *
16455     * @param obj The actionslider object.
16456     * @return The enabled positions.
16457     */
16458    EAPI Elm_Actionslider_Pos  elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16459    /**
16460     * Set the label used on the indicator.
16461     *
16462     * @param obj The actionslider object
16463     * @param label The label to be set on the indicator.
16464     * @deprecated use elm_object_text_set() instead.
16465     */
16466    EINA_DEPRECATED EAPI void                  elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
16467    /**
16468     * Get the label used on the indicator object.
16469     *
16470     * @param obj The actionslider object
16471     * @return The indicator label
16472     * @deprecated use elm_object_text_get() instead.
16473     */
16474    EINA_DEPRECATED EAPI const char           *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
16475    /**
16476     * @}
16477     */
16478
16479    /**
16480     * @defgroup Genlist Genlist
16481     *
16482     * @image html img/widget/genlist/preview-00.png
16483     * @image latex img/widget/genlist/preview-00.eps
16484     * @image html img/genlist.png
16485     * @image latex img/genlist.eps
16486     *
16487     * This widget aims to have more expansive list than the simple list in
16488     * Elementary that could have more flexible items and allow many more entries
16489     * while still being fast and low on memory usage. At the same time it was
16490     * also made to be able to do tree structures. But the price to pay is more
16491     * complexity when it comes to usage. If all you want is a simple list with
16492     * icons and a single label, use the normal @ref List object.
16493     *
16494     * Genlist has a fairly large API, mostly because it's relatively complex,
16495     * trying to be both expansive, powerful and efficient. First we will begin
16496     * an overview on the theory behind genlist.
16497     *
16498     * @section Genlist_Item_Class Genlist item classes - creating items
16499     *
16500     * In order to have the ability to add and delete items on the fly, genlist
16501     * implements a class (callback) system where the application provides a
16502     * structure with information about that type of item (genlist may contain
16503     * multiple different items with different classes, states and styles).
16504     * Genlist will call the functions in this struct (methods) when an item is
16505     * "realized" (i.e., created dynamically, while the user is scrolling the
16506     * grid). All objects will simply be deleted when no longer needed with
16507     * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
16508     * following members:
16509     * - @c item_style - This is a constant string and simply defines the name
16510     *   of the item style. It @b must be specified and the default should be @c
16511     *   "default".
16512     * - @c mode_item_style - This is a constant string and simply defines the
16513     *   name of the style that will be used for mode animations. It can be left
16514     *   as @c NULL if you don't plan to use Genlist mode. See
16515     *   elm_genlist_item_mode_set() for more info.
16516     *
16517     * - @c func - A struct with pointers to functions that will be called when
16518     *   an item is going to be actually created. All of them receive a @c data
16519     *   parameter that will point to the same data passed to
16520     *   elm_genlist_item_append() and related item creation functions, and a @c
16521     *   obj parameter that points to the genlist object itself.
16522     *
16523     * The function pointers inside @c func are @c label_get, @c icon_get, @c
16524     * state_get and @c del. The 3 first functions also receive a @c part
16525     * parameter described below. A brief description of these functions follows:
16526     *
16527     * - @c label_get - The @c part parameter is the name string of one of the
16528     *   existing text parts in the Edje group implementing the item's theme.
16529     *   This function @b must return a strdup'()ed string, as the caller will
16530     *   free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
16531     * - @c icon_get - The @c part parameter is the name string of one of the
16532     *   existing (icon) swallow parts in the Edje group implementing the item's
16533     *   theme. It must return @c NULL, when no icon is desired, or a valid
16534     *   object handle, otherwise.  The object will be deleted by the genlist on
16535     *   its deletion or when the item is "unrealized".  See
16536     *   #Elm_Genlist_Item_Icon_Get_Cb.
16537     * - @c func.state_get - The @c part parameter is the name string of one of
16538     *   the state parts in the Edje group implementing the item's theme. Return
16539     *   @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
16540     *   emit a signal to its theming Edje object with @c "elm,state,XXX,active"
16541     *   and @c "elm" as "emission" and "source" arguments, respectively, when
16542     *   the state is true (the default is false), where @c XXX is the name of
16543     *   the (state) part.  See #Elm_Genlist_Item_State_Get_Cb.
16544     * - @c func.del - This is intended for use when genlist items are deleted,
16545     *   so any data attached to the item (e.g. its data parameter on creation)
16546     *   can be deleted. See #Elm_Genlist_Item_Del_Cb.
16547     *
16548     * available item styles:
16549     * - default
16550     * - default_style - The text part is a textblock
16551     *
16552     * @image html img/widget/genlist/preview-04.png
16553     * @image latex img/widget/genlist/preview-04.eps
16554     *
16555     * - double_label
16556     *
16557     * @image html img/widget/genlist/preview-01.png
16558     * @image latex img/widget/genlist/preview-01.eps
16559     *
16560     * - icon_top_text_bottom
16561     *
16562     * @image html img/widget/genlist/preview-02.png
16563     * @image latex img/widget/genlist/preview-02.eps
16564     *
16565     * - group_index
16566     *
16567     * @image html img/widget/genlist/preview-03.png
16568     * @image latex img/widget/genlist/preview-03.eps
16569     *
16570     * @section Genlist_Items Structure of items
16571     *
16572     * An item in a genlist can have 0 or more text labels (they can be regular
16573     * text or textblock Evas objects - that's up to the style to determine), 0
16574     * or more icons (which are simply objects swallowed into the genlist item's
16575     * theming Edje object) and 0 or more <b>boolean states</b>, which have the
16576     * behavior left to the user to define. The Edje part names for each of
16577     * these properties will be looked up, in the theme file for the genlist,
16578     * under the Edje (string) data items named @c "labels", @c "icons" and @c
16579     * "states", respectively. For each of those properties, if more than one
16580     * part is provided, they must have names listed separated by spaces in the
16581     * data fields. For the default genlist item theme, we have @b one label
16582     * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
16583     * "elm.swallow.end") and @b no state parts.
16584     *
16585     * A genlist item may be at one of several styles. Elementary provides one
16586     * by default - "default", but this can be extended by system or application
16587     * custom themes/overlays/extensions (see @ref Theme "themes" for more
16588     * details).
16589     *
16590     * @section Genlist_Manipulation Editing and Navigating
16591     *
16592     * Items can be added by several calls. All of them return a @ref
16593     * Elm_Genlist_Item handle that is an internal member inside the genlist.
16594     * They all take a data parameter that is meant to be used for a handle to
16595     * the applications internal data (eg the struct with the original item
16596     * data). The parent parameter is the parent genlist item this belongs to if
16597     * it is a tree or an indexed group, and NULL if there is no parent. The
16598     * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
16599     * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
16600     * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
16601     * that is able to expand and have child items.  If ELM_GENLIST_ITEM_GROUP
16602     * is set then this item is group index item that is displayed at the top
16603     * until the next group comes. The func parameter is a convenience callback
16604     * that is called when the item is selected and the data parameter will be
16605     * the func_data parameter, obj be the genlist object and event_info will be
16606     * the genlist item.
16607     *
16608     * elm_genlist_item_append() adds an item to the end of the list, or if
16609     * there is a parent, to the end of all the child items of the parent.
16610     * elm_genlist_item_prepend() is the same but adds to the beginning of
16611     * the list or children list. elm_genlist_item_insert_before() inserts at
16612     * item before another item and elm_genlist_item_insert_after() inserts after
16613     * the indicated item.
16614     *
16615     * The application can clear the list with elm_genlist_clear() which deletes
16616     * all the items in the list and elm_genlist_item_del() will delete a specific
16617     * item. elm_genlist_item_subitems_clear() will clear all items that are
16618     * children of the indicated parent item.
16619     *
16620     * To help inspect list items you can jump to the item at the top of the list
16621     * with elm_genlist_first_item_get() which will return the item pointer, and
16622     * similarly elm_genlist_last_item_get() gets the item at the end of the list.
16623     * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
16624     * and previous items respectively relative to the indicated item. Using
16625     * these calls you can walk the entire item list/tree. Note that as a tree
16626     * the items are flattened in the list, so elm_genlist_item_parent_get() will
16627     * let you know which item is the parent (and thus know how to skip them if
16628     * wanted).
16629     *
16630     * @section Genlist_Muti_Selection Multi-selection
16631     *
16632     * If the application wants multiple items to be able to be selected,
16633     * elm_genlist_multi_select_set() can enable this. If the list is
16634     * single-selection only (the default), then elm_genlist_selected_item_get()
16635     * will return the selected item, if any, or NULL I none is selected. If the
16636     * list is multi-select then elm_genlist_selected_items_get() will return a
16637     * list (that is only valid as long as no items are modified (added, deleted,
16638     * selected or unselected)).
16639     *
16640     * @section Genlist_Usage_Hints Usage hints
16641     *
16642     * There are also convenience functions. elm_genlist_item_genlist_get() will
16643     * return the genlist object the item belongs to. elm_genlist_item_show()
16644     * will make the scroller scroll to show that specific item so its visible.
16645     * elm_genlist_item_data_get() returns the data pointer set by the item
16646     * creation functions.
16647     *
16648     * If an item changes (state of boolean changes, label or icons change),
16649     * then use elm_genlist_item_update() to have genlist update the item with
16650     * the new state. Genlist will re-realize the item thus call the functions
16651     * in the _Elm_Genlist_Item_Class for that item.
16652     *
16653     * To programmatically (un)select an item use elm_genlist_item_selected_set().
16654     * To get its selected state use elm_genlist_item_selected_get(). Similarly
16655     * to expand/contract an item and get its expanded state, use
16656     * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
16657     * again to make an item disabled (unable to be selected and appear
16658     * differently) use elm_genlist_item_disabled_set() to set this and
16659     * elm_genlist_item_disabled_get() to get the disabled state.
16660     *
16661     * In general to indicate how the genlist should expand items horizontally to
16662     * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
16663     * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
16664     * mode means that if items are too wide to fit, the scroller will scroll
16665     * horizontally. Otherwise items are expanded to fill the width of the
16666     * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
16667     * to the viewport width and limited to that size. This can be combined with
16668     * a different style that uses edjes' ellipsis feature (cutting text off like
16669     * this: "tex...").
16670     *
16671     * Items will only call their selection func and callback when first becoming
16672     * selected. Any further clicks will do nothing, unless you enable always
16673     * select with elm_genlist_always_select_mode_set(). This means even if
16674     * selected, every click will make the selected callbacks be called.
16675     * elm_genlist_no_select_mode_set() will turn off the ability to select
16676     * items entirely and they will neither appear selected nor call selected
16677     * callback functions.
16678     *
16679     * Remember that you can create new styles and add your own theme augmentation
16680     * per application with elm_theme_extension_add(). If you absolutely must
16681     * have a specific style that overrides any theme the user or system sets up
16682     * you can use elm_theme_overlay_add() to add such a file.
16683     *
16684     * @section Genlist_Implementation Implementation
16685     *
16686     * Evas tracks every object you create. Every time it processes an event
16687     * (mouse move, down, up etc.) it needs to walk through objects and find out
16688     * what event that affects. Even worse every time it renders display updates,
16689     * in order to just calculate what to re-draw, it needs to walk through many
16690     * many many objects. Thus, the more objects you keep active, the more
16691     * overhead Evas has in just doing its work. It is advisable to keep your
16692     * active objects to the minimum working set you need. Also remember that
16693     * object creation and deletion carries an overhead, so there is a
16694     * middle-ground, which is not easily determined. But don't keep massive lists
16695     * of objects you can't see or use. Genlist does this with list objects. It
16696     * creates and destroys them dynamically as you scroll around. It groups them
16697     * into blocks so it can determine the visibility etc. of a whole block at
16698     * once as opposed to having to walk the whole list. This 2-level list allows
16699     * for very large numbers of items to be in the list (tests have used up to
16700     * 2,000,000 items). Also genlist employs a queue for adding items. As items
16701     * may be different sizes, every item added needs to be calculated as to its
16702     * size and thus this presents a lot of overhead on populating the list, this
16703     * genlist employs a queue. Any item added is queued and spooled off over
16704     * time, actually appearing some time later, so if your list has many members
16705     * you may find it takes a while for them to all appear, with your process
16706     * consuming a lot of CPU while it is busy spooling.
16707     *
16708     * Genlist also implements a tree structure, but it does so with callbacks to
16709     * the application, with the application filling in tree structures when
16710     * requested (allowing for efficient building of a very deep tree that could
16711     * even be used for file-management). See the above smart signal callbacks for
16712     * details.
16713     *
16714     * @section Genlist_Smart_Events Genlist smart events
16715     *
16716     * Signals that you can add callbacks for are:
16717     * - @c "activated" - The user has double-clicked or pressed
16718     *   (enter|return|spacebar) on an item. The @c event_info parameter is the
16719     *   item that was activated.
16720     * - @c "clicked,double" - The user has double-clicked an item.  The @c
16721     *   event_info parameter is the item that was double-clicked.
16722     * - @c "selected" - This is called when a user has made an item selected.
16723     *   The event_info parameter is the genlist item that was selected.
16724     * - @c "unselected" - This is called when a user has made an item
16725     *   unselected. The event_info parameter is the genlist item that was
16726     *   unselected.
16727     * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
16728     *   called and the item is now meant to be expanded. The event_info
16729     *   parameter is the genlist item that was indicated to expand.  It is the
16730     *   job of this callback to then fill in the child items.
16731     * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
16732     *   called and the item is now meant to be contracted. The event_info
16733     *   parameter is the genlist item that was indicated to contract. It is the
16734     *   job of this callback to then delete the child items.
16735     * - @c "expand,request" - This is called when a user has indicated they want
16736     *   to expand a tree branch item. The callback should decide if the item can
16737     *   expand (has any children) and then call elm_genlist_item_expanded_set()
16738     *   appropriately to set the state. The event_info parameter is the genlist
16739     *   item that was indicated to expand.
16740     * - @c "contract,request" - This is called when a user has indicated they
16741     *   want to contract a tree branch item. The callback should decide if the
16742     *   item can contract (has any children) and then call
16743     *   elm_genlist_item_expanded_set() appropriately to set the state. The
16744     *   event_info parameter is the genlist item that was indicated to contract.
16745     * - @c "realized" - This is called when the item in the list is created as a
16746     *   real evas object. event_info parameter is the genlist item that was
16747     *   created. The object may be deleted at any time, so it is up to the
16748     *   caller to not use the object pointer from elm_genlist_item_object_get()
16749     *   in a way where it may point to freed objects.
16750     * - @c "unrealized" - This is called just before an item is unrealized.
16751     *   After this call icon objects provided will be deleted and the item
16752     *   object itself delete or be put into a floating cache.
16753     * - @c "drag,start,up" - This is called when the item in the list has been
16754     *   dragged (not scrolled) up.
16755     * - @c "drag,start,down" - This is called when the item in the list has been
16756     *   dragged (not scrolled) down.
16757     * - @c "drag,start,left" - This is called when the item in the list has been
16758     *   dragged (not scrolled) left.
16759     * - @c "drag,start,right" - This is called when the item in the list has
16760     *   been dragged (not scrolled) right.
16761     * - @c "drag,stop" - This is called when the item in the list has stopped
16762     *   being dragged.
16763     * - @c "drag" - This is called when the item in the list is being dragged.
16764     * - @c "longpressed" - This is called when the item is pressed for a certain
16765     *   amount of time. By default it's 1 second.
16766     * - @c "scroll,anim,start" - This is called when scrolling animation has
16767     *   started.
16768     * - @c "scroll,anim,stop" - This is called when scrolling animation has
16769     *   stopped.
16770     * - @c "scroll,drag,start" - This is called when dragging the content has
16771     *   started.
16772     * - @c "scroll,drag,stop" - This is called when dragging the content has
16773     *   stopped.
16774     * - @c "scroll,edge,top" - This is called when the genlist is scrolled until
16775     *   the top edge.
16776     * - @c "scroll,edge,bottom" - This is called when the genlist is scrolled
16777     *   until the bottom edge.
16778     * - @c "scroll,edge,left" - This is called when the genlist is scrolled
16779     *   until the left edge.
16780     * - @c "scroll,edge,right" - This is called when the genlist is scrolled
16781     *   until the right edge.
16782     * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
16783     *   swiped left.
16784     * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
16785     *   swiped right.
16786     * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
16787     *   swiped up.
16788     * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
16789     *   swiped down.
16790     * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
16791     *   pinched out.  "- @c multi,pinch,in" - This is called when the genlist is
16792     *   multi-touch pinched in.
16793     * - @c "swipe" - This is called when the genlist is swiped.
16794     *
16795     * @section Genlist_Examples Examples
16796     *
16797     * Here is a list of examples that use the genlist, trying to show some of
16798     * its capabilities:
16799     * - @ref genlist_example_01
16800     * - @ref genlist_example_02
16801     * - @ref genlist_example_03
16802     * - @ref genlist_example_04
16803     * - @ref genlist_example_05
16804     */
16805
16806    /**
16807     * @addtogroup Genlist
16808     * @{
16809     */
16810
16811    /**
16812     * @enum _Elm_Genlist_Item_Flags
16813     * @typedef Elm_Genlist_Item_Flags
16814     *
16815     * Defines if the item is of any special type (has subitems or it's the
16816     * index of a group), or is just a simple item.
16817     *
16818     * @ingroup Genlist
16819     */
16820    typedef enum _Elm_Genlist_Item_Flags
16821      {
16822         ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
16823         ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
16824         ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
16825      } Elm_Genlist_Item_Flags;
16826    typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;  /**< Genlist item class definition structs */
16827    typedef struct _Elm_Genlist_Item       Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
16828    typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
16829    typedef char        *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
16830    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. */
16831    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. */
16832    typedef void         (*Elm_Genlist_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
16833    typedef void         (*GenlistItemMovedFunc)    (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after); /** TODO: remove this by SeoZ **/
16834
16835    typedef char        *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Label_Get_Cb instead. */
16836    typedef Evas_Object *(*GenlistItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Icon_Get_Cb instead. */
16837    typedef Eina_Bool    (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_State_Get_Cb instead. */
16838    typedef void         (*GenlistItemDelFunc)      (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Del_Cb instead. */
16839
16840    /**
16841     * @struct _Elm_Genlist_Item_Class
16842     *
16843     * Genlist item class definition structs.
16844     *
16845     * This struct contains the style and fetching functions that will define the
16846     * contents of each item.
16847     *
16848     * @see @ref Genlist_Item_Class
16849     */
16850    struct _Elm_Genlist_Item_Class
16851      {
16852         const char                *item_style; /**< style of this class. */
16853         struct
16854           {
16855              Elm_Genlist_Item_Label_Get_Cb  label_get; /**< Label fetching class function for genlist item classes.*/
16856              Elm_Genlist_Item_Icon_Get_Cb   icon_get; /**< Icon fetching class function for genlist item classes. */
16857              Elm_Genlist_Item_State_Get_Cb  state_get; /**< State fetching class function for genlist item classes. */
16858              Elm_Genlist_Item_Del_Cb        del; /**< Deletion class function for genlist item classes. */
16859              GenlistItemMovedFunc     moved; // TODO: do not use this. change this to smart callback.
16860           } func;
16861         const char                *mode_item_style;
16862      };
16863
16864    /**
16865     * Add a new genlist widget to the given parent Elementary
16866     * (container) object
16867     *
16868     * @param parent The parent object
16869     * @return a new genlist widget handle or @c NULL, on errors
16870     *
16871     * This function inserts a new genlist widget on the canvas.
16872     *
16873     * @see elm_genlist_item_append()
16874     * @see elm_genlist_item_del()
16875     * @see elm_genlist_clear()
16876     *
16877     * @ingroup Genlist
16878     */
16879    EAPI Evas_Object      *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16880    /**
16881     * Remove all items from a given genlist widget.
16882     *
16883     * @param obj The genlist object
16884     *
16885     * This removes (and deletes) all items in @p obj, leaving it empty.
16886     *
16887     * @see elm_genlist_item_del(), to remove just one item.
16888     *
16889     * @ingroup Genlist
16890     */
16891    EAPI void              elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16892    /**
16893     * Enable or disable multi-selection in the genlist
16894     *
16895     * @param obj The genlist object
16896     * @param multi Multi-select enable/disable. Default is disabled.
16897     *
16898     * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
16899     * the list. This allows more than 1 item to be selected. To retrieve the list
16900     * of selected items, use elm_genlist_selected_items_get().
16901     *
16902     * @see elm_genlist_selected_items_get()
16903     * @see elm_genlist_multi_select_get()
16904     *
16905     * @ingroup Genlist
16906     */
16907    EAPI void              elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16908    /**
16909     * Gets if multi-selection in genlist is enabled or disabled.
16910     *
16911     * @param obj The genlist object
16912     * @return Multi-select enabled/disabled
16913     * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
16914     *
16915     * @see elm_genlist_multi_select_set()
16916     *
16917     * @ingroup Genlist
16918     */
16919    EAPI Eina_Bool         elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16920    /**
16921     * This sets the horizontal stretching mode.
16922     *
16923     * @param obj The genlist object
16924     * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
16925     *
16926     * This sets the mode used for sizing items horizontally. Valid modes
16927     * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
16928     * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
16929     * the scroller will scroll horizontally. Otherwise items are expanded
16930     * to fill the width of the viewport of the scroller. If it is
16931     * ELM_LIST_LIMIT, items will be expanded to the viewport width and
16932     * limited to that size.
16933     *
16934     * @see elm_genlist_horizontal_get()
16935     *
16936     * @ingroup Genlist
16937     */
16938    EAPI void              elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16939    EINA_DEPRECATED EAPI void              elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16940    /**
16941     * Gets the horizontal stretching mode.
16942     *
16943     * @param obj The genlist object
16944     * @return The mode to use
16945     * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
16946     *
16947     * @see elm_genlist_horizontal_set()
16948     *
16949     * @ingroup Genlist
16950     */
16951    EAPI Elm_List_Mode     elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16952    EINA_DEPRECATED EAPI Elm_List_Mode     elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16953    /**
16954     * Set the always select mode.
16955     *
16956     * @param obj The genlist object
16957     * @param always_select The always select mode (@c EINA_TRUE = on, @c
16958     * EINA_FALSE = off). Default is @c EINA_FALSE.
16959     *
16960     * Items will only call their selection func and callback when first
16961     * becoming selected. Any further clicks will do nothing, unless you
16962     * enable always select with elm_genlist_always_select_mode_set().
16963     * This means that, even if selected, every click will make the selected
16964     * callbacks be called.
16965     *
16966     * @see elm_genlist_always_select_mode_get()
16967     *
16968     * @ingroup Genlist
16969     */
16970    EAPI void              elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16971    /**
16972     * Get the always select mode.
16973     *
16974     * @param obj The genlist object
16975     * @return The always select mode
16976     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
16977     *
16978     * @see elm_genlist_always_select_mode_set()
16979     *
16980     * @ingroup Genlist
16981     */
16982    EAPI Eina_Bool         elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16983    /**
16984     * Enable/disable the no select mode.
16985     *
16986     * @param obj The genlist object
16987     * @param no_select The no select mode
16988     * (EINA_TRUE = on, EINA_FALSE = off)
16989     *
16990     * This will turn off the ability to select items entirely and they
16991     * will neither appear selected nor call selected callback functions.
16992     *
16993     * @see elm_genlist_no_select_mode_get()
16994     *
16995     * @ingroup Genlist
16996     */
16997    EAPI void              elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
16998    /**
16999     * Gets whether the no select mode is enabled.
17000     *
17001     * @param obj The genlist object
17002     * @return The no select mode
17003     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
17004     *
17005     * @see elm_genlist_no_select_mode_set()
17006     *
17007     * @ingroup Genlist
17008     */
17009    EAPI Eina_Bool         elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17010    /**
17011     * Enable/disable compress mode.
17012     *
17013     * @param obj The genlist object
17014     * @param compress The compress mode
17015     * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
17016     *
17017     * This will enable the compress mode where items are "compressed"
17018     * horizontally to fit the genlist scrollable viewport width. This is
17019     * special for genlist.  Do not rely on
17020     * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
17021     * work as genlist needs to handle it specially.
17022     *
17023     * @see elm_genlist_compress_mode_get()
17024     *
17025     * @ingroup Genlist
17026     */
17027    EAPI void              elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
17028    /**
17029     * Get whether the compress mode is enabled.
17030     *
17031     * @param obj The genlist object
17032     * @return The compress mode
17033     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
17034     *
17035     * @see elm_genlist_compress_mode_set()
17036     *
17037     * @ingroup Genlist
17038     */
17039    EAPI Eina_Bool         elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17040    /**
17041     * Enable/disable height-for-width mode.
17042     *
17043     * @param obj The genlist object
17044     * @param setting The height-for-width mode (@c EINA_TRUE = on,
17045     * @c EINA_FALSE = off). Default is @c EINA_FALSE.
17046     *
17047     * With height-for-width mode the item width will be fixed (restricted
17048     * to a minimum of) to the list width when calculating its size in
17049     * order to allow the height to be calculated based on it. This allows,
17050     * for instance, text block to wrap lines if the Edje part is
17051     * configured with "text.min: 0 1".
17052     *
17053     * @note This mode will make list resize slower as it will have to
17054     *       recalculate every item height again whenever the list width
17055     *       changes!
17056     *
17057     * @note When height-for-width mode is enabled, it also enables
17058     *       compress mode (see elm_genlist_compress_mode_set()) and
17059     *       disables homogeneous (see elm_genlist_homogeneous_set()).
17060     *
17061     * @ingroup Genlist
17062     */
17063    EAPI void              elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
17064    /**
17065     * Get whether the height-for-width mode is enabled.
17066     *
17067     * @param obj The genlist object
17068     * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
17069     * off)
17070     *
17071     * @ingroup Genlist
17072     */
17073    EAPI Eina_Bool         elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17074    /**
17075     * Enable/disable horizontal and vertical bouncing effect.
17076     *
17077     * @param obj The genlist object
17078     * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
17079     * EINA_FALSE = off). Default is @c EINA_FALSE.
17080     * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
17081     * EINA_FALSE = off). Default is @c EINA_TRUE.
17082     *
17083     * This will enable or disable the scroller bouncing effect for the
17084     * genlist. See elm_scroller_bounce_set() for details.
17085     *
17086     * @see elm_scroller_bounce_set()
17087     * @see elm_genlist_bounce_get()
17088     *
17089     * @ingroup Genlist
17090     */
17091    EAPI void              elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
17092    /**
17093     * Get whether the horizontal and vertical bouncing effect is enabled.
17094     *
17095     * @param obj The genlist object
17096     * @param h_bounce Pointer to a bool to receive if the bounce horizontally
17097     * option is set.
17098     * @param v_bounce Pointer to a bool to receive if the bounce vertically
17099     * option is set.
17100     *
17101     * @see elm_genlist_bounce_set()
17102     *
17103     * @ingroup Genlist
17104     */
17105    EAPI void              elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
17106    /**
17107     * Enable/disable homogenous mode.
17108     *
17109     * @param obj The genlist object
17110     * @param homogeneous Assume the items within the genlist are of the
17111     * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
17112     * EINA_FALSE.
17113     *
17114     * This will enable the homogeneous mode where items are of the same
17115     * height and width so that genlist may do the lazy-loading at its
17116     * maximum (which increases the performance for scrolling the list). This
17117     * implies 'compressed' mode.
17118     *
17119     * @see elm_genlist_compress_mode_set()
17120     * @see elm_genlist_homogeneous_get()
17121     *
17122     * @ingroup Genlist
17123     */
17124    EAPI void              elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
17125    /**
17126     * Get whether the homogenous mode is enabled.
17127     *
17128     * @param obj The genlist object
17129     * @return Assume the items within the genlist are of the same height
17130     * and width (EINA_TRUE = on, EINA_FALSE = off)
17131     *
17132     * @see elm_genlist_homogeneous_set()
17133     *
17134     * @ingroup Genlist
17135     */
17136    EAPI Eina_Bool         elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17137    /**
17138     * Set the maximum number of items within an item block
17139     *
17140     * @param obj The genlist object
17141     * @param n   Maximum number of items within an item block. Default is 32.
17142     *
17143     * This will configure the block count to tune to the target with
17144     * particular performance matrix.
17145     *
17146     * A block of objects will be used to reduce the number of operations due to
17147     * many objects in the screen. It can determine the visibility, or if the
17148     * object has changed, it theme needs to be updated, etc. doing this kind of
17149     * calculation to the entire block, instead of per object.
17150     *
17151     * The default value for the block count is enough for most lists, so unless
17152     * you know you will have a lot of objects visible in the screen at the same
17153     * time, don't try to change this.
17154     *
17155     * @see elm_genlist_block_count_get()
17156     * @see @ref Genlist_Implementation
17157     *
17158     * @ingroup Genlist
17159     */
17160    EAPI void              elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
17161    /**
17162     * Get the maximum number of items within an item block
17163     *
17164     * @param obj The genlist object
17165     * @return Maximum number of items within an item block
17166     *
17167     * @see elm_genlist_block_count_set()
17168     *
17169     * @ingroup Genlist
17170     */
17171    EAPI int               elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17172    /**
17173     * Set the timeout in seconds for the longpress event.
17174     *
17175     * @param obj The genlist object
17176     * @param timeout timeout in seconds. Default is 1.
17177     *
17178     * This option will change how long it takes to send an event "longpressed"
17179     * after the mouse down signal is sent to the list. If this event occurs, no
17180     * "clicked" event will be sent.
17181     *
17182     * @see elm_genlist_longpress_timeout_set()
17183     *
17184     * @ingroup Genlist
17185     */
17186    EAPI void              elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
17187    /**
17188     * Get the timeout in seconds for the longpress event.
17189     *
17190     * @param obj The genlist object
17191     * @return timeout in seconds
17192     *
17193     * @see elm_genlist_longpress_timeout_get()
17194     *
17195     * @ingroup Genlist
17196     */
17197    EAPI double            elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17198    /**
17199     * Append a new item in a given genlist widget.
17200     *
17201     * @param obj The genlist object
17202     * @param itc The item class for the item
17203     * @param data The item data
17204     * @param parent The parent item, or NULL if none
17205     * @param flags Item flags
17206     * @param func Convenience function called when the item is selected
17207     * @param func_data Data passed to @p func above.
17208     * @return A handle to the item added or @c NULL if not possible
17209     *
17210     * This adds the given item to the end of the list or the end of
17211     * the children list if the @p parent is given.
17212     *
17213     * @see elm_genlist_item_prepend()
17214     * @see elm_genlist_item_insert_before()
17215     * @see elm_genlist_item_insert_after()
17216     * @see elm_genlist_item_del()
17217     *
17218     * @ingroup Genlist
17219     */
17220    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);
17221    /**
17222     * Prepend a new item in a given genlist widget.
17223     *
17224     * @param obj The genlist object
17225     * @param itc The item class for the item
17226     * @param data The item data
17227     * @param parent The parent item, or NULL if none
17228     * @param flags Item flags
17229     * @param func Convenience function called when the item is selected
17230     * @param func_data Data passed to @p func above.
17231     * @return A handle to the item added or NULL if not possible
17232     *
17233     * This adds an item to the beginning of the list or beginning of the
17234     * children of the parent if given.
17235     *
17236     * @see elm_genlist_item_append()
17237     * @see elm_genlist_item_insert_before()
17238     * @see elm_genlist_item_insert_after()
17239     * @see elm_genlist_item_del()
17240     *
17241     * @ingroup Genlist
17242     */
17243    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);
17244    /**
17245     * Insert an item before another in a genlist widget
17246     *
17247     * @param obj The genlist object
17248     * @param itc The item class for the item
17249     * @param data The item data
17250     * @param before The item to place this new one before.
17251     * @param flags Item flags
17252     * @param func Convenience function called when the item is selected
17253     * @param func_data Data passed to @p func above.
17254     * @return A handle to the item added or @c NULL if not possible
17255     *
17256     * This inserts an item before another in the list. It will be in the
17257     * same tree level or group as the item it is inserted before.
17258     *
17259     * @see elm_genlist_item_append()
17260     * @see elm_genlist_item_prepend()
17261     * @see elm_genlist_item_insert_after()
17262     * @see elm_genlist_item_del()
17263     *
17264     * @ingroup Genlist
17265     */
17266    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);
17267    /**
17268     * Insert an item after another in a genlist widget
17269     *
17270     * @param obj The genlist object
17271     * @param itc The item class for the item
17272     * @param data The item data
17273     * @param after The item to place this new one after.
17274     * @param flags Item flags
17275     * @param func Convenience function called when the item is selected
17276     * @param func_data Data passed to @p func above.
17277     * @return A handle to the item added or @c NULL if not possible
17278     *
17279     * This inserts an item after another in the list. It will be in the
17280     * same tree level or group as the item it is inserted after.
17281     *
17282     * @see elm_genlist_item_append()
17283     * @see elm_genlist_item_prepend()
17284     * @see elm_genlist_item_insert_before()
17285     * @see elm_genlist_item_del()
17286     *
17287     * @ingroup Genlist
17288     */
17289    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);
17290    /**
17291     * Insert a new item into the sorted genlist object
17292     *
17293     * @param obj The genlist object
17294     * @param itc The item class for the item
17295     * @param data The item data
17296     * @param parent The parent item, or NULL if none
17297     * @param flags Item flags
17298     * @param comp The function called for the sort
17299     * @param func Convenience function called when item selected
17300     * @param func_data Data passed to @p func above.
17301     * @return A handle to the item added or NULL if not possible
17302     *
17303     * @ingroup Genlist
17304     */
17305    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);
17306    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);
17307    /* operations to retrieve existing items */
17308    /**
17309     * Get the selectd item in the genlist.
17310     *
17311     * @param obj The genlist object
17312     * @return The selected item, or NULL if none is selected.
17313     *
17314     * This gets the selected item in the list (if multi-selection is enabled, only
17315     * the item that was first selected in the list is returned - which is not very
17316     * useful, so see elm_genlist_selected_items_get() for when multi-selection is
17317     * used).
17318     *
17319     * If no item is selected, NULL is returned.
17320     *
17321     * @see elm_genlist_selected_items_get()
17322     *
17323     * @ingroup Genlist
17324     */
17325    EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17326    /**
17327     * Get a list of selected items in the genlist.
17328     *
17329     * @param obj The genlist object
17330     * @return The list of selected items, or NULL if none are selected.
17331     *
17332     * It returns a list of the selected items. This list pointer is only valid so
17333     * long as the selection doesn't change (no items are selected or unselected, or
17334     * unselected implicitly by deletion). The list contains Elm_Genlist_Item
17335     * pointers. The order of the items in this list is the order which they were
17336     * selected, i.e. the first item in this list is the first item that was
17337     * selected, and so on.
17338     *
17339     * @note If not in multi-select mode, consider using function
17340     * elm_genlist_selected_item_get() instead.
17341     *
17342     * @see elm_genlist_multi_select_set()
17343     * @see elm_genlist_selected_item_get()
17344     *
17345     * @ingroup Genlist
17346     */
17347    EAPI const Eina_List  *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17348    /**
17349     * Get a list of realized items in genlist
17350     *
17351     * @param obj The genlist object
17352     * @return The list of realized items, nor NULL if none are realized.
17353     *
17354     * This returns a list of the realized items in the genlist. The list
17355     * contains Elm_Genlist_Item pointers. The list must be freed by the
17356     * caller when done with eina_list_free(). The item pointers in the
17357     * list are only valid so long as those items are not deleted or the
17358     * genlist is not deleted.
17359     *
17360     * @see elm_genlist_realized_items_update()
17361     *
17362     * @ingroup Genlist
17363     */
17364    EAPI Eina_List        *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17365    /**
17366     * Get the item that is at the x, y canvas coords.
17367     *
17368     * @param obj The gelinst object.
17369     * @param x The input x coordinate
17370     * @param y The input y coordinate
17371     * @param posret The position relative to the item returned here
17372     * @return The item at the coordinates or NULL if none
17373     *
17374     * This returns the item at the given coordinates (which are canvas
17375     * relative, not object-relative). If an item is at that coordinate,
17376     * that item handle is returned, and if @p posret is not NULL, the
17377     * integer pointed to is set to a value of -1, 0 or 1, depending if
17378     * the coordinate is on the upper portion of that item (-1), on the
17379     * middle section (0) or on the lower part (1). If NULL is returned as
17380     * an item (no item found there), then posret may indicate -1 or 1
17381     * based if the coordinate is above or below all items respectively in
17382     * the genlist.
17383     *
17384     * @ingroup Genlist
17385     */
17386    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);
17387    /**
17388     * Get the first item in the genlist
17389     *
17390     * This returns the first item in the list.
17391     *
17392     * @param obj The genlist object
17393     * @return The first item, or NULL if none
17394     *
17395     * @ingroup Genlist
17396     */
17397    EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17398    /**
17399     * Get the last item in the genlist
17400     *
17401     * This returns the last item in the list.
17402     *
17403     * @return The last item, or NULL if none
17404     *
17405     * @ingroup Genlist
17406     */
17407    EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17408    /**
17409     * Set the scrollbar policy
17410     *
17411     * @param obj The genlist object
17412     * @param policy_h Horizontal scrollbar policy.
17413     * @param policy_v Vertical scrollbar policy.
17414     *
17415     * This sets the scrollbar visibility policy for the given genlist
17416     * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
17417     * made visible if it is needed, and otherwise kept hidden.
17418     * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
17419     * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
17420     * respectively for the horizontal and vertical scrollbars. Default is
17421     * #ELM_SMART_SCROLLER_POLICY_AUTO
17422     *
17423     * @see elm_genlist_scroller_policy_get()
17424     *
17425     * @ingroup Genlist
17426     */
17427    EAPI void              elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
17428    /**
17429     * Get the scrollbar policy
17430     *
17431     * @param obj The genlist object
17432     * @param policy_h Pointer to store the horizontal scrollbar policy.
17433     * @param policy_v Pointer to store the vertical scrollbar policy.
17434     *
17435     * @see elm_genlist_scroller_policy_set()
17436     *
17437     * @ingroup Genlist
17438     */
17439    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);
17440    /**
17441     * Get the @b next item in a genlist widget's internal list of items,
17442     * given a handle to one of those items.
17443     *
17444     * @param item The genlist item to fetch next from
17445     * @return The item after @p item, or @c NULL if there's none (and
17446     * on errors)
17447     *
17448     * This returns the item placed after the @p item, on the container
17449     * genlist.
17450     *
17451     * @see elm_genlist_item_prev_get()
17452     *
17453     * @ingroup Genlist
17454     */
17455    EAPI Elm_Genlist_Item  *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17456    /**
17457     * Get the @b previous item in a genlist widget's internal list of items,
17458     * given a handle to one of those items.
17459     *
17460     * @param item The genlist item to fetch previous from
17461     * @return The item before @p item, or @c NULL if there's none (and
17462     * on errors)
17463     *
17464     * This returns the item placed before the @p item, on the container
17465     * genlist.
17466     *
17467     * @see elm_genlist_item_next_get()
17468     *
17469     * @ingroup Genlist
17470     */
17471    EAPI Elm_Genlist_Item  *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17472    /**
17473     * Get the genlist object's handle which contains a given genlist
17474     * item
17475     *
17476     * @param item The item to fetch the container from
17477     * @return The genlist (parent) object
17478     *
17479     * This returns the genlist object itself that an item belongs to.
17480     *
17481     * @ingroup Genlist
17482     */
17483    EAPI Evas_Object       *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17484    /**
17485     * Get the parent item of the given item
17486     *
17487     * @param it The item
17488     * @return The parent of the item or @c NULL if it has no parent.
17489     *
17490     * This returns the item that was specified as parent of the item @p it on
17491     * elm_genlist_item_append() and insertion related functions.
17492     *
17493     * @ingroup Genlist
17494     */
17495    EAPI Elm_Genlist_Item  *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17496    /**
17497     * Remove all sub-items (children) of the given item
17498     *
17499     * @param it The item
17500     *
17501     * This removes all items that are children (and their descendants) of the
17502     * given item @p it.
17503     *
17504     * @see elm_genlist_clear()
17505     * @see elm_genlist_item_del()
17506     *
17507     * @ingroup Genlist
17508     */
17509    EAPI void               elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17510    /**
17511     * Set whether a given genlist item is selected or not
17512     *
17513     * @param it The item
17514     * @param selected Use @c EINA_TRUE, to make it selected, @c
17515     * EINA_FALSE to make it unselected
17516     *
17517     * This sets the selected state of an item. If multi selection is
17518     * not enabled on the containing genlist and @p selected is @c
17519     * EINA_TRUE, any other previously selected items will get
17520     * unselected in favor of this new one.
17521     *
17522     * @see elm_genlist_item_selected_get()
17523     *
17524     * @ingroup Genlist
17525     */
17526    EAPI void               elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
17527    /**
17528     * Get whether a given genlist item is selected or not
17529     *
17530     * @param it The item
17531     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
17532     *
17533     * @see elm_genlist_item_selected_set() for more details
17534     *
17535     * @ingroup Genlist
17536     */
17537    EAPI Eina_Bool          elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17538    /**
17539     * Sets the expanded state of an item.
17540     *
17541     * @param it The item
17542     * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
17543     *
17544     * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
17545     * expanded or not.
17546     *
17547     * The theme will respond to this change visually, and a signal "expanded" or
17548     * "contracted" will be sent from the genlist with a pointer to the item that
17549     * has been expanded/contracted.
17550     *
17551     * Calling this function won't show or hide any child of this item (if it is
17552     * a parent). You must manually delete and create them on the callbacks fo
17553     * the "expanded" or "contracted" signals.
17554     *
17555     * @see elm_genlist_item_expanded_get()
17556     *
17557     * @ingroup Genlist
17558     */
17559    EAPI void               elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
17560    /**
17561     * Get the expanded state of an item
17562     *
17563     * @param it The item
17564     * @return The expanded state
17565     *
17566     * This gets the expanded state of an item.
17567     *
17568     * @see elm_genlist_item_expanded_set()
17569     *
17570     * @ingroup Genlist
17571     */
17572    EAPI Eina_Bool          elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17573    /**
17574     * Get the depth of expanded item
17575     *
17576     * @param it The genlist item object
17577     * @return The depth of expanded item
17578     *
17579     * @ingroup Genlist
17580     */
17581    EAPI int                elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17582    /**
17583     * Set whether a given genlist item is disabled or not.
17584     *
17585     * @param it The item
17586     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
17587     * to enable it back.
17588     *
17589     * A disabled item cannot be selected or unselected. It will also
17590     * change its appearance, to signal the user it's disabled.
17591     *
17592     * @see elm_genlist_item_disabled_get()
17593     *
17594     * @ingroup Genlist
17595     */
17596    EAPI void               elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17597    /**
17598     * Get whether a given genlist item is disabled or not.
17599     *
17600     * @param it The item
17601     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
17602     * (and on errors).
17603     *
17604     * @see elm_genlist_item_disabled_set() for more details
17605     *
17606     * @ingroup Genlist
17607     */
17608    EAPI Eina_Bool          elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17609    /**
17610     * Sets the display only state of an item.
17611     *
17612     * @param it The item
17613     * @param display_only @c EINA_TRUE if the item is display only, @c
17614     * EINA_FALSE otherwise.
17615     *
17616     * A display only item cannot be selected or unselected. It is for
17617     * display only and not selecting or otherwise clicking, dragging
17618     * etc. by the user, thus finger size rules will not be applied to
17619     * this item.
17620     *
17621     * It's good to set group index items to display only state.
17622     *
17623     * @see elm_genlist_item_display_only_get()
17624     *
17625     * @ingroup Genlist
17626     */
17627    EAPI void               elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
17628    /**
17629     * Get the display only state of an item
17630     *
17631     * @param it The item
17632     * @return @c EINA_TRUE if the item is display only, @c
17633     * EINA_FALSE otherwise.
17634     *
17635     * @see elm_genlist_item_display_only_set()
17636     *
17637     * @ingroup Genlist
17638     */
17639    EAPI Eina_Bool          elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17640    /**
17641     * Show the portion of a genlist's internal list containing a given
17642     * item, immediately.
17643     *
17644     * @param it The item to display
17645     *
17646     * This causes genlist to jump to the given item @p it and show it (by
17647     * immediately scrolling to that position), if it is not fully visible.
17648     *
17649     * @see elm_genlist_item_bring_in()
17650     * @see elm_genlist_item_top_show()
17651     * @see elm_genlist_item_middle_show()
17652     *
17653     * @ingroup Genlist
17654     */
17655    EAPI void               elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17656    /**
17657     * Animatedly bring in, to the visible are of a genlist, a given
17658     * item on it.
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     * animatedly scrolling), if it is not fully visible. This may use animation
17664     * to do so and take a period of time
17665     *
17666     * @see elm_genlist_item_show()
17667     * @see elm_genlist_item_top_bring_in()
17668     * @see elm_genlist_item_middle_bring_in()
17669     *
17670     * @ingroup Genlist
17671     */
17672    EAPI void               elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17673    /**
17674     * Show the portion of a genlist's internal list containing a given
17675     * item, immediately.
17676     *
17677     * @param it The item to display
17678     *
17679     * This causes genlist to jump to the given item @p it and show it (by
17680     * immediately scrolling to that position), if it is not fully visible.
17681     *
17682     * The item will be positioned at the top of the genlist viewport.
17683     *
17684     * @see elm_genlist_item_show()
17685     * @see elm_genlist_item_top_bring_in()
17686     *
17687     * @ingroup Genlist
17688     */
17689    EAPI void               elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17690    /**
17691     * Animatedly bring in, to the visible are of a genlist, a given
17692     * item on it.
17693     *
17694     * @param it The item
17695     *
17696     * This causes genlist to jump to the given item @p it and show it (by
17697     * animatedly scrolling), if it is not fully visible. This may use animation
17698     * to do so and take a period of time
17699     *
17700     * The item will be positioned at the top of the genlist viewport.
17701     *
17702     * @see elm_genlist_item_bring_in()
17703     * @see elm_genlist_item_top_show()
17704     *
17705     * @ingroup Genlist
17706     */
17707    EAPI void               elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17708    /**
17709     * Show the portion of a genlist's internal list containing a given
17710     * item, immediately.
17711     *
17712     * @param it The item to display
17713     *
17714     * This causes genlist to jump to the given item @p it and show it (by
17715     * immediately scrolling to that position), if it is not fully visible.
17716     *
17717     * The item will be positioned at the middle of the genlist viewport.
17718     *
17719     * @see elm_genlist_item_show()
17720     * @see elm_genlist_item_middle_bring_in()
17721     *
17722     * @ingroup Genlist
17723     */
17724    EAPI void               elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17725    /**
17726     * Animatedly bring in, to the visible are of a genlist, a given
17727     * item on it.
17728     *
17729     * @param it The item
17730     *
17731     * This causes genlist to jump to the given item @p it and show it (by
17732     * animatedly scrolling), if it is not fully visible. This may use animation
17733     * to do so and take a period of time
17734     *
17735     * The item will be positioned at the middle of the genlist viewport.
17736     *
17737     * @see elm_genlist_item_bring_in()
17738     * @see elm_genlist_item_middle_show()
17739     *
17740     * @ingroup Genlist
17741     */
17742    EAPI void               elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17743    /**
17744     * Remove a genlist item from the its parent, deleting it.
17745     *
17746     * @param item The item to be removed.
17747     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
17748     *
17749     * @see elm_genlist_clear(), to remove all items in a genlist at
17750     * once.
17751     *
17752     * @ingroup Genlist
17753     */
17754    EAPI void               elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17755    /**
17756     * Return the data associated to a given genlist item
17757     *
17758     * @param item The genlist item.
17759     * @return the data associated to this item.
17760     *
17761     * This returns the @c data value passed on the
17762     * elm_genlist_item_append() and related item addition calls.
17763     *
17764     * @see elm_genlist_item_append()
17765     * @see elm_genlist_item_data_set()
17766     *
17767     * @ingroup Genlist
17768     */
17769    EAPI void              *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17770    /**
17771     * Set the data associated to a given genlist item
17772     *
17773     * @param item The genlist item
17774     * @param data The new data pointer to set on it
17775     *
17776     * This @b overrides the @c data value passed on the
17777     * elm_genlist_item_append() and related item addition calls. This
17778     * function @b won't call elm_genlist_item_update() automatically,
17779     * so you'd issue it afterwards if you want to hove the item
17780     * updated to reflect the that new data.
17781     *
17782     * @see elm_genlist_item_data_get()
17783     *
17784     * @ingroup Genlist
17785     */
17786    EAPI void               elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
17787    /**
17788     * Tells genlist to "orphan" icons fetchs by the item class
17789     *
17790     * @param it The item
17791     *
17792     * This instructs genlist to release references to icons in the item,
17793     * meaning that they will no longer be managed by genlist and are
17794     * floating "orphans" that can be re-used elsewhere if the user wants
17795     * to.
17796     *
17797     * @ingroup Genlist
17798     */
17799    EAPI void               elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17800    /**
17801     * Get the real Evas object created to implement the view of a
17802     * given genlist item
17803     *
17804     * @param item The genlist item.
17805     * @return the Evas object implementing this item's view.
17806     *
17807     * This returns the actual Evas object used to implement the
17808     * specified genlist item's view. This may be @c NULL, as it may
17809     * not have been created or may have been deleted, at any time, by
17810     * the genlist. <b>Do not modify this object</b> (move, resize,
17811     * show, hide, etc.), as the genlist is controlling it. This
17812     * function is for querying, emitting custom signals or hooking
17813     * lower level callbacks for events on that object. Do not delete
17814     * this object under any circumstances.
17815     *
17816     * @see elm_genlist_item_data_get()
17817     *
17818     * @ingroup Genlist
17819     */
17820    EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17821    /**
17822     * Update the contents of an item
17823     *
17824     * @param it The item
17825     *
17826     * This updates an item by calling all the item class functions again
17827     * to get the icons, labels and states. Use this when the original
17828     * item data has changed and the changes are desired to be reflected.
17829     *
17830     * Use elm_genlist_realized_items_update() to update all already realized
17831     * items.
17832     *
17833     * @see elm_genlist_realized_items_update()
17834     *
17835     * @ingroup Genlist
17836     */
17837    EAPI void               elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17838    /**
17839     * Update the item class of an item
17840     *
17841     * @param it The item
17842     * @param itc The item class for the item
17843     *
17844     * This sets another class fo the item, changing the way that it is
17845     * displayed. After changing the item class, elm_genlist_item_update() is
17846     * called on the item @p it.
17847     *
17848     * @ingroup Genlist
17849     */
17850    EAPI void               elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
17851    EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17852    /**
17853     * Set the text to be shown in a given genlist item's tooltips.
17854     *
17855     * @param item The genlist item
17856     * @param text The text to set in the content
17857     *
17858     * This call will setup the text to be used as tooltip to that item
17859     * (analogous to elm_object_tooltip_text_set(), but being item
17860     * tooltips with higher precedence than object tooltips). It can
17861     * have only one tooltip at a time, so any previous tooltip data
17862     * will get removed.
17863     *
17864     * In order to set an icon or something else as a tooltip, look at
17865     * elm_genlist_item_tooltip_content_cb_set().
17866     *
17867     * @ingroup Genlist
17868     */
17869    EAPI void               elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
17870    /**
17871     * Set the content to be shown in a given genlist item's tooltips
17872     *
17873     * @param item The genlist item.
17874     * @param func The function returning the tooltip contents.
17875     * @param data What to provide to @a func as callback data/context.
17876     * @param del_cb Called when data is not needed anymore, either when
17877     *        another callback replaces @p func, the tooltip is unset with
17878     *        elm_genlist_item_tooltip_unset() or the owner @p item
17879     *        dies. This callback receives as its first parameter the
17880     *        given @p data, being @c event_info the item handle.
17881     *
17882     * This call will setup the tooltip's contents to @p item
17883     * (analogous to elm_object_tooltip_content_cb_set(), but being
17884     * item tooltips with higher precedence than object tooltips). It
17885     * can have only one tooltip at a time, so any previous tooltip
17886     * content will get removed. @p func (with @p data) will be called
17887     * every time Elementary needs to show the tooltip and it should
17888     * return a valid Evas object, which will be fully managed by the
17889     * tooltip system, getting deleted when the tooltip is gone.
17890     *
17891     * In order to set just a text as a tooltip, look at
17892     * elm_genlist_item_tooltip_text_set().
17893     *
17894     * @ingroup Genlist
17895     */
17896    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);
17897    /**
17898     * Unset a tooltip from a given genlist item
17899     *
17900     * @param item genlist item to remove a previously set tooltip from.
17901     *
17902     * This call removes any tooltip set on @p item. The callback
17903     * provided as @c del_cb to
17904     * elm_genlist_item_tooltip_content_cb_set() will be called to
17905     * notify it is not used anymore (and have resources cleaned, if
17906     * need be).
17907     *
17908     * @see elm_genlist_item_tooltip_content_cb_set()
17909     *
17910     * @ingroup Genlist
17911     */
17912    EAPI void               elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17913    /**
17914     * Set a different @b style for a given genlist item's tooltip.
17915     *
17916     * @param item genlist item with tooltip set
17917     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
17918     * "default", @c "transparent", etc)
17919     *
17920     * Tooltips can have <b>alternate styles</b> to be displayed on,
17921     * which are defined by the theme set on Elementary. This function
17922     * works analogously as elm_object_tooltip_style_set(), but here
17923     * applied only to genlist item objects. The default style for
17924     * tooltips is @c "default".
17925     *
17926     * @note before you set a style you should define a tooltip with
17927     *       elm_genlist_item_tooltip_content_cb_set() or
17928     *       elm_genlist_item_tooltip_text_set()
17929     *
17930     * @see elm_genlist_item_tooltip_style_get()
17931     *
17932     * @ingroup Genlist
17933     */
17934    EAPI void               elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
17935    /**
17936     * Get the style set a given genlist item's tooltip.
17937     *
17938     * @param item genlist item with tooltip already set on.
17939     * @return style the theme style in use, which defaults to
17940     *         "default". If the object does not have a tooltip set,
17941     *         then @c NULL is returned.
17942     *
17943     * @see elm_genlist_item_tooltip_style_set() for more details
17944     *
17945     * @ingroup Genlist
17946     */
17947    EAPI const char        *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17948    /**
17949     * @brief Disable size restrictions on an object's tooltip
17950     * @param item The tooltip's anchor object
17951     * @param disable If EINA_TRUE, size restrictions are disabled
17952     * @return EINA_FALSE on failure, EINA_TRUE on success
17953     *
17954     * This function allows a tooltip to expand beyond its parant window's canvas.
17955     * It will instead be limited only by the size of the display.
17956     */
17957    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
17958    /**
17959     * @brief Retrieve size restriction state of an object's tooltip
17960     * @param item The tooltip's anchor object
17961     * @return If EINA_TRUE, size restrictions are disabled
17962     *
17963     * This function returns whether a tooltip is allowed to expand beyond
17964     * its parant window's canvas.
17965     * It will instead be limited only by the size of the display.
17966     */
17967    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
17968    /**
17969     * Set the type of mouse pointer/cursor decoration to be shown,
17970     * when the mouse pointer is over the given genlist widget item
17971     *
17972     * @param item genlist item to customize cursor on
17973     * @param cursor the cursor type's name
17974     *
17975     * This function works analogously as elm_object_cursor_set(), but
17976     * here the cursor's changing area is restricted to the item's
17977     * area, and not the whole widget's. Note that that item cursors
17978     * have precedence over widget cursors, so that a mouse over @p
17979     * item will always show cursor @p type.
17980     *
17981     * If this function is called twice for an object, a previously set
17982     * cursor will be unset on the second call.
17983     *
17984     * @see elm_object_cursor_set()
17985     * @see elm_genlist_item_cursor_get()
17986     * @see elm_genlist_item_cursor_unset()
17987     *
17988     * @ingroup Genlist
17989     */
17990    EAPI void               elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17991    /**
17992     * Get the type of mouse pointer/cursor decoration set to be shown,
17993     * when the mouse pointer is over the given genlist widget item
17994     *
17995     * @param item genlist item with custom cursor set
17996     * @return the cursor type's name or @c NULL, if no custom cursors
17997     * were set to @p item (and on errors)
17998     *
17999     * @see elm_object_cursor_get()
18000     * @see elm_genlist_item_cursor_set() for more details
18001     * @see elm_genlist_item_cursor_unset()
18002     *
18003     * @ingroup Genlist
18004     */
18005    EAPI const char        *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18006    /**
18007     * Unset any custom mouse pointer/cursor decoration set to be
18008     * shown, when the mouse pointer is over the given genlist widget
18009     * item, thus making it show the @b default cursor again.
18010     *
18011     * @param item a genlist item
18012     *
18013     * Use this call to undo any custom settings on this item's cursor
18014     * decoration, bringing it back to defaults (no custom style set).
18015     *
18016     * @see elm_object_cursor_unset()
18017     * @see elm_genlist_item_cursor_set() for more details
18018     *
18019     * @ingroup Genlist
18020     */
18021    EAPI void               elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18022    /**
18023     * Set a different @b style for a given custom cursor set for a
18024     * genlist item.
18025     *
18026     * @param item genlist item with custom cursor set
18027     * @param style the <b>theme style</b> to use (e.g. @c "default",
18028     * @c "transparent", etc)
18029     *
18030     * This function only makes sense when one is using custom mouse
18031     * cursor decorations <b>defined in a theme file</b> , which can
18032     * have, given a cursor name/type, <b>alternate styles</b> on
18033     * it. It works analogously as elm_object_cursor_style_set(), but
18034     * here applied only to genlist item objects.
18035     *
18036     * @warning Before you set a cursor style you should have defined a
18037     *       custom cursor previously on the item, with
18038     *       elm_genlist_item_cursor_set()
18039     *
18040     * @see elm_genlist_item_cursor_engine_only_set()
18041     * @see elm_genlist_item_cursor_style_get()
18042     *
18043     * @ingroup Genlist
18044     */
18045    EAPI void               elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
18046    /**
18047     * Get the current @b style set for a given genlist item's custom
18048     * cursor
18049     *
18050     * @param item genlist item with custom cursor set.
18051     * @return style the cursor style in use. If the object does not
18052     *         have a cursor set, then @c NULL is returned.
18053     *
18054     * @see elm_genlist_item_cursor_style_set() for more details
18055     *
18056     * @ingroup Genlist
18057     */
18058    EAPI const char        *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18059    /**
18060     * Set if the (custom) cursor for a given genlist item should be
18061     * searched in its theme, also, or should only rely on the
18062     * rendering engine.
18063     *
18064     * @param item item with custom (custom) cursor already set on
18065     * @param engine_only Use @c EINA_TRUE to have cursors looked for
18066     * only on those provided by the rendering engine, @c EINA_FALSE to
18067     * have them searched on the widget's theme, as well.
18068     *
18069     * @note This call is of use only if you've set a custom cursor
18070     * for genlist items, with elm_genlist_item_cursor_set().
18071     *
18072     * @note By default, cursors will only be looked for between those
18073     * provided by the rendering engine.
18074     *
18075     * @ingroup Genlist
18076     */
18077    EAPI void               elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
18078    /**
18079     * Get if the (custom) cursor for a given genlist item is being
18080     * searched in its theme, also, or is only relying on the rendering
18081     * engine.
18082     *
18083     * @param item a genlist item
18084     * @return @c EINA_TRUE, if cursors are being looked for only on
18085     * those provided by the rendering engine, @c EINA_FALSE if they
18086     * are being searched on the widget's theme, as well.
18087     *
18088     * @see elm_genlist_item_cursor_engine_only_set(), for more details
18089     *
18090     * @ingroup Genlist
18091     */
18092    EAPI Eina_Bool          elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18093    /**
18094     * Update the contents of all realized items.
18095     *
18096     * @param obj The genlist object.
18097     *
18098     * This updates all realized items by calling all the item class functions again
18099     * to get the icons, labels and states. Use this when the original
18100     * item data has changed and the changes are desired to be reflected.
18101     *
18102     * To update just one item, use elm_genlist_item_update().
18103     *
18104     * @see elm_genlist_realized_items_get()
18105     * @see elm_genlist_item_update()
18106     *
18107     * @ingroup Genlist
18108     */
18109    EAPI void               elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
18110    /**
18111     * Activate a genlist mode on an item
18112     *
18113     * @param item The genlist item
18114     * @param mode Mode name
18115     * @param mode_set Boolean to define set or unset mode.
18116     *
18117     * A genlist mode is a different way of selecting an item. Once a mode is
18118     * activated on an item, any other selected item is immediately unselected.
18119     * This feature provides an easy way of implementing a new kind of animation
18120     * for selecting an item, without having to entirely rewrite the item style
18121     * theme. However, the elm_genlist_selected_* API can't be used to get what
18122     * item is activate for a mode.
18123     *
18124     * The current item style will still be used, but applying a genlist mode to
18125     * an item will select it using a different kind of animation.
18126     *
18127     * The current active item for a mode can be found by
18128     * elm_genlist_mode_item_get().
18129     *
18130     * The characteristics of genlist mode are:
18131     * - Only one mode can be active at any time, and for only one item.
18132     * - Genlist handles deactivating other items when one item is activated.
18133     * - A mode is defined in the genlist theme (edc), and more modes can easily
18134     *   be added.
18135     * - A mode style and the genlist item style are different things. They
18136     *   can be combined to provide a default style to the item, with some kind
18137     *   of animation for that item when the mode is activated.
18138     *
18139     * When a mode is activated on an item, a new view for that item is created.
18140     * The theme of this mode defines the animation that will be used to transit
18141     * the item from the old view to the new view. This second (new) view will be
18142     * active for that item while the mode is active on the item, and will be
18143     * destroyed after the mode is totally deactivated from that item.
18144     *
18145     * @see elm_genlist_mode_get()
18146     * @see elm_genlist_mode_item_get()
18147     *
18148     * @ingroup Genlist
18149     */
18150    EAPI void               elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
18151    /**
18152     * Get the last (or current) genlist mode used.
18153     *
18154     * @param obj The genlist object
18155     *
18156     * This function just returns the name of the last used genlist mode. It will
18157     * be the current mode if it's still active.
18158     *
18159     * @see elm_genlist_item_mode_set()
18160     * @see elm_genlist_mode_item_get()
18161     *
18162     * @ingroup Genlist
18163     */
18164    EAPI const char        *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18165    /**
18166     * Get active genlist mode item
18167     *
18168     * @param obj The genlist object
18169     * @return The active item for that current mode. Or @c NULL if no item is
18170     * activated with any mode.
18171     *
18172     * This function returns the item that was activated with a mode, by the
18173     * function elm_genlist_item_mode_set().
18174     *
18175     * @see elm_genlist_item_mode_set()
18176     * @see elm_genlist_mode_get()
18177     *
18178     * @ingroup Genlist
18179     */
18180    EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18181
18182    /**
18183     * Set reorder mode
18184     *
18185     * @param obj The genlist object
18186     * @param reorder_mode The reorder mode
18187     * (EINA_TRUE = on, EINA_FALSE = off)
18188     *
18189     * @ingroup Genlist
18190     */
18191    EAPI void               elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
18192
18193    /**
18194     * Get the reorder mode
18195     *
18196     * @param obj The genlist object
18197     * @return The reorder mode
18198     * (EINA_TRUE = on, EINA_FALSE = off)
18199     *
18200     * @ingroup Genlist
18201     */
18202    EAPI Eina_Bool          elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18203
18204    /**
18205     * @}
18206     */
18207
18208    /**
18209     * @defgroup Check Check
18210     *
18211     * @image html img/widget/check/preview-00.png
18212     * @image latex img/widget/check/preview-00.eps
18213     * @image html img/widget/check/preview-01.png
18214     * @image latex img/widget/check/preview-01.eps
18215     * @image html img/widget/check/preview-02.png
18216     * @image latex img/widget/check/preview-02.eps
18217     *
18218     * @brief The check widget allows for toggling a value between true and
18219     * false.
18220     *
18221     * Check objects are a lot like radio objects in layout and functionality
18222     * except they do not work as a group, but independently and only toggle the
18223     * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
18224     * the boolean state (1 for true, 0 for false), and elm_check_state_get()
18225     * returns the current state. For convenience, like the radio objects, you
18226     * can set a pointer to a boolean directly with elm_check_state_pointer_set()
18227     * for it to modify.
18228     *
18229     * Signals that you can add callbacks for are:
18230     * "changed" - This is called whenever the user changes the state of one of
18231     *             the check object(event_info is NULL).
18232     *
18233     * @ref tutorial_check should give you a firm grasp of how to use this widget.
18234     * @{
18235     */
18236    /**
18237     * @brief Add a new Check object
18238     *
18239     * @param parent The parent object
18240     * @return The new object or NULL if it cannot be created
18241     */
18242    EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18243    /**
18244     * @brief Set the text label of the check object
18245     *
18246     * @param obj The check object
18247     * @param label The text label string in UTF-8
18248     *
18249     * @deprecated use elm_object_text_set() instead.
18250     */
18251    EINA_DEPRECATED EAPI void         elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18252    /**
18253     * @brief Get the text label of the check object
18254     *
18255     * @param obj The check object
18256     * @return The text label string in UTF-8
18257     *
18258     * @deprecated use elm_object_text_get() instead.
18259     */
18260    EINA_DEPRECATED EAPI const char  *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18261    /**
18262     * @brief Set the icon object of the check object
18263     *
18264     * @param obj The check object
18265     * @param icon The icon object
18266     *
18267     * Once the icon object is set, a previously set one will be deleted.
18268     * If you want to keep that old content object, use the
18269     * elm_check_icon_unset() function.
18270     */
18271    EAPI void         elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18272    /**
18273     * @brief Get the icon object of the check object
18274     *
18275     * @param obj The check object
18276     * @return The icon object
18277     */
18278    EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18279    /**
18280     * @brief Unset the icon used for the check object
18281     *
18282     * @param obj The check object
18283     * @return The icon object that was being used
18284     *
18285     * Unparent and return the icon object which was set for this widget.
18286     */
18287    EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18288    /**
18289     * @brief Set the on/off state of the check object
18290     *
18291     * @param obj The check object
18292     * @param state The state to use (1 == on, 0 == off)
18293     *
18294     * This sets the state of the check. If set
18295     * with elm_check_state_pointer_set() the state of that variable is also
18296     * changed. Calling this @b doesn't cause the "changed" signal to be emited.
18297     */
18298    EAPI void         elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
18299    /**
18300     * @brief Get the state of the check object
18301     *
18302     * @param obj The check object
18303     * @return The boolean state
18304     */
18305    EAPI Eina_Bool    elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18306    /**
18307     * @brief Set a convenience pointer to a boolean to change
18308     *
18309     * @param obj The check object
18310     * @param statep Pointer to the boolean to modify
18311     *
18312     * This sets a pointer to a boolean, that, in addition to the check objects
18313     * state will also be modified directly. To stop setting the object pointed
18314     * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
18315     * then when this is called, the check objects state will also be modified to
18316     * reflect the value of the boolean @p statep points to, just like calling
18317     * elm_check_state_set().
18318     */
18319    EAPI void         elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
18320    /**
18321     * @}
18322     */
18323
18324    /**
18325     * @defgroup Radio Radio
18326     *
18327     * @image html img/widget/radio/preview-00.png
18328     * @image latex img/widget/radio/preview-00.eps
18329     *
18330     * @brief Radio is a widget that allows for 1 or more options to be displayed
18331     * and have the user choose only 1 of them.
18332     *
18333     * A radio object contains an indicator, an optional Label and an optional
18334     * icon object. While it's possible to have a group of only one radio they,
18335     * are normally used in groups of 2 or more. To add a radio to a group use
18336     * elm_radio_group_add(). The radio object(s) will select from one of a set
18337     * of integer values, so any value they are configuring needs to be mapped to
18338     * a set of integers. To configure what value that radio object represents,
18339     * use  elm_radio_state_value_set() to set the integer it represents. To set
18340     * the value the whole group(which one is currently selected) is to indicate
18341     * use elm_radio_value_set() on any group member, and to get the groups value
18342     * use elm_radio_value_get(). For convenience the radio objects are also able
18343     * to directly set an integer(int) to the value that is selected. To specify
18344     * the pointer to this integer to modify, use elm_radio_value_pointer_set().
18345     * The radio objects will modify this directly. That implies the pointer must
18346     * point to valid memory for as long as the radio objects exist.
18347     *
18348     * Signals that you can add callbacks for are:
18349     * @li changed - This is called whenever the user changes the state of one of
18350     * the radio objects within the group of radio objects that work together.
18351     *
18352     * @ref tutorial_radio show most of this API in action.
18353     * @{
18354     */
18355    /**
18356     * @brief Add a new radio to the parent
18357     *
18358     * @param parent The parent object
18359     * @return The new object or NULL if it cannot be created
18360     */
18361    EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18362    /**
18363     * @brief Set the text label of the radio object
18364     *
18365     * @param obj The radio object
18366     * @param label The text label string in UTF-8
18367     *
18368     * @deprecated use elm_object_text_set() instead.
18369     */
18370    EINA_DEPRECATED EAPI void         elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18371    /**
18372     * @brief Get the text label of the radio object
18373     *
18374     * @param obj The radio object
18375     * @return The text label string in UTF-8
18376     *
18377     * @deprecated use elm_object_text_set() instead.
18378     */
18379    EINA_DEPRECATED EAPI const char  *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18380    /**
18381     * @brief Set the icon object of the radio object
18382     *
18383     * @param obj The radio object
18384     * @param icon The icon object
18385     *
18386     * Once the icon object is set, a previously set one will be deleted. If you
18387     * want to keep that old content object, use the elm_radio_icon_unset()
18388     * function.
18389     */
18390    EAPI void         elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18391    /**
18392     * @brief Get the icon object of the radio object
18393     *
18394     * @param obj The radio object
18395     * @return The icon object
18396     *
18397     * @see elm_radio_icon_set()
18398     */
18399    EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18400    /**
18401     * @brief Unset the icon used for the radio object
18402     *
18403     * @param obj The radio object
18404     * @return The icon object that was being used
18405     *
18406     * Unparent and return the icon object which was set for this widget.
18407     *
18408     * @see elm_radio_icon_set()
18409     */
18410    EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18411    /**
18412     * @brief Add this radio to a group of other radio objects
18413     *
18414     * @param obj The radio object
18415     * @param group Any object whose group the @p obj is to join.
18416     *
18417     * Radio objects work in groups. Each member should have a different integer
18418     * value assigned. In order to have them work as a group, they need to know
18419     * about each other. This adds the given radio object to the group of which
18420     * the group object indicated is a member.
18421     */
18422    EAPI void         elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
18423    /**
18424     * @brief Set the integer value that this radio object represents
18425     *
18426     * @param obj The radio object
18427     * @param value The value to use if this radio object is selected
18428     *
18429     * This sets the value of the radio.
18430     */
18431    EAPI void         elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
18432    /**
18433     * @brief Get the integer value that this radio object represents
18434     *
18435     * @param obj The radio object
18436     * @return The value used if this radio object is selected
18437     *
18438     * This gets the value of the radio.
18439     *
18440     * @see elm_radio_value_set()
18441     */
18442    EAPI int          elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18443    /**
18444     * @brief Set the value of the radio.
18445     *
18446     * @param obj The radio object
18447     * @param value The value to use for the group
18448     *
18449     * This sets the value of the radio group and will also set the value if
18450     * pointed to, to the value supplied, but will not call any callbacks.
18451     */
18452    EAPI void         elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
18453    /**
18454     * @brief Get the state of the radio object
18455     *
18456     * @param obj The radio object
18457     * @return The integer state
18458     */
18459    EAPI int          elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18460    /**
18461     * @brief Set a convenience pointer to a integer to change
18462     *
18463     * @param obj The radio object
18464     * @param valuep Pointer to the integer to modify
18465     *
18466     * This sets a pointer to a integer, that, in addition to the radio objects
18467     * state will also be modified directly. To stop setting the object pointed
18468     * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
18469     * when this is called, the radio objects state will also be modified to
18470     * reflect the value of the integer valuep points to, just like calling
18471     * elm_radio_value_set().
18472     */
18473    EAPI void         elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
18474    /**
18475     * @}
18476     */
18477
18478    /**
18479     * @defgroup Pager Pager
18480     *
18481     * @image html img/widget/pager/preview-00.png
18482     * @image latex img/widget/pager/preview-00.eps
18483     *
18484     * @brief Widget that allows flipping between 1 or more “pages” of objects.
18485     *
18486     * The flipping between “pages” of objects is animated. All content in pager
18487     * is kept in a stack, the last content to be added will be on the top of the
18488     * stack(be visible).
18489     *
18490     * Objects can be pushed or popped from the stack or deleted as normal.
18491     * Pushes and pops will animate (and a pop will delete the object once the
18492     * animation is finished). Any object already in the pager can be promoted to
18493     * the top(from its current stacking position) through the use of
18494     * elm_pager_content_promote(). Objects are pushed to the top with
18495     * elm_pager_content_push() and when the top item is no longer wanted, simply
18496     * pop it with elm_pager_content_pop() and it will also be deleted. If an
18497     * object is no longer needed and is not the top item, just delete it as
18498     * normal. You can query which objects are the top and bottom with
18499     * elm_pager_content_bottom_get() and elm_pager_content_top_get().
18500     *
18501     * Signals that you can add callbacks for are:
18502     * "hide,finished" - when the previous page is hided
18503     *
18504     * This widget has the following styles available:
18505     * @li default
18506     * @li fade
18507     * @li fade_translucide
18508     * @li fade_invisible
18509     * @note This styles affect only the flipping animations, the appearance when
18510     * not animating is unaffected by styles.
18511     *
18512     * @ref tutorial_pager gives a good overview of the usage of the API.
18513     * @{
18514     */
18515    /**
18516     * Add a new pager to the parent
18517     *
18518     * @param parent The parent object
18519     * @return The new object or NULL if it cannot be created
18520     *
18521     * @ingroup Pager
18522     */
18523    EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18524    /**
18525     * @brief Push an object to the top of the pager stack (and show it).
18526     *
18527     * @param obj The pager object
18528     * @param content The object to push
18529     *
18530     * The object pushed becomes a child of the pager, it will be controlled and
18531     * deleted when the pager is deleted.
18532     *
18533     * @note If the content is already in the stack use
18534     * elm_pager_content_promote().
18535     * @warning Using this function on @p content already in the stack results in
18536     * undefined behavior.
18537     */
18538    EAPI void         elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18539    /**
18540     * @brief Pop the object that is on top of the stack
18541     *
18542     * @param obj The pager object
18543     *
18544     * This pops the object that is on the top(visible) of the pager, makes it
18545     * disappear, then deletes the object. The object that was underneath it on
18546     * the stack will become visible.
18547     */
18548    EAPI void         elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
18549    /**
18550     * @brief Moves an object already in the pager stack to the top of the stack.
18551     *
18552     * @param obj The pager object
18553     * @param content The object to promote
18554     *
18555     * This will take the @p content and move it to the top of the stack as
18556     * if it had been pushed there.
18557     *
18558     * @note If the content isn't already in the stack use
18559     * elm_pager_content_push().
18560     * @warning Using this function on @p content not already in the stack
18561     * results in undefined behavior.
18562     */
18563    EAPI void         elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18564    /**
18565     * @brief Return the object at the bottom of the pager stack
18566     *
18567     * @param obj The pager object
18568     * @return The bottom object or NULL if none
18569     */
18570    EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18571    /**
18572     * @brief  Return the object at the top of the pager stack
18573     *
18574     * @param obj The pager object
18575     * @return The top object or NULL if none
18576     */
18577    EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18578    /**
18579     * @}
18580     */
18581
18582    /**
18583     * @defgroup Slideshow Slideshow
18584     *
18585     * @image html img/widget/slideshow/preview-00.png
18586     * @image latex img/widget/slideshow/preview-00.eps
18587     *
18588     * This widget, as the name indicates, is a pre-made image
18589     * slideshow panel, with API functions acting on (child) image
18590     * items presentation. Between those actions, are:
18591     * - advance to next/previous image
18592     * - select the style of image transition animation
18593     * - set the exhibition time for each image
18594     * - start/stop the slideshow
18595     *
18596     * The transition animations are defined in the widget's theme,
18597     * consequently new animations can be added without having to
18598     * update the widget's code.
18599     *
18600     * @section Slideshow_Items Slideshow items
18601     *
18602     * For slideshow items, just like for @ref Genlist "genlist" ones,
18603     * the user defines a @b classes, specifying functions that will be
18604     * called on the item's creation and deletion times.
18605     *
18606     * The #Elm_Slideshow_Item_Class structure contains the following
18607     * members:
18608     *
18609     * - @c func.get - When an item is displayed, this function is
18610     *   called, and it's where one should create the item object, de
18611     *   facto. For example, the object can be a pure Evas image object
18612     *   or an Elementary @ref Photocam "photocam" widget. See
18613     *   #SlideshowItemGetFunc.
18614     * - @c func.del - When an item is no more displayed, this function
18615     *   is called, where the user must delete any data associated to
18616     *   the item. See #SlideshowItemDelFunc.
18617     *
18618     * @section Slideshow_Caching Slideshow caching
18619     *
18620     * The slideshow provides facilities to have items adjacent to the
18621     * one being displayed <b>already "realized"</b> (i.e. loaded) for
18622     * you, so that the system does not have to decode image data
18623     * anymore at the time it has to actually switch images on its
18624     * viewport. The user is able to set the numbers of items to be
18625     * cached @b before and @b after the current item, in the widget's
18626     * item list.
18627     *
18628     * Smart events one can add callbacks for are:
18629     *
18630     * - @c "changed" - when the slideshow switches its view to a new
18631     *   item
18632     *
18633     * List of examples for the slideshow widget:
18634     * @li @ref slideshow_example
18635     */
18636
18637    /**
18638     * @addtogroup Slideshow
18639     * @{
18640     */
18641
18642    typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
18643    typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
18644    typedef struct _Elm_Slideshow_Item       Elm_Slideshow_Item; /**< Slideshow item handle */
18645    typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
18646    typedef void         (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
18647
18648    /**
18649     * @struct _Elm_Slideshow_Item_Class
18650     *
18651     * Slideshow item class definition. See @ref Slideshow_Items for
18652     * field details.
18653     */
18654    struct _Elm_Slideshow_Item_Class
18655      {
18656         struct _Elm_Slideshow_Item_Class_Func
18657           {
18658              SlideshowItemGetFunc get;
18659              SlideshowItemDelFunc del;
18660           } func;
18661      }; /**< #Elm_Slideshow_Item_Class member definitions */
18662
18663    /**
18664     * Add a new slideshow widget to the given parent Elementary
18665     * (container) object
18666     *
18667     * @param parent The parent object
18668     * @return A new slideshow widget handle or @c NULL, on errors
18669     *
18670     * This function inserts a new slideshow widget on the canvas.
18671     *
18672     * @ingroup Slideshow
18673     */
18674    EAPI Evas_Object        *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18675
18676    /**
18677     * Add (append) a new item in a given slideshow widget.
18678     *
18679     * @param obj The slideshow object
18680     * @param itc The item class for the item
18681     * @param data The item's data
18682     * @return A handle to the item added or @c NULL, on errors
18683     *
18684     * Add a new item to @p obj's internal list of items, appending it.
18685     * The item's class must contain the function really fetching the
18686     * image object to show for this item, which could be an Evas image
18687     * object or an Elementary photo, for example. The @p data
18688     * parameter is going to be passed to both class functions of the
18689     * item.
18690     *
18691     * @see #Elm_Slideshow_Item_Class
18692     * @see elm_slideshow_item_sorted_insert()
18693     *
18694     * @ingroup Slideshow
18695     */
18696    EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
18697
18698    /**
18699     * Insert a new item into the given slideshow widget, using the @p func
18700     * function to sort items (by item handles).
18701     *
18702     * @param obj The slideshow object
18703     * @param itc The item class for the item
18704     * @param data The item's data
18705     * @param func The comparing function to be used to sort slideshow
18706     * items <b>by #Elm_Slideshow_Item item handles</b>
18707     * @return Returns The slideshow item handle, on success, or
18708     * @c NULL, on errors
18709     *
18710     * Add a new item to @p obj's internal list of items, in a position
18711     * determined by the @p func comparing function. The item's class
18712     * must contain the function really fetching the image object to
18713     * show for this item, which could be an Evas image object or an
18714     * Elementary photo, for example. The @p data parameter is going to
18715     * be passed to both class functions of the item.
18716     *
18717     * @see #Elm_Slideshow_Item_Class
18718     * @see elm_slideshow_item_add()
18719     *
18720     * @ingroup Slideshow
18721     */
18722    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);
18723
18724    /**
18725     * Display a given slideshow widget's item, programmatically.
18726     *
18727     * @param obj The slideshow object
18728     * @param item The item to display on @p obj's viewport
18729     *
18730     * The change between the current item and @p item will use the
18731     * transition @p obj is set to use (@see
18732     * elm_slideshow_transition_set()).
18733     *
18734     * @ingroup Slideshow
18735     */
18736    EAPI void                elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18737
18738    /**
18739     * Slide to the @b next item, in a given slideshow widget
18740     *
18741     * @param obj The slideshow object
18742     *
18743     * The sliding animation @p obj is set to use will be the
18744     * transition effect used, after this call is issued.
18745     *
18746     * @note If the end of the slideshow's internal list of items is
18747     * reached, it'll wrap around to the list's beginning, again.
18748     *
18749     * @ingroup Slideshow
18750     */
18751    EAPI void                elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
18752
18753    /**
18754     * Slide to the @b previous item, in a given slideshow widget
18755     *
18756     * @param obj The slideshow object
18757     *
18758     * The sliding animation @p obj is set to use will be the
18759     * transition effect used, after this call is issued.
18760     *
18761     * @note If the beginning of the slideshow's internal list of items
18762     * is reached, it'll wrap around to the list's end, again.
18763     *
18764     * @ingroup Slideshow
18765     */
18766    EAPI void                elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
18767
18768    /**
18769     * Returns the list of sliding transition/effect names available, for a
18770     * given slideshow widget.
18771     *
18772     * @param obj The slideshow object
18773     * @return The list of transitions (list of @b stringshared strings
18774     * as data)
18775     *
18776     * The transitions, which come from @p obj's theme, must be an EDC
18777     * data item named @c "transitions" on the theme file, with (prefix)
18778     * names of EDC programs actually implementing them.
18779     *
18780     * The available transitions for slideshows on the default theme are:
18781     * - @c "fade" - the current item fades out, while the new one
18782     *   fades in to the slideshow's viewport.
18783     * - @c "black_fade" - the current item fades to black, and just
18784     *   then, the new item will fade in.
18785     * - @c "horizontal" - the current item slides horizontally, until
18786     *   it gets out of the slideshow's viewport, while the new item
18787     *   comes from the left to take its place.
18788     * - @c "vertical" - the current item slides vertically, until it
18789     *   gets out of the slideshow's viewport, while the new item comes
18790     *   from the bottom to take its place.
18791     * - @c "square" - the new item starts to appear from the middle of
18792     *   the current one, but with a tiny size, growing until its
18793     *   target (full) size and covering the old one.
18794     *
18795     * @warning The stringshared strings get no new references
18796     * exclusive to the user grabbing the list, here, so if you'd like
18797     * to use them out of this call's context, you'd better @c
18798     * eina_stringshare_ref() them.
18799     *
18800     * @see elm_slideshow_transition_set()
18801     *
18802     * @ingroup Slideshow
18803     */
18804    EAPI const Eina_List    *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18805
18806    /**
18807     * Set the current slide transition/effect in use for a given
18808     * slideshow widget
18809     *
18810     * @param obj The slideshow object
18811     * @param transition The new transition's name string
18812     *
18813     * If @p transition is implemented in @p obj's theme (i.e., is
18814     * contained in the list returned by
18815     * elm_slideshow_transitions_get()), this new sliding effect will
18816     * be used on the widget.
18817     *
18818     * @see elm_slideshow_transitions_get() for more details
18819     *
18820     * @ingroup Slideshow
18821     */
18822    EAPI void                elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
18823
18824    /**
18825     * Get the current slide transition/effect in use for a given
18826     * slideshow widget
18827     *
18828     * @param obj The slideshow object
18829     * @return The current transition's name
18830     *
18831     * @see elm_slideshow_transition_set() for more details
18832     *
18833     * @ingroup Slideshow
18834     */
18835    EAPI const char         *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18836
18837    /**
18838     * Set the interval between each image transition on a given
18839     * slideshow widget, <b>and start the slideshow, itself</b>
18840     *
18841     * @param obj The slideshow object
18842     * @param timeout The new displaying timeout for images
18843     *
18844     * After this call, the slideshow widget will start cycling its
18845     * view, sequentially and automatically, with the images of the
18846     * items it has. The time between each new image displayed is going
18847     * to be @p timeout, in @b seconds. If a different timeout was set
18848     * previously and an slideshow was in progress, it will continue
18849     * with the new time between transitions, after this call.
18850     *
18851     * @note A value less than or equal to 0 on @p timeout will disable
18852     * the widget's internal timer, thus halting any slideshow which
18853     * could be happening on @p obj.
18854     *
18855     * @see elm_slideshow_timeout_get()
18856     *
18857     * @ingroup Slideshow
18858     */
18859    EAPI void                elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18860
18861    /**
18862     * Get the interval set for image transitions on a given slideshow
18863     * widget.
18864     *
18865     * @param obj The slideshow object
18866     * @return Returns the timeout set on it
18867     *
18868     * @see elm_slideshow_timeout_set() for more details
18869     *
18870     * @ingroup Slideshow
18871     */
18872    EAPI double              elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18873
18874    /**
18875     * Set if, after a slideshow is started, for a given slideshow
18876     * widget, its items should be displayed cyclically or not.
18877     *
18878     * @param obj The slideshow object
18879     * @param loop Use @c EINA_TRUE to make it cycle through items or
18880     * @c EINA_FALSE for it to stop at the end of @p obj's internal
18881     * list of items
18882     *
18883     * @note elm_slideshow_next() and elm_slideshow_previous() will @b
18884     * ignore what is set by this functions, i.e., they'll @b always
18885     * cycle through items. This affects only the "automatic"
18886     * slideshow, as set by elm_slideshow_timeout_set().
18887     *
18888     * @see elm_slideshow_loop_get()
18889     *
18890     * @ingroup Slideshow
18891     */
18892    EAPI void                elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
18893
18894    /**
18895     * Get if, after a slideshow is started, for a given slideshow
18896     * widget, its items are to be displayed cyclically or not.
18897     *
18898     * @param obj The slideshow object
18899     * @return @c EINA_TRUE, if the items in @p obj will be cycled
18900     * through or @c EINA_FALSE, otherwise
18901     *
18902     * @see elm_slideshow_loop_set() for more details
18903     *
18904     * @ingroup Slideshow
18905     */
18906    EAPI Eina_Bool           elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18907
18908    /**
18909     * Remove all items from a given slideshow widget
18910     *
18911     * @param obj The slideshow object
18912     *
18913     * This removes (and deletes) all items in @p obj, leaving it
18914     * empty.
18915     *
18916     * @see elm_slideshow_item_del(), to remove just one item.
18917     *
18918     * @ingroup Slideshow
18919     */
18920    EAPI void                elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18921
18922    /**
18923     * Get the internal list of items in a given slideshow widget.
18924     *
18925     * @param obj The slideshow object
18926     * @return The list of items (#Elm_Slideshow_Item as data) or
18927     * @c NULL on errors.
18928     *
18929     * This list is @b not to be modified in any way and must not be
18930     * freed. Use the list members with functions like
18931     * elm_slideshow_item_del(), elm_slideshow_item_data_get().
18932     *
18933     * @warning This list is only valid until @p obj object's internal
18934     * items list is changed. It should be fetched again with another
18935     * call to this function when changes happen.
18936     *
18937     * @ingroup Slideshow
18938     */
18939    EAPI const Eina_List    *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18940
18941    /**
18942     * Delete a given item from a slideshow widget.
18943     *
18944     * @param item The slideshow item
18945     *
18946     * @ingroup Slideshow
18947     */
18948    EAPI void                elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18949
18950    /**
18951     * Return the data associated with a given slideshow item
18952     *
18953     * @param item The slideshow item
18954     * @return Returns the data associated to this item
18955     *
18956     * @ingroup Slideshow
18957     */
18958    EAPI void               *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18959
18960    /**
18961     * Returns the currently displayed item, in a given slideshow widget
18962     *
18963     * @param obj The slideshow object
18964     * @return A handle to the item being displayed in @p obj or
18965     * @c NULL, if none is (and on errors)
18966     *
18967     * @ingroup Slideshow
18968     */
18969    EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18970
18971    /**
18972     * Get the real Evas object created to implement the view of a
18973     * given slideshow item
18974     *
18975     * @param item The slideshow item.
18976     * @return the Evas object implementing this item's view.
18977     *
18978     * This returns the actual Evas object used to implement the
18979     * specified slideshow item's view. This may be @c NULL, as it may
18980     * not have been created or may have been deleted, at any time, by
18981     * the slideshow. <b>Do not modify this object</b> (move, resize,
18982     * show, hide, etc.), as the slideshow is controlling it. This
18983     * function is for querying, emitting custom signals or hooking
18984     * lower level callbacks for events on that object. Do not delete
18985     * this object under any circumstances.
18986     *
18987     * @see elm_slideshow_item_data_get()
18988     *
18989     * @ingroup Slideshow
18990     */
18991    EAPI Evas_Object*        elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
18992
18993    /**
18994     * Get the the item, in a given slideshow widget, placed at
18995     * position @p nth, in its internal items list
18996     *
18997     * @param obj The slideshow object
18998     * @param nth The number of the item to grab a handle to (0 being
18999     * the first)
19000     * @return The item stored in @p obj at position @p nth or @c NULL,
19001     * if there's no item with that index (and on errors)
19002     *
19003     * @ingroup Slideshow
19004     */
19005    EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
19006
19007    /**
19008     * Set the current slide layout in use for a given slideshow widget
19009     *
19010     * @param obj The slideshow object
19011     * @param layout The new layout's name string
19012     *
19013     * If @p layout is implemented in @p obj's theme (i.e., is contained
19014     * in the list returned by elm_slideshow_layouts_get()), this new
19015     * images layout will be used on the widget.
19016     *
19017     * @see elm_slideshow_layouts_get() for more details
19018     *
19019     * @ingroup Slideshow
19020     */
19021    EAPI void                elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
19022
19023    /**
19024     * Get the current slide layout in use for a given slideshow widget
19025     *
19026     * @param obj The slideshow object
19027     * @return The current layout's name
19028     *
19029     * @see elm_slideshow_layout_set() for more details
19030     *
19031     * @ingroup Slideshow
19032     */
19033    EAPI const char         *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19034
19035    /**
19036     * Returns the list of @b layout names available, for a given
19037     * slideshow widget.
19038     *
19039     * @param obj The slideshow object
19040     * @return The list of layouts (list of @b stringshared strings
19041     * as data)
19042     *
19043     * Slideshow layouts will change how the widget is to dispose each
19044     * image item in its viewport, with regard to cropping, scaling,
19045     * etc.
19046     *
19047     * The layouts, which come from @p obj's theme, must be an EDC
19048     * data item name @c "layouts" on the theme file, with (prefix)
19049     * names of EDC programs actually implementing them.
19050     *
19051     * The available layouts for slideshows on the default theme are:
19052     * - @c "fullscreen" - item images with original aspect, scaled to
19053     *   touch top and down slideshow borders or, if the image's heigh
19054     *   is not enough, left and right slideshow borders.
19055     * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
19056     *   one, but always leaving 10% of the slideshow's dimensions of
19057     *   distance between the item image's borders and the slideshow
19058     *   borders, for each axis.
19059     *
19060     * @warning The stringshared strings get no new references
19061     * exclusive to the user grabbing the list, here, so if you'd like
19062     * to use them out of this call's context, you'd better @c
19063     * eina_stringshare_ref() them.
19064     *
19065     * @see elm_slideshow_layout_set()
19066     *
19067     * @ingroup Slideshow
19068     */
19069    EAPI const Eina_List    *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19070
19071    /**
19072     * Set the number of items to cache, on a given slideshow widget,
19073     * <b>before the current item</b>
19074     *
19075     * @param obj The slideshow object
19076     * @param count Number of items to cache before the current one
19077     *
19078     * The default value for this property is @c 2. See
19079     * @ref Slideshow_Caching "slideshow caching" for more details.
19080     *
19081     * @see elm_slideshow_cache_before_get()
19082     *
19083     * @ingroup Slideshow
19084     */
19085    EAPI void                elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
19086
19087    /**
19088     * Retrieve the number of items to cache, on a given slideshow widget,
19089     * <b>before the current item</b>
19090     *
19091     * @param obj The slideshow object
19092     * @return The number of items set to be cached before the current one
19093     *
19094     * @see elm_slideshow_cache_before_set() for more details
19095     *
19096     * @ingroup Slideshow
19097     */
19098    EAPI int                 elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19099
19100    /**
19101     * Set the number of items to cache, on a given slideshow widget,
19102     * <b>after the current item</b>
19103     *
19104     * @param obj The slideshow object
19105     * @param count Number of items to cache after the current one
19106     *
19107     * The default value for this property is @c 2. See
19108     * @ref Slideshow_Caching "slideshow caching" for more details.
19109     *
19110     * @see elm_slideshow_cache_after_get()
19111     *
19112     * @ingroup Slideshow
19113     */
19114    EAPI void                elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
19115
19116    /**
19117     * Retrieve the number of items to cache, on a given slideshow widget,
19118     * <b>after the current item</b>
19119     *
19120     * @param obj The slideshow object
19121     * @return The number of items set to be cached after the current one
19122     *
19123     * @see elm_slideshow_cache_after_set() for more details
19124     *
19125     * @ingroup Slideshow
19126     */
19127    EAPI int                 elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19128
19129    /**
19130     * Get the number of items stored in a given slideshow widget
19131     *
19132     * @param obj The slideshow object
19133     * @return The number of items on @p obj, at the moment of this call
19134     *
19135     * @ingroup Slideshow
19136     */
19137    EAPI unsigned int        elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19138
19139    /**
19140     * @}
19141     */
19142
19143    /**
19144     * @defgroup Fileselector File Selector
19145     *
19146     * @image html img/widget/fileselector/preview-00.png
19147     * @image latex img/widget/fileselector/preview-00.eps
19148     *
19149     * A file selector is a widget that allows a user to navigate
19150     * through a file system, reporting file selections back via its
19151     * API.
19152     *
19153     * It contains shortcut buttons for home directory (@c ~) and to
19154     * jump one directory upwards (..), as well as cancel/ok buttons to
19155     * confirm/cancel a given selection. After either one of those two
19156     * former actions, the file selector will issue its @c "done" smart
19157     * callback.
19158     *
19159     * There's a text entry on it, too, showing the name of the current
19160     * selection. There's the possibility of making it editable, so it
19161     * is useful on file saving dialogs on applications, where one
19162     * gives a file name to save contents to, in a given directory in
19163     * the system. This custom file name will be reported on the @c
19164     * "done" smart callback (explained in sequence).
19165     *
19166     * Finally, it has a view to display file system items into in two
19167     * possible forms:
19168     * - list
19169     * - grid
19170     *
19171     * If Elementary is built with support of the Ethumb thumbnailing
19172     * library, the second form of view will display preview thumbnails
19173     * of files which it supports.
19174     *
19175     * Smart callbacks one can register to:
19176     *
19177     * - @c "selected" - the user has clicked on a file (when not in
19178     *      folders-only mode) or directory (when in folders-only mode)
19179     * - @c "directory,open" - the list has been populated with new
19180     *      content (@c event_info is a pointer to the directory's
19181     *      path, a @b stringshared string)
19182     * - @c "done" - the user has clicked on the "ok" or "cancel"
19183     *      buttons (@c event_info is a pointer to the selection's
19184     *      path, a @b stringshared string)
19185     *
19186     * Here is an example on its usage:
19187     * @li @ref fileselector_example
19188     */
19189
19190    /**
19191     * @addtogroup Fileselector
19192     * @{
19193     */
19194
19195    /**
19196     * Defines how a file selector widget is to layout its contents
19197     * (file system entries).
19198     */
19199    typedef enum _Elm_Fileselector_Mode
19200      {
19201         ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
19202         ELM_FILESELECTOR_GRID, /**< layout as a grid */
19203         ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
19204      } Elm_Fileselector_Mode;
19205
19206    /**
19207     * Add a new file selector widget to the given parent Elementary
19208     * (container) object
19209     *
19210     * @param parent The parent object
19211     * @return a new file selector widget handle or @c NULL, on errors
19212     *
19213     * This function inserts a new file selector widget on the canvas.
19214     *
19215     * @ingroup Fileselector
19216     */
19217    EAPI Evas_Object          *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19218
19219    /**
19220     * Enable/disable the file name entry box where the user can type
19221     * in a name for a file, in a given file selector widget
19222     *
19223     * @param obj The file selector object
19224     * @param is_save @c EINA_TRUE to make the file selector a "saving
19225     * dialog", @c EINA_FALSE otherwise
19226     *
19227     * Having the entry editable is useful on file saving dialogs on
19228     * applications, where one gives a file name to save contents to,
19229     * in a given directory in the system. This custom file name will
19230     * be reported on the @c "done" smart callback.
19231     *
19232     * @see elm_fileselector_is_save_get()
19233     *
19234     * @ingroup Fileselector
19235     */
19236    EAPI void                  elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
19237
19238    /**
19239     * Get whether the given file selector is in "saving dialog" mode
19240     *
19241     * @param obj The file selector object
19242     * @return @c EINA_TRUE, if the file selector is in "saving dialog"
19243     * mode, @c EINA_FALSE otherwise (and on errors)
19244     *
19245     * @see elm_fileselector_is_save_set() for more details
19246     *
19247     * @ingroup Fileselector
19248     */
19249    EAPI Eina_Bool             elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19250
19251    /**
19252     * Enable/disable folder-only view for a given file selector widget
19253     *
19254     * @param obj The file selector object
19255     * @param only @c EINA_TRUE to make @p obj only display
19256     * directories, @c EINA_FALSE to make files to be displayed in it
19257     * too
19258     *
19259     * If enabled, the widget's view will only display folder items,
19260     * naturally.
19261     *
19262     * @see elm_fileselector_folder_only_get()
19263     *
19264     * @ingroup Fileselector
19265     */
19266    EAPI void                  elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
19267
19268    /**
19269     * Get whether folder-only view is set for a given file selector
19270     * widget
19271     *
19272     * @param obj The file selector object
19273     * @return only @c EINA_TRUE if @p obj is only displaying
19274     * directories, @c EINA_FALSE if files are being displayed in it
19275     * too (and on errors)
19276     *
19277     * @see elm_fileselector_folder_only_get()
19278     *
19279     * @ingroup Fileselector
19280     */
19281    EAPI Eina_Bool             elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19282
19283    /**
19284     * Enable/disable the "ok" and "cancel" buttons on a given file
19285     * selector widget
19286     *
19287     * @param obj The file selector object
19288     * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
19289     *
19290     * @note A file selector without those buttons will never emit the
19291     * @c "done" smart event, and is only usable if one is just hooking
19292     * to the other two events.
19293     *
19294     * @see elm_fileselector_buttons_ok_cancel_get()
19295     *
19296     * @ingroup Fileselector
19297     */
19298    EAPI void                  elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
19299
19300    /**
19301     * Get whether the "ok" and "cancel" buttons on a given file
19302     * selector widget are being shown.
19303     *
19304     * @param obj The file selector object
19305     * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
19306     * otherwise (and on errors)
19307     *
19308     * @see elm_fileselector_buttons_ok_cancel_set() for more details
19309     *
19310     * @ingroup Fileselector
19311     */
19312    EAPI Eina_Bool             elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19313
19314    /**
19315     * Enable/disable a tree view in the given file selector widget,
19316     * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
19317     *
19318     * @param obj The file selector object
19319     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
19320     * disable
19321     *
19322     * In a tree view, arrows are created on the sides of directories,
19323     * allowing them to expand in place.
19324     *
19325     * @note If it's in other mode, the changes made by this function
19326     * will only be visible when one switches back to "list" mode.
19327     *
19328     * @see elm_fileselector_expandable_get()
19329     *
19330     * @ingroup Fileselector
19331     */
19332    EAPI void                  elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
19333
19334    /**
19335     * Get whether tree view is enabled for the given file selector
19336     * widget
19337     *
19338     * @param obj The file selector object
19339     * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
19340     * otherwise (and or errors)
19341     *
19342     * @see elm_fileselector_expandable_set() for more details
19343     *
19344     * @ingroup Fileselector
19345     */
19346    EAPI Eina_Bool             elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19347
19348    /**
19349     * Set, programmatically, the @b directory that a given file
19350     * selector widget will display contents from
19351     *
19352     * @param obj The file selector object
19353     * @param path The path to display in @p obj
19354     *
19355     * This will change the @b directory that @p obj is displaying. It
19356     * will also clear the text entry area on the @p obj object, which
19357     * displays select files' names.
19358     *
19359     * @see elm_fileselector_path_get()
19360     *
19361     * @ingroup Fileselector
19362     */
19363    EAPI void                  elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
19364
19365    /**
19366     * Get the parent directory's path that a given file selector
19367     * widget is displaying
19368     *
19369     * @param obj The file selector object
19370     * @return The (full) path of the directory the file selector is
19371     * displaying, a @b stringshared string
19372     *
19373     * @see elm_fileselector_path_set()
19374     *
19375     * @ingroup Fileselector
19376     */
19377    EAPI const char           *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19378
19379    /**
19380     * Set, programmatically, the currently selected file/directory in
19381     * the given file selector widget
19382     *
19383     * @param obj The file selector object
19384     * @param path The (full) path to a file or directory
19385     * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
19386     * latter case occurs if the directory or file pointed to do not
19387     * exist.
19388     *
19389     * @see elm_fileselector_selected_get()
19390     *
19391     * @ingroup Fileselector
19392     */
19393    EAPI Eina_Bool             elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
19394
19395    /**
19396     * Get the currently selected item's (full) path, in the given file
19397     * selector widget
19398     *
19399     * @param obj The file selector object
19400     * @return The absolute path of the selected item, a @b
19401     * stringshared string
19402     *
19403     * @note Custom editions on @p obj object's text entry, if made,
19404     * will appear on the return string of this function, naturally.
19405     *
19406     * @see elm_fileselector_selected_set() for more details
19407     *
19408     * @ingroup Fileselector
19409     */
19410    EAPI const char           *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19411
19412    /**
19413     * Set the mode in which a given file selector widget will display
19414     * (layout) file system entries in its view
19415     *
19416     * @param obj The file selector object
19417     * @param mode The mode of the fileselector, being it one of
19418     * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
19419     * first one, naturally, will display the files in a list. The
19420     * latter will make the widget to display its entries in a grid
19421     * form.
19422     *
19423     * @note By using elm_fileselector_expandable_set(), the user may
19424     * trigger a tree view for that list.
19425     *
19426     * @note If Elementary is built with support of the Ethumb
19427     * thumbnailing library, the second form of view will display
19428     * preview thumbnails of files which it supports. You must have
19429     * elm_need_ethumb() called in your Elementary for thumbnailing to
19430     * work, though.
19431     *
19432     * @see elm_fileselector_expandable_set().
19433     * @see elm_fileselector_mode_get().
19434     *
19435     * @ingroup Fileselector
19436     */
19437    EAPI void                  elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
19438
19439    /**
19440     * Get the mode in which a given file selector widget is displaying
19441     * (layouting) file system entries in its view
19442     *
19443     * @param obj The fileselector object
19444     * @return The mode in which the fileselector is at
19445     *
19446     * @see elm_fileselector_mode_set() for more details
19447     *
19448     * @ingroup Fileselector
19449     */
19450    EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19451
19452    /**
19453     * @}
19454     */
19455
19456    /**
19457     * @defgroup Progressbar Progress bar
19458     *
19459     * The progress bar is a widget for visually representing the
19460     * progress status of a given job/task.
19461     *
19462     * A progress bar may be horizontal or vertical. It may display an
19463     * icon besides it, as well as primary and @b units labels. The
19464     * former is meant to label the widget as a whole, while the
19465     * latter, which is formatted with floating point values (and thus
19466     * accepts a <c>printf</c>-style format string, like <c>"%1.2f
19467     * units"</c>), is meant to label the widget's <b>progress
19468     * value</b>. Label, icon and unit strings/objects are @b optional
19469     * for progress bars.
19470     *
19471     * A progress bar may be @b inverted, in which state it gets its
19472     * values inverted, with high values being on the left or top and
19473     * low values on the right or bottom, as opposed to normally have
19474     * the low values on the former and high values on the latter,
19475     * respectively, for horizontal and vertical modes.
19476     *
19477     * The @b span of the progress, as set by
19478     * elm_progressbar_span_size_set(), is its length (horizontally or
19479     * vertically), unless one puts size hints on the widget to expand
19480     * on desired directions, by any container. That length will be
19481     * scaled by the object or applications scaling factor. At any
19482     * point code can query the progress bar for its value with
19483     * elm_progressbar_value_get().
19484     *
19485     * Available widget styles for progress bars:
19486     * - @c "default"
19487     * - @c "wheel" (simple style, no text, no progression, only
19488     *      "pulse" effect is available)
19489     *
19490     * Here is an example on its usage:
19491     * @li @ref progressbar_example
19492     */
19493
19494    /**
19495     * Add a new progress bar widget to the given parent Elementary
19496     * (container) object
19497     *
19498     * @param parent The parent object
19499     * @return a new progress bar widget handle or @c NULL, on errors
19500     *
19501     * This function inserts a new progress bar widget on the canvas.
19502     *
19503     * @ingroup Progressbar
19504     */
19505    EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19506
19507    /**
19508     * Set whether a given progress bar widget is at "pulsing mode" or
19509     * not.
19510     *
19511     * @param obj The progress bar object
19512     * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
19513     * @c EINA_FALSE to put it back to its default one
19514     *
19515     * By default, progress bars will display values from the low to
19516     * high value boundaries. There are, though, contexts in which the
19517     * state of progression of a given task is @b unknown.  For those,
19518     * one can set a progress bar widget to a "pulsing state", to give
19519     * the user an idea that some computation is being held, but
19520     * without exact progress values. In the default theme it will
19521     * animate its bar with the contents filling in constantly and back
19522     * to non-filled, in a loop. To start and stop this pulsing
19523     * animation, one has to explicitly call elm_progressbar_pulse().
19524     *
19525     * @see elm_progressbar_pulse_get()
19526     * @see elm_progressbar_pulse()
19527     *
19528     * @ingroup Progressbar
19529     */
19530    EAPI void         elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
19531
19532    /**
19533     * Get whether a given progress bar widget is at "pulsing mode" or
19534     * not.
19535     *
19536     * @param obj The progress bar object
19537     * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
19538     * if it's in the default one (and on errors)
19539     *
19540     * @ingroup Progressbar
19541     */
19542    EAPI Eina_Bool    elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19543
19544    /**
19545     * Start/stop a given progress bar "pulsing" animation, if its
19546     * under that mode
19547     *
19548     * @param obj The progress bar object
19549     * @param state @c EINA_TRUE, to @b start the pulsing animation,
19550     * @c EINA_FALSE to @b stop it
19551     *
19552     * @note This call won't do anything if @p obj is not under "pulsing mode".
19553     *
19554     * @see elm_progressbar_pulse_set() for more details.
19555     *
19556     * @ingroup Progressbar
19557     */
19558    EAPI void         elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19559
19560    /**
19561     * Set the progress value (in percentage) on a given progress bar
19562     * widget
19563     *
19564     * @param obj The progress bar object
19565     * @param val The progress value (@b must be between @c 0.0 and @c
19566     * 1.0)
19567     *
19568     * Use this call to set progress bar levels.
19569     *
19570     * @note If you passes a value out of the specified range for @p
19571     * val, it will be interpreted as the @b closest of the @b boundary
19572     * values in the range.
19573     *
19574     * @ingroup Progressbar
19575     */
19576    EAPI void         elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
19577
19578    /**
19579     * Get the progress value (in percentage) on a given progress bar
19580     * widget
19581     *
19582     * @param obj The progress bar object
19583     * @return The value of the progressbar
19584     *
19585     * @see elm_progressbar_value_set() for more details
19586     *
19587     * @ingroup Progressbar
19588     */
19589    EAPI double       elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19590
19591    /**
19592     * Set the label of a given progress bar widget
19593     *
19594     * @param obj The progress bar object
19595     * @param label The text label string, in UTF-8
19596     *
19597     * @ingroup Progressbar
19598     * @deprecated use elm_object_text_set() instead.
19599     */
19600    EINA_DEPRECATED EAPI void         elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19601
19602    /**
19603     * Get the label of a given progress bar widget
19604     *
19605     * @param obj The progressbar object
19606     * @return The text label string, in UTF-8
19607     *
19608     * @ingroup Progressbar
19609     * @deprecated use elm_object_text_set() instead.
19610     */
19611    EINA_DEPRECATED EAPI const char  *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19612
19613    /**
19614     * Set the icon object of a given progress bar widget
19615     *
19616     * @param obj The progress bar object
19617     * @param icon The icon object
19618     *
19619     * Use this call to decorate @p obj with an icon next to it.
19620     *
19621     * @note Once the icon object is set, a previously set one will be
19622     * deleted. If you want to keep that old content object, use the
19623     * elm_progressbar_icon_unset() function.
19624     *
19625     * @see elm_progressbar_icon_get()
19626     *
19627     * @ingroup Progressbar
19628     */
19629    EAPI void         elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19630
19631    /**
19632     * Retrieve the icon object set for a given progress bar widget
19633     *
19634     * @param obj The progress bar object
19635     * @return The icon object's handle, if @p obj had one set, or @c NULL,
19636     * otherwise (and on errors)
19637     *
19638     * @see elm_progressbar_icon_set() for more details
19639     *
19640     * @ingroup Progressbar
19641     */
19642    EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19643
19644    /**
19645     * Unset an icon set on a given progress bar widget
19646     *
19647     * @param obj The progress bar object
19648     * @return The icon object that was being used, if any was set, or
19649     * @c NULL, otherwise (and on errors)
19650     *
19651     * This call will unparent and return the icon object which was set
19652     * for this widget, previously, on success.
19653     *
19654     * @see elm_progressbar_icon_set() for more details
19655     *
19656     * @ingroup Progressbar
19657     */
19658    EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19659
19660    /**
19661     * Set the (exact) length of the bar region of a given progress bar
19662     * widget
19663     *
19664     * @param obj The progress bar object
19665     * @param size The length of the progress bar's bar region
19666     *
19667     * This sets the minimum width (when in horizontal mode) or height
19668     * (when in vertical mode) of the actual bar area of the progress
19669     * bar @p obj. This in turn affects the object's minimum size. Use
19670     * this when you're not setting other size hints expanding on the
19671     * given direction (like weight and alignment hints) and you would
19672     * like it to have a specific size.
19673     *
19674     * @note Icon, label and unit text around @p obj will require their
19675     * own space, which will make @p obj to require more the @p size,
19676     * actually.
19677     *
19678     * @see elm_progressbar_span_size_get()
19679     *
19680     * @ingroup Progressbar
19681     */
19682    EAPI void         elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
19683
19684    /**
19685     * Get the length set for the bar region of a given progress bar
19686     * widget
19687     *
19688     * @param obj The progress bar object
19689     * @return The length of the progress bar's bar region
19690     *
19691     * If that size was not set previously, with
19692     * elm_progressbar_span_size_set(), this call will return @c 0.
19693     *
19694     * @ingroup Progressbar
19695     */
19696    EAPI Evas_Coord   elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19697
19698    /**
19699     * Set the format string for a given progress bar widget's units
19700     * label
19701     *
19702     * @param obj The progress bar object
19703     * @param format The format string for @p obj's units label
19704     *
19705     * If @c NULL is passed on @p format, it will make @p obj's units
19706     * area to be hidden completely. If not, it'll set the <b>format
19707     * string</b> for the units label's @b text. The units label is
19708     * provided a floating point value, so the units text is up display
19709     * at most one floating point falue. Note that the units label is
19710     * optional. Use a format string such as "%1.2f meters" for
19711     * example.
19712     *
19713     * @note The default format string for a progress bar is an integer
19714     * percentage, as in @c "%.0f %%".
19715     *
19716     * @see elm_progressbar_unit_format_get()
19717     *
19718     * @ingroup Progressbar
19719     */
19720    EAPI void         elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
19721
19722    /**
19723     * Retrieve the format string set for a given progress bar widget's
19724     * units label
19725     *
19726     * @param obj The progress bar object
19727     * @return The format set string for @p obj's units label or
19728     * @c NULL, if none was set (and on errors)
19729     *
19730     * @see elm_progressbar_unit_format_set() for more details
19731     *
19732     * @ingroup Progressbar
19733     */
19734    EAPI const char  *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19735
19736    /**
19737     * Set the orientation of a given progress bar widget
19738     *
19739     * @param obj The progress bar object
19740     * @param horizontal Use @c EINA_TRUE to make @p obj to be
19741     * @b horizontal, @c EINA_FALSE to make it @b vertical
19742     *
19743     * Use this function to change how your progress bar is to be
19744     * disposed: vertically or horizontally.
19745     *
19746     * @see elm_progressbar_horizontal_get()
19747     *
19748     * @ingroup Progressbar
19749     */
19750    EAPI void         elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
19751
19752    /**
19753     * Retrieve the orientation of a given progress bar widget
19754     *
19755     * @param obj The progress bar object
19756     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
19757     * @c EINA_FALSE if it's @b vertical (and on errors)
19758     *
19759     * @see elm_progressbar_horizontal_set() for more details
19760     *
19761     * @ingroup Progressbar
19762     */
19763    EAPI Eina_Bool    elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19764
19765    /**
19766     * Invert a given progress bar widget's displaying values order
19767     *
19768     * @param obj The progress bar object
19769     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
19770     * @c EINA_FALSE to bring it back to default, non-inverted values.
19771     *
19772     * A progress bar may be @b inverted, in which state it gets its
19773     * values inverted, with high values being on the left or top and
19774     * low values on the right or bottom, as opposed to normally have
19775     * the low values on the former and high values on the latter,
19776     * respectively, for horizontal and vertical modes.
19777     *
19778     * @see elm_progressbar_inverted_get()
19779     *
19780     * @ingroup Progressbar
19781     */
19782    EAPI void         elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
19783
19784    /**
19785     * Get whether a given progress bar widget's displaying values are
19786     * inverted or not
19787     *
19788     * @param obj The progress bar object
19789     * @return @c EINA_TRUE, if @p obj has inverted values,
19790     * @c EINA_FALSE otherwise (and on errors)
19791     *
19792     * @see elm_progressbar_inverted_set() for more details
19793     *
19794     * @ingroup Progressbar
19795     */
19796    EAPI Eina_Bool    elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19797
19798    /**
19799     * @defgroup Separator Separator
19800     *
19801     * @brief Separator is a very thin object used to separate other objects.
19802     *
19803     * A separator can be vertical or horizontal.
19804     *
19805     * @ref tutorial_separator is a good example of how to use a separator.
19806     * @{
19807     */
19808    /**
19809     * @brief Add a separator object to @p parent
19810     *
19811     * @param parent The parent object
19812     *
19813     * @return The separator object, or NULL upon failure
19814     */
19815    EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19816    /**
19817     * @brief Set the horizontal mode of a separator object
19818     *
19819     * @param obj The separator object
19820     * @param horizontal If true, the separator is horizontal
19821     */
19822    EAPI void         elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
19823    /**
19824     * @brief Get the horizontal mode of a separator object
19825     *
19826     * @param obj The separator object
19827     * @return If true, the separator is horizontal
19828     *
19829     * @see elm_separator_horizontal_set()
19830     */
19831    EAPI Eina_Bool    elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19832    /**
19833     * @}
19834     */
19835
19836    /**
19837     * @defgroup Spinner Spinner
19838     * @ingroup Elementary
19839     *
19840     * @image html img/widget/spinner/preview-00.png
19841     * @image latex img/widget/spinner/preview-00.eps
19842     *
19843     * A spinner is a widget which allows the user to increase or decrease
19844     * numeric values using arrow buttons, or edit values directly, clicking
19845     * over it and typing the new value.
19846     *
19847     * By default the spinner will not wrap and has a label
19848     * of "%.0f" (just showing the integer value of the double).
19849     *
19850     * A spinner has a label that is formatted with floating
19851     * point values and thus accepts a printf-style format string, like
19852     * “%1.2f units”.
19853     *
19854     * It also allows specific values to be replaced by pre-defined labels.
19855     *
19856     * Smart callbacks one can register to:
19857     *
19858     * - "changed" - Whenever the spinner value is changed.
19859     * - "delay,changed" - A short time after the value is changed by the user.
19860     *    This will be called only when the user stops dragging for a very short
19861     *    period or when they release their finger/mouse, so it avoids possibly
19862     *    expensive reactions to the value change.
19863     *
19864     * Available styles for it:
19865     * - @c "default";
19866     * - @c "vertical": up/down buttons at the right side and text left aligned.
19867     *
19868     * Here is an example on its usage:
19869     * @ref spinner_example
19870     */
19871
19872    /**
19873     * @addtogroup Spinner
19874     * @{
19875     */
19876
19877    /**
19878     * Add a new spinner widget to the given parent Elementary
19879     * (container) object.
19880     *
19881     * @param parent The parent object.
19882     * @return a new spinner widget handle or @c NULL, on errors.
19883     *
19884     * This function inserts a new spinner widget on the canvas.
19885     *
19886     * @ingroup Spinner
19887     *
19888     */
19889    EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19890
19891    /**
19892     * Set the format string of the displayed label.
19893     *
19894     * @param obj The spinner object.
19895     * @param fmt The format string for the label display.
19896     *
19897     * If @c NULL, this sets the format to "%.0f". If not it sets the format
19898     * string for the label text. The label text is provided a floating point
19899     * value, so the label text can display up to 1 floating point value.
19900     * Note that this is optional.
19901     *
19902     * Use a format string such as "%1.2f meters" for example, and it will
19903     * display values like: "3.14 meters" for a value equal to 3.14159.
19904     *
19905     * Default is "%0.f".
19906     *
19907     * @see elm_spinner_label_format_get()
19908     *
19909     * @ingroup Spinner
19910     */
19911    EAPI void         elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
19912
19913    /**
19914     * Get the label format of the spinner.
19915     *
19916     * @param obj The spinner object.
19917     * @return The text label format string in UTF-8.
19918     *
19919     * @see elm_spinner_label_format_set() for details.
19920     *
19921     * @ingroup Spinner
19922     */
19923    EAPI const char  *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19924
19925    /**
19926     * Set the minimum and maximum values for the spinner.
19927     *
19928     * @param obj The spinner object.
19929     * @param min The minimum value.
19930     * @param max The maximum value.
19931     *
19932     * Define the allowed range of values to be selected by the user.
19933     *
19934     * If actual value is less than @p min, it will be updated to @p min. If it
19935     * is bigger then @p max, will be updated to @p max. Actual value can be
19936     * get with elm_spinner_value_get().
19937     *
19938     * By default, min is equal to 0, and max is equal to 100.
19939     *
19940     * @warning Maximum must be greater than minimum.
19941     *
19942     * @see elm_spinner_min_max_get()
19943     *
19944     * @ingroup Spinner
19945     */
19946    EAPI void         elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
19947
19948    /**
19949     * Get the minimum and maximum values of the spinner.
19950     *
19951     * @param obj The spinner object.
19952     * @param min Pointer where to store the minimum value.
19953     * @param max Pointer where to store the maximum value.
19954     *
19955     * @note If only one value is needed, the other pointer can be passed
19956     * as @c NULL.
19957     *
19958     * @see elm_spinner_min_max_set() for details.
19959     *
19960     * @ingroup Spinner
19961     */
19962    EAPI void         elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
19963
19964    /**
19965     * Set the step used to increment or decrement the spinner value.
19966     *
19967     * @param obj The spinner object.
19968     * @param step The step value.
19969     *
19970     * This value will be incremented or decremented to the displayed value.
19971     * It will be incremented while the user keep right or top arrow pressed,
19972     * and will be decremented while the user keep left or bottom arrow pressed.
19973     *
19974     * The interval to increment / decrement can be set with
19975     * elm_spinner_interval_set().
19976     *
19977     * By default step value is equal to 1.
19978     *
19979     * @see elm_spinner_step_get()
19980     *
19981     * @ingroup Spinner
19982     */
19983    EAPI void         elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
19984
19985    /**
19986     * Get the step used to increment or decrement the spinner value.
19987     *
19988     * @param obj The spinner object.
19989     * @return The step value.
19990     *
19991     * @see elm_spinner_step_get() for more details.
19992     *
19993     * @ingroup Spinner
19994     */
19995    EAPI double       elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19996
19997    /**
19998     * Set the value the spinner displays.
19999     *
20000     * @param obj The spinner object.
20001     * @param val The value to be displayed.
20002     *
20003     * Value will be presented on the label following format specified with
20004     * elm_spinner_format_set().
20005     *
20006     * @warning The value must to be between min and max values. This values
20007     * are set by elm_spinner_min_max_set().
20008     *
20009     * @see elm_spinner_value_get().
20010     * @see elm_spinner_format_set().
20011     * @see elm_spinner_min_max_set().
20012     *
20013     * @ingroup Spinner
20014     */
20015    EAPI void         elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
20016
20017    /**
20018     * Get the value displayed by the spinner.
20019     *
20020     * @param obj The spinner object.
20021     * @return The value displayed.
20022     *
20023     * @see elm_spinner_value_set() for details.
20024     *
20025     * @ingroup Spinner
20026     */
20027    EAPI double       elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20028
20029    /**
20030     * Set whether the spinner should wrap when it reaches its
20031     * minimum or maximum value.
20032     *
20033     * @param obj The spinner object.
20034     * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
20035     * disable it.
20036     *
20037     * Disabled by default. If disabled, when the user tries to increment the
20038     * value,
20039     * but displayed value plus step value is bigger than maximum value,
20040     * the spinner
20041     * won't allow it. The same happens when the user tries to decrement it,
20042     * but the value less step is less than minimum value.
20043     *
20044     * When wrap is enabled, in such situations it will allow these changes,
20045     * but will get the value that would be less than minimum and subtracts
20046     * from maximum. Or add the value that would be more than maximum to
20047     * the minimum.
20048     *
20049     * E.g.:
20050     * @li min value = 10
20051     * @li max value = 50
20052     * @li step value = 20
20053     * @li displayed value = 20
20054     *
20055     * When the user decrement value (using left or bottom arrow), it will
20056     * displays @c 40, because max - (min - (displayed - step)) is
20057     * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
20058     *
20059     * @see elm_spinner_wrap_get().
20060     *
20061     * @ingroup Spinner
20062     */
20063    EAPI void         elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
20064
20065    /**
20066     * Get whether the spinner should wrap when it reaches its
20067     * minimum or maximum value.
20068     *
20069     * @param obj The spinner object
20070     * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
20071     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20072     *
20073     * @see elm_spinner_wrap_set() for details.
20074     *
20075     * @ingroup Spinner
20076     */
20077    EAPI Eina_Bool    elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20078
20079    /**
20080     * Set whether the spinner can be directly edited by the user or not.
20081     *
20082     * @param obj The spinner object.
20083     * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
20084     * don't allow users to edit it directly.
20085     *
20086     * Spinner objects can have edition @b disabled, in which state they will
20087     * be changed only by arrows.
20088     * Useful for contexts
20089     * where you don't want your users to interact with it writting the value.
20090     * Specially
20091     * when using special values, the user can see real value instead
20092     * of special label on edition.
20093     *
20094     * It's enabled by default.
20095     *
20096     * @see elm_spinner_editable_get()
20097     *
20098     * @ingroup Spinner
20099     */
20100    EAPI void         elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
20101
20102    /**
20103     * Get whether the spinner can be directly edited by the user or not.
20104     *
20105     * @param obj The spinner object.
20106     * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
20107     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20108     *
20109     * @see elm_spinner_editable_set() for details.
20110     *
20111     * @ingroup Spinner
20112     */
20113    EAPI Eina_Bool    elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20114
20115    /**
20116     * Set a special string to display in the place of the numerical value.
20117     *
20118     * @param obj The spinner object.
20119     * @param value The value to be replaced.
20120     * @param label The label to be used.
20121     *
20122     * It's useful for cases when a user should select an item that is
20123     * better indicated by a label than a value. For example, weekdays or months.
20124     *
20125     * E.g.:
20126     * @code
20127     * sp = elm_spinner_add(win);
20128     * elm_spinner_min_max_set(sp, 1, 3);
20129     * elm_spinner_special_value_add(sp, 1, "January");
20130     * elm_spinner_special_value_add(sp, 2, "February");
20131     * elm_spinner_special_value_add(sp, 3, "March");
20132     * evas_object_show(sp);
20133     * @endcode
20134     *
20135     * @ingroup Spinner
20136     */
20137    EAPI void         elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
20138
20139    /**
20140     * Set the interval on time updates for an user mouse button hold
20141     * on spinner widgets' arrows.
20142     *
20143     * @param obj The spinner object.
20144     * @param interval The (first) interval value in seconds.
20145     *
20146     * This interval value is @b decreased while the user holds the
20147     * mouse pointer either incrementing or decrementing spinner's value.
20148     *
20149     * This helps the user to get to a given value distant from the
20150     * current one easier/faster, as it will start to change quicker and
20151     * quicker on mouse button holds.
20152     *
20153     * The calculation for the next change interval value, starting from
20154     * the one set with this call, is the previous interval divided by
20155     * @c 1.05, so it decreases a little bit.
20156     *
20157     * The default starting interval value for automatic changes is
20158     * @c 0.85 seconds.
20159     *
20160     * @see elm_spinner_interval_get()
20161     *
20162     * @ingroup Spinner
20163     */
20164    EAPI void         elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
20165
20166    /**
20167     * Get the interval on time updates for an user mouse button hold
20168     * on spinner widgets' arrows.
20169     *
20170     * @param obj The spinner object.
20171     * @return The (first) interval value, in seconds, set on it.
20172     *
20173     * @see elm_spinner_interval_set() for more details.
20174     *
20175     * @ingroup Spinner
20176     */
20177    EAPI double       elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20178
20179    /**
20180     * @}
20181     */
20182
20183    /**
20184     * @defgroup Index Index
20185     *
20186     * @image html img/widget/index/preview-00.png
20187     * @image latex img/widget/index/preview-00.eps
20188     *
20189     * An index widget gives you an index for fast access to whichever
20190     * group of other UI items one might have. It's a list of text
20191     * items (usually letters, for alphabetically ordered access).
20192     *
20193     * Index widgets are by default hidden and just appear when the
20194     * user clicks over it's reserved area in the canvas. In its
20195     * default theme, it's an area one @ref Fingers "finger" wide on
20196     * the right side of the index widget's container.
20197     *
20198     * When items on the index are selected, smart callbacks get
20199     * called, so that its user can make other container objects to
20200     * show a given area or child object depending on the index item
20201     * selected. You'd probably be using an index together with @ref
20202     * List "lists", @ref Genlist "generic lists" or @ref Gengrid
20203     * "general grids".
20204     *
20205     * Smart events one  can add callbacks for are:
20206     * - @c "changed" - When the selected index item changes. @c
20207     *      event_info is the selected item's data pointer.
20208     * - @c "delay,changed" - When the selected index item changes, but
20209     *      after a small idling period. @c event_info is the selected
20210     *      item's data pointer.
20211     * - @c "selected" - When the user releases a mouse button and
20212     *      selects an item. @c event_info is the selected item's data
20213     *      pointer.
20214     * - @c "level,up" - when the user moves a finger from the first
20215     *      level to the second level
20216     * - @c "level,down" - when the user moves a finger from the second
20217     *      level to the first level
20218     *
20219     * The @c "delay,changed" event is so that it'll wait a small time
20220     * before actually reporting those events and, moreover, just the
20221     * last event happening on those time frames will actually be
20222     * reported.
20223     *
20224     * Here are some examples on its usage:
20225     * @li @ref index_example_01
20226     * @li @ref index_example_02
20227     */
20228
20229    /**
20230     * @addtogroup Index
20231     * @{
20232     */
20233
20234    typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
20235
20236    /**
20237     * Add a new index widget to the given parent Elementary
20238     * (container) object
20239     *
20240     * @param parent The parent object
20241     * @return a new index widget handle or @c NULL, on errors
20242     *
20243     * This function inserts a new index widget on the canvas.
20244     *
20245     * @ingroup Index
20246     */
20247    EAPI Evas_Object    *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20248
20249    /**
20250     * Set whether a given index widget is or not visible,
20251     * programatically.
20252     *
20253     * @param obj The index object
20254     * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
20255     *
20256     * Not to be confused with visible as in @c evas_object_show() --
20257     * visible with regard to the widget's auto hiding feature.
20258     *
20259     * @see elm_index_active_get()
20260     *
20261     * @ingroup Index
20262     */
20263    EAPI void            elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
20264
20265    /**
20266     * Get whether a given index widget is currently visible or not.
20267     *
20268     * @param obj The index object
20269     * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
20270     *
20271     * @see elm_index_active_set() for more details
20272     *
20273     * @ingroup Index
20274     */
20275    EAPI Eina_Bool       elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20276
20277    /**
20278     * Set the items level for a given index widget.
20279     *
20280     * @param obj The index object.
20281     * @param level @c 0 or @c 1, the currently implemented levels.
20282     *
20283     * @see elm_index_item_level_get()
20284     *
20285     * @ingroup Index
20286     */
20287    EAPI void            elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20288
20289    /**
20290     * Get the items level set for a given index widget.
20291     *
20292     * @param obj The index object.
20293     * @return @c 0 or @c 1, which are the levels @p obj might be at.
20294     *
20295     * @see elm_index_item_level_set() for more information
20296     *
20297     * @ingroup Index
20298     */
20299    EAPI int             elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20300
20301    /**
20302     * Returns the last selected item's data, for a given index widget.
20303     *
20304     * @param obj The index object.
20305     * @return The item @b data associated to the last selected item on
20306     * @p obj (or @c NULL, on errors).
20307     *
20308     * @warning The returned value is @b not an #Elm_Index_Item item
20309     * handle, but the data associated to it (see the @c item parameter
20310     * in elm_index_item_append(), as an example).
20311     *
20312     * @ingroup Index
20313     */
20314    EAPI void           *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20315
20316    /**
20317     * Append a new item on a given index widget.
20318     *
20319     * @param obj The index object.
20320     * @param letter Letter under which the item should be indexed
20321     * @param item The item data to set for the index's item
20322     *
20323     * Despite the most common usage of the @p letter argument is for
20324     * single char strings, one could use arbitrary strings as index
20325     * entries.
20326     *
20327     * @c item will be the pointer returned back on @c "changed", @c
20328     * "delay,changed" and @c "selected" smart events.
20329     *
20330     * @ingroup Index
20331     */
20332    EAPI void            elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
20333
20334    /**
20335     * Prepend a new item on a given index widget.
20336     *
20337     * @param obj The index object.
20338     * @param letter Letter under which the item should be indexed
20339     * @param item The item data to set for the index's item
20340     *
20341     * Despite the most common usage of the @p letter argument is for
20342     * single char strings, one could use arbitrary strings as index
20343     * entries.
20344     *
20345     * @c item will be the pointer returned back on @c "changed", @c
20346     * "delay,changed" and @c "selected" smart events.
20347     *
20348     * @ingroup Index
20349     */
20350    EAPI void            elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
20351
20352    /**
20353     * Append a new item, on a given index widget, <b>after the item
20354     * having @p relative as data</b>.
20355     *
20356     * @param obj The index object.
20357     * @param letter Letter under which the item should be indexed
20358     * @param item The item data to set for the index's item
20359     * @param relative The item data of the index item to be the
20360     * predecessor of this new one
20361     *
20362     * Despite the most common usage of the @p letter argument is for
20363     * single char strings, one could use arbitrary strings as index
20364     * entries.
20365     *
20366     * @c item will be the pointer returned back on @c "changed", @c
20367     * "delay,changed" and @c "selected" smart events.
20368     *
20369     * @note If @p relative is @c NULL or if it's not found to be data
20370     * set on any previous item on @p obj, this function will behave as
20371     * elm_index_item_append().
20372     *
20373     * @ingroup Index
20374     */
20375    EAPI void            elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
20376
20377    /**
20378     * Prepend a new item, on a given index widget, <b>after the item
20379     * having @p relative as data</b>.
20380     *
20381     * @param obj The index object.
20382     * @param letter Letter under which the item should be indexed
20383     * @param item The item data to set for the index's item
20384     * @param relative The item data of the index item to be the
20385     * successor of this new one
20386     *
20387     * Despite the most common usage of the @p letter argument is for
20388     * single char strings, one could use arbitrary strings as index
20389     * entries.
20390     *
20391     * @c item will be the pointer returned back on @c "changed", @c
20392     * "delay,changed" and @c "selected" smart events.
20393     *
20394     * @note If @p relative is @c NULL or if it's not found to be data
20395     * set on any previous item on @p obj, this function will behave as
20396     * elm_index_item_prepend().
20397     *
20398     * @ingroup Index
20399     */
20400    EAPI void            elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
20401
20402    /**
20403     * Insert a new item into the given index widget, using @p cmp_func
20404     * function to sort items (by item handles).
20405     *
20406     * @param obj The index object.
20407     * @param letter Letter under which the item should be indexed
20408     * @param item The item data to set for the index's item
20409     * @param cmp_func The comparing function to be used to sort index
20410     * items <b>by #Elm_Index_Item item handles</b>
20411     * @param cmp_data_func A @b fallback function to be called for the
20412     * sorting of index items <b>by item data</b>). It will be used
20413     * when @p cmp_func returns @c 0 (equality), which means an index
20414     * item with provided item data already exists. To decide which
20415     * data item should be pointed to by the index item in question, @p
20416     * cmp_data_func will be used. If @p cmp_data_func returns a
20417     * non-negative value, the previous index item data will be
20418     * replaced by the given @p item pointer. If the previous data need
20419     * to be freed, it should be done by the @p cmp_data_func function,
20420     * because all references to it will be lost. If this function is
20421     * not provided (@c NULL is given), index items will be @b
20422     * duplicated, if @p cmp_func returns @c 0.
20423     *
20424     * Despite the most common usage of the @p letter argument is for
20425     * single char strings, one could use arbitrary strings as index
20426     * entries.
20427     *
20428     * @c item will be the pointer returned back on @c "changed", @c
20429     * "delay,changed" and @c "selected" smart events.
20430     *
20431     * @ingroup Index
20432     */
20433    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);
20434
20435    /**
20436     * Remove an item from a given index widget, <b>to be referenced by
20437     * it's data value</b>.
20438     *
20439     * @param obj The index object
20440     * @param item The item's data pointer for the item to be removed
20441     * from @p obj
20442     *
20443     * If a deletion callback is set, via elm_index_item_del_cb_set(),
20444     * that callback function will be called by this one.
20445     *
20446     * @warning The item to be removed from @p obj will be found via
20447     * its item data pointer, and not by an #Elm_Index_Item handle.
20448     *
20449     * @ingroup Index
20450     */
20451    EAPI void            elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
20452
20453    /**
20454     * Find a given index widget's item, <b>using item data</b>.
20455     *
20456     * @param obj The index object
20457     * @param item The item data pointed to by the desired index item
20458     * @return The index item handle, if found, or @c NULL otherwise
20459     *
20460     * @ingroup Index
20461     */
20462    EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
20463
20464    /**
20465     * Removes @b all items from a given index widget.
20466     *
20467     * @param obj The index object.
20468     *
20469     * If deletion callbacks are set, via elm_index_item_del_cb_set(),
20470     * that callback function will be called for each item in @p obj.
20471     *
20472     * @ingroup Index
20473     */
20474    EAPI void            elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20475
20476    /**
20477     * Go to a given items level on a index widget
20478     *
20479     * @param obj The index object
20480     * @param level The index level (one of @c 0 or @c 1)
20481     *
20482     * @ingroup Index
20483     */
20484    EAPI void            elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20485
20486    /**
20487     * Return the data associated with a given index widget item
20488     *
20489     * @param it The index widget item handle
20490     * @return The data associated with @p it
20491     *
20492     * @see elm_index_item_data_set()
20493     *
20494     * @ingroup Index
20495     */
20496    EAPI void           *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
20497
20498    /**
20499     * Set the data associated with a given index widget item
20500     *
20501     * @param it The index widget item handle
20502     * @param data The new data pointer to set to @p it
20503     *
20504     * This sets new item data on @p it.
20505     *
20506     * @warning The old data pointer won't be touched by this function, so
20507     * the user had better to free that old data himself/herself.
20508     *
20509     * @ingroup Index
20510     */
20511    EAPI void            elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
20512
20513    /**
20514     * Set the function to be called when a given index widget item is freed.
20515     *
20516     * @param it The item to set the callback on
20517     * @param func The function to call on the item's deletion
20518     *
20519     * When called, @p func will have both @c data and @c event_info
20520     * arguments with the @p it item's data value and, naturally, the
20521     * @c obj argument with a handle to the parent index widget.
20522     *
20523     * @ingroup Index
20524     */
20525    EAPI void            elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
20526
20527    /**
20528     * Get the letter (string) set on a given index widget item.
20529     *
20530     * @param it The index item handle
20531     * @return The letter string set on @p it
20532     *
20533     * @ingroup Index
20534     */
20535    EAPI const char     *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
20536
20537    /**
20538     * @}
20539     */
20540
20541    /**
20542     * @defgroup Photocam Photocam
20543     *
20544     * @image html img/widget/photocam/preview-00.png
20545     * @image latex img/widget/photocam/preview-00.eps
20546     *
20547     * This is a widget specifically for displaying high-resolution digital
20548     * camera photos giving speedy feedback (fast load), low memory footprint
20549     * and zooming and panning as well as fitting logic. It is entirely focused
20550     * on jpeg images, and takes advantage of properties of the jpeg format (via
20551     * evas loader features in the jpeg loader).
20552     *
20553     * Signals that you can add callbacks for are:
20554     * @li "clicked" - This is called when a user has clicked the photo without
20555     *                 dragging around.
20556     * @li "press" - This is called when a user has pressed down on the photo.
20557     * @li "longpressed" - This is called when a user has pressed down on the
20558     *                     photo for a long time without dragging around.
20559     * @li "clicked,double" - This is called when a user has double-clicked the
20560     *                        photo.
20561     * @li "load" - Photo load begins.
20562     * @li "loaded" - This is called when the image file load is complete for the
20563     *                first view (low resolution blurry version).
20564     * @li "load,detail" - Photo detailed data load begins.
20565     * @li "loaded,detail" - This is called when the image file load is complete
20566     *                      for the detailed image data (full resolution needed).
20567     * @li "zoom,start" - Zoom animation started.
20568     * @li "zoom,stop" - Zoom animation stopped.
20569     * @li "zoom,change" - Zoom changed when using an auto zoom mode.
20570     * @li "scroll" - the content has been scrolled (moved)
20571     * @li "scroll,anim,start" - scrolling animation has started
20572     * @li "scroll,anim,stop" - scrolling animation has stopped
20573     * @li "scroll,drag,start" - dragging the contents around has started
20574     * @li "scroll,drag,stop" - dragging the contents around has stopped
20575     *
20576     * @ref tutorial_photocam shows the API in action.
20577     * @{
20578     */
20579    /**
20580     * @brief Types of zoom available.
20581     */
20582    typedef enum _Elm_Photocam_Zoom_Mode
20583      {
20584         ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
20585         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
20586         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
20587         ELM_PHOTOCAM_ZOOM_MODE_LAST
20588      } Elm_Photocam_Zoom_Mode;
20589    /**
20590     * @brief Add a new Photocam object
20591     *
20592     * @param parent The parent object
20593     * @return The new object or NULL if it cannot be created
20594     */
20595    EAPI Evas_Object           *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20596    /**
20597     * @brief Set the photo file to be shown
20598     *
20599     * @param obj The photocam object
20600     * @param file The photo file
20601     * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
20602     *
20603     * This sets (and shows) the specified file (with a relative or absolute
20604     * path) and will return a load error (same error that
20605     * evas_object_image_load_error_get() will return). The image will change and
20606     * adjust its size at this point and begin a background load process for this
20607     * photo that at some time in the future will be displayed at the full
20608     * quality needed.
20609     */
20610    EAPI Evas_Load_Error        elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
20611    /**
20612     * @brief Returns the path of the current image file
20613     *
20614     * @param obj The photocam object
20615     * @return Returns the path
20616     *
20617     * @see elm_photocam_file_set()
20618     */
20619    EAPI const char            *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20620    /**
20621     * @brief Set the zoom level of the photo
20622     *
20623     * @param obj The photocam object
20624     * @param zoom The zoom level to set
20625     *
20626     * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
20627     * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
20628     * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
20629     * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
20630     * 16, 32, etc.).
20631     */
20632    EAPI void                   elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
20633    /**
20634     * @brief Get the zoom level of the photo
20635     *
20636     * @param obj The photocam object
20637     * @return The current zoom level
20638     *
20639     * This returns the current zoom level of the photocam object. Note that if
20640     * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
20641     * (which is the default), the zoom level may be changed at any time by the
20642     * photocam object itself to account for photo size and photocam viewpoer
20643     * size.
20644     *
20645     * @see elm_photocam_zoom_set()
20646     * @see elm_photocam_zoom_mode_set()
20647     */
20648    EAPI double                 elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20649    /**
20650     * @brief Set the zoom mode
20651     *
20652     * @param obj The photocam object
20653     * @param mode The desired mode
20654     *
20655     * This sets the zoom mode to manual or one of several automatic levels.
20656     * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
20657     * elm_photocam_zoom_set() and will stay at that level until changed by code
20658     * or until zoom mode is changed. This is the default mode. The Automatic
20659     * modes will allow the photocam object to automatically adjust zoom mode
20660     * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
20661     * the photo fits EXACTLY inside the scroll frame with no pixels outside this
20662     * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
20663     * pixels within the frame are left unfilled.
20664     */
20665    EAPI void                   elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
20666    /**
20667     * @brief Get the zoom mode
20668     *
20669     * @param obj The photocam object
20670     * @return The current zoom mode
20671     *
20672     * This gets the current zoom mode of the photocam object.
20673     *
20674     * @see elm_photocam_zoom_mode_set()
20675     */
20676    EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20677    /**
20678     * @brief Get the current image pixel width and height
20679     *
20680     * @param obj The photocam object
20681     * @param w A pointer to the width return
20682     * @param h A pointer to the height return
20683     *
20684     * This gets the current photo pixel width and height (for the original).
20685     * The size will be returned in the integers @p w and @p h that are pointed
20686     * to.
20687     */
20688    EAPI void                   elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
20689    /**
20690     * @brief Get the area of the image that is currently shown
20691     *
20692     * @param obj
20693     * @param x A pointer to the X-coordinate of region
20694     * @param y A pointer to the Y-coordinate of region
20695     * @param w A pointer to the width
20696     * @param h A pointer to the height
20697     *
20698     * @see elm_photocam_image_region_show()
20699     * @see elm_photocam_image_region_bring_in()
20700     */
20701    EAPI void                   elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
20702    /**
20703     * @brief Set the viewed portion of the image
20704     *
20705     * @param obj The photocam object
20706     * @param x X-coordinate of region in image original pixels
20707     * @param y Y-coordinate of region in image original pixels
20708     * @param w Width of region in image original pixels
20709     * @param h Height of region in image original pixels
20710     *
20711     * This shows the region of the image without using animation.
20712     */
20713    EAPI void                   elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
20714    /**
20715     * @brief Bring in the viewed portion of the image
20716     *
20717     * @param obj The photocam object
20718     * @param x X-coordinate of region in image original pixels
20719     * @param y Y-coordinate of region in image original pixels
20720     * @param w Width of region in image original pixels
20721     * @param h Height of region in image original pixels
20722     *
20723     * This shows the region of the image using animation.
20724     */
20725    EAPI void                   elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
20726    /**
20727     * @brief Set the paused state for photocam
20728     *
20729     * @param obj The photocam object
20730     * @param paused The pause state to set
20731     *
20732     * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
20733     * photocam. The default is off. This will stop zooming using animation on
20734     * zoom levels changes and change instantly. This will stop any existing
20735     * animations that are running.
20736     */
20737    EAPI void                   elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
20738    /**
20739     * @brief Get the paused state for photocam
20740     *
20741     * @param obj The photocam object
20742     * @return The current paused state
20743     *
20744     * This gets the current paused state for the photocam object.
20745     *
20746     * @see elm_photocam_paused_set()
20747     */
20748    EAPI Eina_Bool              elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20749    /**
20750     * @brief Get the internal low-res image used for photocam
20751     *
20752     * @param obj The photocam object
20753     * @return The internal image object handle, or NULL if none exists
20754     *
20755     * This gets the internal image object inside photocam. Do not modify it. It
20756     * is for inspection only, and hooking callbacks to. Nothing else. It may be
20757     * deleted at any time as well.
20758     */
20759    EAPI Evas_Object           *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20760    /**
20761     * @brief Set the photocam scrolling bouncing.
20762     *
20763     * @param obj The photocam object
20764     * @param h_bounce bouncing for horizontal
20765     * @param v_bounce bouncing for vertical
20766     */
20767    EAPI void                   elm_photocam_bounce_set(Evas_Object *obj,  Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
20768    /**
20769     * @brief Get the photocam scrolling bouncing.
20770     *
20771     * @param obj The photocam object
20772     * @param h_bounce bouncing for horizontal
20773     * @param v_bounce bouncing for vertical
20774     *
20775     * @see elm_photocam_bounce_set()
20776     */
20777    EAPI void                   elm_photocam_bounce_get(const Evas_Object *obj,  Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
20778    /**
20779     * @}
20780     */
20781
20782    /**
20783     * @defgroup Map Map
20784     * @ingroup Elementary
20785     *
20786     * @image html img/widget/map/preview-00.png
20787     * @image latex img/widget/map/preview-00.eps
20788     *
20789     * This is a widget specifically for displaying a map. It uses basically
20790     * OpenStreetMap provider http://www.openstreetmap.org/,
20791     * but custom providers can be added.
20792     *
20793     * It supports some basic but yet nice features:
20794     * @li zoom and scroll
20795     * @li markers with content to be displayed when user clicks over it
20796     * @li group of markers
20797     * @li routes
20798     *
20799     * Smart callbacks one can listen to:
20800     *
20801     * - "clicked" - This is called when a user has clicked the map without
20802     *   dragging around.
20803     * - "press" - This is called when a user has pressed down on the map.
20804     * - "longpressed" - This is called when a user has pressed down on the map
20805     *   for a long time without dragging around.
20806     * - "clicked,double" - This is called when a user has double-clicked
20807     *   the map.
20808     * - "load,detail" - Map detailed data load begins.
20809     * - "loaded,detail" - This is called when all currently visible parts of
20810     *   the map are loaded.
20811     * - "zoom,start" - Zoom animation started.
20812     * - "zoom,stop" - Zoom animation stopped.
20813     * - "zoom,change" - Zoom changed when using an auto zoom mode.
20814     * - "scroll" - the content has been scrolled (moved).
20815     * - "scroll,anim,start" - scrolling animation has started.
20816     * - "scroll,anim,stop" - scrolling animation has stopped.
20817     * - "scroll,drag,start" - dragging the contents around has started.
20818     * - "scroll,drag,stop" - dragging the contents around has stopped.
20819     * - "downloaded" - This is called when all currently required map images
20820     *   are downloaded.
20821     * - "route,load" - This is called when route request begins.
20822     * - "route,loaded" - This is called when route request ends.
20823     * - "name,load" - This is called when name request begins.
20824     * - "name,loaded- This is called when name request ends.
20825     *
20826     * Available style for map widget:
20827     * - @c "default"
20828     *
20829     * Available style for markers:
20830     * - @c "radio"
20831     * - @c "radio2"
20832     * - @c "empty"
20833     *
20834     * Available style for marker bubble:
20835     * - @c "default"
20836     *
20837     * List of examples:
20838     * @li @ref map_example_01
20839     * @li @ref map_example_02
20840     * @li @ref map_example_03
20841     */
20842
20843    /**
20844     * @addtogroup Map
20845     * @{
20846     */
20847
20848    /**
20849     * @enum _Elm_Map_Zoom_Mode
20850     * @typedef Elm_Map_Zoom_Mode
20851     *
20852     * Set map's zoom behavior. It can be set to manual or automatic.
20853     *
20854     * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
20855     *
20856     * Values <b> don't </b> work as bitmask, only one can be choosen.
20857     *
20858     * @note Valid sizes are 2^zoom, consequently the map may be smaller
20859     * than the scroller view.
20860     *
20861     * @see elm_map_zoom_mode_set()
20862     * @see elm_map_zoom_mode_get()
20863     *
20864     * @ingroup Map
20865     */
20866    typedef enum _Elm_Map_Zoom_Mode
20867      {
20868         ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
20869         ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
20870         ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
20871         ELM_MAP_ZOOM_MODE_LAST
20872      } Elm_Map_Zoom_Mode;
20873
20874    /**
20875     * @enum _Elm_Map_Route_Sources
20876     * @typedef Elm_Map_Route_Sources
20877     *
20878     * Set route service to be used. By default used source is
20879     * #ELM_MAP_ROUTE_SOURCE_YOURS.
20880     *
20881     * @see elm_map_route_source_set()
20882     * @see elm_map_route_source_get()
20883     *
20884     * @ingroup Map
20885     */
20886    typedef enum _Elm_Map_Route_Sources
20887      {
20888         ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
20889         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. */
20890         ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
20891         ELM_MAP_ROUTE_SOURCE_LAST
20892      } Elm_Map_Route_Sources;
20893
20894    typedef enum _Elm_Map_Name_Sources
20895      {
20896         ELM_MAP_NAME_SOURCE_NOMINATIM,
20897         ELM_MAP_NAME_SOURCE_LAST
20898      } Elm_Map_Name_Sources;
20899
20900    /**
20901     * @enum _Elm_Map_Route_Type
20902     * @typedef Elm_Map_Route_Type
20903     *
20904     * Set type of transport used on route.
20905     *
20906     * @see elm_map_route_add()
20907     *
20908     * @ingroup Map
20909     */
20910    typedef enum _Elm_Map_Route_Type
20911      {
20912         ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
20913         ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
20914         ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
20915         ELM_MAP_ROUTE_TYPE_LAST
20916      } Elm_Map_Route_Type;
20917
20918    /**
20919     * @enum _Elm_Map_Route_Method
20920     * @typedef Elm_Map_Route_Method
20921     *
20922     * Set the routing method, what should be priorized, time or distance.
20923     *
20924     * @see elm_map_route_add()
20925     *
20926     * @ingroup Map
20927     */
20928    typedef enum _Elm_Map_Route_Method
20929      {
20930         ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
20931         ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
20932         ELM_MAP_ROUTE_METHOD_LAST
20933      } Elm_Map_Route_Method;
20934
20935    typedef enum _Elm_Map_Name_Method
20936      {
20937         ELM_MAP_NAME_METHOD_SEARCH,
20938         ELM_MAP_NAME_METHOD_REVERSE,
20939         ELM_MAP_NAME_METHOD_LAST
20940      } Elm_Map_Name_Method;
20941
20942    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(). */
20943    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(). */
20944    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(). */
20945    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(). */
20946    typedef struct _Elm_Map_Name            Elm_Map_Name; /**< A handle for specific coordinates. */
20947    typedef struct _Elm_Map_Track           Elm_Map_Track;
20948
20949    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. */
20950    typedef void         (*ElmMapMarkerDelFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
20951    typedef Evas_Object *(*ElmMapMarkerIconGetFunc)  (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
20952    typedef Evas_Object *(*ElmMapGroupIconGetFunc)   (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
20953
20954    typedef char        *(*ElmMapModuleSourceFunc) (void);
20955    typedef int          (*ElmMapModuleZoomMinFunc) (void);
20956    typedef int          (*ElmMapModuleZoomMaxFunc) (void);
20957    typedef char        *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
20958    typedef int          (*ElmMapModuleRouteSourceFunc) (void);
20959    typedef char        *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
20960    typedef char        *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
20961    typedef Eina_Bool    (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
20962    typedef Eina_Bool    (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
20963
20964    /**
20965     * Add a new map widget to the given parent Elementary (container) object.
20966     *
20967     * @param parent The parent object.
20968     * @return a new map widget handle or @c NULL, on errors.
20969     *
20970     * This function inserts a new map widget on the canvas.
20971     *
20972     * @ingroup Map
20973     */
20974    EAPI Evas_Object          *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20975
20976    /**
20977     * Set the zoom level of the map.
20978     *
20979     * @param obj The map object.
20980     * @param zoom The zoom level to set.
20981     *
20982     * This sets the zoom level.
20983     *
20984     * It will respect limits defined by elm_map_source_zoom_min_set() and
20985     * elm_map_source_zoom_max_set().
20986     *
20987     * By default these values are 0 (world map) and 18 (maximum zoom).
20988     *
20989     * This function should be used when zoom mode is set to
20990     * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
20991     * with elm_map_zoom_mode_set().
20992     *
20993     * @see elm_map_zoom_mode_set().
20994     * @see elm_map_zoom_get().
20995     *
20996     * @ingroup Map
20997     */
20998    EAPI void                  elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
20999
21000    /**
21001     * Get the zoom level of the map.
21002     *
21003     * @param obj The map object.
21004     * @return The current zoom level.
21005     *
21006     * This returns the current zoom level of the map object.
21007     *
21008     * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
21009     * (which is the default), the zoom level may be changed at any time by the
21010     * map object itself to account for map size and map viewport size.
21011     *
21012     * @see elm_map_zoom_set() for details.
21013     *
21014     * @ingroup Map
21015     */
21016    EAPI int                   elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21017
21018    /**
21019     * Set the zoom mode used by the map object.
21020     *
21021     * @param obj The map object.
21022     * @param mode The zoom mode of the map, being it one of
21023     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
21024     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
21025     *
21026     * This sets the zoom mode to manual or one of the automatic levels.
21027     * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
21028     * elm_map_zoom_set() and will stay at that level until changed by code
21029     * or until zoom mode is changed. This is the default mode.
21030     *
21031     * The Automatic modes will allow the map object to automatically
21032     * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
21033     * adjust zoom so the map fits inside the scroll frame with no pixels
21034     * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
21035     * ensure no pixels within the frame are left unfilled. Do not forget that
21036     * the valid sizes are 2^zoom, consequently the map may be smaller than
21037     * the scroller view.
21038     *
21039     * @see elm_map_zoom_set()
21040     *
21041     * @ingroup Map
21042     */
21043    EAPI void                  elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
21044
21045    /**
21046     * Get the zoom mode used by the map object.
21047     *
21048     * @param obj The map object.
21049     * @return The zoom mode of the map, being it one of
21050     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
21051     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
21052     *
21053     * This function returns the current zoom mode used by the map object.
21054     *
21055     * @see elm_map_zoom_mode_set() for more details.
21056     *
21057     * @ingroup Map
21058     */
21059    EAPI Elm_Map_Zoom_Mode     elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21060
21061    /**
21062     * Get the current coordinates of the map.
21063     *
21064     * @param obj The map object.
21065     * @param lon Pointer where to store longitude.
21066     * @param lat Pointer where to store latitude.
21067     *
21068     * This gets the current center coordinates of the map object. It can be
21069     * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
21070     *
21071     * @see elm_map_geo_region_bring_in()
21072     * @see elm_map_geo_region_show()
21073     *
21074     * @ingroup Map
21075     */
21076    EAPI void                  elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
21077
21078    /**
21079     * Animatedly bring in given coordinates to the center of the map.
21080     *
21081     * @param obj The map object.
21082     * @param lon Longitude to center at.
21083     * @param lat Latitude to center at.
21084     *
21085     * This causes map to jump to the given @p lat and @p lon coordinates
21086     * and show it (by scrolling) in the center of the viewport, if it is not
21087     * already centered. This will use animation to do so and take a period
21088     * of time to complete.
21089     *
21090     * @see elm_map_geo_region_show() for a function to avoid animation.
21091     * @see elm_map_geo_region_get()
21092     *
21093     * @ingroup Map
21094     */
21095    EAPI void                  elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
21096
21097    /**
21098     * Show the given coordinates at the center of the map, @b immediately.
21099     *
21100     * @param obj The map object.
21101     * @param lon Longitude to center at.
21102     * @param lat Latitude to center at.
21103     *
21104     * This causes map to @b redraw its viewport's contents to the
21105     * region contining the given @p lat and @p lon, that will be moved to the
21106     * center of the map.
21107     *
21108     * @see elm_map_geo_region_bring_in() for a function to move with animation.
21109     * @see elm_map_geo_region_get()
21110     *
21111     * @ingroup Map
21112     */
21113    EAPI void                  elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
21114
21115    /**
21116     * Pause or unpause the map.
21117     *
21118     * @param obj The map object.
21119     * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
21120     * to unpause it.
21121     *
21122     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21123     * for map.
21124     *
21125     * The default is off.
21126     *
21127     * This will stop zooming using animation, changing zoom levels will
21128     * change instantly. This will stop any existing animations that are running.
21129     *
21130     * @see elm_map_paused_get()
21131     *
21132     * @ingroup Map
21133     */
21134    EAPI void                  elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
21135
21136    /**
21137     * Get a value whether map is paused or not.
21138     *
21139     * @param obj The map object.
21140     * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
21141     * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
21142     *
21143     * This gets the current paused state for the map object.
21144     *
21145     * @see elm_map_paused_set() for details.
21146     *
21147     * @ingroup Map
21148     */
21149    EAPI Eina_Bool             elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21150
21151    /**
21152     * Set to show markers during zoom level changes or not.
21153     *
21154     * @param obj The map object.
21155     * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
21156     * to show them.
21157     *
21158     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21159     * for map.
21160     *
21161     * The default is off.
21162     *
21163     * This will stop zooming using animation, changing zoom levels will
21164     * change instantly. This will stop any existing animations that are running.
21165     *
21166     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21167     * for the markers.
21168     *
21169     * The default  is off.
21170     *
21171     * Enabling it will force the map to stop displaying the markers during
21172     * zoom level changes. Set to on if you have a large number of markers.
21173     *
21174     * @see elm_map_paused_markers_get()
21175     *
21176     * @ingroup Map
21177     */
21178    EAPI void                  elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
21179
21180    /**
21181     * Get a value whether markers will be displayed on zoom level changes or not
21182     *
21183     * @param obj The map object.
21184     * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
21185     * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
21186     *
21187     * This gets the current markers paused state for the map object.
21188     *
21189     * @see elm_map_paused_markers_set() for details.
21190     *
21191     * @ingroup Map
21192     */
21193    EAPI Eina_Bool             elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21194
21195    /**
21196     * Get the information of downloading status.
21197     *
21198     * @param obj The map object.
21199     * @param try_num Pointer where to store number of tiles being downloaded.
21200     * @param finish_num Pointer where to store number of tiles successfully
21201     * downloaded.
21202     *
21203     * This gets the current downloading status for the map object, the number
21204     * of tiles being downloaded and the number of tiles already downloaded.
21205     *
21206     * @ingroup Map
21207     */
21208    EAPI void                  elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
21209
21210    /**
21211     * Convert a pixel coordinate (x,y) into a geographic coordinate
21212     * (longitude, latitude).
21213     *
21214     * @param obj The map object.
21215     * @param x the coordinate.
21216     * @param y the coordinate.
21217     * @param size the size in pixels of the map.
21218     * The map is a square and generally his size is : pow(2.0, zoom)*256.
21219     * @param lon Pointer where to store the longitude that correspond to x.
21220     * @param lat Pointer where to store the latitude that correspond to y.
21221     *
21222     * @note Origin pixel point is the top left corner of the viewport.
21223     * Map zoom and size are taken on account.
21224     *
21225     * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
21226     *
21227     * @ingroup Map
21228     */
21229    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);
21230
21231    /**
21232     * Convert a geographic coordinate (longitude, latitude) into a pixel
21233     * coordinate (x, y).
21234     *
21235     * @param obj The map object.
21236     * @param lon the longitude.
21237     * @param lat the latitude.
21238     * @param size the size in pixels of the map. The map is a square
21239     * and generally his size is : pow(2.0, zoom)*256.
21240     * @param x Pointer where to store the horizontal pixel coordinate that
21241     * correspond to the longitude.
21242     * @param y Pointer where to store the vertical pixel coordinate that
21243     * correspond to the latitude.
21244     *
21245     * @note Origin pixel point is the top left corner of the viewport.
21246     * Map zoom and size are taken on account.
21247     *
21248     * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
21249     *
21250     * @ingroup Map
21251     */
21252    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);
21253
21254    /**
21255     * Convert a geographic coordinate (longitude, latitude) into a name
21256     * (address).
21257     *
21258     * @param obj The map object.
21259     * @param lon the longitude.
21260     * @param lat the latitude.
21261     * @return name A #Elm_Map_Name handle for this coordinate.
21262     *
21263     * To get the string for this address, elm_map_name_address_get()
21264     * should be used.
21265     *
21266     * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
21267     *
21268     * @ingroup Map
21269     */
21270    EAPI Elm_Map_Name         *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
21271
21272    /**
21273     * Convert a name (address) into a geographic coordinate
21274     * (longitude, latitude).
21275     *
21276     * @param obj The map object.
21277     * @param name The address.
21278     * @return name A #Elm_Map_Name handle for this address.
21279     *
21280     * To get the longitude and latitude, elm_map_name_region_get()
21281     * should be used.
21282     *
21283     * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
21284     *
21285     * @ingroup Map
21286     */
21287    EAPI Elm_Map_Name         *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
21288
21289    /**
21290     * Convert a pixel coordinate into a rotated pixel coordinate.
21291     *
21292     * @param obj The map object.
21293     * @param x horizontal coordinate of the point to rotate.
21294     * @param y vertical coordinate of the point to rotate.
21295     * @param cx rotation's center horizontal position.
21296     * @param cy rotation's center vertical position.
21297     * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
21298     * @param xx Pointer where to store rotated x.
21299     * @param yy Pointer where to store rotated y.
21300     *
21301     * @ingroup Map
21302     */
21303    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);
21304
21305    /**
21306     * Add a new marker to the map object.
21307     *
21308     * @param obj The map object.
21309     * @param lon The longitude of the marker.
21310     * @param lat The latitude of the marker.
21311     * @param clas The class, to use when marker @b isn't grouped to others.
21312     * @param clas_group The class group, to use when marker is grouped to others
21313     * @param data The data passed to the callbacks.
21314     *
21315     * @return The created marker or @c NULL upon failure.
21316     *
21317     * A marker will be created and shown in a specific point of the map, defined
21318     * by @p lon and @p lat.
21319     *
21320     * It will be displayed using style defined by @p class when this marker
21321     * is displayed alone (not grouped). A new class can be created with
21322     * elm_map_marker_class_new().
21323     *
21324     * If the marker is grouped to other markers, it will be displayed with
21325     * style defined by @p class_group. Markers with the same group are grouped
21326     * if they are close. A new group class can be created with
21327     * elm_map_marker_group_class_new().
21328     *
21329     * Markers created with this method can be deleted with
21330     * elm_map_marker_remove().
21331     *
21332     * A marker can have associated content to be displayed by a bubble,
21333     * when a user click over it, as well as an icon. These objects will
21334     * be fetch using class' callback functions.
21335     *
21336     * @see elm_map_marker_class_new()
21337     * @see elm_map_marker_group_class_new()
21338     * @see elm_map_marker_remove()
21339     *
21340     * @ingroup Map
21341     */
21342    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);
21343
21344    /**
21345     * Set the maximum numbers of markers' content to be displayed in a group.
21346     *
21347     * @param obj The map object.
21348     * @param max The maximum numbers of items displayed in a bubble.
21349     *
21350     * A bubble will be displayed when the user clicks over the group,
21351     * and will place the content of markers that belong to this group
21352     * inside it.
21353     *
21354     * A group can have a long list of markers, consequently the creation
21355     * of the content of the bubble can be very slow.
21356     *
21357     * In order to avoid this, a maximum number of items is displayed
21358     * in a bubble.
21359     *
21360     * By default this number is 30.
21361     *
21362     * Marker with the same group class are grouped if they are close.
21363     *
21364     * @see elm_map_marker_add()
21365     *
21366     * @ingroup Map
21367     */
21368    EAPI void                  elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
21369
21370    /**
21371     * Remove a marker from the map.
21372     *
21373     * @param marker The marker to remove.
21374     *
21375     * @see elm_map_marker_add()
21376     *
21377     * @ingroup Map
21378     */
21379    EAPI void                  elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21380
21381    /**
21382     * Get the current coordinates of the marker.
21383     *
21384     * @param marker marker.
21385     * @param lat Pointer where to store the marker's latitude.
21386     * @param lon Pointer where to store the marker's longitude.
21387     *
21388     * These values are set when adding markers, with function
21389     * elm_map_marker_add().
21390     *
21391     * @see elm_map_marker_add()
21392     *
21393     * @ingroup Map
21394     */
21395    EAPI void                  elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
21396
21397    /**
21398     * Animatedly bring in given marker to the center of the map.
21399     *
21400     * @param marker The marker to center at.
21401     *
21402     * This causes map to jump to the given @p marker's coordinates
21403     * and show it (by scrolling) in the center of the viewport, if it is not
21404     * already centered. This will use animation to do so and take a period
21405     * of time to complete.
21406     *
21407     * @see elm_map_marker_show() for a function to avoid animation.
21408     * @see elm_map_marker_region_get()
21409     *
21410     * @ingroup Map
21411     */
21412    EAPI void                  elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21413
21414    /**
21415     * Show the given marker at the center of the map, @b immediately.
21416     *
21417     * @param marker The marker to center at.
21418     *
21419     * This causes map to @b redraw its viewport's contents to the
21420     * region contining the given @p marker's coordinates, that will be
21421     * moved to the center of the map.
21422     *
21423     * @see elm_map_marker_bring_in() for a function to move with animation.
21424     * @see elm_map_markers_list_show() if more than one marker need to be
21425     * displayed.
21426     * @see elm_map_marker_region_get()
21427     *
21428     * @ingroup Map
21429     */
21430    EAPI void                  elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21431
21432    /**
21433     * Move and zoom the map to display a list of markers.
21434     *
21435     * @param markers A list of #Elm_Map_Marker handles.
21436     *
21437     * The map will be centered on the center point of the markers in the list.
21438     * Then the map will be zoomed in order to fit the markers using the maximum
21439     * zoom which allows display of all the markers.
21440     *
21441     * @warning All the markers should belong to the same map object.
21442     *
21443     * @see elm_map_marker_show() to show a single marker.
21444     * @see elm_map_marker_bring_in()
21445     *
21446     * @ingroup Map
21447     */
21448    EAPI void                  elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
21449
21450    /**
21451     * Get the Evas object returned by the ElmMapMarkerGetFunc callback
21452     *
21453     * @param marker The marker wich content should be returned.
21454     * @return Return the evas object if it exists, else @c NULL.
21455     *
21456     * To set callback function #ElmMapMarkerGetFunc for the marker class,
21457     * elm_map_marker_class_get_cb_set() should be used.
21458     *
21459     * This content is what will be inside the bubble that will be displayed
21460     * when an user clicks over the marker.
21461     *
21462     * This returns the actual Evas object used to be placed inside
21463     * the bubble. This may be @c NULL, as it may
21464     * not have been created or may have been deleted, at any time, by
21465     * the map. <b>Do not modify this object</b> (move, resize,
21466     * show, hide, etc.), as the map is controlling it. This
21467     * function is for querying, emitting custom signals or hooking
21468     * lower level callbacks for events on that object. Do not delete
21469     * this object under any circumstances.
21470     *
21471     * @ingroup Map
21472     */
21473    EAPI Evas_Object          *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21474
21475    /**
21476     * Update the marker
21477     *
21478     * @param marker The marker to be updated.
21479     *
21480     * If a content is set to this marker, it will call function to delete it,
21481     * #ElmMapMarkerDelFunc, and then will fetch the content again with
21482     * #ElmMapMarkerGetFunc.
21483     *
21484     * These functions are set for the marker class with
21485     * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
21486     *
21487     * @ingroup Map
21488     */
21489    EAPI void                  elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21490
21491    /**
21492     * Close all the bubbles opened by the user.
21493     *
21494     * @param obj The map object.
21495     *
21496     * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
21497     * when the user clicks on a marker.
21498     *
21499     * This functions is set for the marker class with
21500     * elm_map_marker_class_get_cb_set().
21501     *
21502     * @ingroup Map
21503     */
21504    EAPI void                  elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
21505
21506    /**
21507     * Create a new group class.
21508     *
21509     * @param obj The map object.
21510     * @return Returns the new group class.
21511     *
21512     * Each marker must be associated to a group class. Markers in the same
21513     * group are grouped if they are close.
21514     *
21515     * The group class defines the style of the marker when a marker is grouped
21516     * to others markers. When it is alone, another class will be used.
21517     *
21518     * A group class will need to be provided when creating a marker with
21519     * elm_map_marker_add().
21520     *
21521     * Some properties and functions can be set by class, as:
21522     * - style, with elm_map_group_class_style_set()
21523     * - data - to be associated to the group class. It can be set using
21524     *   elm_map_group_class_data_set().
21525     * - min zoom to display markers, set with
21526     *   elm_map_group_class_zoom_displayed_set().
21527     * - max zoom to group markers, set using
21528     *   elm_map_group_class_zoom_grouped_set().
21529     * - visibility - set if markers will be visible or not, set with
21530     *   elm_map_group_class_hide_set().
21531     * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
21532     *   It can be set using elm_map_group_class_icon_cb_set().
21533     *
21534     * @see elm_map_marker_add()
21535     * @see elm_map_group_class_style_set()
21536     * @see elm_map_group_class_data_set()
21537     * @see elm_map_group_class_zoom_displayed_set()
21538     * @see elm_map_group_class_zoom_grouped_set()
21539     * @see elm_map_group_class_hide_set()
21540     * @see elm_map_group_class_icon_cb_set()
21541     *
21542     * @ingroup Map
21543     */
21544    EAPI Elm_Map_Group_Class  *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
21545
21546    /**
21547     * Set the marker's style of a group class.
21548     *
21549     * @param clas The group class.
21550     * @param style The style to be used by markers.
21551     *
21552     * Each marker must be associated to a group class, and will use the style
21553     * defined by such class when grouped to other markers.
21554     *
21555     * The following styles are provided by default theme:
21556     * @li @c radio - blue circle
21557     * @li @c radio2 - green circle
21558     * @li @c empty
21559     *
21560     * @see elm_map_group_class_new() for more details.
21561     * @see elm_map_marker_add()
21562     *
21563     * @ingroup Map
21564     */
21565    EAPI void                  elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
21566
21567    /**
21568     * Set the icon callback function of a group class.
21569     *
21570     * @param clas The group class.
21571     * @param icon_get The callback function that will return the icon.
21572     *
21573     * Each marker must be associated to a group class, and it can display a
21574     * custom icon. The function @p icon_get must return this icon.
21575     *
21576     * @see elm_map_group_class_new() for more details.
21577     * @see elm_map_marker_add()
21578     *
21579     * @ingroup Map
21580     */
21581    EAPI void                  elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
21582
21583    /**
21584     * Set the data associated to the group class.
21585     *
21586     * @param clas The group class.
21587     * @param data The new user data.
21588     *
21589     * This data will be passed for callback functions, like icon get callback,
21590     * that can be set with elm_map_group_class_icon_cb_set().
21591     *
21592     * If a data was previously set, the object will lose the pointer for it,
21593     * so if needs to be freed, you must do it yourself.
21594     *
21595     * @see elm_map_group_class_new() for more details.
21596     * @see elm_map_group_class_icon_cb_set()
21597     * @see elm_map_marker_add()
21598     *
21599     * @ingroup Map
21600     */
21601    EAPI void                  elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
21602
21603    /**
21604     * Set the minimum zoom from where the markers are displayed.
21605     *
21606     * @param clas The group class.
21607     * @param zoom The minimum zoom.
21608     *
21609     * Markers only will be displayed when the map is displayed at @p zoom
21610     * or bigger.
21611     *
21612     * @see elm_map_group_class_new() for more details.
21613     * @see elm_map_marker_add()
21614     *
21615     * @ingroup Map
21616     */
21617    EAPI void                  elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
21618
21619    /**
21620     * Set the zoom from where the markers are no more grouped.
21621     *
21622     * @param clas The group class.
21623     * @param zoom The maximum zoom.
21624     *
21625     * Markers only will be grouped when the map is displayed at
21626     * less than @p zoom.
21627     *
21628     * @see elm_map_group_class_new() for more details.
21629     * @see elm_map_marker_add()
21630     *
21631     * @ingroup Map
21632     */
21633    EAPI void                  elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
21634
21635    /**
21636     * Set if the markers associated to the group class @clas are hidden or not.
21637     *
21638     * @param clas The group class.
21639     * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
21640     * to show them.
21641     *
21642     * If @p hide is @c EINA_TRUE the markers will be hidden, but default
21643     * is to show them.
21644     *
21645     * @ingroup Map
21646     */
21647    EAPI void                  elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
21648
21649    /**
21650     * Create a new marker class.
21651     *
21652     * @param obj The map object.
21653     * @return Returns the new group class.
21654     *
21655     * Each marker must be associated to a class.
21656     *
21657     * The marker class defines the style of the marker when a marker is
21658     * displayed alone, i.e., not grouped to to others markers. When grouped
21659     * it will use group class style.
21660     *
21661     * A marker class will need to be provided when creating a marker with
21662     * elm_map_marker_add().
21663     *
21664     * Some properties and functions can be set by class, as:
21665     * - style, with elm_map_marker_class_style_set()
21666     * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
21667     *   It can be set using elm_map_marker_class_icon_cb_set().
21668     * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
21669     *   Set using elm_map_marker_class_get_cb_set().
21670     * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
21671     *   Set using elm_map_marker_class_del_cb_set().
21672     *
21673     * @see elm_map_marker_add()
21674     * @see elm_map_marker_class_style_set()
21675     * @see elm_map_marker_class_icon_cb_set()
21676     * @see elm_map_marker_class_get_cb_set()
21677     * @see elm_map_marker_class_del_cb_set()
21678     *
21679     * @ingroup Map
21680     */
21681    EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
21682
21683    /**
21684     * Set the marker's style of a marker class.
21685     *
21686     * @param clas The marker class.
21687     * @param style The style to be used by markers.
21688     *
21689     * Each marker must be associated to a marker class, and will use the style
21690     * defined by such class when alone, i.e., @b not grouped to other markers.
21691     *
21692     * The following styles are provided by default theme:
21693     * @li @c radio
21694     * @li @c radio2
21695     * @li @c empty
21696     *
21697     * @see elm_map_marker_class_new() for more details.
21698     * @see elm_map_marker_add()
21699     *
21700     * @ingroup Map
21701     */
21702    EAPI void                  elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
21703
21704    /**
21705     * Set the icon callback function of a marker class.
21706     *
21707     * @param clas The marker class.
21708     * @param icon_get The callback function that will return the icon.
21709     *
21710     * Each marker must be associated to a marker class, and it can display a
21711     * custom icon. The function @p icon_get must return this icon.
21712     *
21713     * @see elm_map_marker_class_new() for more details.
21714     * @see elm_map_marker_add()
21715     *
21716     * @ingroup Map
21717     */
21718    EAPI void                  elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
21719
21720    /**
21721     * Set the bubble content callback function of a marker class.
21722     *
21723     * @param clas The marker class.
21724     * @param get The callback function that will return the content.
21725     *
21726     * Each marker must be associated to a marker class, and it can display a
21727     * a content on a bubble that opens when the user click over the marker.
21728     * The function @p get must return this content object.
21729     *
21730     * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
21731     * can be used.
21732     *
21733     * @see elm_map_marker_class_new() for more details.
21734     * @see elm_map_marker_class_del_cb_set()
21735     * @see elm_map_marker_add()
21736     *
21737     * @ingroup Map
21738     */
21739    EAPI void                  elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
21740
21741    /**
21742     * Set the callback function used to delete bubble content of a marker class.
21743     *
21744     * @param clas The marker class.
21745     * @param del The callback function that will delete the content.
21746     *
21747     * Each marker must be associated to a marker class, and it can display a
21748     * a content on a bubble that opens when the user click over the marker.
21749     * The function to return such content can be set with
21750     * elm_map_marker_class_get_cb_set().
21751     *
21752     * If this content must be freed, a callback function need to be
21753     * set for that task with this function.
21754     *
21755     * If this callback is defined it will have to delete (or not) the
21756     * object inside, but if the callback is not defined the object will be
21757     * destroyed with evas_object_del().
21758     *
21759     * @see elm_map_marker_class_new() for more details.
21760     * @see elm_map_marker_class_get_cb_set()
21761     * @see elm_map_marker_add()
21762     *
21763     * @ingroup Map
21764     */
21765    EAPI void                  elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
21766
21767    /**
21768     * Get the list of available sources.
21769     *
21770     * @param obj The map object.
21771     * @return The source names list.
21772     *
21773     * It will provide a list with all available sources, that can be set as
21774     * current source with elm_map_source_name_set(), or get with
21775     * elm_map_source_name_get().
21776     *
21777     * Available sources:
21778     * @li "Mapnik"
21779     * @li "Osmarender"
21780     * @li "CycleMap"
21781     * @li "Maplint"
21782     *
21783     * @see elm_map_source_name_set() for more details.
21784     * @see elm_map_source_name_get()
21785     *
21786     * @ingroup Map
21787     */
21788    EAPI const char          **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21789
21790    /**
21791     * Set the source of the map.
21792     *
21793     * @param obj The map object.
21794     * @param source The source to be used.
21795     *
21796     * Map widget retrieves images that composes the map from a web service.
21797     * This web service can be set with this method.
21798     *
21799     * A different service can return a different maps with different
21800     * information and it can use different zoom values.
21801     *
21802     * The @p source_name need to match one of the names provided by
21803     * elm_map_source_names_get().
21804     *
21805     * The current source can be get using elm_map_source_name_get().
21806     *
21807     * @see elm_map_source_names_get()
21808     * @see elm_map_source_name_get()
21809     *
21810     *
21811     * @ingroup Map
21812     */
21813    EAPI void                  elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
21814
21815    /**
21816     * Get the name of currently used source.
21817     *
21818     * @param obj The map object.
21819     * @return Returns the name of the source in use.
21820     *
21821     * @see elm_map_source_name_set() for more details.
21822     *
21823     * @ingroup Map
21824     */
21825    EAPI const char           *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21826
21827    /**
21828     * Set the source of the route service to be used by the map.
21829     *
21830     * @param obj The map object.
21831     * @param source The route service to be used, being it one of
21832     * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
21833     * and #ELM_MAP_ROUTE_SOURCE_ORS.
21834     *
21835     * Each one has its own algorithm, so the route retrieved may
21836     * differ depending on the source route. Now, only the default is working.
21837     *
21838     * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
21839     * http://www.yournavigation.org/.
21840     *
21841     * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
21842     * assumptions. Its routing core is based on Contraction Hierarchies.
21843     *
21844     * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
21845     *
21846     * @see elm_map_route_source_get().
21847     *
21848     * @ingroup Map
21849     */
21850    EAPI void                  elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
21851
21852    /**
21853     * Get the current route source.
21854     *
21855     * @param obj The map object.
21856     * @return The source of the route service used by the map.
21857     *
21858     * @see elm_map_route_source_set() for details.
21859     *
21860     * @ingroup Map
21861     */
21862    EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21863
21864    /**
21865     * Set the minimum zoom of the source.
21866     *
21867     * @param obj The map object.
21868     * @param zoom New minimum zoom value to be used.
21869     *
21870     * By default, it's 0.
21871     *
21872     * @ingroup Map
21873     */
21874    EAPI void                  elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
21875
21876    /**
21877     * Get the minimum zoom of the source.
21878     *
21879     * @param obj The map object.
21880     * @return Returns the minimum zoom of the source.
21881     *
21882     * @see elm_map_source_zoom_min_set() for details.
21883     *
21884     * @ingroup Map
21885     */
21886    EAPI int                   elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21887
21888    /**
21889     * Set the maximum zoom of the source.
21890     *
21891     * @param obj The map object.
21892     * @param zoom New maximum zoom value to be used.
21893     *
21894     * By default, it's 18.
21895     *
21896     * @ingroup Map
21897     */
21898    EAPI void                  elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
21899
21900    /**
21901     * Get the maximum zoom of the source.
21902     *
21903     * @param obj The map object.
21904     * @return Returns the maximum zoom of the source.
21905     *
21906     * @see elm_map_source_zoom_min_set() for details.
21907     *
21908     * @ingroup Map
21909     */
21910    EAPI int                   elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21911
21912    /**
21913     * Set the user agent used by the map object to access routing services.
21914     *
21915     * @param obj The map object.
21916     * @param user_agent The user agent to be used by the map.
21917     *
21918     * User agent is a client application implementing a network protocol used
21919     * in communications within a client–server distributed computing system
21920     *
21921     * The @p user_agent identification string will transmitted in a header
21922     * field @c User-Agent.
21923     *
21924     * @see elm_map_user_agent_get()
21925     *
21926     * @ingroup Map
21927     */
21928    EAPI void                  elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
21929
21930    /**
21931     * Get the user agent used by the map object.
21932     *
21933     * @param obj The map object.
21934     * @return The user agent identification string used by the map.
21935     *
21936     * @see elm_map_user_agent_set() for details.
21937     *
21938     * @ingroup Map
21939     */
21940    EAPI const char           *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21941
21942    /**
21943     * Add a new route to the map object.
21944     *
21945     * @param obj The map object.
21946     * @param type The type of transport to be considered when tracing a route.
21947     * @param method The routing method, what should be priorized.
21948     * @param flon The start longitude.
21949     * @param flat The start latitude.
21950     * @param tlon The destination longitude.
21951     * @param tlat The destination latitude.
21952     *
21953     * @return The created route or @c NULL upon failure.
21954     *
21955     * A route will be traced by point on coordinates (@p flat, @p flon)
21956     * to point on coordinates (@p tlat, @p tlon), using the route service
21957     * set with elm_map_route_source_set().
21958     *
21959     * It will take @p type on consideration to define the route,
21960     * depending if the user will be walking or driving, the route may vary.
21961     * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
21962     * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
21963     *
21964     * Another parameter is what the route should priorize, the minor distance
21965     * or the less time to be spend on the route. So @p method should be one
21966     * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
21967     *
21968     * Routes created with this method can be deleted with
21969     * elm_map_route_remove(), colored with elm_map_route_color_set(),
21970     * and distance can be get with elm_map_route_distance_get().
21971     *
21972     * @see elm_map_route_remove()
21973     * @see elm_map_route_color_set()
21974     * @see elm_map_route_distance_get()
21975     * @see elm_map_route_source_set()
21976     *
21977     * @ingroup Map
21978     */
21979    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);
21980
21981    /**
21982     * Remove a route from the map.
21983     *
21984     * @param route The route to remove.
21985     *
21986     * @see elm_map_route_add()
21987     *
21988     * @ingroup Map
21989     */
21990    EAPI void                  elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21991
21992    /**
21993     * Set the route color.
21994     *
21995     * @param route The route object.
21996     * @param r Red channel value, from 0 to 255.
21997     * @param g Green channel value, from 0 to 255.
21998     * @param b Blue channel value, from 0 to 255.
21999     * @param a Alpha channel value, from 0 to 255.
22000     *
22001     * It uses an additive color model, so each color channel represents
22002     * how much of each primary colors must to be used. 0 represents
22003     * ausence of this color, so if all of the three are set to 0,
22004     * the color will be black.
22005     *
22006     * These component values should be integers in the range 0 to 255,
22007     * (single 8-bit byte).
22008     *
22009     * This sets the color used for the route. By default, it is set to
22010     * solid red (r = 255, g = 0, b = 0, a = 255).
22011     *
22012     * For alpha channel, 0 represents completely transparent, and 255, opaque.
22013     *
22014     * @see elm_map_route_color_get()
22015     *
22016     * @ingroup Map
22017     */
22018    EAPI void                  elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
22019
22020    /**
22021     * Get the route color.
22022     *
22023     * @param route The route object.
22024     * @param r Pointer where to store the red channel value.
22025     * @param g Pointer where to store the green channel value.
22026     * @param b Pointer where to store the blue channel value.
22027     * @param a Pointer where to store the alpha channel value.
22028     *
22029     * @see elm_map_route_color_set() for details.
22030     *
22031     * @ingroup Map
22032     */
22033    EAPI void                  elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
22034
22035    /**
22036     * Get the route distance in kilometers.
22037     *
22038     * @param route The route object.
22039     * @return The distance of route (unit : km).
22040     *
22041     * @ingroup Map
22042     */
22043    EAPI double                elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
22044
22045    /**
22046     * Get the information of route nodes.
22047     *
22048     * @param route The route object.
22049     * @return Returns a string with the nodes of route.
22050     *
22051     * @ingroup Map
22052     */
22053    EAPI const char           *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
22054
22055    /**
22056     * Get the information of route waypoint.
22057     *
22058     * @param route the route object.
22059     * @return Returns a string with information about waypoint of route.
22060     *
22061     * @ingroup Map
22062     */
22063    EAPI const char           *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
22064
22065    /**
22066     * Get the address of the name.
22067     *
22068     * @param name The name handle.
22069     * @return Returns the address string of @p name.
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 const char           *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
22080
22081    /**
22082     * Get the current coordinates of the name.
22083     *
22084     * @param name The name handle.
22085     * @param lat Pointer where to store the latitude.
22086     * @param lon Pointer where to store The longitude.
22087     *
22088     * This gets the coordinates of the @p name, created with one of the
22089     * conversion functions.
22090     *
22091     * @see elm_map_utils_convert_name_into_coord()
22092     * @see elm_map_utils_convert_coord_into_name()
22093     *
22094     * @ingroup Map
22095     */
22096    EAPI void                  elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
22097
22098    /**
22099     * Remove a name from the map.
22100     *
22101     * @param name The name to remove.
22102     *
22103     * Basically the struct handled by @p name will be freed, so convertions
22104     * between address and coordinates will be lost.
22105     *
22106     * @see elm_map_utils_convert_name_into_coord()
22107     * @see elm_map_utils_convert_coord_into_name()
22108     *
22109     * @ingroup Map
22110     */
22111    EAPI void                  elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
22112
22113    /**
22114     * Rotate the map.
22115     *
22116     * @param obj The map object.
22117     * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
22118     * @param cx Rotation's center horizontal position.
22119     * @param cy Rotation's center vertical position.
22120     *
22121     * @see elm_map_rotate_get()
22122     *
22123     * @ingroup Map
22124     */
22125    EAPI void                  elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
22126
22127    /**
22128     * Get the rotate degree of the map
22129     *
22130     * @param obj The map object
22131     * @param degree Pointer where to store degrees from 0.0 to 360.0
22132     * to rotate arount Z axis.
22133     * @param cx Pointer where to store rotation's center horizontal position.
22134     * @param cy Pointer where to store rotation's center vertical position.
22135     *
22136     * @see elm_map_rotate_set() to set map rotation.
22137     *
22138     * @ingroup Map
22139     */
22140    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);
22141
22142    /**
22143     * Enable or disable mouse wheel to be used to zoom in / out the map.
22144     *
22145     * @param obj The map object.
22146     * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
22147     * to enable it.
22148     *
22149     * Mouse wheel can be used for the user to zoom in or zoom out the map.
22150     *
22151     * It's disabled by default.
22152     *
22153     * @see elm_map_wheel_disabled_get()
22154     *
22155     * @ingroup Map
22156     */
22157    EAPI void                  elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22158
22159    /**
22160     * Get a value whether mouse wheel is enabled or not.
22161     *
22162     * @param obj The map object.
22163     * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
22164     * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22165     *
22166     * Mouse wheel can be used for the user to zoom in or zoom out the map.
22167     *
22168     * @see elm_map_wheel_disabled_set() for details.
22169     *
22170     * @ingroup Map
22171     */
22172    EAPI Eina_Bool             elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22173
22174 #ifdef ELM_EMAP
22175    /**
22176     * Add a track on the map
22177     *
22178     * @param obj The map object.
22179     * @param emap The emap route object.
22180     * @return The route object. This is an elm object of type Route.
22181     *
22182     * @see elm_route_add() for details.
22183     *
22184     * @ingroup Map
22185     */
22186    EAPI Evas_Object          *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
22187 #endif
22188
22189    /**
22190     * Remove a track from the map
22191     *
22192     * @param obj The map object.
22193     * @param route The track to remove.
22194     *
22195     * @ingroup Map
22196     */
22197    EAPI void                  elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
22198
22199    /**
22200     * @}
22201     */
22202
22203    /* Route */
22204    EAPI Evas_Object *elm_route_add(Evas_Object *parent);
22205 #ifdef ELM_EMAP
22206    EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
22207 #endif
22208    EAPI double elm_route_lon_min_get(Evas_Object *obj);
22209    EAPI double elm_route_lat_min_get(Evas_Object *obj);
22210    EAPI double elm_route_lon_max_get(Evas_Object *obj);
22211    EAPI double elm_route_lat_max_get(Evas_Object *obj);
22212
22213
22214    /**
22215     * @defgroup Panel Panel
22216     *
22217     * @image html img/widget/panel/preview-00.png
22218     * @image latex img/widget/panel/preview-00.eps
22219     *
22220     * @brief A panel is a type of animated container that contains subobjects.
22221     * It can be expanded or contracted by clicking the button on it's edge.
22222     *
22223     * Orientations are as follows:
22224     * @li ELM_PANEL_ORIENT_TOP
22225     * @li ELM_PANEL_ORIENT_LEFT
22226     * @li ELM_PANEL_ORIENT_RIGHT
22227     *
22228     * @ref tutorial_panel shows one way to use this widget.
22229     * @{
22230     */
22231    typedef enum _Elm_Panel_Orient
22232      {
22233         ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
22234         ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
22235         ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
22236         ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
22237      } Elm_Panel_Orient;
22238    /**
22239     * @brief Adds a panel object
22240     *
22241     * @param parent The parent object
22242     *
22243     * @return The panel object, or NULL on failure
22244     */
22245    EAPI Evas_Object          *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22246    /**
22247     * @brief Sets the orientation of the panel
22248     *
22249     * @param parent The parent object
22250     * @param orient The panel orientation. Can be one of the following:
22251     * @li ELM_PANEL_ORIENT_TOP
22252     * @li ELM_PANEL_ORIENT_LEFT
22253     * @li ELM_PANEL_ORIENT_RIGHT
22254     *
22255     * Sets from where the panel will (dis)appear.
22256     */
22257    EAPI void                  elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
22258    /**
22259     * @brief Get the orientation of the panel.
22260     *
22261     * @param obj The panel object
22262     * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
22263     */
22264    EAPI Elm_Panel_Orient      elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22265    /**
22266     * @brief Set the content of the panel.
22267     *
22268     * @param obj The panel object
22269     * @param content The panel content
22270     *
22271     * Once the content object is set, a previously set one will be deleted.
22272     * If you want to keep that old content object, use the
22273     * elm_panel_content_unset() function.
22274     */
22275    EAPI void                  elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22276    /**
22277     * @brief Get the content of the panel.
22278     *
22279     * @param obj The panel object
22280     * @return The content that is being used
22281     *
22282     * Return the content object which is set for this widget.
22283     *
22284     * @see elm_panel_content_set()
22285     */
22286    EAPI Evas_Object          *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22287    /**
22288     * @brief Unset the content of the panel.
22289     *
22290     * @param obj The panel object
22291     * @return The content that was being used
22292     *
22293     * Unparent and return the content object which was set for this widget.
22294     *
22295     * @see elm_panel_content_set()
22296     */
22297    EAPI Evas_Object          *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22298    /**
22299     * @brief Set the state of the panel.
22300     *
22301     * @param obj The panel object
22302     * @param hidden If true, the panel will run the animation to contract
22303     */
22304    EAPI void                  elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
22305    /**
22306     * @brief Get the state of the panel.
22307     *
22308     * @param obj The panel object
22309     * @param hidden If true, the panel is in the "hide" state
22310     */
22311    EAPI Eina_Bool             elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22312    /**
22313     * @brief Toggle the hidden state of the panel from code
22314     *
22315     * @param obj The panel object
22316     */
22317    EAPI void                  elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
22318    /**
22319     * @}
22320     */
22321
22322    /**
22323     * @defgroup Panes Panes
22324     * @ingroup Elementary
22325     *
22326     * @image html img/widget/panes/preview-00.png
22327     * @image latex img/widget/panes/preview-00.eps width=\textwidth
22328     *
22329     * @image html img/panes.png
22330     * @image latex img/panes.eps width=\textwidth
22331     *
22332     * The panes adds a dragable bar between two contents. When dragged
22333     * this bar will resize contents size.
22334     *
22335     * Panes can be displayed vertically or horizontally, and contents
22336     * size proportion can be customized (homogeneous by default).
22337     *
22338     * Smart callbacks one can listen to:
22339     * - "press" - The panes has been pressed (button wasn't released yet).
22340     * - "unpressed" - The panes was released after being pressed.
22341     * - "clicked" - The panes has been clicked>
22342     * - "clicked,double" - The panes has been double clicked
22343     *
22344     * Available styles for it:
22345     * - @c "default"
22346     *
22347     * Here is an example on its usage:
22348     * @li @ref panes_example
22349     */
22350
22351    /**
22352     * @addtogroup Panes
22353     * @{
22354     */
22355
22356    /**
22357     * Add a new panes widget to the given parent Elementary
22358     * (container) object.
22359     *
22360     * @param parent The parent object.
22361     * @return a new panes widget handle or @c NULL, on errors.
22362     *
22363     * This function inserts a new panes widget on the canvas.
22364     *
22365     * @ingroup Panes
22366     */
22367    EAPI Evas_Object          *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22368
22369    /**
22370     * Set the left content of the panes widget.
22371     *
22372     * @param obj The panes object.
22373     * @param content The new left content object.
22374     *
22375     * Once the content object is set, a previously set one will be deleted.
22376     * If you want to keep that old content object, use the
22377     * elm_panes_content_left_unset() function.
22378     *
22379     * If panes is displayed vertically, left content will be displayed at
22380     * top.
22381     *
22382     * @see elm_panes_content_left_get()
22383     * @see elm_panes_content_right_set() to set content on the other side.
22384     *
22385     * @ingroup Panes
22386     */
22387    EAPI void                  elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22388
22389    /**
22390     * Set the right content of the panes widget.
22391     *
22392     * @param obj The panes object.
22393     * @param content The new right content object.
22394     *
22395     * Once the content object is set, a previously set one will be deleted.
22396     * If you want to keep that old content object, use the
22397     * elm_panes_content_right_unset() function.
22398     *
22399     * If panes is displayed vertically, left content will be displayed at
22400     * bottom.
22401     *
22402     * @see elm_panes_content_right_get()
22403     * @see elm_panes_content_left_set() to set content on the other side.
22404     *
22405     * @ingroup Panes
22406     */
22407    EAPI void                  elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22408
22409    /**
22410     * Get the left content of the panes.
22411     *
22412     * @param obj The panes object.
22413     * @return The left content object that is being used.
22414     *
22415     * Return the left content object which is set for this widget.
22416     *
22417     * @see elm_panes_content_left_set() for details.
22418     *
22419     * @ingroup Panes
22420     */
22421    EAPI Evas_Object          *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22422
22423    /**
22424     * Get the right content of the panes.
22425     *
22426     * @param obj The panes object
22427     * @return The right content object that is being used
22428     *
22429     * Return the right content object which is set for this widget.
22430     *
22431     * @see elm_panes_content_right_set() for details.
22432     *
22433     * @ingroup Panes
22434     */
22435    EAPI Evas_Object          *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22436
22437    /**
22438     * Unset the left content used for the panes.
22439     *
22440     * @param obj The panes object.
22441     * @return The left content object that was being used.
22442     *
22443     * Unparent and return the left content object which was set for this widget.
22444     *
22445     * @see elm_panes_content_left_set() for details.
22446     * @see elm_panes_content_left_get().
22447     *
22448     * @ingroup Panes
22449     */
22450    EAPI Evas_Object          *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22451
22452    /**
22453     * Unset the right content used for the panes.
22454     *
22455     * @param obj The panes object.
22456     * @return The right content object that was being used.
22457     *
22458     * Unparent and return the right content object which was set for this
22459     * widget.
22460     *
22461     * @see elm_panes_content_right_set() for details.
22462     * @see elm_panes_content_right_get().
22463     *
22464     * @ingroup Panes
22465     */
22466    EAPI Evas_Object          *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22467
22468    /**
22469     * Get the size proportion of panes widget's left side.
22470     *
22471     * @param obj The panes object.
22472     * @return float value between 0.0 and 1.0 representing size proportion
22473     * of left side.
22474     *
22475     * @see elm_panes_content_left_size_set() for more details.
22476     *
22477     * @ingroup Panes
22478     */
22479    EAPI double                elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22480
22481    /**
22482     * Set the size proportion of panes widget's left side.
22483     *
22484     * @param obj The panes object.
22485     * @param size Value between 0.0 and 1.0 representing size proportion
22486     * of left side.
22487     *
22488     * By default it's homogeneous, i.e., both sides have the same size.
22489     *
22490     * If something different is required, it can be set with this function.
22491     * For example, if the left content should be displayed over
22492     * 75% of the panes size, @p size should be passed as @c 0.75.
22493     * This way, right content will be resized to 25% of panes size.
22494     *
22495     * If displayed vertically, left content is displayed at top, and
22496     * right content at bottom.
22497     *
22498     * @note This proportion will change when user drags the panes bar.
22499     *
22500     * @see elm_panes_content_left_size_get()
22501     *
22502     * @ingroup Panes
22503     */
22504    EAPI void                  elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
22505
22506   /**
22507    * Set the orientation of a given panes widget.
22508    *
22509    * @param obj The panes object.
22510    * @param horizontal Use @c EINA_TRUE to make @p obj to be
22511    * @b horizontal, @c EINA_FALSE to make it @b vertical.
22512    *
22513    * Use this function to change how your panes is to be
22514    * disposed: vertically or horizontally.
22515    *
22516    * By default it's displayed horizontally.
22517    *
22518    * @see elm_panes_horizontal_get()
22519    *
22520    * @ingroup Panes
22521    */
22522    EAPI void                  elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22523
22524    /**
22525     * Retrieve the orientation of a given panes widget.
22526     *
22527     * @param obj The panes object.
22528     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
22529     * @c EINA_FALSE if it's @b vertical (and on errors).
22530     *
22531     * @see elm_panes_horizontal_set() for more details.
22532     *
22533     * @ingroup Panes
22534     */
22535    EAPI Eina_Bool             elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22536
22537    /**
22538     * @}
22539     */
22540
22541    /**
22542     * @defgroup Flip Flip
22543     *
22544     * @image html img/widget/flip/preview-00.png
22545     * @image latex img/widget/flip/preview-00.eps
22546     *
22547     * This widget holds 2 content objects(Evas_Object): one on the front and one
22548     * on the back. It allows you to flip from front to back and vice-versa using
22549     * various animations.
22550     *
22551     * If either the front or back contents are not set the flip will treat that
22552     * as transparent. So if you wore to set the front content but not the back,
22553     * and then call elm_flip_go() you would see whatever is below the flip.
22554     *
22555     * For a list of supported animations see elm_flip_go().
22556     *
22557     * Signals that you can add callbacks for are:
22558     * "animate,begin" - when a flip animation was started
22559     * "animate,done" - when a flip animation is finished
22560     *
22561     * @ref tutorial_flip show how to use most of the API.
22562     *
22563     * @{
22564     */
22565    typedef enum _Elm_Flip_Mode
22566      {
22567         ELM_FLIP_ROTATE_Y_CENTER_AXIS,
22568         ELM_FLIP_ROTATE_X_CENTER_AXIS,
22569         ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
22570         ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
22571         ELM_FLIP_CUBE_LEFT,
22572         ELM_FLIP_CUBE_RIGHT,
22573         ELM_FLIP_CUBE_UP,
22574         ELM_FLIP_CUBE_DOWN,
22575         ELM_FLIP_PAGE_LEFT,
22576         ELM_FLIP_PAGE_RIGHT,
22577         ELM_FLIP_PAGE_UP,
22578         ELM_FLIP_PAGE_DOWN
22579      } Elm_Flip_Mode;
22580    typedef enum _Elm_Flip_Interaction
22581      {
22582         ELM_FLIP_INTERACTION_NONE,
22583         ELM_FLIP_INTERACTION_ROTATE,
22584         ELM_FLIP_INTERACTION_CUBE,
22585         ELM_FLIP_INTERACTION_PAGE
22586      } Elm_Flip_Interaction;
22587    typedef enum _Elm_Flip_Direction
22588      {
22589         ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
22590         ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
22591         ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
22592         ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
22593      } Elm_Flip_Direction;
22594    /**
22595     * @brief Add a new flip to the parent
22596     *
22597     * @param parent The parent object
22598     * @return The new object or NULL if it cannot be created
22599     */
22600    EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22601    /**
22602     * @brief Set the front content of the flip widget.
22603     *
22604     * @param obj The flip object
22605     * @param content The new front content object
22606     *
22607     * Once the content object is set, a previously set one will be deleted.
22608     * If you want to keep that old content object, use the
22609     * elm_flip_content_front_unset() function.
22610     */
22611    EAPI void         elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22612    /**
22613     * @brief Set the back content of the flip widget.
22614     *
22615     * @param obj The flip object
22616     * @param content The new back content object
22617     *
22618     * Once the content object is set, a previously set one will be deleted.
22619     * If you want to keep that old content object, use the
22620     * elm_flip_content_back_unset() function.
22621     */
22622    EAPI void         elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22623    /**
22624     * @brief Get the front content used for the flip
22625     *
22626     * @param obj The flip object
22627     * @return The front content object that is being used
22628     *
22629     * Return the front content object which is set for this widget.
22630     */
22631    EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22632    /**
22633     * @brief Get the back content used for the flip
22634     *
22635     * @param obj The flip object
22636     * @return The back content object that is being used
22637     *
22638     * Return the back content object which is set for this widget.
22639     */
22640    EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22641    /**
22642     * @brief Unset the front content used for the flip
22643     *
22644     * @param obj The flip object
22645     * @return The front content object that was being used
22646     *
22647     * Unparent and return the front content object which was set for this widget.
22648     */
22649    EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22650    /**
22651     * @brief Unset the back content used for the flip
22652     *
22653     * @param obj The flip object
22654     * @return The back content object that was being used
22655     *
22656     * Unparent and return the back content object which was set for this widget.
22657     */
22658    EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22659    /**
22660     * @brief Get flip front visibility state
22661     *
22662     * @param obj The flip objct
22663     * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
22664     * showing.
22665     */
22666    EAPI Eina_Bool    elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22667    /**
22668     * @brief Set flip perspective
22669     *
22670     * @param obj The flip object
22671     * @param foc The coordinate to set the focus on
22672     * @param x The X coordinate
22673     * @param y The Y coordinate
22674     *
22675     * @warning This function currently does nothing.
22676     */
22677    EAPI void         elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
22678    /**
22679     * @brief Runs the flip animation
22680     *
22681     * @param obj The flip object
22682     * @param mode The mode type
22683     *
22684     * Flips the front and back contents using the @p mode animation. This
22685     * efectively hides the currently visible content and shows the hidden one.
22686     *
22687     * There a number of possible animations to use for the flipping:
22688     * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
22689     * around a horizontal axis in the middle of its height, the other content
22690     * is shown as the other side of the flip.
22691     * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
22692     * around a vertical axis in the middle of its width, the other content is
22693     * shown as the other side of the flip.
22694     * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
22695     * around a diagonal axis in the middle of its width, the other content is
22696     * shown as the other side of the flip.
22697     * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
22698     * around a diagonal axis in the middle of its height, the other content is
22699     * shown as the other side of the flip.
22700     * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
22701     * as if the flip was a cube, the other content is show as the right face of
22702     * the cube.
22703     * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
22704     * right as if the flip was a cube, the other content is show as the left
22705     * face of the cube.
22706     * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
22707     * flip was a cube, the other content is show as the bottom face of the cube.
22708     * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
22709     * the flip was a cube, the other content is show as the upper face of the
22710     * cube.
22711     * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
22712     * if the flip was a book, the other content is shown as the page below that.
22713     * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
22714     * as if the flip was a book, the other content is shown as the page below
22715     * that.
22716     * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
22717     * flip was a book, the other content is shown as the page below that.
22718     * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
22719     * flip was a book, the other content is shown as the page below that.
22720     *
22721     * @image html elm_flip.png
22722     * @image latex elm_flip.eps width=\textwidth
22723     */
22724    EAPI void         elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
22725    /**
22726     * @brief Set the interactive flip mode
22727     *
22728     * @param obj The flip object
22729     * @param mode The interactive flip mode to use
22730     *
22731     * This sets if the flip should be interactive (allow user to click and
22732     * drag a side of the flip to reveal the back page and cause it to flip).
22733     * By default a flip is not interactive. You may also need to set which
22734     * sides of the flip are "active" for flipping and how much space they use
22735     * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
22736     * and elm_flip_interacton_direction_hitsize_set()
22737     *
22738     * The four avilable mode of interaction are:
22739     * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
22740     * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
22741     * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
22742     * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
22743     *
22744     * @note ELM_FLIP_INTERACTION_ROTATE won't cause
22745     * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
22746     * happen, those can only be acheived with elm_flip_go();
22747     */
22748    EAPI void         elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
22749    /**
22750     * @brief Get the interactive flip mode
22751     *
22752     * @param obj The flip object
22753     * @return The interactive flip mode
22754     *
22755     * Returns the interactive flip mode set by elm_flip_interaction_set()
22756     */
22757    EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
22758    /**
22759     * @brief Set which directions of the flip respond to interactive flip
22760     *
22761     * @param obj The flip object
22762     * @param dir The direction to change
22763     * @param enabled If that direction is enabled or not
22764     *
22765     * By default all directions are disabled, so you may want to enable the
22766     * desired directions for flipping if you need interactive flipping. You must
22767     * call this function once for each direction that should be enabled.
22768     *
22769     * @see elm_flip_interaction_set()
22770     */
22771    EAPI void         elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
22772    /**
22773     * @brief Get the enabled state of that flip direction
22774     *
22775     * @param obj The flip object
22776     * @param dir The direction to check
22777     * @return If that direction is enabled or not
22778     *
22779     * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
22780     *
22781     * @see elm_flip_interaction_set()
22782     */
22783    EAPI Eina_Bool    elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
22784    /**
22785     * @brief Set the amount of the flip that is sensitive to interactive flip
22786     *
22787     * @param obj The flip object
22788     * @param dir The direction to modify
22789     * @param hitsize The amount of that dimension (0.0 to 1.0) to use
22790     *
22791     * Set the amount of the flip that is sensitive to interactive flip, with 0
22792     * representing no area in the flip and 1 representing the entire flip. There
22793     * is however a consideration to be made in that the area will never be
22794     * smaller than the finger size set(as set in your Elementary configuration).
22795     *
22796     * @see elm_flip_interaction_set()
22797     */
22798    EAPI void         elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
22799    /**
22800     * @brief Get the amount of the flip that is sensitive to interactive flip
22801     *
22802     * @param obj The flip object
22803     * @param dir The direction to check
22804     * @return The size set for that direction
22805     *
22806     * Returns the amount os sensitive area set by
22807     * elm_flip_interacton_direction_hitsize_set().
22808     */
22809    EAPI double       elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
22810    /**
22811     * @}
22812     */
22813
22814    /* scrolledentry */
22815    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22816    EINA_DEPRECATED EAPI void         elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
22817    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22818    EINA_DEPRECATED EAPI void         elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
22819    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22820    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22821    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22822    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22823    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22824    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22825    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22826    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
22827    EINA_DEPRECATED EAPI void         elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
22828    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22829    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
22830    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
22831    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
22832    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
22833    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
22834    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
22835    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22836    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22837    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22838    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22839    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
22840    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
22841    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22842    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22843    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22844    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
22845    EINA_DEPRECATED EAPI int          elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22846    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
22847    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
22848    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
22849    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22850    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);
22851    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22852    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22853    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);
22854    EINA_DEPRECATED EAPI void         elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22855    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);
22856    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
22857    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22858    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22859    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
22860    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
22861    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22862    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22863    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
22864    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);
22865    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);
22866    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);
22867    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);
22868    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);
22869    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);
22870    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
22871    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
22872    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
22873    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
22874    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22875    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
22876    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
22877
22878    /**
22879     * @defgroup Conformant Conformant
22880     * @ingroup Elementary
22881     *
22882     * @image html img/widget/conformant/preview-00.png
22883     * @image latex img/widget/conformant/preview-00.eps width=\textwidth
22884     *
22885     * @image html img/conformant.png
22886     * @image latex img/conformant.eps width=\textwidth
22887     *
22888     * The aim is to provide a widget that can be used in elementary apps to
22889     * account for space taken up by the indicator, virtual keypad & softkey
22890     * windows when running the illume2 module of E17.
22891     *
22892     * So conformant content will be sized and positioned considering the
22893     * space required for such stuff, and when they popup, as a keyboard
22894     * shows when an entry is selected, conformant content won't change.
22895     *
22896     * Available styles for it:
22897     * - @c "default"
22898     *
22899     * See how to use this widget in this example:
22900     * @ref conformant_example
22901     */
22902
22903    /**
22904     * @addtogroup Conformant
22905     * @{
22906     */
22907
22908    /**
22909     * Add a new conformant widget to the given parent Elementary
22910     * (container) object.
22911     *
22912     * @param parent The parent object.
22913     * @return A new conformant widget handle or @c NULL, on errors.
22914     *
22915     * This function inserts a new conformant widget on the canvas.
22916     *
22917     * @ingroup Conformant
22918     */
22919    EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22920
22921    /**
22922     * Set the content of the conformant widget.
22923     *
22924     * @param obj The conformant object.
22925     * @param content The content to be displayed by the conformant.
22926     *
22927     * Content will be sized and positioned considering the space required
22928     * to display a virtual keyboard. So it won't fill all the conformant
22929     * size. This way is possible to be sure that content won't resize
22930     * or be re-positioned after the keyboard is displayed.
22931     *
22932     * Once the content object is set, a previously set one will be deleted.
22933     * If you want to keep that old content object, use the
22934     * elm_conformat_content_unset() function.
22935     *
22936     * @see elm_conformant_content_unset()
22937     * @see elm_conformant_content_get()
22938     *
22939     * @ingroup Conformant
22940     */
22941    EAPI void         elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22942
22943    /**
22944     * Get the content of the conformant widget.
22945     *
22946     * @param obj The conformant object.
22947     * @return The content that is being used.
22948     *
22949     * Return the content object which is set for this widget.
22950     * It won't be unparent from conformant. For that, use
22951     * elm_conformant_content_unset().
22952     *
22953     * @see elm_conformant_content_set() for more details.
22954     * @see elm_conformant_content_unset()
22955     *
22956     * @ingroup Conformant
22957     */
22958    EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22959
22960    /**
22961     * Unset the content of the conformant widget.
22962     *
22963     * @param obj The conformant object.
22964     * @return The content that was being used.
22965     *
22966     * Unparent and return the content object which was set for this widget.
22967     *
22968     * @see elm_conformant_content_set() for more details.
22969     *
22970     * @ingroup Conformant
22971     */
22972    EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22973
22974    /**
22975     * Returns the Evas_Object that represents the content area.
22976     *
22977     * @param obj The conformant object.
22978     * @return The content area of the widget.
22979     *
22980     * @ingroup Conformant
22981     */
22982    EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22983
22984    /**
22985     * @}
22986     */
22987
22988    /**
22989     * @defgroup Mapbuf Mapbuf
22990     * @ingroup Elementary
22991     *
22992     * @image html img/widget/mapbuf/preview-00.png
22993     * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
22994     *
22995     * This holds one content object and uses an Evas Map of transformation
22996     * points to be later used with this content. So the content will be
22997     * moved, resized, etc as a single image. So it will improve performance
22998     * when you have a complex interafce, with a lot of elements, and will
22999     * need to resize or move it frequently (the content object and its
23000     * children).
23001     *
23002     * See how to use this widget in this example:
23003     * @ref mapbuf_example
23004     */
23005
23006    /**
23007     * @addtogroup Mapbuf
23008     * @{
23009     */
23010
23011    /**
23012     * Add a new mapbuf widget to the given parent Elementary
23013     * (container) object.
23014     *
23015     * @param parent The parent object.
23016     * @return A new mapbuf widget handle or @c NULL, on errors.
23017     *
23018     * This function inserts a new mapbuf widget on the canvas.
23019     *
23020     * @ingroup Mapbuf
23021     */
23022    EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23023
23024    /**
23025     * Set the content of the mapbuf.
23026     *
23027     * @param obj The mapbuf object.
23028     * @param content The content that will be filled in this mapbuf object.
23029     *
23030     * Once the content object is set, a previously set one will be deleted.
23031     * If you want to keep that old content object, use the
23032     * elm_mapbuf_content_unset() function.
23033     *
23034     * To enable map, elm_mapbuf_enabled_set() should be used.
23035     *
23036     * @ingroup Mapbuf
23037     */
23038    EAPI void         elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23039
23040    /**
23041     * Get the content of the mapbuf.
23042     *
23043     * @param obj The mapbuf object.
23044     * @return The content that is being used.
23045     *
23046     * Return the content object which is set for this widget.
23047     *
23048     * @see elm_mapbuf_content_set() for details.
23049     *
23050     * @ingroup Mapbuf
23051     */
23052    EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23053
23054    /**
23055     * Unset the content of the mapbuf.
23056     *
23057     * @param obj The mapbuf object.
23058     * @return The content that was being used.
23059     *
23060     * Unparent and return the content object which was set for this widget.
23061     *
23062     * @see elm_mapbuf_content_set() for details.
23063     *
23064     * @ingroup Mapbuf
23065     */
23066    EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23067
23068    /**
23069     * Enable or disable the map.
23070     *
23071     * @param obj The mapbuf object.
23072     * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
23073     *
23074     * This enables the map that is set or disables it. On enable, the object
23075     * geometry will be saved, and the new geometry will change (position and
23076     * size) to reflect the map geometry set.
23077     *
23078     * Also, when enabled, alpha and smooth states will be used, so if the
23079     * content isn't solid, alpha should be enabled, for example, otherwise
23080     * a black retangle will fill the content.
23081     *
23082     * When disabled, the stored map will be freed and geometry prior to
23083     * enabling the map will be restored.
23084     *
23085     * It's disabled by default.
23086     *
23087     * @see elm_mapbuf_alpha_set()
23088     * @see elm_mapbuf_smooth_set()
23089     *
23090     * @ingroup Mapbuf
23091     */
23092    EAPI void         elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23093
23094    /**
23095     * Get a value whether map is enabled or not.
23096     *
23097     * @param obj The mapbuf object.
23098     * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
23099     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23100     *
23101     * @see elm_mapbuf_enabled_set() for details.
23102     *
23103     * @ingroup Mapbuf
23104     */
23105    EAPI Eina_Bool    elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23106
23107    /**
23108     * Enable or disable smooth map rendering.
23109     *
23110     * @param obj The mapbuf object.
23111     * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
23112     * to disable it.
23113     *
23114     * This sets smoothing for map rendering. If the object is a type that has
23115     * its own smoothing settings, then both the smooth settings for this object
23116     * and the map must be turned off.
23117     *
23118     * By default smooth maps are enabled.
23119     *
23120     * @ingroup Mapbuf
23121     */
23122    EAPI void         elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
23123
23124    /**
23125     * Get a value whether smooth map rendering is enabled or not.
23126     *
23127     * @param obj The mapbuf object.
23128     * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
23129     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23130     *
23131     * @see elm_mapbuf_smooth_set() for details.
23132     *
23133     * @ingroup Mapbuf
23134     */
23135    EAPI Eina_Bool    elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23136
23137    /**
23138     * Set or unset alpha flag for map rendering.
23139     *
23140     * @param obj The mapbuf object.
23141     * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
23142     * to disable it.
23143     *
23144     * This sets alpha flag for map rendering. If the object is a type that has
23145     * its own alpha settings, then this will take precedence. Only image objects
23146     * have this currently. It stops alpha blending of the map area, and is
23147     * useful if you know the object and/or all sub-objects is 100% solid.
23148     *
23149     * Alpha is enabled by default.
23150     *
23151     * @ingroup Mapbuf
23152     */
23153    EAPI void         elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
23154
23155    /**
23156     * Get a value whether alpha blending is enabled or not.
23157     *
23158     * @param obj The mapbuf object.
23159     * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
23160     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23161     *
23162     * @see elm_mapbuf_alpha_set() for details.
23163     *
23164     * @ingroup Mapbuf
23165     */
23166    EAPI Eina_Bool    elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23167
23168    /**
23169     * @}
23170     */
23171
23172    /**
23173     * @defgroup Flipselector Flip Selector
23174     *
23175     * @image html img/widget/flipselector/preview-00.png
23176     * @image latex img/widget/flipselector/preview-00.eps
23177     *
23178     * A flip selector is a widget to show a set of @b text items, one
23179     * at a time, with the same sheet switching style as the @ref Clock
23180     * "clock" widget, when one changes the current displaying sheet
23181     * (thus, the "flip" in the name).
23182     *
23183     * User clicks to flip sheets which are @b held for some time will
23184     * make the flip selector to flip continuosly and automatically for
23185     * the user. The interval between flips will keep growing in time,
23186     * so that it helps the user to reach an item which is distant from
23187     * the current selection.
23188     *
23189     * Smart callbacks one can register to:
23190     * - @c "selected" - when the widget's selected text item is changed
23191     * - @c "overflowed" - when the widget's current selection is changed
23192     *   from the first item in its list to the last
23193     * - @c "underflowed" - when the widget's current selection is changed
23194     *   from the last item in its list to the first
23195     *
23196     * Available styles for it:
23197     * - @c "default"
23198     *
23199     * Here is an example on its usage:
23200     * @li @ref flipselector_example
23201     */
23202
23203    /**
23204     * @addtogroup Flipselector
23205     * @{
23206     */
23207
23208    typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
23209
23210    /**
23211     * Add a new flip selector widget to the given parent Elementary
23212     * (container) widget
23213     *
23214     * @param parent The parent object
23215     * @return a new flip selector widget handle or @c NULL, on errors
23216     *
23217     * This function inserts a new flip selector widget on the canvas.
23218     *
23219     * @ingroup Flipselector
23220     */
23221    EAPI Evas_Object               *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23222
23223    /**
23224     * Programmatically select the next item of a flip selector widget
23225     *
23226     * @param obj The flipselector object
23227     *
23228     * @note The selection will be animated. Also, if it reaches the
23229     * end of its list of member items, it will continue with the first
23230     * one onwards.
23231     *
23232     * @ingroup Flipselector
23233     */
23234    EAPI void                       elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
23235
23236    /**
23237     * Programmatically select the previous item of a flip selector
23238     * widget
23239     *
23240     * @param obj The flipselector object
23241     *
23242     * @note The selection will be animated.  Also, if it reaches the
23243     * beginning of its list of member items, it will continue with the
23244     * last one backwards.
23245     *
23246     * @ingroup Flipselector
23247     */
23248    EAPI void                       elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
23249
23250    /**
23251     * Append a (text) item to a flip selector widget
23252     *
23253     * @param obj The flipselector object
23254     * @param label The (text) label of the new item
23255     * @param func Convenience callback function to take place when
23256     * item is selected
23257     * @param data Data passed to @p func, above
23258     * @return A handle to the item added or @c NULL, on errors
23259     *
23260     * The widget's list of labels to show will be appended with the
23261     * given value. If the user wishes so, a callback function pointer
23262     * can be passed, which will get called when this same item is
23263     * selected.
23264     *
23265     * @note The current selection @b won't be modified by appending an
23266     * element to the list.
23267     *
23268     * @note The maximum length of the text label is going to be
23269     * determined <b>by the widget's theme</b>. Strings larger than
23270     * that value are going to be @b truncated.
23271     *
23272     * @ingroup Flipselector
23273     */
23274    EAPI Elm_Flipselector_Item     *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
23275
23276    /**
23277     * Prepend a (text) item to a flip selector widget
23278     *
23279     * @param obj The flipselector object
23280     * @param label The (text) label of the new item
23281     * @param func Convenience callback function to take place when
23282     * item is selected
23283     * @param data Data passed to @p func, above
23284     * @return A handle to the item added or @c NULL, on errors
23285     *
23286     * The widget's list of labels to show will be prepended with the
23287     * given value. If the user wishes so, a callback function pointer
23288     * can be passed, which will get called when this same item is
23289     * selected.
23290     *
23291     * @note The current selection @b won't be modified by prepending
23292     * an element to the list.
23293     *
23294     * @note The maximum length of the text label is going to be
23295     * determined <b>by the widget's theme</b>. Strings larger than
23296     * that value are going to be @b truncated.
23297     *
23298     * @ingroup Flipselector
23299     */
23300    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
23301
23302    /**
23303     * Get the internal list of items in a given flip selector widget.
23304     *
23305     * @param obj The flipselector object
23306     * @return The list of items (#Elm_Flipselector_Item as data) or
23307     * @c NULL on errors.
23308     *
23309     * This list is @b not to be modified in any way and must not be
23310     * freed. Use the list members with functions like
23311     * elm_flipselector_item_label_set(),
23312     * elm_flipselector_item_label_get(),
23313     * elm_flipselector_item_del(),
23314     * elm_flipselector_item_selected_get(),
23315     * elm_flipselector_item_selected_set().
23316     *
23317     * @warning This list is only valid until @p obj object's internal
23318     * items list is changed. It should be fetched again with another
23319     * call to this function when changes happen.
23320     *
23321     * @ingroup Flipselector
23322     */
23323    EAPI const Eina_List           *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23324
23325    /**
23326     * Get the first item in the given flip selector widget's list of
23327     * items.
23328     *
23329     * @param obj The flipselector object
23330     * @return The first item or @c NULL, if it has no items (and on
23331     * errors)
23332     *
23333     * @see elm_flipselector_item_append()
23334     * @see elm_flipselector_last_item_get()
23335     *
23336     * @ingroup Flipselector
23337     */
23338    EAPI Elm_Flipselector_Item     *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23339
23340    /**
23341     * Get the last item in the given flip selector widget's list of
23342     * items.
23343     *
23344     * @param obj The flipselector object
23345     * @return The last item or @c NULL, if it has no items (and on
23346     * errors)
23347     *
23348     * @see elm_flipselector_item_prepend()
23349     * @see elm_flipselector_first_item_get()
23350     *
23351     * @ingroup Flipselector
23352     */
23353    EAPI Elm_Flipselector_Item     *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23354
23355    /**
23356     * Get the currently selected item in a flip selector widget.
23357     *
23358     * @param obj The flipselector object
23359     * @return The selected item or @c NULL, if the widget has no items
23360     * (and on erros)
23361     *
23362     * @ingroup Flipselector
23363     */
23364    EAPI Elm_Flipselector_Item     *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23365
23366    /**
23367     * Set whether a given flip selector widget's item should be the
23368     * currently selected one.
23369     *
23370     * @param item The flip selector item
23371     * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
23372     *
23373     * This sets whether @p item is or not the selected (thus, under
23374     * display) one. If @p item is different than one under display,
23375     * the latter will be unselected. If the @p item is set to be
23376     * unselected, on the other hand, the @b first item in the widget's
23377     * internal members list will be the new selected one.
23378     *
23379     * @see elm_flipselector_item_selected_get()
23380     *
23381     * @ingroup Flipselector
23382     */
23383    EAPI void                       elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
23384
23385    /**
23386     * Get whether a given flip selector widget's item is the currently
23387     * selected one.
23388     *
23389     * @param item The flip selector item
23390     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
23391     * (or on errors).
23392     *
23393     * @see elm_flipselector_item_selected_set()
23394     *
23395     * @ingroup Flipselector
23396     */
23397    EAPI Eina_Bool                  elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23398
23399    /**
23400     * Delete a given item from a flip selector widget.
23401     *
23402     * @param item The item to delete
23403     *
23404     * @ingroup Flipselector
23405     */
23406    EAPI void                       elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23407
23408    /**
23409     * Get the label of a given flip selector widget's item.
23410     *
23411     * @param item The item to get label from
23412     * @return The text label of @p item or @c NULL, on errors
23413     *
23414     * @see elm_flipselector_item_label_set()
23415     *
23416     * @ingroup Flipselector
23417     */
23418    EAPI const char                *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23419
23420    /**
23421     * Set the label of a given flip selector widget's item.
23422     *
23423     * @param item The item to set label on
23424     * @param label The text label string, in UTF-8 encoding
23425     *
23426     * @see elm_flipselector_item_label_get()
23427     *
23428     * @ingroup Flipselector
23429     */
23430    EAPI void                       elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
23431
23432    /**
23433     * Gets the item before @p item in a flip selector widget's
23434     * internal list of items.
23435     *
23436     * @param item The item to fetch previous from
23437     * @return The item before the @p item, in its parent's list. If
23438     *         there is no previous item for @p item or there's an
23439     *         error, @c NULL is returned.
23440     *
23441     * @see elm_flipselector_item_next_get()
23442     *
23443     * @ingroup Flipselector
23444     */
23445    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23446
23447    /**
23448     * Gets the item after @p item in a flip selector widget's
23449     * internal list of items.
23450     *
23451     * @param item The item to fetch next from
23452     * @return The item after the @p item, in its parent's list. If
23453     *         there is no next item for @p item or there's an
23454     *         error, @c NULL is returned.
23455     *
23456     * @see elm_flipselector_item_next_get()
23457     *
23458     * @ingroup Flipselector
23459     */
23460    EAPI Elm_Flipselector_Item     *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23461
23462    /**
23463     * Set the interval on time updates for an user mouse button hold
23464     * on a flip selector widget.
23465     *
23466     * @param obj The flip selector object
23467     * @param interval The (first) interval value in seconds
23468     *
23469     * This interval value is @b decreased while the user holds the
23470     * mouse pointer either flipping up or flipping doww a given flip
23471     * selector.
23472     *
23473     * This helps the user to get to a given item distant from the
23474     * current one easier/faster, as it will start to flip quicker and
23475     * quicker on mouse button holds.
23476     *
23477     * The calculation for the next flip interval value, starting from
23478     * the one set with this call, is the previous interval divided by
23479     * 1.05, so it decreases a little bit.
23480     *
23481     * The default starting interval value for automatic flips is
23482     * @b 0.85 seconds.
23483     *
23484     * @see elm_flipselector_interval_get()
23485     *
23486     * @ingroup Flipselector
23487     */
23488    EAPI void                       elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
23489
23490    /**
23491     * Get the interval on time updates for an user mouse button hold
23492     * on a flip selector widget.
23493     *
23494     * @param obj The flip selector object
23495     * @return The (first) interval value, in seconds, set on it
23496     *
23497     * @see elm_flipselector_interval_set() for more details
23498     *
23499     * @ingroup Flipselector
23500     */
23501    EAPI double                     elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23502    /**
23503     * @}
23504     */
23505
23506    /**
23507     * @addtogroup Calendar
23508     * @{
23509     */
23510
23511    /**
23512     * @enum _Elm_Calendar_Mark_Repeat
23513     * @typedef Elm_Calendar_Mark_Repeat
23514     *
23515     * Event periodicity, used to define if a mark should be repeated
23516     * @b beyond event's day. It's set when a mark is added.
23517     *
23518     * So, for a mark added to 13th May with periodicity set to WEEKLY,
23519     * there will be marks every week after this date. Marks will be displayed
23520     * at 13th, 20th, 27th, 3rd June ...
23521     *
23522     * Values don't work as bitmask, only one can be choosen.
23523     *
23524     * @see elm_calendar_mark_add()
23525     *
23526     * @ingroup Calendar
23527     */
23528    typedef enum _Elm_Calendar_Mark_Repeat
23529      {
23530         ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
23531         ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
23532         ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
23533         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*/
23534         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. */
23535      } Elm_Calendar_Mark_Repeat;
23536
23537    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(). */
23538
23539    /**
23540     * Add a new calendar widget to the given parent Elementary
23541     * (container) object.
23542     *
23543     * @param parent The parent object.
23544     * @return a new calendar widget handle or @c NULL, on errors.
23545     *
23546     * This function inserts a new calendar widget on the canvas.
23547     *
23548     * @ref calendar_example_01
23549     *
23550     * @ingroup Calendar
23551     */
23552    EAPI Evas_Object       *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23553
23554    /**
23555     * Get weekdays names displayed by the calendar.
23556     *
23557     * @param obj The calendar object.
23558     * @return Array of seven strings to be used as weekday names.
23559     *
23560     * By default, weekdays abbreviations get from system are displayed:
23561     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
23562     * The first string is related to Sunday, the second to Monday...
23563     *
23564     * @see elm_calendar_weekdays_name_set()
23565     *
23566     * @ref calendar_example_05
23567     *
23568     * @ingroup Calendar
23569     */
23570    EAPI const char       **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23571
23572    /**
23573     * Set weekdays names to be displayed by the calendar.
23574     *
23575     * @param obj The calendar object.
23576     * @param weekdays Array of seven strings to be used as weekday names.
23577     * @warning It must have 7 elements, or it will access invalid memory.
23578     * @warning The strings must be NULL terminated ('@\0').
23579     *
23580     * By default, weekdays abbreviations get from system are displayed:
23581     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
23582     *
23583     * The first string should be related to Sunday, the second to Monday...
23584     *
23585     * The usage should be like this:
23586     * @code
23587     *   const char *weekdays[] =
23588     *   {
23589     *      "Sunday", "Monday", "Tuesday", "Wednesday",
23590     *      "Thursday", "Friday", "Saturday"
23591     *   };
23592     *   elm_calendar_weekdays_names_set(calendar, weekdays);
23593     * @endcode
23594     *
23595     * @see elm_calendar_weekdays_name_get()
23596     *
23597     * @ref calendar_example_02
23598     *
23599     * @ingroup Calendar
23600     */
23601    EAPI void               elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
23602
23603    /**
23604     * Set the minimum and maximum values for the year
23605     *
23606     * @param obj The calendar object
23607     * @param min The minimum year, greater than 1901;
23608     * @param max The maximum year;
23609     *
23610     * Maximum must be greater than minimum, except if you don't wan't to set
23611     * maximum year.
23612     * Default values are 1902 and -1.
23613     *
23614     * If the maximum year is a negative value, it will be limited depending
23615     * on the platform architecture (year 2037 for 32 bits);
23616     *
23617     * @see elm_calendar_min_max_year_get()
23618     *
23619     * @ref calendar_example_03
23620     *
23621     * @ingroup Calendar
23622     */
23623    EAPI void               elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
23624
23625    /**
23626     * Get the minimum and maximum values for the year
23627     *
23628     * @param obj The calendar object.
23629     * @param min The minimum year.
23630     * @param max The maximum year.
23631     *
23632     * Default values are 1902 and -1.
23633     *
23634     * @see elm_calendar_min_max_year_get() for more details.
23635     *
23636     * @ref calendar_example_05
23637     *
23638     * @ingroup Calendar
23639     */
23640    EAPI void               elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
23641
23642    /**
23643     * Enable or disable day selection
23644     *
23645     * @param obj The calendar object.
23646     * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
23647     * disable it.
23648     *
23649     * Enabled by default. If disabled, the user still can select months,
23650     * but not days. Selected days are highlighted on calendar.
23651     * It should be used if you won't need such selection for the widget usage.
23652     *
23653     * When a day is selected, or month is changed, smart callbacks for
23654     * signal "changed" will be called.
23655     *
23656     * @see elm_calendar_day_selection_enable_get()
23657     *
23658     * @ref calendar_example_04
23659     *
23660     * @ingroup Calendar
23661     */
23662    EAPI void               elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23663
23664    /**
23665     * Get a value whether day selection is enabled or not.
23666     *
23667     * @see elm_calendar_day_selection_enable_set() for details.
23668     *
23669     * @param obj The calendar object.
23670     * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
23671     * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
23672     *
23673     * @ref calendar_example_05
23674     *
23675     * @ingroup Calendar
23676     */
23677    EAPI Eina_Bool          elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23678
23679
23680    /**
23681     * Set selected date to be highlighted on calendar.
23682     *
23683     * @param obj The calendar object.
23684     * @param selected_time A @b tm struct to represent the selected date.
23685     *
23686     * Set the selected date, changing the displayed month if needed.
23687     * Selected date changes when the user goes to next/previous month or
23688     * select a day pressing over it on calendar.
23689     *
23690     * @see elm_calendar_selected_time_get()
23691     *
23692     * @ref calendar_example_04
23693     *
23694     * @ingroup Calendar
23695     */
23696    EAPI void               elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
23697
23698    /**
23699     * Get selected date.
23700     *
23701     * @param obj The calendar object
23702     * @param selected_time A @b tm struct to point to selected date
23703     * @return EINA_FALSE means an error ocurred and returned time shouldn't
23704     * be considered.
23705     *
23706     * Get date selected by the user or set by function
23707     * elm_calendar_selected_time_set().
23708     * Selected date changes when the user goes to next/previous month or
23709     * select a day pressing over it on calendar.
23710     *
23711     * @see elm_calendar_selected_time_get()
23712     *
23713     * @ref calendar_example_05
23714     *
23715     * @ingroup Calendar
23716     */
23717    EAPI Eina_Bool          elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
23718
23719    /**
23720     * Set a function to format the string that will be used to display
23721     * month and year;
23722     *
23723     * @param obj The calendar object
23724     * @param format_function Function to set the month-year string given
23725     * the selected date
23726     *
23727     * By default it uses strftime with "%B %Y" format string.
23728     * It should allocate the memory that will be used by the string,
23729     * that will be freed by the widget after usage.
23730     * A pointer to the string and a pointer to the time struct will be provided.
23731     *
23732     * Example:
23733     * @code
23734     * static char *
23735     * _format_month_year(struct tm *selected_time)
23736     * {
23737     *    char buf[32];
23738     *    if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
23739     *    return strdup(buf);
23740     * }
23741     *
23742     * elm_calendar_format_function_set(calendar, _format_month_year);
23743     * @endcode
23744     *
23745     * @ref calendar_example_02
23746     *
23747     * @ingroup Calendar
23748     */
23749    EAPI void               elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
23750
23751    /**
23752     * Add a new mark to the calendar
23753     *
23754     * @param obj The calendar object
23755     * @param mark_type A string used to define the type of mark. It will be
23756     * emitted to the theme, that should display a related modification on these
23757     * days representation.
23758     * @param mark_time A time struct to represent the date of inclusion of the
23759     * mark. For marks that repeats it will just be displayed after the inclusion
23760     * date in the calendar.
23761     * @param repeat Repeat the event following this periodicity. Can be a unique
23762     * mark (that don't repeat), daily, weekly, monthly or annually.
23763     * @return The created mark or @p NULL upon failure.
23764     *
23765     * Add a mark that will be drawn in the calendar respecting the insertion
23766     * time and periodicity. It will emit the type as signal to the widget theme.
23767     * Default theme supports "holiday" and "checked", but it can be extended.
23768     *
23769     * It won't immediately update the calendar, drawing the marks.
23770     * For this, call elm_calendar_marks_draw(). However, when user selects
23771     * next or previous month calendar forces marks drawn.
23772     *
23773     * Marks created with this method can be deleted with
23774     * elm_calendar_mark_del().
23775     *
23776     * Example
23777     * @code
23778     * struct tm selected_time;
23779     * time_t current_time;
23780     *
23781     * current_time = time(NULL) + 5 * 84600;
23782     * localtime_r(&current_time, &selected_time);
23783     * elm_calendar_mark_add(cal, "holiday", selected_time,
23784     *     ELM_CALENDAR_ANNUALLY);
23785     *
23786     * current_time = time(NULL) + 1 * 84600;
23787     * localtime_r(&current_time, &selected_time);
23788     * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
23789     *
23790     * elm_calendar_marks_draw(cal);
23791     * @endcode
23792     *
23793     * @see elm_calendar_marks_draw()
23794     * @see elm_calendar_mark_del()
23795     *
23796     * @ref calendar_example_06
23797     *
23798     * @ingroup Calendar
23799     */
23800    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);
23801
23802    /**
23803     * Delete mark from the calendar.
23804     *
23805     * @param mark The mark to be deleted.
23806     *
23807     * If deleting all calendar marks is required, elm_calendar_marks_clear()
23808     * should be used instead of getting marks list and deleting each one.
23809     *
23810     * @see elm_calendar_mark_add()
23811     *
23812     * @ref calendar_example_06
23813     *
23814     * @ingroup Calendar
23815     */
23816    EAPI void               elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
23817
23818    /**
23819     * Remove all calendar's marks
23820     *
23821     * @param obj The calendar object.
23822     *
23823     * @see elm_calendar_mark_add()
23824     * @see elm_calendar_mark_del()
23825     *
23826     * @ingroup Calendar
23827     */
23828    EAPI void               elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
23829
23830
23831    /**
23832     * Get a list of all the calendar marks.
23833     *
23834     * @param obj The calendar object.
23835     * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
23836     *
23837     * @see elm_calendar_mark_add()
23838     * @see elm_calendar_mark_del()
23839     * @see elm_calendar_marks_clear()
23840     *
23841     * @ingroup Calendar
23842     */
23843    EAPI const Eina_List   *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23844
23845    /**
23846     * Draw calendar marks.
23847     *
23848     * @param obj The calendar object.
23849     *
23850     * Should be used after adding, removing or clearing marks.
23851     * It will go through the entire marks list updating the calendar.
23852     * If lots of marks will be added, add all the marks and then call
23853     * this function.
23854     *
23855     * When the month is changed, i.e. user selects next or previous month,
23856     * marks will be drawed.
23857     *
23858     * @see elm_calendar_mark_add()
23859     * @see elm_calendar_mark_del()
23860     * @see elm_calendar_marks_clear()
23861     *
23862     * @ref calendar_example_06
23863     *
23864     * @ingroup Calendar
23865     */
23866    EAPI void               elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
23867
23868    /**
23869     * Set a day text color to the same that represents Saturdays.
23870     *
23871     * @param obj The calendar object.
23872     * @param pos The text position. Position is the cell counter, from left
23873     * to right, up to down. It starts on 0 and ends on 41.
23874     *
23875     * @deprecated use elm_calendar_mark_add() instead like:
23876     *
23877     * @code
23878     * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
23879     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
23880     * @endcode
23881     *
23882     * @see elm_calendar_mark_add()
23883     *
23884     * @ingroup Calendar
23885     */
23886    EINA_DEPRECATED EAPI void               elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23887
23888    /**
23889     * Set a day text color to the same that represents Sundays.
23890     *
23891     * @param obj The calendar object.
23892     * @param pos The text position. Position is the cell counter, from left
23893     * to right, up to down. It starts on 0 and ends on 41.
23894
23895     * @deprecated use elm_calendar_mark_add() instead like:
23896     *
23897     * @code
23898     * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
23899     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
23900     * @endcode
23901     *
23902     * @see elm_calendar_mark_add()
23903     *
23904     * @ingroup Calendar
23905     */
23906    EINA_DEPRECATED EAPI void               elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23907
23908    /**
23909     * Set a day text color to the same that represents Weekdays.
23910     *
23911     * @param obj The calendar object
23912     * @param pos The text position. Position is the cell counter, from left
23913     * to right, up to down. It starts on 0 and ends on 41.
23914     *
23915     * @deprecated use elm_calendar_mark_add() instead like:
23916     *
23917     * @code
23918     * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
23919     *
23920     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
23921     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23922     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
23923     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23924     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
23925     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23926     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
23927     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23928     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
23929     * @endcode
23930     *
23931     * @see elm_calendar_mark_add()
23932     *
23933     * @ingroup Calendar
23934     */
23935    EINA_DEPRECATED EAPI void               elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23936
23937    /**
23938     * Set the interval on time updates for an user mouse button hold
23939     * on calendar widgets' month selection.
23940     *
23941     * @param obj The calendar object
23942     * @param interval The (first) interval value in seconds
23943     *
23944     * This interval value is @b decreased while the user holds the
23945     * mouse pointer either selecting next or previous month.
23946     *
23947     * This helps the user to get to a given month distant from the
23948     * current one easier/faster, as it will start to change quicker and
23949     * quicker on mouse button holds.
23950     *
23951     * The calculation for the next change interval value, starting from
23952     * the one set with this call, is the previous interval divided by
23953     * 1.05, so it decreases a little bit.
23954     *
23955     * The default starting interval value for automatic changes is
23956     * @b 0.85 seconds.
23957     *
23958     * @see elm_calendar_interval_get()
23959     *
23960     * @ingroup Calendar
23961     */
23962    EAPI void               elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
23963
23964    /**
23965     * Get the interval on time updates for an user mouse button hold
23966     * on calendar widgets' month selection.
23967     *
23968     * @param obj The calendar object
23969     * @return The (first) interval value, in seconds, set on it
23970     *
23971     * @see elm_calendar_interval_set() for more details
23972     *
23973     * @ingroup Calendar
23974     */
23975    EAPI double             elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23976
23977    /**
23978     * @}
23979     */
23980
23981    /**
23982     * @defgroup Diskselector Diskselector
23983     * @ingroup Elementary
23984     *
23985     * @image html img/widget/diskselector/preview-00.png
23986     * @image latex img/widget/diskselector/preview-00.eps
23987     *
23988     * A diskselector is a kind of list widget. It scrolls horizontally,
23989     * and can contain label and icon objects. Three items are displayed
23990     * with the selected one in the middle.
23991     *
23992     * It can act like a circular list with round mode and labels can be
23993     * reduced for a defined length for side items.
23994     *
23995     * Smart callbacks one can listen to:
23996     * - "selected" - when item is selected, i.e. scroller stops.
23997     *
23998     * Available styles for it:
23999     * - @c "default"
24000     *
24001     * List of examples:
24002     * @li @ref diskselector_example_01
24003     * @li @ref diskselector_example_02
24004     */
24005
24006    /**
24007     * @addtogroup Diskselector
24008     * @{
24009     */
24010
24011    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(). */
24012
24013    /**
24014     * Add a new diskselector widget to the given parent Elementary
24015     * (container) object.
24016     *
24017     * @param parent The parent object.
24018     * @return a new diskselector widget handle or @c NULL, on errors.
24019     *
24020     * This function inserts a new diskselector widget on the canvas.
24021     *
24022     * @ingroup Diskselector
24023     */
24024    EAPI Evas_Object           *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24025
24026    /**
24027     * Enable or disable round mode.
24028     *
24029     * @param obj The diskselector object.
24030     * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
24031     * disable it.
24032     *
24033     * Disabled by default. If round mode is enabled the items list will
24034     * work like a circle list, so when the user reaches the last item,
24035     * the first one will popup.
24036     *
24037     * @see elm_diskselector_round_get()
24038     *
24039     * @ingroup Diskselector
24040     */
24041    EAPI void                   elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
24042
24043    /**
24044     * Get a value whether round mode is enabled or not.
24045     *
24046     * @see elm_diskselector_round_set() for details.
24047     *
24048     * @param obj The diskselector object.
24049     * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
24050     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24051     *
24052     * @ingroup Diskselector
24053     */
24054    EAPI Eina_Bool              elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24055
24056    /**
24057     * Get the side labels max length.
24058     *
24059     * @deprecated use elm_diskselector_side_label_length_get() instead:
24060     *
24061     * @param obj The diskselector object.
24062     * @return The max length defined for side labels, or 0 if not a valid
24063     * diskselector.
24064     *
24065     * @ingroup Diskselector
24066     */
24067    EINA_DEPRECATED EAPI int    elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24068
24069    /**
24070     * Set the side labels max length.
24071     *
24072     * @deprecated use elm_diskselector_side_label_length_set() instead:
24073     *
24074     * @param obj The diskselector object.
24075     * @param len The max length defined for side labels.
24076     *
24077     * @ingroup Diskselector
24078     */
24079    EINA_DEPRECATED EAPI void   elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
24080
24081    /**
24082     * Get the side labels max length.
24083     *
24084     * @see elm_diskselector_side_label_length_set() for details.
24085     *
24086     * @param obj The diskselector object.
24087     * @return The max length defined for side labels, or 0 if not a valid
24088     * diskselector.
24089     *
24090     * @ingroup Diskselector
24091     */
24092    EAPI int                    elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24093
24094    /**
24095     * Set the side labels max length.
24096     *
24097     * @param obj The diskselector object.
24098     * @param len The max length defined for side labels.
24099     *
24100     * Length is the number of characters of items' label that will be
24101     * visible when it's set on side positions. It will just crop
24102     * the string after defined size. E.g.:
24103     *
24104     * An item with label "January" would be displayed on side position as
24105     * "Jan" if max length is set to 3, or "Janu", if this property
24106     * is set to 4.
24107     *
24108     * When it's selected, the entire label will be displayed, except for
24109     * width restrictions. In this case label will be cropped and "..."
24110     * will be concatenated.
24111     *
24112     * Default side label max length is 3.
24113     *
24114     * This property will be applyed over all items, included before or
24115     * later this function call.
24116     *
24117     * @ingroup Diskselector
24118     */
24119    EAPI void                   elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
24120
24121    /**
24122     * Set the number of items to be displayed.
24123     *
24124     * @param obj The diskselector object.
24125     * @param num The number of items the diskselector will display.
24126     *
24127     * Default value is 3, and also it's the minimun. If @p num is less
24128     * than 3, it will be set to 3.
24129     *
24130     * Also, it can be set on theme, using data item @c display_item_num
24131     * on group "elm/diskselector/item/X", where X is style set.
24132     * E.g.:
24133     *
24134     * group { name: "elm/diskselector/item/X";
24135     * data {
24136     *     item: "display_item_num" "5";
24137     *     }
24138     *
24139     * @ingroup Diskselector
24140     */
24141    EAPI void                   elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
24142
24143    /**
24144     * Get the number of items in the diskselector object.
24145     *
24146     * @param obj The diskselector object.
24147     *
24148     * @ingroup Diskselector
24149     */
24150    EAPI int                   elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24151
24152    /**
24153     * Set bouncing behaviour when the scrolled content reaches an edge.
24154     *
24155     * Tell the internal scroller object whether it should bounce or not
24156     * when it reaches the respective edges for each axis.
24157     *
24158     * @param obj The diskselector object.
24159     * @param h_bounce Whether to bounce or not in the horizontal axis.
24160     * @param v_bounce Whether to bounce or not in the vertical axis.
24161     *
24162     * @see elm_scroller_bounce_set()
24163     *
24164     * @ingroup Diskselector
24165     */
24166    EAPI void                   elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24167
24168    /**
24169     * Get the bouncing behaviour of the internal scroller.
24170     *
24171     * Get whether the internal scroller should bounce when the edge of each
24172     * axis is reached scrolling.
24173     *
24174     * @param obj The diskselector object.
24175     * @param h_bounce Pointer where to store the bounce state of the horizontal
24176     * axis.
24177     * @param v_bounce Pointer where to store the bounce state of the vertical
24178     * axis.
24179     *
24180     * @see elm_scroller_bounce_get()
24181     * @see elm_diskselector_bounce_set()
24182     *
24183     * @ingroup Diskselector
24184     */
24185    EAPI void                   elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
24186
24187    /**
24188     * Get the scrollbar policy.
24189     *
24190     * @see elm_diskselector_scroller_policy_get() for details.
24191     *
24192     * @param obj The diskselector object.
24193     * @param policy_h Pointer where to store horizontal scrollbar policy.
24194     * @param policy_v Pointer where to store vertical scrollbar policy.
24195     *
24196     * @ingroup Diskselector
24197     */
24198    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);
24199
24200    /**
24201     * Set the scrollbar policy.
24202     *
24203     * @param obj The diskselector object.
24204     * @param policy_h Horizontal scrollbar policy.
24205     * @param policy_v Vertical scrollbar policy.
24206     *
24207     * This sets the scrollbar visibility policy for the given scroller.
24208     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
24209     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
24210     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
24211     * This applies respectively for the horizontal and vertical scrollbars.
24212     *
24213     * The both are disabled by default, i.e., are set to
24214     * #ELM_SCROLLER_POLICY_OFF.
24215     *
24216     * @ingroup Diskselector
24217     */
24218    EAPI void                   elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
24219
24220    /**
24221     * Remove all diskselector's items.
24222     *
24223     * @param obj The diskselector object.
24224     *
24225     * @see elm_diskselector_item_del()
24226     * @see elm_diskselector_item_append()
24227     *
24228     * @ingroup Diskselector
24229     */
24230    EAPI void                   elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24231
24232    /**
24233     * Get a list of all the diskselector items.
24234     *
24235     * @param obj The diskselector object.
24236     * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
24237     * or @c NULL on failure.
24238     *
24239     * @see elm_diskselector_item_append()
24240     * @see elm_diskselector_item_del()
24241     * @see elm_diskselector_clear()
24242     *
24243     * @ingroup Diskselector
24244     */
24245    EAPI const Eina_List       *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24246
24247    /**
24248     * Appends a new item to the diskselector object.
24249     *
24250     * @param obj The diskselector object.
24251     * @param label The label of the diskselector item.
24252     * @param icon The icon object to use at left side of the item. An
24253     * icon can be any Evas object, but usually it is an icon created
24254     * with elm_icon_add().
24255     * @param func The function to call when the item is selected.
24256     * @param data The data to associate with the item for related callbacks.
24257     *
24258     * @return The created item or @c NULL upon failure.
24259     *
24260     * A new item will be created and appended to the diskselector, i.e., will
24261     * be set as last item. Also, if there is no selected item, it will
24262     * be selected. This will always happens for the first appended item.
24263     *
24264     * If no icon is set, label will be centered on item position, otherwise
24265     * the icon will be placed at left of the label, that will be shifted
24266     * to the right.
24267     *
24268     * Items created with this method can be deleted with
24269     * elm_diskselector_item_del().
24270     *
24271     * Associated @p data can be properly freed when item is deleted if a
24272     * callback function is set with elm_diskselector_item_del_cb_set().
24273     *
24274     * If a function is passed as argument, it will be called everytime this item
24275     * is selected, i.e., the user stops the diskselector with this
24276     * item on center position. If such function isn't needed, just passing
24277     * @c NULL as @p func is enough. The same should be done for @p data.
24278     *
24279     * Simple example (with no function callback or data associated):
24280     * @code
24281     * disk = elm_diskselector_add(win);
24282     * ic = elm_icon_add(win);
24283     * elm_icon_file_set(ic, "path/to/image", NULL);
24284     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
24285     * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
24286     * @endcode
24287     *
24288     * @see elm_diskselector_item_del()
24289     * @see elm_diskselector_item_del_cb_set()
24290     * @see elm_diskselector_clear()
24291     * @see elm_icon_add()
24292     *
24293     * @ingroup Diskselector
24294     */
24295    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);
24296
24297
24298    /**
24299     * Delete them item from the diskselector.
24300     *
24301     * @param it The item of diskselector to be deleted.
24302     *
24303     * If deleting all diskselector items is required, elm_diskselector_clear()
24304     * should be used instead of getting items list and deleting each one.
24305     *
24306     * @see elm_diskselector_clear()
24307     * @see elm_diskselector_item_append()
24308     * @see elm_diskselector_item_del_cb_set()
24309     *
24310     * @ingroup Diskselector
24311     */
24312    EAPI void                   elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24313
24314    /**
24315     * Set the function called when a diskselector item is freed.
24316     *
24317     * @param it The item to set the callback on
24318     * @param func The function called
24319     *
24320     * If there is a @p func, then it will be called prior item's memory release.
24321     * That will be called with the following arguments:
24322     * @li item's data;
24323     * @li item's Evas object;
24324     * @li item itself;
24325     *
24326     * This way, a data associated to a diskselector item could be properly
24327     * freed.
24328     *
24329     * @ingroup Diskselector
24330     */
24331    EAPI void                   elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
24332
24333    /**
24334     * Get the data associated to the item.
24335     *
24336     * @param it The diskselector item
24337     * @return The data associated to @p it
24338     *
24339     * The return value is a pointer to data associated to @p item when it was
24340     * created, with function elm_diskselector_item_append(). If no data
24341     * was passed as argument, it will return @c NULL.
24342     *
24343     * @see elm_diskselector_item_append()
24344     *
24345     * @ingroup Diskselector
24346     */
24347    EAPI void                  *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24348
24349    /**
24350     * Set the icon associated to the item.
24351     *
24352     * @param it The diskselector item
24353     * @param icon The icon object to associate with @p it
24354     *
24355     * The icon object to use at left side of the item. An
24356     * icon can be any Evas object, but usually it is an icon created
24357     * with elm_icon_add().
24358     *
24359     * Once the icon object is set, a previously set one will be deleted.
24360     * @warning Setting the same icon for two items will cause the icon to
24361     * dissapear from the first item.
24362     *
24363     * If an icon was passed as argument on item creation, with function
24364     * elm_diskselector_item_append(), it will be already
24365     * associated to the item.
24366     *
24367     * @see elm_diskselector_item_append()
24368     * @see elm_diskselector_item_icon_get()
24369     *
24370     * @ingroup Diskselector
24371     */
24372    EAPI void                   elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
24373
24374    /**
24375     * Get the icon associated to the item.
24376     *
24377     * @param it The diskselector item
24378     * @return The icon associated to @p it
24379     *
24380     * The return value is a pointer to the icon associated to @p item when it was
24381     * created, with function elm_diskselector_item_append(), or later
24382     * with function elm_diskselector_item_icon_set. If no icon
24383     * was passed as argument, it will return @c NULL.
24384     *
24385     * @see elm_diskselector_item_append()
24386     * @see elm_diskselector_item_icon_set()
24387     *
24388     * @ingroup Diskselector
24389     */
24390    EAPI Evas_Object           *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24391
24392    /**
24393     * Set the label of item.
24394     *
24395     * @param it The item of diskselector.
24396     * @param label The label of item.
24397     *
24398     * The label to be displayed by the item.
24399     *
24400     * If no icon is set, label will be centered on item position, otherwise
24401     * the icon will be placed at left of the label, that will be shifted
24402     * to the right.
24403     *
24404     * An item with label "January" would be displayed on side position as
24405     * "Jan" if max length is set to 3 with function
24406     * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
24407     * is set to 4.
24408     *
24409     * When this @p item is selected, the entire label will be displayed,
24410     * except for width restrictions.
24411     * In this case label will be cropped and "..." will be concatenated,
24412     * but only for display purposes. It will keep the entire string, so
24413     * if diskselector is resized the remaining characters will be displayed.
24414     *
24415     * If a label was passed as argument on item creation, with function
24416     * elm_diskselector_item_append(), it will be already
24417     * displayed by the item.
24418     *
24419     * @see elm_diskselector_side_label_lenght_set()
24420     * @see elm_diskselector_item_label_get()
24421     * @see elm_diskselector_item_append()
24422     *
24423     * @ingroup Diskselector
24424     */
24425    EAPI void                   elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
24426
24427    /**
24428     * Get the label of item.
24429     *
24430     * @param it The item of diskselector.
24431     * @return The label of item.
24432     *
24433     * The return value is a pointer to the label associated to @p item when it was
24434     * created, with function elm_diskselector_item_append(), or later
24435     * with function elm_diskselector_item_label_set. If no label
24436     * was passed as argument, it will return @c NULL.
24437     *
24438     * @see elm_diskselector_item_label_set() for more details.
24439     * @see elm_diskselector_item_append()
24440     *
24441     * @ingroup Diskselector
24442     */
24443    EAPI const char            *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24444
24445    /**
24446     * Get the selected item.
24447     *
24448     * @param obj The diskselector object.
24449     * @return The selected diskselector item.
24450     *
24451     * The selected item can be unselected with function
24452     * elm_diskselector_item_selected_set(), and the first item of
24453     * diskselector will be selected.
24454     *
24455     * The selected item always will be centered on diskselector, with
24456     * full label displayed, i.e., max lenght set to side labels won't
24457     * apply on the selected item. More details on
24458     * elm_diskselector_side_label_length_set().
24459     *
24460     * @ingroup Diskselector
24461     */
24462    EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24463
24464    /**
24465     * Set the selected state of an item.
24466     *
24467     * @param it The diskselector item
24468     * @param selected The selected state
24469     *
24470     * This sets the selected state of the given item @p it.
24471     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
24472     *
24473     * If a new item is selected the previosly selected will be unselected.
24474     * Previoulsy selected item can be get with function
24475     * elm_diskselector_selected_item_get().
24476     *
24477     * If the item @p it is unselected, the first item of diskselector will
24478     * be selected.
24479     *
24480     * Selected items will be visible on center position of diskselector.
24481     * So if it was on another position before selected, or was invisible,
24482     * diskselector will animate items until the selected item reaches center
24483     * position.
24484     *
24485     * @see elm_diskselector_item_selected_get()
24486     * @see elm_diskselector_selected_item_get()
24487     *
24488     * @ingroup Diskselector
24489     */
24490    EAPI void                   elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
24491
24492    /*
24493     * Get whether the @p item is selected or not.
24494     *
24495     * @param it The diskselector item.
24496     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
24497     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
24498     *
24499     * @see elm_diskselector_selected_item_set() for details.
24500     * @see elm_diskselector_item_selected_get()
24501     *
24502     * @ingroup Diskselector
24503     */
24504    EAPI Eina_Bool              elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24505
24506    /**
24507     * Get the first item of the diskselector.
24508     *
24509     * @param obj The diskselector object.
24510     * @return The first item, or @c NULL if none.
24511     *
24512     * The list of items follows append order. So it will return the first
24513     * item appended to the widget that wasn't deleted.
24514     *
24515     * @see elm_diskselector_item_append()
24516     * @see elm_diskselector_items_get()
24517     *
24518     * @ingroup Diskselector
24519     */
24520    EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24521
24522    /**
24523     * Get the last item of the diskselector.
24524     *
24525     * @param obj The diskselector object.
24526     * @return The last item, or @c NULL if none.
24527     *
24528     * The list of items follows append order. So it will return last first
24529     * item appended to the widget that wasn't deleted.
24530     *
24531     * @see elm_diskselector_item_append()
24532     * @see elm_diskselector_items_get()
24533     *
24534     * @ingroup Diskselector
24535     */
24536    EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24537
24538    /**
24539     * Get the item before @p item in diskselector.
24540     *
24541     * @param it The diskselector item.
24542     * @return The item before @p item, or @c NULL if none or on failure.
24543     *
24544     * The list of items follows append order. So it will return item appended
24545     * just before @p item and that wasn't deleted.
24546     *
24547     * If it is the first item, @c NULL will be returned.
24548     * First item can be get by elm_diskselector_first_item_get().
24549     *
24550     * @see elm_diskselector_item_append()
24551     * @see elm_diskselector_items_get()
24552     *
24553     * @ingroup Diskselector
24554     */
24555    EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24556
24557    /**
24558     * Get the item after @p item in diskselector.
24559     *
24560     * @param it The diskselector item.
24561     * @return The item after @p item, or @c NULL if none or on failure.
24562     *
24563     * The list of items follows append order. So it will return item appended
24564     * just after @p item and that wasn't deleted.
24565     *
24566     * If it is the last item, @c NULL will be returned.
24567     * Last item can be get by elm_diskselector_last_item_get().
24568     *
24569     * @see elm_diskselector_item_append()
24570     * @see elm_diskselector_items_get()
24571     *
24572     * @ingroup Diskselector
24573     */
24574    EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24575
24576    /**
24577     * Set the text to be shown in the diskselector item.
24578     *
24579     * @param item Target item
24580     * @param text The text to set in the content
24581     *
24582     * Setup the text as tooltip to object. The item can have only one tooltip,
24583     * so any previous tooltip data is removed.
24584     *
24585     * @see elm_object_tooltip_text_set() for more details.
24586     *
24587     * @ingroup Diskselector
24588     */
24589    EAPI void                   elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
24590
24591    /**
24592     * Set the content to be shown in the tooltip item.
24593     *
24594     * Setup the tooltip to item. The item can have only one tooltip,
24595     * so any previous tooltip data is removed. @p func(with @p data) will
24596     * be called every time that need show the tooltip and it should
24597     * return a valid Evas_Object. This object is then managed fully by
24598     * tooltip system and is deleted when the tooltip is gone.
24599     *
24600     * @param item the diskselector item being attached a tooltip.
24601     * @param func the function used to create the tooltip contents.
24602     * @param data what to provide to @a func as callback data/context.
24603     * @param del_cb called when data is not needed anymore, either when
24604     *        another callback replaces @p func, the tooltip is unset with
24605     *        elm_diskselector_item_tooltip_unset() or the owner @a item
24606     *        dies. This callback receives as the first parameter the
24607     *        given @a data, and @c event_info is the item.
24608     *
24609     * @see elm_object_tooltip_content_cb_set() for more details.
24610     *
24611     * @ingroup Diskselector
24612     */
24613    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);
24614
24615    /**
24616     * Unset tooltip from item.
24617     *
24618     * @param item diskselector item to remove previously set tooltip.
24619     *
24620     * Remove tooltip from item. The callback provided as del_cb to
24621     * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
24622     * it is not used anymore.
24623     *
24624     * @see elm_object_tooltip_unset() for more details.
24625     * @see elm_diskselector_item_tooltip_content_cb_set()
24626     *
24627     * @ingroup Diskselector
24628     */
24629    EAPI void                   elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24630
24631
24632    /**
24633     * Sets a different style for this item tooltip.
24634     *
24635     * @note before you set a style you should define a tooltip with
24636     *       elm_diskselector_item_tooltip_content_cb_set() or
24637     *       elm_diskselector_item_tooltip_text_set()
24638     *
24639     * @param item diskselector item with tooltip already set.
24640     * @param style the theme style to use (default, transparent, ...)
24641     *
24642     * @see elm_object_tooltip_style_set() for more details.
24643     *
24644     * @ingroup Diskselector
24645     */
24646    EAPI void                   elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
24647
24648    /**
24649     * Get the style for this item tooltip.
24650     *
24651     * @param item diskselector item with tooltip already set.
24652     * @return style the theme style in use, defaults to "default". If the
24653     *         object does not have a tooltip set, then NULL is returned.
24654     *
24655     * @see elm_object_tooltip_style_get() for more details.
24656     * @see elm_diskselector_item_tooltip_style_set()
24657     *
24658     * @ingroup Diskselector
24659     */
24660    EAPI const char            *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24661
24662    /**
24663     * Set the cursor to be shown when mouse is over the diskselector item
24664     *
24665     * @param item Target item
24666     * @param cursor the cursor name to be used.
24667     *
24668     * @see elm_object_cursor_set() for more details.
24669     *
24670     * @ingroup Diskselector
24671     */
24672    EAPI void                   elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
24673
24674    /**
24675     * Get the cursor to be shown when mouse is over the diskselector item
24676     *
24677     * @param item diskselector item with cursor already set.
24678     * @return the cursor name.
24679     *
24680     * @see elm_object_cursor_get() for more details.
24681     * @see elm_diskselector_cursor_set()
24682     *
24683     * @ingroup Diskselector
24684     */
24685    EAPI const char            *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24686
24687
24688    /**
24689     * Unset the cursor to be shown when mouse is over the diskselector item
24690     *
24691     * @param item Target item
24692     *
24693     * @see elm_object_cursor_unset() for more details.
24694     * @see elm_diskselector_cursor_set()
24695     *
24696     * @ingroup Diskselector
24697     */
24698    EAPI void                   elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24699
24700    /**
24701     * Sets a different style for this item cursor.
24702     *
24703     * @note before you set a style you should define a cursor with
24704     *       elm_diskselector_item_cursor_set()
24705     *
24706     * @param item diskselector item with cursor already set.
24707     * @param style the theme style to use (default, transparent, ...)
24708     *
24709     * @see elm_object_cursor_style_set() for more details.
24710     *
24711     * @ingroup Diskselector
24712     */
24713    EAPI void                   elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
24714
24715
24716    /**
24717     * Get the style for this item cursor.
24718     *
24719     * @param item diskselector item with cursor already set.
24720     * @return style the theme style in use, defaults to "default". If the
24721     *         object does not have a cursor set, then @c NULL is returned.
24722     *
24723     * @see elm_object_cursor_style_get() for more details.
24724     * @see elm_diskselector_item_cursor_style_set()
24725     *
24726     * @ingroup Diskselector
24727     */
24728    EAPI const char            *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24729
24730
24731    /**
24732     * Set if the cursor set should be searched on the theme or should use
24733     * the provided by the engine, only.
24734     *
24735     * @note before you set if should look on theme you should define a cursor
24736     * with elm_diskselector_item_cursor_set().
24737     * By default it will only look for cursors provided by the engine.
24738     *
24739     * @param item widget item with cursor already set.
24740     * @param engine_only boolean to define if cursors set with
24741     * elm_diskselector_item_cursor_set() should be searched only
24742     * between cursors provided by the engine or searched on widget's
24743     * theme as well.
24744     *
24745     * @see elm_object_cursor_engine_only_set() for more details.
24746     *
24747     * @ingroup Diskselector
24748     */
24749    EAPI void                   elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
24750
24751    /**
24752     * Get the cursor engine only usage for this item cursor.
24753     *
24754     * @param item widget item with cursor already set.
24755     * @return engine_only boolean to define it cursors should be looked only
24756     * between the provided by the engine or searched on widget's theme as well.
24757     * If the item does not have a cursor set, then @c EINA_FALSE is returned.
24758     *
24759     * @see elm_object_cursor_engine_only_get() for more details.
24760     * @see elm_diskselector_item_cursor_engine_only_set()
24761     *
24762     * @ingroup Diskselector
24763     */
24764    EAPI Eina_Bool              elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24765
24766    /**
24767     * @}
24768     */
24769
24770    /**
24771     * @defgroup Colorselector Colorselector
24772     *
24773     * @{
24774     *
24775     * @image html img/widget/colorselector/preview-00.png
24776     * @image latex img/widget/colorselector/preview-00.eps
24777     *
24778     * @brief Widget for user to select a color.
24779     *
24780     * Signals that you can add callbacks for are:
24781     * "changed" - When the color value changes(event_info is NULL).
24782     *
24783     * See @ref tutorial_colorselector.
24784     */
24785    /**
24786     * @brief Add a new colorselector to the parent
24787     *
24788     * @param parent The parent object
24789     * @return The new object or NULL if it cannot be created
24790     *
24791     * @ingroup Colorselector
24792     */
24793    EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24794    /**
24795     * Set a color for the colorselector
24796     *
24797     * @param obj   Colorselector object
24798     * @param r     r-value of color
24799     * @param g     g-value of color
24800     * @param b     b-value of color
24801     * @param a     a-value of color
24802     *
24803     * @ingroup Colorselector
24804     */
24805    EAPI void         elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
24806    /**
24807     * Get a color from the colorselector
24808     *
24809     * @param obj   Colorselector object
24810     * @param r     integer pointer for r-value of color
24811     * @param g     integer pointer for g-value of color
24812     * @param b     integer pointer for b-value of color
24813     * @param a     integer pointer for a-value of color
24814     *
24815     * @ingroup Colorselector
24816     */
24817    EAPI void         elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
24818    /**
24819     * @}
24820     */
24821
24822    /**
24823     * @defgroup Ctxpopup Ctxpopup
24824     *
24825     * @image html img/widget/ctxpopup/preview-00.png
24826     * @image latex img/widget/ctxpopup/preview-00.eps
24827     *
24828     * @brief Context popup widet.
24829     *
24830     * A ctxpopup is a widget that, when shown, pops up a list of items.
24831     * It automatically chooses an area inside its parent object's view
24832     * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
24833     * optimally fit into it. In the default theme, it will also point an
24834     * arrow to it's top left position at the time one shows it. Ctxpopup
24835     * items have a label and/or an icon. It is intended for a small
24836     * number of items (hence the use of list, not genlist).
24837     *
24838     * @note Ctxpopup is a especialization of @ref Hover.
24839     *
24840     * Signals that you can add callbacks for are:
24841     * "dismissed" - the ctxpopup was dismissed
24842     *
24843     * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
24844     * @{
24845     */
24846    typedef enum _Elm_Ctxpopup_Direction
24847      {
24848         ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
24849                                           area */
24850         ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
24851                                            the clicked area */
24852         ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
24853                                           the clicked area */
24854         ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
24855                                         area */
24856         ELM_CTXPOPUP_DIRECTION_DONT_KNOW, /**< ctxpopup does not determine it's direction yet*/
24857      } Elm_Ctxpopup_Direction;
24858
24859    /**
24860     * @brief Add a new Ctxpopup object to the parent.
24861     *
24862     * @param parent Parent object
24863     * @return New object or @c NULL, if it cannot be created
24864     */
24865    EAPI Evas_Object  *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24866    /**
24867     * @brief Set the Ctxpopup's parent
24868     *
24869     * @param obj The ctxpopup object
24870     * @param area The parent to use
24871     *
24872     * Set the parent object.
24873     *
24874     * @note elm_ctxpopup_add() will automatically call this function
24875     * with its @c parent argument.
24876     *
24877     * @see elm_ctxpopup_add()
24878     * @see elm_hover_parent_set()
24879     */
24880    EAPI void          elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
24881    /**
24882     * @brief Get the Ctxpopup's parent
24883     *
24884     * @param obj The ctxpopup object
24885     *
24886     * @see elm_ctxpopup_hover_parent_set() for more information
24887     */
24888    EAPI Evas_Object  *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24889    /**
24890     * @brief Clear all items in the given ctxpopup object.
24891     *
24892     * @param obj Ctxpopup object
24893     */
24894    EAPI void          elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24895    /**
24896     * @brief Change the ctxpopup's orientation to horizontal or vertical.
24897     *
24898     * @param obj Ctxpopup object
24899     * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
24900     */
24901    EAPI void          elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24902    /**
24903     * @brief Get the value of current ctxpopup object's orientation.
24904     *
24905     * @param obj Ctxpopup object
24906     * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
24907     *
24908     * @see elm_ctxpopup_horizontal_set()
24909     */
24910    EAPI Eina_Bool     elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24911    /**
24912     * @brief Add a new item to a ctxpopup object.
24913     *
24914     * @param obj Ctxpopup object
24915     * @param icon Icon to be set on new item
24916     * @param label The Label of the new item
24917     * @param func Convenience function called when item selected
24918     * @param data Data passed to @p func
24919     * @return A handle to the item added or @c NULL, on errors
24920     *
24921     * @warning Ctxpopup can't hold both an item list and a content at the same
24922     * time. When an item is added, any previous content will be removed.
24923     *
24924     * @see elm_ctxpopup_content_set()
24925     */
24926    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);
24927    /**
24928     * @brief Delete the given item in a ctxpopup object.
24929     *
24930     * @param it Ctxpopup item to be deleted
24931     *
24932     * @see elm_ctxpopup_item_append()
24933     */
24934    EAPI void          elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24935    /**
24936     * @brief Set the ctxpopup item's state as disabled or enabled.
24937     *
24938     * @param it Ctxpopup item to be enabled/disabled
24939     * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
24940     *
24941     * When disabled the item is greyed out to indicate it's state.
24942     */
24943    EAPI void          elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24944    /**
24945     * @brief Get the ctxpopup item's disabled/enabled state.
24946     *
24947     * @param it Ctxpopup item to be enabled/disabled
24948     * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
24949     *
24950     * @see elm_ctxpopup_item_disabled_set()
24951     */
24952    EAPI Eina_Bool     elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24953    /**
24954     * @brief Get the icon object for the given ctxpopup item.
24955     *
24956     * @param it Ctxpopup item
24957     * @return icon object or @c NULL, if the item does not have icon or an error
24958     * occurred
24959     *
24960     * @see elm_ctxpopup_item_append()
24961     * @see elm_ctxpopup_item_icon_set()
24962     */
24963    EAPI Evas_Object  *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24964    /**
24965     * @brief Sets the side icon associated with the ctxpopup item
24966     *
24967     * @param it Ctxpopup item
24968     * @param icon Icon object to be set
24969     *
24970     * Once the icon object is set, a previously set one will be deleted.
24971     * @warning Setting the same icon for two items will cause the icon to
24972     * dissapear from the first item.
24973     *
24974     * @see elm_ctxpopup_item_append()
24975     */
24976    EAPI void          elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
24977    /**
24978     * @brief Get the label for the given ctxpopup item.
24979     *
24980     * @param it Ctxpopup item
24981     * @return label string or @c NULL, if the item does not have label or an
24982     * error occured
24983     *
24984     * @see elm_ctxpopup_item_append()
24985     * @see elm_ctxpopup_item_label_set()
24986     */
24987    EAPI const char   *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24988    /**
24989     * @brief (Re)set the label on the given ctxpopup item.
24990     *
24991     * @param it Ctxpopup item
24992     * @param label String to set as label
24993     */
24994    EAPI void          elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
24995    /**
24996     * @brief Set an elm widget as the content of the ctxpopup.
24997     *
24998     * @param obj Ctxpopup object
24999     * @param content Content to be swallowed
25000     *
25001     * If the content object is already set, a previous one will bedeleted. If
25002     * you want to keep that old content object, use the
25003     * elm_ctxpopup_content_unset() function.
25004     *
25005     * @deprecated use elm_object_content_set()
25006     *
25007     * @warning Ctxpopup can't hold both a item list and a content at the same
25008     * time. When a content is set, any previous items will be removed.
25009     */
25010    EINA_DEPRECATED EAPI void          elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
25011    /**
25012     * @brief Unset the ctxpopup content
25013     *
25014     * @param obj Ctxpopup object
25015     * @return The content that was being used
25016     *
25017     * Unparent and return the content object which was set for this widget.
25018     *
25019     * @deprecated use elm_object_content_unset()
25020     *
25021     * @see elm_ctxpopup_content_set()
25022     */
25023    EINA_DEPRECATED EAPI Evas_Object  *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25024    /**
25025     * @brief Set the direction priority of a ctxpopup.
25026     *
25027     * @param obj Ctxpopup object
25028     * @param first 1st priority of direction
25029     * @param second 2nd priority of direction
25030     * @param third 3th priority of direction
25031     * @param fourth 4th priority of direction
25032     *
25033     * This functions gives a chance to user to set the priority of ctxpopup
25034     * showing direction. This doesn't guarantee the ctxpopup will appear in the
25035     * requested direction.
25036     *
25037     * @see Elm_Ctxpopup_Direction
25038     */
25039    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);
25040    /**
25041     * @brief Get the direction priority of a ctxpopup.
25042     *
25043     * @param obj Ctxpopup object
25044     * @param first 1st priority of direction to be returned
25045     * @param second 2nd priority of direction to be returned
25046     * @param third 3th priority of direction to be returned
25047     * @param fourth 4th priority of direction to be returned
25048     *
25049     * @see elm_ctxpopup_direction_priority_set() for more information.
25050     */
25051    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);
25052
25053    /**
25054     * @brief Get the current direction of a ctxpopup.
25055     *
25056     * @param obj Ctxpopup object
25057     * @return current direction of a ctxpopup
25058     *
25059     * @warning Once the ctxpopup showed up, the direction would be determined
25060     */
25061    EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25062
25063    /**
25064     * @}
25065     */
25066
25067    /* transit */
25068    /**
25069     *
25070     * @defgroup Transit Transit
25071     * @ingroup Elementary
25072     *
25073     * Transit is designed to apply various animated transition effects to @c
25074     * Evas_Object, such like translation, rotation, etc. For using these
25075     * effects, create an @ref Elm_Transit and add the desired transition effects.
25076     *
25077     * Once the effects are added into transit, they will be automatically
25078     * managed (their callback will be called until the duration is ended, and
25079     * they will be deleted on completion).
25080     *
25081     * Example:
25082     * @code
25083     * Elm_Transit *trans = elm_transit_add();
25084     * elm_transit_object_add(trans, obj);
25085     * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
25086     * elm_transit_duration_set(transit, 1);
25087     * elm_transit_auto_reverse_set(transit, EINA_TRUE);
25088     * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
25089     * elm_transit_repeat_times_set(transit, 3);
25090     * @endcode
25091     *
25092     * Some transition effects are used to change the properties of objects. They
25093     * are:
25094     * @li @ref elm_transit_effect_translation_add
25095     * @li @ref elm_transit_effect_color_add
25096     * @li @ref elm_transit_effect_rotation_add
25097     * @li @ref elm_transit_effect_wipe_add
25098     * @li @ref elm_transit_effect_zoom_add
25099     * @li @ref elm_transit_effect_resizing_add
25100     *
25101     * Other transition effects are used to make one object disappear and another
25102     * object appear on its old place. These effects are:
25103     *
25104     * @li @ref elm_transit_effect_flip_add
25105     * @li @ref elm_transit_effect_resizable_flip_add
25106     * @li @ref elm_transit_effect_fade_add
25107     * @li @ref elm_transit_effect_blend_add
25108     *
25109     * It's also possible to make a transition chain with @ref
25110     * elm_transit_chain_transit_add.
25111     *
25112     * @warning We strongly recommend to use elm_transit just when edje can not do
25113     * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
25114     * animations can be manipulated inside the theme.
25115     *
25116     * List of examples:
25117     * @li @ref transit_example_01_explained
25118     * @li @ref transit_example_02_explained
25119     * @li @ref transit_example_03_c
25120     * @li @ref transit_example_04_c
25121     *
25122     * @{
25123     */
25124
25125    /**
25126     * @enum Elm_Transit_Tween_Mode
25127     *
25128     * The type of acceleration used in the transition.
25129     */
25130    typedef enum
25131      {
25132         ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
25133         ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
25134                                              over time, then decrease again
25135                                              and stop slowly */
25136         ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
25137                                              speed over time */
25138         ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
25139                                             over time */
25140      } Elm_Transit_Tween_Mode;
25141
25142    /**
25143     * @enum Elm_Transit_Effect_Flip_Axis
25144     *
25145     * The axis where flip effect should be applied.
25146     */
25147    typedef enum
25148      {
25149         ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
25150         ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
25151      } Elm_Transit_Effect_Flip_Axis;
25152    /**
25153     * @enum Elm_Transit_Effect_Wipe_Dir
25154     *
25155     * The direction where the wipe effect should occur.
25156     */
25157    typedef enum
25158      {
25159         ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
25160         ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
25161         ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
25162         ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
25163      } Elm_Transit_Effect_Wipe_Dir;
25164    /** @enum Elm_Transit_Effect_Wipe_Type
25165     *
25166     * Whether the wipe effect should show or hide the object.
25167     */
25168    typedef enum
25169      {
25170         ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
25171                                              animation */
25172         ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
25173                                             animation */
25174      } Elm_Transit_Effect_Wipe_Type;
25175
25176    /**
25177     * @typedef Elm_Transit
25178     *
25179     * The Transit created with elm_transit_add(). This type has the information
25180     * about the objects which the transition will be applied, and the
25181     * transition effects that will be used. It also contains info about
25182     * duration, number of repetitions, auto-reverse, etc.
25183     */
25184    typedef struct _Elm_Transit Elm_Transit;
25185    typedef void Elm_Transit_Effect;
25186    /**
25187     * @typedef Elm_Transit_Effect_Transition_Cb
25188     *
25189     * Transition callback called for this effect on each transition iteration.
25190     */
25191    typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
25192    /**
25193     * Elm_Transit_Effect_End_Cb
25194     *
25195     * Transition callback called for this effect when the transition is over.
25196     */
25197    typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
25198
25199    /**
25200     * Elm_Transit_Del_Cb
25201     *
25202     * A callback called when the transit is deleted.
25203     */
25204    typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
25205
25206    /**
25207     * Add new transit.
25208     *
25209     * @note Is not necessary to delete the transit object, it will be deleted at
25210     * the end of its operation.
25211     * @note The transit will start playing when the program enter in the main loop, is not
25212     * necessary to give a start to the transit.
25213     *
25214     * @return The transit object.
25215     *
25216     * @ingroup Transit
25217     */
25218    EAPI Elm_Transit                *elm_transit_add(void);
25219
25220    /**
25221     * Stops the animation and delete the @p transit object.
25222     *
25223     * Call this function if you wants to stop the animation before the duration
25224     * time. Make sure the @p transit object is still alive with
25225     * elm_transit_del_cb_set() function.
25226     * All added effects will be deleted, calling its repective data_free_cb
25227     * functions. The function setted by elm_transit_del_cb_set() will be called.
25228     *
25229     * @see elm_transit_del_cb_set()
25230     *
25231     * @param transit The transit object to be deleted.
25232     *
25233     * @ingroup Transit
25234     * @warning Just call this function if you are sure the transit is alive.
25235     */
25236    EAPI void                        elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
25237
25238    /**
25239     * Add a new effect to the transit.
25240     *
25241     * @note The cb function and the data are the key to the effect. If you try to
25242     * add an already added effect, nothing is done.
25243     * @note After the first addition of an effect in @p transit, if its
25244     * effect list become empty again, the @p transit will be killed by
25245     * elm_transit_del(transit) function.
25246     *
25247     * Exemple:
25248     * @code
25249     * Elm_Transit *transit = elm_transit_add();
25250     * elm_transit_effect_add(transit,
25251     *                        elm_transit_effect_blend_op,
25252     *                        elm_transit_effect_blend_context_new(),
25253     *                        elm_transit_effect_blend_context_free);
25254     * @endcode
25255     *
25256     * @param transit The transit object.
25257     * @param transition_cb The operation function. It is called when the
25258     * animation begins, it is the function that actually performs the animation.
25259     * It is called with the @p data, @p transit and the time progression of the
25260     * animation (a double value between 0.0 and 1.0).
25261     * @param effect The context data of the effect.
25262     * @param end_cb The function to free the context data, it will be called
25263     * at the end of the effect, it must finalize the animation and free the
25264     * @p data.
25265     *
25266     * @ingroup Transit
25267     * @warning The transit free the context data at the and of the transition with
25268     * the data_free_cb function, do not use the context data in another transit.
25269     */
25270    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);
25271
25272    /**
25273     * Delete an added effect.
25274     *
25275     * This function will remove the effect from the @p transit, calling the
25276     * data_free_cb to free the @p data.
25277     *
25278     * @see elm_transit_effect_add()
25279     *
25280     * @note If the effect is not found, nothing is done.
25281     * @note If the effect list become empty, this function will call
25282     * elm_transit_del(transit), that is, it will kill the @p transit.
25283     *
25284     * @param transit The transit object.
25285     * @param transition_cb The operation function.
25286     * @param effect The context data of the effect.
25287     *
25288     * @ingroup Transit
25289     */
25290    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);
25291
25292    /**
25293     * Add new object to apply the effects.
25294     *
25295     * @note After the first addition of an object in @p transit, if its
25296     * object list become empty again, the @p transit will be killed by
25297     * elm_transit_del(transit) function.
25298     * @note If the @p obj belongs to another transit, the @p obj will be
25299     * removed from it and it will only belong to the @p transit. If the old
25300     * transit stays without objects, it will die.
25301     * @note When you add an object into the @p transit, its state from
25302     * evas_object_pass_events_get(obj) is saved, and it is applied when the
25303     * transit ends, if you change this state whith evas_object_pass_events_set()
25304     * after add the object, this state will change again when @p transit stops to
25305     * run.
25306     *
25307     * @param transit The transit object.
25308     * @param obj Object to be animated.
25309     *
25310     * @ingroup Transit
25311     * @warning It is not allowed to add a new object after transit begins to go.
25312     */
25313    EAPI void                        elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
25314
25315    /**
25316     * Removes an added object from the transit.
25317     *
25318     * @note If the @p obj is not in the @p transit, nothing is done.
25319     * @note If the list become empty, this function will call
25320     * elm_transit_del(transit), that is, it will kill the @p transit.
25321     *
25322     * @param transit The transit object.
25323     * @param obj Object to be removed from @p transit.
25324     *
25325     * @ingroup Transit
25326     * @warning It is not allowed to remove objects after transit begins to go.
25327     */
25328    EAPI void                        elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
25329
25330    /**
25331     * Get the objects of the transit.
25332     *
25333     * @param transit The transit object.
25334     * @return a Eina_List with the objects from the transit.
25335     *
25336     * @ingroup Transit
25337     */
25338    EAPI const Eina_List            *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25339
25340    /**
25341     * Enable/disable keeping up the objects states.
25342     * If it is not kept, the objects states will be reset when transition ends.
25343     *
25344     * @note @p transit can not be NULL.
25345     * @note One state includes geometry, color, map data.
25346     *
25347     * @param transit The transit object.
25348     * @param state_keep Keeping or Non Keeping.
25349     *
25350     * @ingroup Transit
25351     */
25352    EAPI void                        elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
25353
25354    /**
25355     * Get a value whether the objects states will be reset or not.
25356     *
25357     * @note @p transit can not be NULL
25358     *
25359     * @see elm_transit_objects_final_state_keep_set()
25360     *
25361     * @param transit The transit object.
25362     * @return EINA_TRUE means the states of the objects will be reset.
25363     * If @p transit is NULL, EINA_FALSE is returned
25364     *
25365     * @ingroup Transit
25366     */
25367    EAPI Eina_Bool                   elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25368
25369    /**
25370     * Set the event enabled when transit is operating.
25371     *
25372     * If @p enabled is EINA_TRUE, the objects of the transit will receives
25373     * events from mouse and keyboard during the animation.
25374     * @note When you add an object with elm_transit_object_add(), its state from
25375     * evas_object_pass_events_get(obj) is saved, and it is applied when the
25376     * transit ends, if you change this state with evas_object_pass_events_set()
25377     * after adding the object, this state will change again when @p transit stops
25378     * to run.
25379     *
25380     * @param transit The transit object.
25381     * @param enabled Events are received when enabled is @c EINA_TRUE, and
25382     * ignored otherwise.
25383     *
25384     * @ingroup Transit
25385     */
25386    EAPI void                        elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25387
25388    /**
25389     * Get the value of event enabled status.
25390     *
25391     * @see elm_transit_event_enabled_set()
25392     *
25393     * @param transit The Transit object
25394     * @return EINA_TRUE, when event is enabled. If @p transit is NULL
25395     * EINA_FALSE is returned
25396     *
25397     * @ingroup Transit
25398     */
25399    EAPI Eina_Bool                   elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25400
25401    /**
25402     * Set the user-callback function when the transit is deleted.
25403     *
25404     * @note Using this function twice will overwrite the first function setted.
25405     * @note the @p transit object will be deleted after call @p cb function.
25406     *
25407     * @param transit The transit object.
25408     * @param cb Callback function pointer. This function will be called before
25409     * the deletion of the transit.
25410     * @param data Callback funtion user data. It is the @p op parameter.
25411     *
25412     * @ingroup Transit
25413     */
25414    EAPI void                        elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
25415
25416    /**
25417     * Set reverse effect automatically.
25418     *
25419     * If auto reverse is setted, after running the effects with the progress
25420     * parameter from 0 to 1, it will call the effecs again with the progress
25421     * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
25422     * where the duration was setted with the function elm_transit_add and
25423     * the repeat with the function elm_transit_repeat_times_set().
25424     *
25425     * @param transit The transit object.
25426     * @param reverse EINA_TRUE means the auto_reverse is on.
25427     *
25428     * @ingroup Transit
25429     */
25430    EAPI void                        elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
25431
25432    /**
25433     * Get if the auto reverse is on.
25434     *
25435     * @see elm_transit_auto_reverse_set()
25436     *
25437     * @param transit The transit object.
25438     * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
25439     * EINA_FALSE is returned
25440     *
25441     * @ingroup Transit
25442     */
25443    EAPI Eina_Bool                   elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25444
25445    /**
25446     * Set the transit repeat count. Effect will be repeated by repeat count.
25447     *
25448     * This function sets the number of repetition the transit will run after
25449     * the first one, that is, if @p repeat is 1, the transit will run 2 times.
25450     * If the @p repeat is a negative number, it will repeat infinite times.
25451     *
25452     * @note If this function is called during the transit execution, the transit
25453     * will run @p repeat times, ignoring the times it already performed.
25454     *
25455     * @param transit The transit object
25456     * @param repeat Repeat count
25457     *
25458     * @ingroup Transit
25459     */
25460    EAPI void                        elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
25461
25462    /**
25463     * Get the transit repeat count.
25464     *
25465     * @see elm_transit_repeat_times_set()
25466     *
25467     * @param transit The Transit object.
25468     * @return The repeat count. If @p transit is NULL
25469     * 0 is returned
25470     *
25471     * @ingroup Transit
25472     */
25473    EAPI int                         elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25474
25475    /**
25476     * Set the transit animation acceleration type.
25477     *
25478     * This function sets the tween mode of the transit that can be:
25479     * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
25480     * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
25481     * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
25482     * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
25483     *
25484     * @param transit The transit object.
25485     * @param tween_mode The tween type.
25486     *
25487     * @ingroup Transit
25488     */
25489    EAPI void                        elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
25490
25491    /**
25492     * Get the transit animation acceleration type.
25493     *
25494     * @note @p transit can not be NULL
25495     *
25496     * @param transit The transit object.
25497     * @return The tween type. If @p transit is NULL
25498     * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
25499     *
25500     * @ingroup Transit
25501     */
25502    EAPI Elm_Transit_Tween_Mode      elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25503
25504    /**
25505     * Set the transit animation time
25506     *
25507     * @note @p transit can not be NULL
25508     *
25509     * @param transit The transit object.
25510     * @param duration The animation time.
25511     *
25512     * @ingroup Transit
25513     */
25514    EAPI void                        elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
25515
25516    /**
25517     * Get the transit animation time
25518     *
25519     * @note @p transit can not be NULL
25520     *
25521     * @param transit The transit object.
25522     *
25523     * @return The transit animation time.
25524     *
25525     * @ingroup Transit
25526     */
25527    EAPI double                      elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25528
25529    /**
25530     * Starts the transition.
25531     * Once this API is called, the transit begins to measure the time.
25532     *
25533     * @note @p transit can not be NULL
25534     *
25535     * @param transit The transit object.
25536     *
25537     * @ingroup Transit
25538     */
25539    EAPI void                        elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
25540
25541    /**
25542     * Pause/Resume the transition.
25543     *
25544     * If you call elm_transit_go again, the transit will be started from the
25545     * beginning, and will be unpaused.
25546     *
25547     * @note @p transit can not be NULL
25548     *
25549     * @param transit The transit object.
25550     * @param paused Whether the transition should be paused or not.
25551     *
25552     * @ingroup Transit
25553     */
25554    EAPI void                        elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
25555
25556    /**
25557     * Get the value of paused status.
25558     *
25559     * @see elm_transit_paused_set()
25560     *
25561     * @note @p transit can not be NULL
25562     *
25563     * @param transit The transit object.
25564     * @return EINA_TRUE means transition is paused. If @p transit is NULL
25565     * EINA_FALSE is returned
25566     *
25567     * @ingroup Transit
25568     */
25569    EAPI Eina_Bool                   elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25570
25571    /**
25572     * Get the time progression of the animation (a double value between 0.0 and 1.0).
25573     *
25574     * The value returned is a fraction (current time / total time). It
25575     * represents the progression position relative to the total.
25576     *
25577     * @note @p transit can not be NULL
25578     *
25579     * @param transit The transit object.
25580     *
25581     * @return The time progression value. If @p transit is NULL
25582     * 0 is returned
25583     *
25584     * @ingroup Transit
25585     */
25586    EAPI double                      elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25587
25588    /**
25589     * Makes the chain relationship between two transits.
25590     *
25591     * @note @p transit can not be NULL. Transit would have multiple chain transits.
25592     * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
25593     *
25594     * @param transit The transit object.
25595     * @param chain_transit The chain transit object. This transit will be operated
25596     *        after transit is done.
25597     *
25598     * This function adds @p chain_transit transition to a chain after the @p
25599     * transit, and will be started as soon as @p transit ends. See @ref
25600     * transit_example_02_explained for a full example.
25601     *
25602     * @ingroup Transit
25603     */
25604    EAPI void                        elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
25605
25606    /**
25607     * Cut off the chain relationship between two transits.
25608     *
25609     * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
25610     * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
25611     *
25612     * @param transit The transit object.
25613     * @param chain_transit The chain transit object.
25614     *
25615     * This function remove the @p chain_transit transition from the @p transit.
25616     *
25617     * @ingroup Transit
25618     */
25619    EAPI void                        elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
25620
25621    /**
25622     * Get the current chain transit list.
25623     *
25624     * @note @p transit can not be NULL.
25625     *
25626     * @param transit The transit object.
25627     * @return chain transit list.
25628     *
25629     * @ingroup Transit
25630     */
25631    EAPI Eina_List                  *elm_transit_chain_transits_get(const Elm_Transit *transit);
25632
25633    /**
25634     * Add the Resizing Effect to Elm_Transit.
25635     *
25636     * @note This API is one of the facades. It creates resizing effect context
25637     * and add it's required APIs to elm_transit_effect_add.
25638     *
25639     * @see elm_transit_effect_add()
25640     *
25641     * @param transit Transit object.
25642     * @param from_w Object width size when effect begins.
25643     * @param from_h Object height size when effect begins.
25644     * @param to_w Object width size when effect ends.
25645     * @param to_h Object height size when effect ends.
25646     * @return Resizing effect context data.
25647     *
25648     * @ingroup Transit
25649     */
25650    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);
25651
25652    /**
25653     * Add the Translation Effect to Elm_Transit.
25654     *
25655     * @note This API is one of the facades. It creates translation effect context
25656     * and add it's required APIs to elm_transit_effect_add.
25657     *
25658     * @see elm_transit_effect_add()
25659     *
25660     * @param transit Transit object.
25661     * @param from_dx X Position variation when effect begins.
25662     * @param from_dy Y Position variation when effect begins.
25663     * @param to_dx X Position variation when effect ends.
25664     * @param to_dy Y Position variation when effect ends.
25665     * @return Translation effect context data.
25666     *
25667     * @ingroup Transit
25668     * @warning It is highly recommended just create a transit with this effect when
25669     * the window that the objects of the transit belongs has already been created.
25670     * This is because this effect needs the geometry information about the objects,
25671     * and if the window was not created yet, it can get a wrong information.
25672     */
25673    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);
25674
25675    /**
25676     * Add the Zoom Effect to Elm_Transit.
25677     *
25678     * @note This API is one of the facades. It creates zoom effect context
25679     * and add it's required APIs to elm_transit_effect_add.
25680     *
25681     * @see elm_transit_effect_add()
25682     *
25683     * @param transit Transit object.
25684     * @param from_rate Scale rate when effect begins (1 is current rate).
25685     * @param to_rate Scale rate when effect ends.
25686     * @return Zoom effect context data.
25687     *
25688     * @ingroup Transit
25689     * @warning It is highly recommended just create a transit with this effect when
25690     * the window that the objects of the transit belongs has already been created.
25691     * This is because this effect needs the geometry information about the objects,
25692     * and if the window was not created yet, it can get a wrong information.
25693     */
25694    EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
25695
25696    /**
25697     * Add the Flip Effect to Elm_Transit.
25698     *
25699     * @note This API is one of the facades. It creates flip effect context
25700     * and add it's required APIs to elm_transit_effect_add.
25701     * @note This effect is applied to each pair of objects in the order they are listed
25702     * in the transit list of objects. The first object in the pair will be the
25703     * "front" object and the second will be the "back" object.
25704     *
25705     * @see elm_transit_effect_add()
25706     *
25707     * @param transit Transit object.
25708     * @param axis Flipping Axis(X or Y).
25709     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
25710     * @return Flip effect context data.
25711     *
25712     * @ingroup Transit
25713     * @warning It is highly recommended just create a transit with this effect when
25714     * the window that the objects of the transit belongs has already been created.
25715     * This is because this effect needs the geometry information about the objects,
25716     * and if the window was not created yet, it can get a wrong information.
25717     */
25718    EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
25719
25720    /**
25721     * Add the Resizable Flip Effect to Elm_Transit.
25722     *
25723     * @note This API is one of the facades. It creates resizable flip effect context
25724     * and add it's required APIs to elm_transit_effect_add.
25725     * @note This effect is applied to each pair of objects in the order they are listed
25726     * in the transit list of objects. The first object in the pair will be the
25727     * "front" object and the second will be the "back" object.
25728     *
25729     * @see elm_transit_effect_add()
25730     *
25731     * @param transit Transit object.
25732     * @param axis Flipping Axis(X or Y).
25733     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
25734     * @return Resizable flip effect context data.
25735     *
25736     * @ingroup Transit
25737     * @warning It is highly recommended just create a transit with this effect when
25738     * the window that the objects of the transit belongs has already been created.
25739     * This is because this effect needs the geometry information about the objects,
25740     * and if the window was not created yet, it can get a wrong information.
25741     */
25742    EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
25743
25744    /**
25745     * Add the Wipe Effect to Elm_Transit.
25746     *
25747     * @note This API is one of the facades. It creates wipe effect context
25748     * and add it's required APIs to elm_transit_effect_add.
25749     *
25750     * @see elm_transit_effect_add()
25751     *
25752     * @param transit Transit object.
25753     * @param type Wipe type. Hide or show.
25754     * @param dir Wipe Direction.
25755     * @return Wipe effect context data.
25756     *
25757     * @ingroup Transit
25758     * @warning It is highly recommended just create a transit with this effect when
25759     * the window that the objects of the transit belongs has already been created.
25760     * This is because this effect needs the geometry information about the objects,
25761     * and if the window was not created yet, it can get a wrong information.
25762     */
25763    EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
25764
25765    /**
25766     * Add the Color Effect to Elm_Transit.
25767     *
25768     * @note This API is one of the facades. It creates color effect context
25769     * and add it's required APIs to elm_transit_effect_add.
25770     *
25771     * @see elm_transit_effect_add()
25772     *
25773     * @param transit        Transit object.
25774     * @param  from_r        RGB R when effect begins.
25775     * @param  from_g        RGB G when effect begins.
25776     * @param  from_b        RGB B when effect begins.
25777     * @param  from_a        RGB A when effect begins.
25778     * @param  to_r          RGB R when effect ends.
25779     * @param  to_g          RGB G when effect ends.
25780     * @param  to_b          RGB B when effect ends.
25781     * @param  to_a          RGB A when effect ends.
25782     * @return               Color effect context data.
25783     *
25784     * @ingroup Transit
25785     */
25786    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);
25787
25788    /**
25789     * Add the Fade Effect to Elm_Transit.
25790     *
25791     * @note This API is one of the facades. It creates fade effect context
25792     * and add it's required APIs to elm_transit_effect_add.
25793     * @note This effect is applied to each pair of objects in the order they are listed
25794     * in the transit list of objects. The first object in the pair will be the
25795     * "before" object and the second will be the "after" object.
25796     *
25797     * @see elm_transit_effect_add()
25798     *
25799     * @param transit Transit object.
25800     * @return Fade effect context data.
25801     *
25802     * @ingroup Transit
25803     * @warning It is highly recommended just create a transit with this effect when
25804     * the window that the objects of the transit belongs has already been created.
25805     * This is because this effect needs the color information about the objects,
25806     * and if the window was not created yet, it can get a wrong information.
25807     */
25808    EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
25809
25810    /**
25811     * Add the Blend Effect to Elm_Transit.
25812     *
25813     * @note This API is one of the facades. It creates blend effect context
25814     * and add it's required APIs to elm_transit_effect_add.
25815     * @note This effect is applied to each pair of objects in the order they are listed
25816     * in the transit list of objects. The first object in the pair will be the
25817     * "before" object and the second will be the "after" object.
25818     *
25819     * @see elm_transit_effect_add()
25820     *
25821     * @param transit Transit object.
25822     * @return Blend effect context data.
25823     *
25824     * @ingroup Transit
25825     * @warning It is highly recommended just create a transit with this effect when
25826     * the window that the objects of the transit belongs has already been created.
25827     * This is because this effect needs the color information about the objects,
25828     * and if the window was not created yet, it can get a wrong information.
25829     */
25830    EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
25831
25832    /**
25833     * Add the Rotation Effect to Elm_Transit.
25834     *
25835     * @note This API is one of the facades. It creates rotation effect context
25836     * and add it's required APIs to elm_transit_effect_add.
25837     *
25838     * @see elm_transit_effect_add()
25839     *
25840     * @param transit Transit object.
25841     * @param from_degree Degree when effect begins.
25842     * @param to_degree Degree when effect is ends.
25843     * @return Rotation effect context data.
25844     *
25845     * @ingroup Transit
25846     * @warning It is highly recommended just create a transit with this effect when
25847     * the window that the objects of the transit belongs has already been created.
25848     * This is because this effect needs the geometry information about the objects,
25849     * and if the window was not created yet, it can get a wrong information.
25850     */
25851    EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
25852
25853    /**
25854     * Add the ImageAnimation Effect to Elm_Transit.
25855     *
25856     * @note This API is one of the facades. It creates image animation effect context
25857     * and add it's required APIs to elm_transit_effect_add.
25858     * The @p images parameter is a list images paths. This list and
25859     * its contents will be deleted at the end of the effect by
25860     * elm_transit_effect_image_animation_context_free() function.
25861     *
25862     * Example:
25863     * @code
25864     * char buf[PATH_MAX];
25865     * Eina_List *images = NULL;
25866     * Elm_Transit *transi = elm_transit_add();
25867     *
25868     * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
25869     * images = eina_list_append(images, eina_stringshare_add(buf));
25870     *
25871     * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
25872     * images = eina_list_append(images, eina_stringshare_add(buf));
25873     * elm_transit_effect_image_animation_add(transi, images);
25874     *
25875     * @endcode
25876     *
25877     * @see elm_transit_effect_add()
25878     *
25879     * @param transit Transit object.
25880     * @param images Eina_List of images file paths. This list and
25881     * its contents will be deleted at the end of the effect by
25882     * elm_transit_effect_image_animation_context_free() function.
25883     * @return Image Animation effect context data.
25884     *
25885     * @ingroup Transit
25886     */
25887    EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
25888    /**
25889     * @}
25890     */
25891
25892   typedef struct _Elm_Store                      Elm_Store;
25893   typedef struct _Elm_Store_Filesystem           Elm_Store_Filesystem;
25894   typedef struct _Elm_Store_Item                 Elm_Store_Item;
25895   typedef struct _Elm_Store_Item_Filesystem      Elm_Store_Item_Filesystem;
25896   typedef struct _Elm_Store_Item_Info            Elm_Store_Item_Info;
25897   typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
25898   typedef struct _Elm_Store_Item_Mapping         Elm_Store_Item_Mapping;
25899   typedef struct _Elm_Store_Item_Mapping_Empty   Elm_Store_Item_Mapping_Empty;
25900   typedef struct _Elm_Store_Item_Mapping_Icon    Elm_Store_Item_Mapping_Icon;
25901   typedef struct _Elm_Store_Item_Mapping_Photo   Elm_Store_Item_Mapping_Photo;
25902   typedef struct _Elm_Store_Item_Mapping_Custom  Elm_Store_Item_Mapping_Custom;
25903
25904   typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
25905   typedef void      (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
25906   typedef void      (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
25907   typedef void     *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
25908
25909   typedef enum
25910     {
25911        ELM_STORE_ITEM_MAPPING_NONE = 0,
25912        ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
25913        ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
25914        ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
25915        ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
25916        ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
25917        // can add more here as needed by common apps
25918        ELM_STORE_ITEM_MAPPING_LAST
25919     } Elm_Store_Item_Mapping_Type;
25920
25921   struct _Elm_Store_Item_Mapping_Icon
25922     {
25923        // FIXME: allow edje file icons
25924        int                   w, h;
25925        Elm_Icon_Lookup_Order lookup_order;
25926        Eina_Bool             standard_name : 1;
25927        Eina_Bool             no_scale : 1;
25928        Eina_Bool             smooth : 1;
25929        Eina_Bool             scale_up : 1;
25930        Eina_Bool             scale_down : 1;
25931     };
25932
25933   struct _Elm_Store_Item_Mapping_Empty
25934     {
25935        Eina_Bool             dummy;
25936     };
25937
25938   struct _Elm_Store_Item_Mapping_Photo
25939     {
25940        int                   size;
25941     };
25942
25943   struct _Elm_Store_Item_Mapping_Custom
25944     {
25945        Elm_Store_Item_Mapping_Cb func;
25946     };
25947
25948   struct _Elm_Store_Item_Mapping
25949     {
25950        Elm_Store_Item_Mapping_Type     type;
25951        const char                     *part;
25952        int                             offset;
25953        union
25954          {
25955             Elm_Store_Item_Mapping_Empty  empty;
25956             Elm_Store_Item_Mapping_Icon   icon;
25957             Elm_Store_Item_Mapping_Photo  photo;
25958             Elm_Store_Item_Mapping_Custom custom;
25959             // add more types here
25960          } details;
25961     };
25962
25963   struct _Elm_Store_Item_Info
25964     {
25965       Elm_Genlist_Item_Class       *item_class;
25966       const Elm_Store_Item_Mapping *mapping;
25967       void                         *data;
25968       char                         *sort_id;
25969     };
25970
25971   struct _Elm_Store_Item_Info_Filesystem
25972     {
25973       Elm_Store_Item_Info  base;
25974       char                *path;
25975     };
25976
25977 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
25978 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
25979
25980   EAPI void                    elm_store_free(Elm_Store *st);
25981
25982   EAPI Elm_Store              *elm_store_filesystem_new(void);
25983   EAPI void                    elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
25984   EAPI const char             *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25985   EAPI const char             *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25986
25987   EAPI void                    elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
25988
25989   EAPI void                    elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
25990   EAPI int                     elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25991   EAPI void                    elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25992   EAPI void                    elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25993   EAPI void                    elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
25994   EAPI Eina_Bool               elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25995
25996   EAPI void                    elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25997   EAPI void                    elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
25998   EAPI Eina_Bool               elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25999   EAPI void                    elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
26000   EAPI void                   *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
26001   EAPI const Elm_Store        *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
26002   EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
26003
26004    /**
26005     * @defgroup SegmentControl SegmentControl
26006     * @ingroup Elementary
26007     *
26008     * @image html img/widget/segment_control/preview-00.png
26009     * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
26010     *
26011     * @image html img/segment_control.png
26012     * @image latex img/segment_control.eps width=\textwidth
26013     *
26014     * Segment control widget is a horizontal control made of multiple segment
26015     * items, each segment item functioning similar to discrete two state button.
26016     * A segment control groups the items together and provides compact
26017     * single button with multiple equal size segments.
26018     *
26019     * Segment item size is determined by base widget
26020     * size and the number of items added.
26021     * Only one segment item can be at selected state. A segment item can display
26022     * combination of Text and any Evas_Object like Images or other widget.
26023     *
26024     * Smart callbacks one can listen to:
26025     * - "changed" - When the user clicks on a segment item which is not
26026     *   previously selected and get selected. The event_info parameter is the
26027     *   segment item index.
26028     *
26029     * Available styles for it:
26030     * - @c "default"
26031     *
26032     * Here is an example on its usage:
26033     * @li @ref segment_control_example
26034     */
26035
26036    /**
26037     * @addtogroup SegmentControl
26038     * @{
26039     */
26040
26041    typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
26042
26043    /**
26044     * Add a new segment control widget to the given parent Elementary
26045     * (container) object.
26046     *
26047     * @param parent The parent object.
26048     * @return a new segment control widget handle or @c NULL, on errors.
26049     *
26050     * This function inserts a new segment control widget on the canvas.
26051     *
26052     * @ingroup SegmentControl
26053     */
26054    EAPI Evas_Object      *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26055
26056    /**
26057     * Append a new item to the segment control object.
26058     *
26059     * @param obj The segment control object.
26060     * @param icon The icon object to use for the left side of the item. An
26061     * icon can be any Evas object, but usually it is an icon created
26062     * with elm_icon_add().
26063     * @param label The label of the item.
26064     *        Note that, NULL is different from empty string "".
26065     * @return The created item or @c NULL upon failure.
26066     *
26067     * A new item will be created and appended to the segment control, i.e., will
26068     * be set as @b last item.
26069     *
26070     * If it should be inserted at another position,
26071     * elm_segment_control_item_insert_at() should be used instead.
26072     *
26073     * Items created with this function can be deleted with function
26074     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
26075     *
26076     * @note @p label set to @c NULL is different from empty string "".
26077     * If an item
26078     * only has icon, it will be displayed bigger and centered. If it has
26079     * icon and label, even that an empty string, icon will be smaller and
26080     * positioned at left.
26081     *
26082     * Simple example:
26083     * @code
26084     * sc = elm_segment_control_add(win);
26085     * ic = elm_icon_add(win);
26086     * elm_icon_file_set(ic, "path/to/image", NULL);
26087     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
26088     * elm_segment_control_item_add(sc, ic, "label");
26089     * evas_object_show(sc);
26090     * @endcode
26091     *
26092     * @see elm_segment_control_item_insert_at()
26093     * @see elm_segment_control_item_del()
26094     *
26095     * @ingroup SegmentControl
26096     */
26097    EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
26098
26099    /**
26100     * Insert a new item to the segment control object at specified position.
26101     *
26102     * @param obj The segment control object.
26103     * @param icon The icon object to use for the left side of the item. An
26104     * icon can be any Evas object, but usually it is an icon created
26105     * with elm_icon_add().
26106     * @param label The label of the item.
26107     * @param index Item position. Value should be between 0 and items count.
26108     * @return The created item or @c NULL upon failure.
26109
26110     * Index values must be between @c 0, when item will be prepended to
26111     * segment control, and items count, that can be get with
26112     * elm_segment_control_item_count_get(), case when item will be appended
26113     * to segment control, just like elm_segment_control_item_add().
26114     *
26115     * Items created with this function can be deleted with function
26116     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
26117     *
26118     * @note @p label set to @c NULL is different from empty string "".
26119     * If an item
26120     * only has icon, it will be displayed bigger and centered. If it has
26121     * icon and label, even that an empty string, icon will be smaller and
26122     * positioned at left.
26123     *
26124     * @see elm_segment_control_item_add()
26125     * @see elm_segment_control_item_count_get()
26126     * @see elm_segment_control_item_del()
26127     *
26128     * @ingroup SegmentControl
26129     */
26130    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);
26131
26132    /**
26133     * Remove a segment control item from its parent, deleting it.
26134     *
26135     * @param it The item to be removed.
26136     *
26137     * Items can be added with elm_segment_control_item_add() or
26138     * elm_segment_control_item_insert_at().
26139     *
26140     * @ingroup SegmentControl
26141     */
26142    EAPI void              elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26143
26144    /**
26145     * Remove a segment control item at given index from its parent,
26146     * deleting it.
26147     *
26148     * @param obj The segment control object.
26149     * @param index The position of the segment control item to be deleted.
26150     *
26151     * Items can be added with elm_segment_control_item_add() or
26152     * elm_segment_control_item_insert_at().
26153     *
26154     * @ingroup SegmentControl
26155     */
26156    EAPI void              elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26157
26158    /**
26159     * Get the Segment items count from segment control.
26160     *
26161     * @param obj The segment control object.
26162     * @return Segment items count.
26163     *
26164     * It will just return the number of items added to segment control @p obj.
26165     *
26166     * @ingroup SegmentControl
26167     */
26168    EAPI int               elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26169
26170    /**
26171     * Get the item placed at specified index.
26172     *
26173     * @param obj The segment control object.
26174     * @param index The index of the segment item.
26175     * @return The segment control item or @c NULL on failure.
26176     *
26177     * Index is the position of an item in segment control widget. Its
26178     * range is from @c 0 to <tt> count - 1 </tt>.
26179     * Count is the number of items, that can be get with
26180     * elm_segment_control_item_count_get().
26181     *
26182     * @ingroup SegmentControl
26183     */
26184    EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26185
26186    /**
26187     * Get the label of item.
26188     *
26189     * @param obj The segment control object.
26190     * @param index The index of the segment item.
26191     * @return The label of the item at @p index.
26192     *
26193     * The return value is a pointer to the label associated to the item when
26194     * it was created, with function elm_segment_control_item_add(), or later
26195     * with function elm_segment_control_item_label_set. If no label
26196     * was passed as argument, it will return @c NULL.
26197     *
26198     * @see elm_segment_control_item_label_set() for more details.
26199     * @see elm_segment_control_item_add()
26200     *
26201     * @ingroup SegmentControl
26202     */
26203    EAPI const char       *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26204
26205    /**
26206     * Set the label of item.
26207     *
26208     * @param it The item of segment control.
26209     * @param text The label of item.
26210     *
26211     * The label to be displayed by the item.
26212     * Label will be at right of the icon (if set).
26213     *
26214     * If a label was passed as argument on item creation, with function
26215     * elm_control_segment_item_add(), it will be already
26216     * displayed by the item.
26217     *
26218     * @see elm_segment_control_item_label_get()
26219     * @see elm_segment_control_item_add()
26220     *
26221     * @ingroup SegmentControl
26222     */
26223    EAPI void              elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
26224
26225    /**
26226     * Get the icon associated to the item.
26227     *
26228     * @param obj The segment control object.
26229     * @param index The index of the segment item.
26230     * @return The left side icon associated to the item at @p index.
26231     *
26232     * The return value is a pointer to the icon associated to the item when
26233     * it was created, with function elm_segment_control_item_add(), or later
26234     * with function elm_segment_control_item_icon_set(). If no icon
26235     * was passed as argument, it will return @c NULL.
26236     *
26237     * @see elm_segment_control_item_add()
26238     * @see elm_segment_control_item_icon_set()
26239     *
26240     * @ingroup SegmentControl
26241     */
26242    EAPI Evas_Object      *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26243
26244    /**
26245     * Set the icon associated to the item.
26246     *
26247     * @param it The segment control item.
26248     * @param icon The icon object to associate with @p it.
26249     *
26250     * The icon object to use at left side of the item. An
26251     * icon can be any Evas object, but usually it is an icon created
26252     * with elm_icon_add().
26253     *
26254     * Once the icon object is set, a previously set one will be deleted.
26255     * @warning Setting the same icon for two items will cause the icon to
26256     * dissapear from the first item.
26257     *
26258     * If an icon was passed as argument on item creation, with function
26259     * elm_segment_control_item_add(), it will be already
26260     * associated to the item.
26261     *
26262     * @see elm_segment_control_item_add()
26263     * @see elm_segment_control_item_icon_get()
26264     *
26265     * @ingroup SegmentControl
26266     */
26267    EAPI void              elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26268
26269    /**
26270     * Get the index of an item.
26271     *
26272     * @param it The segment control item.
26273     * @return The position of item in segment control widget.
26274     *
26275     * Index is the position of an item in segment control widget. Its
26276     * range is from @c 0 to <tt> count - 1 </tt>.
26277     * Count is the number of items, that can be get with
26278     * elm_segment_control_item_count_get().
26279     *
26280     * @ingroup SegmentControl
26281     */
26282    EAPI int               elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26283
26284    /**
26285     * Get the base object of the item.
26286     *
26287     * @param it The segment control item.
26288     * @return The base object associated with @p it.
26289     *
26290     * Base object is the @c Evas_Object that represents that item.
26291     *
26292     * @ingroup SegmentControl
26293     */
26294    EAPI Evas_Object      *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26295
26296    /**
26297     * Get the selected item.
26298     *
26299     * @param obj The segment control object.
26300     * @return The selected item or @c NULL if none of segment items is
26301     * selected.
26302     *
26303     * The selected item can be unselected with function
26304     * elm_segment_control_item_selected_set().
26305     *
26306     * The selected item always will be highlighted on segment control.
26307     *
26308     * @ingroup SegmentControl
26309     */
26310    EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26311
26312    /**
26313     * Set the selected state of an item.
26314     *
26315     * @param it The segment control item
26316     * @param select The selected state
26317     *
26318     * This sets the selected state of the given item @p it.
26319     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26320     *
26321     * If a new item is selected the previosly selected will be unselected.
26322     * Previoulsy selected item can be get with function
26323     * elm_segment_control_item_selected_get().
26324     *
26325     * The selected item always will be highlighted on segment control.
26326     *
26327     * @see elm_segment_control_item_selected_get()
26328     *
26329     * @ingroup SegmentControl
26330     */
26331    EAPI void              elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
26332
26333    /**
26334     * @}
26335     */
26336
26337    /**
26338     * @defgroup Grid Grid
26339     *
26340     * The grid is a grid layout widget that lays out a series of children as a
26341     * fixed "grid" of widgets using a given percentage of the grid width and
26342     * height each using the child object.
26343     *
26344     * The Grid uses a "Virtual resolution" that is stretched to fill the grid
26345     * widgets size itself. The default is 100 x 100, so that means the
26346     * position and sizes of children will effectively be percentages (0 to 100)
26347     * of the width or height of the grid widget
26348     *
26349     * @{
26350     */
26351
26352    /**
26353     * Add a new grid to the parent
26354     *
26355     * @param parent The parent object
26356     * @return The new object or NULL if it cannot be created
26357     *
26358     * @ingroup Grid
26359     */
26360    EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
26361
26362    /**
26363     * Set the virtual size of the grid
26364     *
26365     * @param obj The grid object
26366     * @param w The virtual width of the grid
26367     * @param h The virtual height of the grid
26368     *
26369     * @ingroup Grid
26370     */
26371    EAPI void         elm_grid_size_set(Evas_Object *obj, int w, int h);
26372
26373    /**
26374     * Get the virtual size of the grid
26375     *
26376     * @param obj The grid object
26377     * @param w Pointer to integer to store the virtual width of the grid
26378     * @param h Pointer to integer to store the virtual height of the grid
26379     *
26380     * @ingroup Grid
26381     */
26382    EAPI void         elm_grid_size_get(Evas_Object *obj, int *w, int *h);
26383
26384    /**
26385     * Pack child at given position and size
26386     *
26387     * @param obj The grid object
26388     * @param subobj The child to pack
26389     * @param x The virtual x coord at which to pack it
26390     * @param y The virtual y coord at which to pack it
26391     * @param w The virtual width at which to pack it
26392     * @param h The virtual height at which to pack it
26393     *
26394     * @ingroup Grid
26395     */
26396    EAPI void         elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
26397
26398    /**
26399     * Unpack a child from a grid object
26400     *
26401     * @param obj The grid object
26402     * @param subobj The child to unpack
26403     *
26404     * @ingroup Grid
26405     */
26406    EAPI void         elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
26407
26408    /**
26409     * Faster way to remove all child objects from a grid object.
26410     *
26411     * @param obj The grid object
26412     * @param clear If true, it will delete just removed children
26413     *
26414     * @ingroup Grid
26415     */
26416    EAPI void         elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
26417
26418    /**
26419     * Set packing of an existing child at to position and size
26420     *
26421     * @param subobj The child to set packing of
26422     * @param x The virtual x coord at which to pack it
26423     * @param y The virtual y coord at which to pack it
26424     * @param w The virtual width at which to pack it
26425     * @param h The virtual height at which to pack it
26426     *
26427     * @ingroup Grid
26428     */
26429    EAPI void         elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
26430
26431    /**
26432     * get packing of a child
26433     *
26434     * @param subobj The child to query
26435     * @param x Pointer to integer to store the virtual x coord
26436     * @param y Pointer to integer to store the virtual y coord
26437     * @param w Pointer to integer to store the virtual width
26438     * @param h Pointer to integer to store the virtual height
26439     *
26440     * @ingroup Grid
26441     */
26442    EAPI void         elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
26443
26444    /**
26445     * @}
26446     */
26447
26448    EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
26449    EAPI void         elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
26450    EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
26451    EAPI void         elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
26452    EAPI Eina_Bool    elm_factory_maxmin_mode_get(const Evas_Object *obj);
26453    EAPI void         elm_factory_maxmin_reset_set(Evas_Object *obj);
26454
26455    /**
26456     * @defgroup Video Video
26457     *
26458     * This object display an player that let you control an Elm_Video
26459     * object. It take care of updating it's content according to what is
26460     * going on inside the Emotion object. It does activate the remember
26461     * function on the linked Elm_Video object.
26462     *
26463     * Signals that you cann add callback for are :
26464     *
26465     * "forward,clicked" - the user clicked the forward button.
26466     * "info,clicked" - the user clicked the info button.
26467     * "next,clicked" - the user clicked the next button.
26468     * "pause,clicked" - the user clicked the pause button.
26469     * "play,clicked" - the user clicked the play button.
26470     * "prev,clicked" - the user clicked the prev button.
26471     * "rewind,clicked" - the user clicked the rewind button.
26472     * "stop,clicked" - the user clicked the stop button.
26473     */
26474    EAPI Evas_Object *elm_video_add(Evas_Object *parent);
26475    EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
26476    EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
26477    EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
26478    EAPI void elm_video_play(Evas_Object *video);
26479    EAPI void elm_video_pause(Evas_Object *video);
26480    EAPI void elm_video_stop(Evas_Object *video);
26481    EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
26482    EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
26483    EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
26484    EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
26485    EAPI double elm_video_audio_level_get(Evas_Object *video);
26486    EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
26487    EAPI double elm_video_play_position_get(Evas_Object *video);
26488    EAPI void elm_video_play_position_set(Evas_Object *video, double position);
26489    EAPI double elm_video_play_length_get(Evas_Object *video);
26490    EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
26491    EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
26492    EAPI const char *elm_video_title_get(Evas_Object *video);
26493
26494    EAPI Evas_Object *elm_player_add(Evas_Object *parent);
26495    EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
26496
26497   /* naviframe */
26498    EAPI Evas_Object        *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26499    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);
26500    EAPI Evas_Object        *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
26501    EAPI void                elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
26502    EAPI Eina_Bool           elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26503    EAPI void                elm_naviframe_item_title_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26504    EAPI const char         *elm_naviframe_item_title_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26505    EAPI void                elm_naviframe_item_subtitle_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26506    EAPI const char         *elm_naviframe_item_subtitle_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26507    EAPI Elm_Object_Item    *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26508    EAPI Elm_Object_Item    *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26509    EAPI void                elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
26510    EAPI const char         *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26511    EAPI void                elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
26512    EAPI Eina_Bool           elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26513
26514 #ifdef __cplusplus
26515 }
26516 #endif
26517
26518 #endif