elm gengrid: Added page feature to gengrid. Patch by Benjamin Drucker
[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) elm_object_item_content_part_get((it), NULL)
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     * Get the data associated with an object item
1109     * @param it The object item
1110     * @return The data associated with @p it
1111     *
1112     * @ingroup General
1113     */
1114    EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1115
1116    /**
1117     * Set the data associated with an object item
1118     * @param it The object item
1119     * @param data The data to be associated with @p it
1120     *
1121     * @ingroup General
1122     */
1123    EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1124
1125    /**
1126     * @}
1127     */
1128
1129    /**
1130     * @defgroup Caches Caches
1131     *
1132     * These are functions which let one fine-tune some cache values for
1133     * Elementary applications, thus allowing for performance adjustments.
1134     *
1135     * @{
1136     */
1137
1138    /**
1139     * @brief Flush all caches.
1140     *
1141     * Frees all data that was in cache and is not currently being used to reduce
1142     * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1143     * to calling all of the following functions:
1144     * @li edje_file_cache_flush()
1145     * @li edje_collection_cache_flush()
1146     * @li eet_clearcache()
1147     * @li evas_image_cache_flush()
1148     * @li evas_font_cache_flush()
1149     * @li evas_render_dump()
1150     * @note Evas caches are flushed for every canvas associated with a window.
1151     *
1152     * @ingroup Caches
1153     */
1154    EAPI void         elm_all_flush(void);
1155
1156    /**
1157     * Get the configured cache flush interval time
1158     *
1159     * This gets the globally configured cache flush interval time, in
1160     * ticks
1161     *
1162     * @return The cache flush interval time
1163     * @ingroup Caches
1164     *
1165     * @see elm_all_flush()
1166     */
1167    EAPI int          elm_cache_flush_interval_get(void);
1168
1169    /**
1170     * Set the configured cache flush interval time
1171     *
1172     * This sets the globally configured cache flush interval time, in ticks
1173     *
1174     * @param size The cache flush interval time
1175     * @ingroup Caches
1176     *
1177     * @see elm_all_flush()
1178     */
1179    EAPI void         elm_cache_flush_interval_set(int size);
1180
1181    /**
1182     * Set the configured cache flush interval time for all applications on the
1183     * display
1184     *
1185     * This sets the globally configured cache flush interval time -- in ticks
1186     * -- for all applications on the display.
1187     *
1188     * @param size The cache flush interval time
1189     * @ingroup Caches
1190     */
1191    EAPI void         elm_cache_flush_interval_all_set(int size);
1192
1193    /**
1194     * Get the configured cache flush enabled state
1195     *
1196     * This gets the globally configured cache flush state - if it is enabled
1197     * or not. When cache flushing is enabled, elementary will regularly
1198     * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1199     * memory and allow usage to re-seed caches and data in memory where it
1200     * can do so. An idle application will thus minimise its memory usage as
1201     * data will be freed from memory and not be re-loaded as it is idle and
1202     * not rendering or doing anything graphically right now.
1203     *
1204     * @return The cache flush state
1205     * @ingroup Caches
1206     *
1207     * @see elm_all_flush()
1208     */
1209    EAPI Eina_Bool    elm_cache_flush_enabled_get(void);
1210
1211    /**
1212     * Set the configured cache flush enabled state
1213     *
1214     * This sets the globally configured cache flush enabled state
1215     *
1216     * @param size The cache flush enabled state
1217     * @ingroup Caches
1218     *
1219     * @see elm_all_flush()
1220     */
1221    EAPI void         elm_cache_flush_enabled_set(Eina_Bool enabled);
1222
1223    /**
1224     * Set the configured cache flush enabled state for all applications on the
1225     * display
1226     *
1227     * This sets the globally configured cache flush enabled state for all
1228     * applications on the display.
1229     *
1230     * @param size The cache flush enabled state
1231     * @ingroup Caches
1232     */
1233    EAPI void         elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1234
1235    /**
1236     * Get the configured font cache size
1237     *
1238     * This gets the globally configured font cache size, in bytes
1239     *
1240     * @return The font cache size
1241     * @ingroup Caches
1242     */
1243    EAPI int          elm_font_cache_get(void);
1244
1245    /**
1246     * Set the configured font cache size
1247     *
1248     * This sets the globally configured font cache size, in bytes
1249     *
1250     * @param size The font cache size
1251     * @ingroup Caches
1252     */
1253    EAPI void         elm_font_cache_set(int size);
1254
1255    /**
1256     * Set the configured font cache size for all applications on the
1257     * display
1258     *
1259     * This sets the globally configured font cache size -- in bytes
1260     * -- for all applications on the display.
1261     *
1262     * @param size The font cache size
1263     * @ingroup Caches
1264     */
1265    EAPI void         elm_font_cache_all_set(int size);
1266
1267    /**
1268     * Get the configured image cache size
1269     *
1270     * This gets the globally configured image cache size, in bytes
1271     *
1272     * @return The image cache size
1273     * @ingroup Caches
1274     */
1275    EAPI int          elm_image_cache_get(void);
1276
1277    /**
1278     * Set the configured image cache size
1279     *
1280     * This sets the globally configured image cache size, in bytes
1281     *
1282     * @param size The image cache size
1283     * @ingroup Caches
1284     */
1285    EAPI void         elm_image_cache_set(int size);
1286
1287    /**
1288     * Set the configured image cache size for all applications on the
1289     * display
1290     *
1291     * This sets the globally configured image cache size -- in bytes
1292     * -- for all applications on the display.
1293     *
1294     * @param size The image cache size
1295     * @ingroup Caches
1296     */
1297    EAPI void         elm_image_cache_all_set(int size);
1298
1299    /**
1300     * Get the configured edje file cache size.
1301     *
1302     * This gets the globally configured edje file cache size, in number
1303     * of files.
1304     *
1305     * @return The edje file cache size
1306     * @ingroup Caches
1307     */
1308    EAPI int          elm_edje_file_cache_get(void);
1309
1310    /**
1311     * Set the configured edje file cache size
1312     *
1313     * This sets the globally configured edje file cache size, in number
1314     * of files.
1315     *
1316     * @param size The edje file cache size
1317     * @ingroup Caches
1318     */
1319    EAPI void         elm_edje_file_cache_set(int size);
1320
1321    /**
1322     * Set the configured edje file cache size for all applications on the
1323     * display
1324     *
1325     * This sets the globally configured edje file cache size -- in number
1326     * of files -- for all applications on the display.
1327     *
1328     * @param size The edje file cache size
1329     * @ingroup Caches
1330     */
1331    EAPI void         elm_edje_file_cache_all_set(int size);
1332
1333    /**
1334     * Get the configured edje collections (groups) cache size.
1335     *
1336     * This gets the globally configured edje collections cache size, in
1337     * number of collections.
1338     *
1339     * @return The edje collections cache size
1340     * @ingroup Caches
1341     */
1342    EAPI int          elm_edje_collection_cache_get(void);
1343
1344    /**
1345     * Set the configured edje collections (groups) cache size
1346     *
1347     * This sets the globally configured edje collections cache size, in
1348     * number of collections.
1349     *
1350     * @param size The edje collections cache size
1351     * @ingroup Caches
1352     */
1353    EAPI void         elm_edje_collection_cache_set(int size);
1354
1355    /**
1356     * Set the configured edje collections (groups) cache size for all
1357     * applications on the display
1358     *
1359     * This sets the globally configured edje collections cache size -- in
1360     * number of collections -- for all applications on the display.
1361     *
1362     * @param size The edje collections cache size
1363     * @ingroup Caches
1364     */
1365    EAPI void         elm_edje_collection_cache_all_set(int size);
1366
1367    /**
1368     * @}
1369     */
1370
1371    /**
1372     * @defgroup Scaling Widget Scaling
1373     *
1374     * Different widgets can be scaled independently. These functions
1375     * allow you to manipulate this scaling on a per-widget basis. The
1376     * object and all its children get their scaling factors multiplied
1377     * by the scale factor set. This is multiplicative, in that if a
1378     * child also has a scale size set it is in turn multiplied by its
1379     * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
1380     * double size, @c 0.5 is half, etc.
1381     *
1382     * @ref general_functions_example_page "This" example contemplates
1383     * some of these functions.
1384     */
1385
1386    /**
1387     * Get the global scaling factor
1388     *
1389     * This gets the globally configured scaling factor that is applied to all
1390     * objects.
1391     *
1392     * @return The scaling factor
1393     * @ingroup Scaling
1394     */
1395    EAPI double       elm_scale_get(void);
1396
1397    /**
1398     * Set the global scaling factor
1399     *
1400     * This sets the globally configured scaling factor that is applied to all
1401     * objects.
1402     *
1403     * @param scale The scaling factor to set
1404     * @ingroup Scaling
1405     */
1406    EAPI void         elm_scale_set(double scale);
1407
1408    /**
1409     * Set the global scaling factor for all applications on the display
1410     *
1411     * This sets the globally configured scaling factor that is applied to all
1412     * objects for all applications.
1413     * @param scale The scaling factor to set
1414     * @ingroup Scaling
1415     */
1416    EAPI void         elm_scale_all_set(double scale);
1417
1418    /**
1419     * Set the scaling factor for a given Elementary object
1420     *
1421     * @param obj The Elementary to operate on
1422     * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1423     * no scaling)
1424     *
1425     * @ingroup Scaling
1426     */
1427    EAPI void         elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1428
1429    /**
1430     * Get the scaling factor for a given Elementary object
1431     *
1432     * @param obj The object
1433     * @return The scaling factor set by elm_object_scale_set()
1434     *
1435     * @ingroup Scaling
1436     */
1437    EAPI double       elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1438
1439    /**
1440     * @defgroup Password_last_show Password last input show
1441     *
1442     * Last show feature of password mode enables user to view
1443     * the last input entered for few seconds before masking it.
1444     * These functions allow to set this feature in password mode
1445     * of entry widget and also allow to manipulate the duration
1446     * for which the input has to be visible.
1447     *
1448     * @{
1449     */
1450
1451    /**
1452     * Get show last setting of password mode.
1453     *
1454     * This gets the show last input setting of password mode which might be
1455     * enabled or disabled.
1456     *
1457     * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1458     *            if it's disabled.
1459     * @ingroup Password_last_show
1460     */
1461    EAPI Eina_Bool elm_password_show_last_get(void);
1462
1463    /**
1464     * Set show last setting in password mode.
1465     *
1466     * This enables or disables show last setting of password mode.
1467     *
1468     * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1469     * @see elm_password_show_last_timeout_set()
1470     * @ingroup Password_last_show
1471     */
1472    EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1473
1474    /**
1475     * Get's the timeout value in last show password mode.
1476     *
1477     * This gets the time out value for which the last input entered in password
1478     * mode will be visible.
1479     *
1480     * @return The timeout value of last show password mode.
1481     * @ingroup Password_last_show
1482     */
1483    EAPI double elm_password_show_last_timeout_get(void);
1484
1485    /**
1486     * Set's the timeout value in last show password mode.
1487     *
1488     * This sets the time out value for which the last input entered in password
1489     * mode will be visible.
1490     *
1491     * @param password_show_last_timeout The timeout value.
1492     * @see elm_password_show_last_set()
1493     * @ingroup Password_last_show
1494     */
1495    EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1496
1497    /**
1498     * @}
1499     */
1500
1501    /**
1502     * @defgroup UI-Mirroring Selective Widget mirroring
1503     *
1504     * These functions allow you to set ui-mirroring on specific
1505     * widgets or the whole interface. Widgets can be in one of two
1506     * modes, automatic and manual.  Automatic means they'll be changed
1507     * according to the system mirroring mode and manual means only
1508     * explicit changes will matter. You are not supposed to change
1509     * mirroring state of a widget set to automatic, will mostly work,
1510     * but the behavior is not really defined.
1511     *
1512     * @{
1513     */
1514
1515    EAPI Eina_Bool    elm_mirrored_get(void);
1516    EAPI void         elm_mirrored_set(Eina_Bool mirrored);
1517
1518    /**
1519     * Get the system mirrored mode. This determines the default mirrored mode
1520     * of widgets.
1521     *
1522     * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1523     */
1524    EAPI Eina_Bool    elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1525
1526    /**
1527     * Set the system mirrored mode. This determines the default mirrored mode
1528     * of widgets.
1529     *
1530     * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1531     */
1532    EAPI void         elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1533
1534    /**
1535     * Returns the widget's mirrored mode setting.
1536     *
1537     * @param obj The widget.
1538     * @return mirrored mode setting of the object.
1539     *
1540     **/
1541    EAPI Eina_Bool    elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1542
1543    /**
1544     * Sets the widget's mirrored mode setting.
1545     * When widget in automatic mode, it follows the system mirrored mode set by
1546     * elm_mirrored_set().
1547     * @param obj The widget.
1548     * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1549     */
1550    EAPI void         elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1551
1552    /**
1553     * @}
1554     */
1555
1556    /**
1557     * Set the style to use by a widget
1558     *
1559     * Sets the style name that will define the appearance of a widget. Styles
1560     * vary from widget to widget and may also be defined by other themes
1561     * by means of extensions and overlays.
1562     *
1563     * @param obj The Elementary widget to style
1564     * @param style The style name to use
1565     *
1566     * @see elm_theme_extension_add()
1567     * @see elm_theme_extension_del()
1568     * @see elm_theme_overlay_add()
1569     * @see elm_theme_overlay_del()
1570     *
1571     * @ingroup Styles
1572     */
1573    EAPI void         elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1574    /**
1575     * Get the style used by the widget
1576     *
1577     * This gets the style being used for that widget. Note that the string
1578     * pointer is only valid as longas the object is valid and the style doesn't
1579     * change.
1580     *
1581     * @param obj The Elementary widget to query for its style
1582     * @return The style name used
1583     *
1584     * @see elm_object_style_set()
1585     *
1586     * @ingroup Styles
1587     */
1588    EAPI const char  *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1589
1590    /**
1591     * @defgroup Styles Styles
1592     *
1593     * Widgets can have different styles of look. These generic API's
1594     * set styles of widgets, if they support them (and if the theme(s)
1595     * do).
1596     *
1597     * @ref general_functions_example_page "This" example contemplates
1598     * some of these functions.
1599     */
1600
1601    /**
1602     * Set the disabled state of an Elementary object.
1603     *
1604     * @param obj The Elementary object to operate on
1605     * @param disabled The state to put in in: @c EINA_TRUE for
1606     *        disabled, @c EINA_FALSE for enabled
1607     *
1608     * Elementary objects can be @b disabled, in which state they won't
1609     * receive input and, in general, will be themed differently from
1610     * their normal state, usually greyed out. Useful for contexts
1611     * where you don't want your users to interact with some of the
1612     * parts of you interface.
1613     *
1614     * This sets the state for the widget, either disabling it or
1615     * enabling it back.
1616     *
1617     * @ingroup Styles
1618     */
1619    EAPI void         elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1620
1621    /**
1622     * Get the disabled state of an Elementary object.
1623     *
1624     * @param obj The Elementary object to operate on
1625     * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1626     *            if it's enabled (or on errors)
1627     *
1628     * This gets the state of the widget, which might be enabled or disabled.
1629     *
1630     * @ingroup Styles
1631     */
1632    EAPI Eina_Bool    elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1633
1634    /**
1635     * @defgroup WidgetNavigation Widget Tree Navigation.
1636     *
1637     * How to check if an Evas Object is an Elementary widget? How to
1638     * get the first elementary widget that is parent of the given
1639     * object?  These are all covered in widget tree navigation.
1640     *
1641     * @ref general_functions_example_page "This" example contemplates
1642     * some of these functions.
1643     */
1644
1645    /**
1646     * Check if the given Evas Object is an Elementary widget.
1647     *
1648     * @param obj the object to query.
1649     * @return @c EINA_TRUE if it is an elementary widget variant,
1650     *         @c EINA_FALSE otherwise
1651     * @ingroup WidgetNavigation
1652     */
1653    EAPI Eina_Bool    elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1654
1655    /**
1656     * Get the first parent of the given object that is an Elementary
1657     * widget.
1658     *
1659     * @param obj the Elementary object to query parent from.
1660     * @return the parent object that is an Elementary widget, or @c
1661     *         NULL, if it was not found.
1662     *
1663     * Use this to query for an object's parent widget.
1664     *
1665     * @note Most of Elementary users wouldn't be mixing non-Elementary
1666     * smart objects in the objects tree of an application, as this is
1667     * an advanced usage of Elementary with Evas. So, except for the
1668     * application's window, which is the root of that tree, all other
1669     * objects would have valid Elementary widget parents.
1670     *
1671     * @ingroup WidgetNavigation
1672     */
1673    EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1674
1675    /**
1676     * Get the top level parent of an Elementary widget.
1677     *
1678     * @param obj The object to query.
1679     * @return The top level Elementary widget, or @c NULL if parent cannot be
1680     * found.
1681     * @ingroup WidgetNavigation
1682     */
1683    EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1684
1685    /**
1686     * Get the string that represents this Elementary widget.
1687     *
1688     * @note Elementary is weird and exposes itself as a single
1689     *       Evas_Object_Smart_Class of type "elm_widget", so
1690     *       evas_object_type_get() always return that, making debug and
1691     *       language bindings hard. This function tries to mitigate this
1692     *       problem, but the solution is to change Elementary to use
1693     *       proper inheritance.
1694     *
1695     * @param obj the object to query.
1696     * @return Elementary widget name, or @c NULL if not a valid widget.
1697     * @ingroup WidgetNavigation
1698     */
1699    EAPI const char  *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1700
1701    /**
1702     * @defgroup Config Elementary Config
1703     *
1704     * Elementary configuration is formed by a set options bounded to a
1705     * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1706     * "finger size", etc. These are functions with which one syncronizes
1707     * changes made to those values to the configuration storing files, de
1708     * facto. You most probably don't want to use the functions in this
1709     * group unlees you're writing an elementary configuration manager.
1710     *
1711     * @{
1712     */
1713
1714    /**
1715     * Save back Elementary's configuration, so that it will persist on
1716     * future sessions.
1717     *
1718     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1719     * @ingroup Config
1720     *
1721     * This function will take effect -- thus, do I/O -- immediately. Use
1722     * it when you want to apply all configuration changes at once. The
1723     * current configuration set will get saved onto the current profile
1724     * configuration file.
1725     *
1726     */
1727    EAPI Eina_Bool    elm_config_save(void);
1728
1729    /**
1730     * Reload Elementary's configuration, bounded to current selected
1731     * profile.
1732     *
1733     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1734     * @ingroup Config
1735     *
1736     * Useful when you want to force reloading of configuration values for
1737     * a profile. If one removes user custom configuration directories,
1738     * for example, it will force a reload with system values insted.
1739     *
1740     */
1741    EAPI void         elm_config_reload(void);
1742
1743    /**
1744     * @}
1745     */
1746
1747    /**
1748     * @defgroup Profile Elementary Profile
1749     *
1750     * Profiles are pre-set options that affect the whole look-and-feel of
1751     * Elementary-based applications. There are, for example, profiles
1752     * aimed at desktop computer applications and others aimed at mobile,
1753     * touchscreen-based ones. You most probably don't want to use the
1754     * functions in this group unlees you're writing an elementary
1755     * configuration manager.
1756     *
1757     * @{
1758     */
1759
1760    /**
1761     * Get Elementary's profile in use.
1762     *
1763     * This gets the global profile that is applied to all Elementary
1764     * applications.
1765     *
1766     * @return The profile's name
1767     * @ingroup Profile
1768     */
1769    EAPI const char  *elm_profile_current_get(void);
1770
1771    /**
1772     * Get an Elementary's profile directory path in the filesystem. One
1773     * may want to fetch a system profile's dir or an user one (fetched
1774     * inside $HOME).
1775     *
1776     * @param profile The profile's name
1777     * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1778     *                or a system one (@c EINA_FALSE)
1779     * @return The profile's directory path.
1780     * @ingroup Profile
1781     *
1782     * @note You must free it with elm_profile_dir_free().
1783     */
1784    EAPI const char  *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1785
1786    /**
1787     * Free an Elementary's profile directory path, as returned by
1788     * elm_profile_dir_get().
1789     *
1790     * @param p_dir The profile's path
1791     * @ingroup Profile
1792     *
1793     */
1794    EAPI void         elm_profile_dir_free(const char *p_dir);
1795
1796    /**
1797     * Get Elementary's list of available profiles.
1798     *
1799     * @return The profiles list. List node data are the profile name
1800     *         strings.
1801     * @ingroup Profile
1802     *
1803     * @note One must free this list, after usage, with the function
1804     *       elm_profile_list_free().
1805     */
1806    EAPI Eina_List   *elm_profile_list_get(void);
1807
1808    /**
1809     * Free Elementary's list of available profiles.
1810     *
1811     * @param l The profiles list, as returned by elm_profile_list_get().
1812     * @ingroup Profile
1813     *
1814     */
1815    EAPI void         elm_profile_list_free(Eina_List *l);
1816
1817    /**
1818     * Set Elementary's profile.
1819     *
1820     * This sets the global profile that is applied to Elementary
1821     * applications. Just the process the call comes from will be
1822     * affected.
1823     *
1824     * @param profile The profile's name
1825     * @ingroup Profile
1826     *
1827     */
1828    EAPI void         elm_profile_set(const char *profile);
1829
1830    /**
1831     * Set Elementary's profile.
1832     *
1833     * This sets the global profile that is applied to all Elementary
1834     * applications. All running Elementary windows will be affected.
1835     *
1836     * @param profile The profile's name
1837     * @ingroup Profile
1838     *
1839     */
1840    EAPI void         elm_profile_all_set(const char *profile);
1841
1842    /**
1843     * @}
1844     */
1845
1846    /**
1847     * @defgroup Engine Elementary Engine
1848     *
1849     * These are functions setting and querying which rendering engine
1850     * Elementary will use for drawing its windows' pixels.
1851     *
1852     * The following are the available engines:
1853     * @li "software_x11"
1854     * @li "fb"
1855     * @li "directfb"
1856     * @li "software_16_x11"
1857     * @li "software_8_x11"
1858     * @li "xrender_x11"
1859     * @li "opengl_x11"
1860     * @li "software_gdi"
1861     * @li "software_16_wince_gdi"
1862     * @li "sdl"
1863     * @li "software_16_sdl"
1864     * @li "opengl_sdl"
1865     * @li "buffer"
1866     *
1867     * @{
1868     */
1869
1870    /**
1871     * @brief Get Elementary's rendering engine in use.
1872     *
1873     * @return The rendering engine's name
1874     * @note there's no need to free the returned string, here.
1875     *
1876     * This gets the global rendering engine that is applied to all Elementary
1877     * applications.
1878     *
1879     * @see elm_engine_set()
1880     */
1881    EAPI const char  *elm_engine_current_get(void);
1882
1883    /**
1884     * @brief Set Elementary's rendering engine for use.
1885     *
1886     * @param engine The rendering engine's name
1887     *
1888     * This sets global rendering engine that is applied to all Elementary
1889     * applications. Note that it will take effect only to Elementary windows
1890     * created after this is called.
1891     *
1892     * @see elm_win_add()
1893     */
1894    EAPI void         elm_engine_set(const char *engine);
1895
1896    /**
1897     * @}
1898     */
1899
1900    /**
1901     * @defgroup Fonts Elementary Fonts
1902     *
1903     * These are functions dealing with font rendering, selection and the
1904     * like for Elementary applications. One might fetch which system
1905     * fonts are there to use and set custom fonts for individual classes
1906     * of UI items containing text (text classes).
1907     *
1908     * @{
1909     */
1910
1911   typedef struct _Elm_Text_Class
1912     {
1913        const char *name;
1914        const char *desc;
1915     } Elm_Text_Class;
1916
1917   typedef struct _Elm_Font_Overlay
1918     {
1919        const char     *text_class;
1920        const char     *font;
1921        Evas_Font_Size  size;
1922     } Elm_Font_Overlay;
1923
1924   typedef struct _Elm_Font_Properties
1925     {
1926        const char *name;
1927        Eina_List  *styles;
1928     } Elm_Font_Properties;
1929
1930    /**
1931     * Get Elementary's list of supported text classes.
1932     *
1933     * @return The text classes list, with @c Elm_Text_Class blobs as data.
1934     * @ingroup Fonts
1935     *
1936     * Release the list with elm_text_classes_list_free().
1937     */
1938    EAPI const Eina_List     *elm_text_classes_list_get(void);
1939
1940    /**
1941     * Free Elementary's list of supported text classes.
1942     *
1943     * @ingroup Fonts
1944     *
1945     * @see elm_text_classes_list_get().
1946     */
1947    EAPI void                 elm_text_classes_list_free(const Eina_List *list);
1948
1949    /**
1950     * Get Elementary's list of font overlays, set with
1951     * elm_font_overlay_set().
1952     *
1953     * @return The font overlays list, with @c Elm_Font_Overlay blobs as
1954     * data.
1955     *
1956     * @ingroup Fonts
1957     *
1958     * For each text class, one can set a <b>font overlay</b> for it,
1959     * overriding the default font properties for that class coming from
1960     * the theme in use. There is no need to free this list.
1961     *
1962     * @see elm_font_overlay_set() and elm_font_overlay_unset().
1963     */
1964    EAPI const Eina_List     *elm_font_overlay_list_get(void);
1965
1966    /**
1967     * Set a font overlay for a given Elementary text class.
1968     *
1969     * @param text_class Text class name
1970     * @param font Font name and style string
1971     * @param size Font size
1972     *
1973     * @ingroup Fonts
1974     *
1975     * @p font has to be in the format returned by
1976     * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
1977     * and elm_font_overlay_unset().
1978     */
1979    EAPI void                 elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
1980
1981    /**
1982     * Unset a font overlay for a given Elementary text class.
1983     *
1984     * @param text_class Text class name
1985     *
1986     * @ingroup Fonts
1987     *
1988     * This will bring back text elements belonging to text class
1989     * @p text_class back to their default font settings.
1990     */
1991    EAPI void                 elm_font_overlay_unset(const char *text_class);
1992
1993    /**
1994     * Apply the changes made with elm_font_overlay_set() and
1995     * elm_font_overlay_unset() on the current Elementary window.
1996     *
1997     * @ingroup Fonts
1998     *
1999     * This applies all font overlays set to all objects in the UI.
2000     */
2001    EAPI void                 elm_font_overlay_apply(void);
2002
2003    /**
2004     * Apply the changes made with elm_font_overlay_set() and
2005     * elm_font_overlay_unset() on all Elementary application windows.
2006     *
2007     * @ingroup Fonts
2008     *
2009     * This applies all font overlays set to all objects in the UI.
2010     */
2011    EAPI void                 elm_font_overlay_all_apply(void);
2012
2013    /**
2014     * Translate a font (family) name string in fontconfig's font names
2015     * syntax into an @c Elm_Font_Properties struct.
2016     *
2017     * @param font The font name and styles string
2018     * @return the font properties struct
2019     *
2020     * @ingroup Fonts
2021     *
2022     * @note The reverse translation can be achived with
2023     * elm_font_fontconfig_name_get(), for one style only (single font
2024     * instance, not family).
2025     */
2026    EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2027
2028    /**
2029     * Free font properties return by elm_font_properties_get().
2030     *
2031     * @param efp the font properties struct
2032     *
2033     * @ingroup Fonts
2034     */
2035    EAPI void                 elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2036
2037    /**
2038     * Translate a font name, bound to a style, into fontconfig's font names
2039     * syntax.
2040     *
2041     * @param name The font (family) name
2042     * @param style The given style (may be @c NULL)
2043     *
2044     * @return the font name and style string
2045     *
2046     * @ingroup Fonts
2047     *
2048     * @note The reverse translation can be achived with
2049     * elm_font_properties_get(), for one style only (single font
2050     * instance, not family).
2051     */
2052    EAPI const char          *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2053
2054    /**
2055     * Free the font string return by elm_font_fontconfig_name_get().
2056     *
2057     * @param efp the font properties struct
2058     *
2059     * @ingroup Fonts
2060     */
2061    EAPI void                 elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2062
2063    /**
2064     * Create a font hash table of available system fonts.
2065     *
2066     * One must call it with @p list being the return value of
2067     * evas_font_available_list(). The hash will be indexed by font
2068     * (family) names, being its values @c Elm_Font_Properties blobs.
2069     *
2070     * @param list The list of available system fonts, as returned by
2071     * evas_font_available_list().
2072     * @return the font hash.
2073     *
2074     * @ingroup Fonts
2075     *
2076     * @note The user is supposed to get it populated at least with 3
2077     * default font families (Sans, Serif, Monospace), which should be
2078     * present on most systems.
2079     */
2080    EAPI Eina_Hash           *elm_font_available_hash_add(Eina_List *list);
2081
2082    /**
2083     * Free the hash return by elm_font_available_hash_add().
2084     *
2085     * @param hash the hash to be freed.
2086     *
2087     * @ingroup Fonts
2088     */
2089    EAPI void                 elm_font_available_hash_del(Eina_Hash *hash);
2090
2091    /**
2092     * @}
2093     */
2094
2095    /**
2096     * @defgroup Fingers Fingers
2097     *
2098     * Elementary is designed to be finger-friendly for touchscreens,
2099     * and so in addition to scaling for display resolution, it can
2100     * also scale based on finger "resolution" (or size). You can then
2101     * customize the granularity of the areas meant to receive clicks
2102     * on touchscreens.
2103     *
2104     * Different profiles may have pre-set values for finger sizes.
2105     *
2106     * @ref general_functions_example_page "This" example contemplates
2107     * some of these functions.
2108     *
2109     * @{
2110     */
2111
2112    /**
2113     * Get the configured "finger size"
2114     *
2115     * @return The finger size
2116     *
2117     * This gets the globally configured finger size, <b>in pixels</b>
2118     *
2119     * @ingroup Fingers
2120     */
2121    EAPI Evas_Coord       elm_finger_size_get(void);
2122
2123    /**
2124     * Set the configured finger size
2125     *
2126     * This sets the globally configured finger size in pixels
2127     *
2128     * @param size The finger size
2129     * @ingroup Fingers
2130     */
2131    EAPI void             elm_finger_size_set(Evas_Coord size);
2132
2133    /**
2134     * Set the configured finger size for all applications on the display
2135     *
2136     * This sets the globally configured finger size in pixels for all
2137     * applications on the display
2138     *
2139     * @param size The finger size
2140     * @ingroup Fingers
2141     */
2142    EAPI void             elm_finger_size_all_set(Evas_Coord size);
2143
2144    /**
2145     * @}
2146     */
2147
2148    /**
2149     * @defgroup Focus Focus
2150     *
2151     * An Elementary application has, at all times, one (and only one)
2152     * @b focused object. This is what determines where the input
2153     * events go to within the application's window. Also, focused
2154     * objects can be decorated differently, in order to signal to the
2155     * user where the input is, at a given moment.
2156     *
2157     * Elementary applications also have the concept of <b>focus
2158     * chain</b>: one can cycle through all the windows' focusable
2159     * objects by input (tab key) or programmatically. The default
2160     * focus chain for an application is the one define by the order in
2161     * which the widgets where added in code. One will cycle through
2162     * top level widgets, and, for each one containg sub-objects, cycle
2163     * through them all, before returning to the level
2164     * above. Elementary also allows one to set @b custom focus chains
2165     * for their applications.
2166     *
2167     * Besides the focused decoration a widget may exhibit, when it
2168     * gets focus, Elementary has a @b global focus highlight object
2169     * that can be enabled for a window. If one chooses to do so, this
2170     * extra highlight effect will surround the current focused object,
2171     * too.
2172     *
2173     * @note Some Elementary widgets are @b unfocusable, after
2174     * creation, by their very nature: they are not meant to be
2175     * interacted with input events, but are there just for visual
2176     * purposes.
2177     *
2178     * @ref general_functions_example_page "This" example contemplates
2179     * some of these functions.
2180     */
2181
2182    /**
2183     * Get the enable status of the focus highlight
2184     *
2185     * This gets whether the highlight on focused objects is enabled or not
2186     * @ingroup Focus
2187     */
2188    EAPI Eina_Bool        elm_focus_highlight_enabled_get(void);
2189
2190    /**
2191     * Set the enable status of the focus highlight
2192     *
2193     * Set whether to show or not the highlight on focused objects
2194     * @param enable Enable highlight if EINA_TRUE, disable otherwise
2195     * @ingroup Focus
2196     */
2197    EAPI void             elm_focus_highlight_enabled_set(Eina_Bool enable);
2198
2199    /**
2200     * Get the enable status of the highlight animation
2201     *
2202     * Get whether the focus highlight, if enabled, will animate its switch from
2203     * one object to the next
2204     * @ingroup Focus
2205     */
2206    EAPI Eina_Bool        elm_focus_highlight_animate_get(void);
2207
2208    /**
2209     * Set the enable status of the highlight animation
2210     *
2211     * Set whether the focus highlight, if enabled, will animate its switch from
2212     * one object to the next
2213     * @param animate Enable animation if EINA_TRUE, disable otherwise
2214     * @ingroup Focus
2215     */
2216    EAPI void             elm_focus_highlight_animate_set(Eina_Bool animate);
2217
2218    /**
2219     * Get the whether an Elementary object has the focus or not.
2220     *
2221     * @param obj The Elementary object to get the information from
2222     * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2223     *            not (and on errors).
2224     *
2225     * @see elm_object_focus_set()
2226     *
2227     * @ingroup Focus
2228     */
2229    EAPI Eina_Bool        elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2230
2231    /**
2232     * Set/unset focus to a given Elementary object.
2233     *
2234     * @param obj The Elementary object to operate on.
2235     * @param enable @c EINA_TRUE Set focus to a given object,
2236     *               @c EINA_FALSE Unset focus to a given object.
2237     *
2238     * @note When you set focus to this object, if it can handle focus, will
2239     * take the focus away from the one who had it previously and will, for
2240     * now on, be the one receiving input events. Unsetting focus will remove
2241     * the focus from @p obj, passing it back to the previous element in the
2242     * focus chain list.
2243     *
2244     * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2245     *
2246     * @ingroup Focus
2247     */
2248    EAPI void             elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2249
2250    /**
2251     * Make a given Elementary object the focused one.
2252     *
2253     * @param obj The Elementary object to make focused.
2254     *
2255     * @note This object, if it can handle focus, will take the focus
2256     * away from the one who had it previously and will, for now on, be
2257     * the one receiving input events.
2258     *
2259     * @see elm_object_focus_get()
2260     * @deprecated use elm_object_focus_set() instead.
2261     *
2262     * @ingroup Focus
2263     */
2264    EINA_DEPRECATED EAPI void             elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2265
2266    /**
2267     * Remove the focus from an Elementary object
2268     *
2269     * @param obj The Elementary to take focus from
2270     *
2271     * This removes the focus from @p obj, passing it back to the
2272     * previous element in the focus chain list.
2273     *
2274     * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2275     * @deprecated use elm_object_focus_set() instead.
2276     *
2277     * @ingroup Focus
2278     */
2279    EINA_DEPRECATED EAPI void             elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2280
2281    /**
2282     * Set the ability for an Element object to be focused
2283     *
2284     * @param obj The Elementary object to operate on
2285     * @param enable @c EINA_TRUE if the object can be focused, @c
2286     *        EINA_FALSE if not (and on errors)
2287     *
2288     * This sets whether the object @p obj is able to take focus or
2289     * not. Unfocusable objects do nothing when programmatically
2290     * focused, being the nearest focusable parent object the one
2291     * really getting focus. Also, when they receive mouse input, they
2292     * will get the event, but not take away the focus from where it
2293     * was previously.
2294     *
2295     * @ingroup Focus
2296     */
2297    EAPI void             elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2298
2299    /**
2300     * Get whether an Elementary object is focusable or not
2301     *
2302     * @param obj The Elementary object to operate on
2303     * @return @c EINA_TRUE if the object is allowed to be focused, @c
2304     *             EINA_FALSE if not (and on errors)
2305     *
2306     * @note Objects which are meant to be interacted with by input
2307     * events are created able to be focused, by default. All the
2308     * others are not.
2309     *
2310     * @ingroup Focus
2311     */
2312    EAPI Eina_Bool        elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2313
2314    /**
2315     * Set custom focus chain.
2316     *
2317     * This function overwrites any previous custom focus chain within
2318     * the list of objects. The previous list will be deleted and this list
2319     * will be managed by elementary. After it is set, don't modify it.
2320     *
2321     * @note On focus cycle, only will be evaluated children of this container.
2322     *
2323     * @param obj The container object
2324     * @param objs Chain of objects to pass focus
2325     * @ingroup Focus
2326     */
2327    EAPI void             elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2328
2329    /**
2330     * Unset a custom focus chain on a given Elementary widget
2331     *
2332     * @param obj The container object to remove focus chain from
2333     *
2334     * Any focus chain previously set on @p obj (for its child objects)
2335     * is removed entirely after this call.
2336     *
2337     * @ingroup Focus
2338     */
2339    EAPI void             elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2340
2341    /**
2342     * Get custom focus chain
2343     *
2344     * @param obj The container object
2345     * @ingroup Focus
2346     */
2347    EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2348
2349    /**
2350     * Append object to custom focus chain.
2351     *
2352     * @note If relative_child equal to NULL or not in custom chain, the object
2353     * will be added in end.
2354     *
2355     * @note On focus cycle, only will be evaluated children of this container.
2356     *
2357     * @param obj The container object
2358     * @param child The child to be added in custom chain
2359     * @param relative_child The relative object to position the child
2360     * @ingroup Focus
2361     */
2362    EAPI void             elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2363
2364    /**
2365     * Prepend object to custom focus chain.
2366     *
2367     * @note If relative_child equal to NULL or not in custom chain, the object
2368     * will be added in begin.
2369     *
2370     * @note On focus cycle, only will be evaluated children of this container.
2371     *
2372     * @param obj The container object
2373     * @param child The child to be added in custom chain
2374     * @param relative_child The relative object to position the child
2375     * @ingroup Focus
2376     */
2377    EAPI void             elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2378
2379    /**
2380     * Give focus to next object in object tree.
2381     *
2382     * Give focus to next object in focus chain of one object sub-tree.
2383     * If the last object of chain already have focus, the focus will go to the
2384     * first object of chain.
2385     *
2386     * @param obj The object root of sub-tree
2387     * @param dir Direction to cycle the focus
2388     *
2389     * @ingroup Focus
2390     */
2391    EAPI void             elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2392
2393    /**
2394     * Give focus to near object in one direction.
2395     *
2396     * Give focus to near object in direction of one object.
2397     * If none focusable object in given direction, the focus will not change.
2398     *
2399     * @param obj The reference object
2400     * @param x Horizontal component of direction to focus
2401     * @param y Vertical component of direction to focus
2402     *
2403     * @ingroup Focus
2404     */
2405    EAPI void             elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2406
2407    /**
2408     * Make the elementary object and its children to be unfocusable
2409     * (or focusable).
2410     *
2411     * @param obj The Elementary object to operate on
2412     * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2413     *        @c EINA_FALSE for focusable.
2414     *
2415     * This sets whether the object @p obj and its children objects
2416     * are able to take focus or not. If the tree is set as unfocusable,
2417     * newest focused object which is not in this tree will get focus.
2418     * This API can be helpful for an object to be deleted.
2419     * When an object will be deleted soon, it and its children may not
2420     * want to get focus (by focus reverting or by other focus controls).
2421     * Then, just use this API before deleting.
2422     *
2423     * @see elm_object_tree_unfocusable_get()
2424     *
2425     * @ingroup Focus
2426     */
2427    EAPI void             elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2428
2429    /**
2430     * Get whether an Elementary object and its children are unfocusable or not.
2431     *
2432     * @param obj The Elementary object to get the information from
2433     * @return @c EINA_TRUE, if the tree is unfocussable,
2434     *         @c EINA_FALSE if not (and on errors).
2435     *
2436     * @see elm_object_tree_unfocusable_set()
2437     *
2438     * @ingroup Focus
2439     */
2440    EAPI Eina_Bool        elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2441
2442    /**
2443     * @defgroup Scrolling Scrolling
2444     *
2445     * These are functions setting how scrollable views in Elementary
2446     * widgets should behave on user interaction.
2447     *
2448     * @{
2449     */
2450
2451    /**
2452     * Get whether scrollers should bounce when they reach their
2453     * viewport's edge during a scroll.
2454     *
2455     * @return the thumb scroll bouncing state
2456     *
2457     * This is the default behavior for touch screens, in general.
2458     * @ingroup Scrolling
2459     */
2460    EAPI Eina_Bool        elm_scroll_bounce_enabled_get(void);
2461
2462    /**
2463     * Set whether scrollers should bounce when they reach their
2464     * viewport's edge during a scroll.
2465     *
2466     * @param enabled the thumb scroll bouncing state
2467     *
2468     * @see elm_thumbscroll_bounce_enabled_get()
2469     * @ingroup Scrolling
2470     */
2471    EAPI void             elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2472
2473    /**
2474     * Set whether scrollers should bounce when they reach their
2475     * viewport's edge during a scroll, for all Elementary application
2476     * windows.
2477     *
2478     * @param enabled the thumb scroll bouncing state
2479     *
2480     * @see elm_thumbscroll_bounce_enabled_get()
2481     * @ingroup Scrolling
2482     */
2483    EAPI void             elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2484
2485    /**
2486     * Get the amount of inertia a scroller will impose at bounce
2487     * animations.
2488     *
2489     * @return the thumb scroll bounce friction
2490     *
2491     * @ingroup Scrolling
2492     */
2493    EAPI double           elm_scroll_bounce_friction_get(void);
2494
2495    /**
2496     * Set the amount of inertia a scroller will impose at bounce
2497     * animations.
2498     *
2499     * @param friction the thumb scroll bounce friction
2500     *
2501     * @see elm_thumbscroll_bounce_friction_get()
2502     * @ingroup Scrolling
2503     */
2504    EAPI void             elm_scroll_bounce_friction_set(double friction);
2505
2506    /**
2507     * Set the amount of inertia a scroller will impose at bounce
2508     * animations, for all Elementary application windows.
2509     *
2510     * @param friction the thumb scroll bounce friction
2511     *
2512     * @see elm_thumbscroll_bounce_friction_get()
2513     * @ingroup Scrolling
2514     */
2515    EAPI void             elm_scroll_bounce_friction_all_set(double friction);
2516
2517    /**
2518     * Get the amount of inertia a <b>paged</b> scroller will impose at
2519     * page fitting animations.
2520     *
2521     * @return the page scroll friction
2522     *
2523     * @ingroup Scrolling
2524     */
2525    EAPI double           elm_scroll_page_scroll_friction_get(void);
2526
2527    /**
2528     * Set the amount of inertia a <b>paged</b> scroller will impose at
2529     * page fitting animations.
2530     *
2531     * @param friction the page scroll friction
2532     *
2533     * @see elm_thumbscroll_page_scroll_friction_get()
2534     * @ingroup Scrolling
2535     */
2536    EAPI void             elm_scroll_page_scroll_friction_set(double friction);
2537
2538    /**
2539     * Set the amount of inertia a <b>paged</b> scroller will impose at
2540     * page fitting animations, for all Elementary application windows.
2541     *
2542     * @param friction the page scroll friction
2543     *
2544     * @see elm_thumbscroll_page_scroll_friction_get()
2545     * @ingroup Scrolling
2546     */
2547    EAPI void             elm_scroll_page_scroll_friction_all_set(double friction);
2548
2549    /**
2550     * Get the amount of inertia a scroller will impose at region bring
2551     * animations.
2552     *
2553     * @return the bring in scroll friction
2554     *
2555     * @ingroup Scrolling
2556     */
2557    EAPI double           elm_scroll_bring_in_scroll_friction_get(void);
2558
2559    /**
2560     * Set the amount of inertia a scroller will impose at region bring
2561     * animations.
2562     *
2563     * @param friction the bring in scroll friction
2564     *
2565     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2566     * @ingroup Scrolling
2567     */
2568    EAPI void             elm_scroll_bring_in_scroll_friction_set(double friction);
2569
2570    /**
2571     * Set the amount of inertia a scroller will impose at region bring
2572     * animations, for all Elementary application windows.
2573     *
2574     * @param friction the bring in scroll friction
2575     *
2576     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2577     * @ingroup Scrolling
2578     */
2579    EAPI void             elm_scroll_bring_in_scroll_friction_all_set(double friction);
2580
2581    /**
2582     * Get the amount of inertia scrollers will impose at animations
2583     * triggered by Elementary widgets' zooming API.
2584     *
2585     * @return the zoom friction
2586     *
2587     * @ingroup Scrolling
2588     */
2589    EAPI double           elm_scroll_zoom_friction_get(void);
2590
2591    /**
2592     * Set the amount of inertia scrollers will impose at animations
2593     * triggered by Elementary widgets' zooming API.
2594     *
2595     * @param friction the zoom friction
2596     *
2597     * @see elm_thumbscroll_zoom_friction_get()
2598     * @ingroup Scrolling
2599     */
2600    EAPI void             elm_scroll_zoom_friction_set(double friction);
2601
2602    /**
2603     * Set the amount of inertia scrollers will impose at animations
2604     * triggered by Elementary widgets' zooming API, for all Elementary
2605     * application windows.
2606     *
2607     * @param friction the zoom friction
2608     *
2609     * @see elm_thumbscroll_zoom_friction_get()
2610     * @ingroup Scrolling
2611     */
2612    EAPI void             elm_scroll_zoom_friction_all_set(double friction);
2613
2614    /**
2615     * Get whether scrollers should be draggable from any point in their
2616     * views.
2617     *
2618     * @return the thumb scroll state
2619     *
2620     * @note This is the default behavior for touch screens, in general.
2621     * @note All other functions namespaced with "thumbscroll" will only
2622     *       have effect if this mode is enabled.
2623     *
2624     * @ingroup Scrolling
2625     */
2626    EAPI Eina_Bool        elm_scroll_thumbscroll_enabled_get(void);
2627
2628    /**
2629     * Set whether scrollers should be draggable from any point in their
2630     * views.
2631     *
2632     * @param enabled the thumb scroll state
2633     *
2634     * @see elm_thumbscroll_enabled_get()
2635     * @ingroup Scrolling
2636     */
2637    EAPI void             elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2638
2639    /**
2640     * Set whether scrollers should be draggable from any point in their
2641     * views, for all Elementary application windows.
2642     *
2643     * @param enabled the thumb scroll state
2644     *
2645     * @see elm_thumbscroll_enabled_get()
2646     * @ingroup Scrolling
2647     */
2648    EAPI void             elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2649
2650    /**
2651     * Get the number of pixels one should travel while dragging a
2652     * scroller's view to actually trigger scrolling.
2653     *
2654     * @return the thumb scroll threshould
2655     *
2656     * One would use higher values for touch screens, in general, because
2657     * of their inherent imprecision.
2658     * @ingroup Scrolling
2659     */
2660    EAPI unsigned int     elm_scroll_thumbscroll_threshold_get(void);
2661
2662    /**
2663     * Set the number of pixels one should travel while dragging a
2664     * scroller's view to actually trigger scrolling.
2665     *
2666     * @param threshold the thumb scroll threshould
2667     *
2668     * @see elm_thumbscroll_threshould_get()
2669     * @ingroup Scrolling
2670     */
2671    EAPI void             elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2672
2673    /**
2674     * Set the number of pixels one should travel while dragging a
2675     * scroller's view to actually trigger scrolling, for all Elementary
2676     * application windows.
2677     *
2678     * @param threshold the thumb scroll threshould
2679     *
2680     * @see elm_thumbscroll_threshould_get()
2681     * @ingroup Scrolling
2682     */
2683    EAPI void             elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2684
2685    /**
2686     * Get the minimum speed of mouse cursor movement which will trigger
2687     * list self scrolling animation after a mouse up event
2688     * (pixels/second).
2689     *
2690     * @return the thumb scroll momentum threshould
2691     *
2692     * @ingroup Scrolling
2693     */
2694    EAPI double           elm_scroll_thumbscroll_momentum_threshold_get(void);
2695
2696    /**
2697     * Set the minimum speed of mouse cursor movement which will trigger
2698     * list self scrolling animation after a mouse up event
2699     * (pixels/second).
2700     *
2701     * @param threshold the thumb scroll momentum threshould
2702     *
2703     * @see elm_thumbscroll_momentum_threshould_get()
2704     * @ingroup Scrolling
2705     */
2706    EAPI void             elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2707
2708    /**
2709     * Set the minimum speed of mouse cursor movement which will trigger
2710     * list self scrolling animation after a mouse up event
2711     * (pixels/second), for all Elementary application windows.
2712     *
2713     * @param threshold the thumb scroll momentum threshould
2714     *
2715     * @see elm_thumbscroll_momentum_threshould_get()
2716     * @ingroup Scrolling
2717     */
2718    EAPI void             elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2719
2720    /**
2721     * Get the amount of inertia a scroller will impose at self scrolling
2722     * animations.
2723     *
2724     * @return the thumb scroll friction
2725     *
2726     * @ingroup Scrolling
2727     */
2728    EAPI double           elm_scroll_thumbscroll_friction_get(void);
2729
2730    /**
2731     * Set the amount of inertia a scroller will impose at self scrolling
2732     * animations.
2733     *
2734     * @param friction the thumb scroll friction
2735     *
2736     * @see elm_thumbscroll_friction_get()
2737     * @ingroup Scrolling
2738     */
2739    EAPI void             elm_scroll_thumbscroll_friction_set(double friction);
2740
2741    /**
2742     * Set the amount of inertia a scroller will impose at self scrolling
2743     * animations, for all Elementary application windows.
2744     *
2745     * @param friction the thumb scroll friction
2746     *
2747     * @see elm_thumbscroll_friction_get()
2748     * @ingroup Scrolling
2749     */
2750    EAPI void             elm_scroll_thumbscroll_friction_all_set(double friction);
2751
2752    /**
2753     * Get the amount of lag between your actual mouse cursor dragging
2754     * movement and a scroller's view movement itself, while pushing it
2755     * into bounce state manually.
2756     *
2757     * @return the thumb scroll border friction
2758     *
2759     * @ingroup Scrolling
2760     */
2761    EAPI double           elm_scroll_thumbscroll_border_friction_get(void);
2762
2763    /**
2764     * Set the amount of lag between your actual mouse cursor dragging
2765     * movement and a scroller's view movement itself, while pushing it
2766     * into bounce state manually.
2767     *
2768     * @param friction the thumb scroll border friction. @c 0.0 for
2769     *        perfect synchrony between two movements, @c 1.0 for maximum
2770     *        lag.
2771     *
2772     * @see elm_thumbscroll_border_friction_get()
2773     * @note parameter value will get bound to 0.0 - 1.0 interval, always
2774     *
2775     * @ingroup Scrolling
2776     */
2777    EAPI void             elm_scroll_thumbscroll_border_friction_set(double friction);
2778
2779    /**
2780     * Set the amount of lag between your actual mouse cursor dragging
2781     * movement and a scroller's view movement itself, while pushing it
2782     * into bounce state manually, for all Elementary application windows.
2783     *
2784     * @param friction the thumb scroll border friction. @c 0.0 for
2785     *        perfect synchrony between two movements, @c 1.0 for maximum
2786     *        lag.
2787     *
2788     * @see elm_thumbscroll_border_friction_get()
2789     * @note parameter value will get bound to 0.0 - 1.0 interval, always
2790     *
2791     * @ingroup Scrolling
2792     */
2793    EAPI void             elm_scroll_thumbscroll_border_friction_all_set(double friction);
2794
2795    /**
2796     * @}
2797     */
2798
2799    /**
2800     * @defgroup Scrollhints Scrollhints
2801     *
2802     * Objects when inside a scroller can scroll, but this may not always be
2803     * desirable in certain situations. This allows an object to hint to itself
2804     * and parents to "not scroll" in one of 2 ways. If any child object of a
2805     * scroller has pushed a scroll freeze or hold then it affects all parent
2806     * scrollers until all children have released them.
2807     *
2808     * 1. To hold on scrolling. This means just flicking and dragging may no
2809     * longer scroll, but pressing/dragging near an edge of the scroller will
2810     * still scroll. This is automatically used by the entry object when
2811     * selecting text.
2812     *
2813     * 2. To totally freeze scrolling. This means it stops. until
2814     * popped/released.
2815     *
2816     * @{
2817     */
2818
2819    /**
2820     * Push the scroll hold by 1
2821     *
2822     * This increments the scroll hold count by one. If it is more than 0 it will
2823     * take effect on the parents of the indicated object.
2824     *
2825     * @param obj The object
2826     * @ingroup Scrollhints
2827     */
2828    EAPI void             elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2829
2830    /**
2831     * Pop the scroll hold by 1
2832     *
2833     * This decrements the scroll hold count by one. If it is more than 0 it will
2834     * take effect on the parents of the indicated object.
2835     *
2836     * @param obj The object
2837     * @ingroup Scrollhints
2838     */
2839    EAPI void             elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2840
2841    /**
2842     * Push the scroll freeze by 1
2843     *
2844     * This increments the scroll freeze count by one. If it is more
2845     * than 0 it will take effect on the parents of the indicated
2846     * object.
2847     *
2848     * @param obj The object
2849     * @ingroup Scrollhints
2850     */
2851    EAPI void             elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2852
2853    /**
2854     * Pop the scroll freeze by 1
2855     *
2856     * This decrements the scroll freeze count by one. If it is more
2857     * than 0 it will take effect on the parents of the indicated
2858     * object.
2859     *
2860     * @param obj The object
2861     * @ingroup Scrollhints
2862     */
2863    EAPI void             elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2864
2865    /**
2866     * Lock the scrolling of the given widget (and thus all parents)
2867     *
2868     * This locks the given object from scrolling in the X axis (and implicitly
2869     * also locks all parent scrollers too from doing the same).
2870     *
2871     * @param obj The object
2872     * @param lock The lock state (1 == locked, 0 == unlocked)
2873     * @ingroup Scrollhints
2874     */
2875    EAPI void             elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2876
2877    /**
2878     * Lock the scrolling of the given widget (and thus all parents)
2879     *
2880     * This locks the given object from scrolling in the Y axis (and implicitly
2881     * also locks all parent scrollers too from doing the same).
2882     *
2883     * @param obj The object
2884     * @param lock The lock state (1 == locked, 0 == unlocked)
2885     * @ingroup Scrollhints
2886     */
2887    EAPI void             elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2888
2889    /**
2890     * Get the scrolling lock of the given widget
2891     *
2892     * This gets the lock for X axis scrolling.
2893     *
2894     * @param obj The object
2895     * @ingroup Scrollhints
2896     */
2897    EAPI Eina_Bool        elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2898
2899    /**
2900     * Get the scrolling lock of the given widget
2901     *
2902     * This gets the lock for X axis scrolling.
2903     *
2904     * @param obj The object
2905     * @ingroup Scrollhints
2906     */
2907    EAPI Eina_Bool        elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2908
2909    /**
2910     * @}
2911     */
2912
2913    /**
2914     * Send a signal to the widget edje object.
2915     *
2916     * This function sends a signal to the edje object of the obj. An
2917     * edje program can respond to a signal by specifying matching
2918     * 'signal' and 'source' fields.
2919     *
2920     * @param obj The object
2921     * @param emission The signal's name.
2922     * @param source The signal's source.
2923     * @ingroup General
2924     */
2925    EAPI void             elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
2926
2927    /**
2928     * Add a callback for a signal emitted by widget edje object.
2929     *
2930     * This function connects a callback function to a signal emitted by the
2931     * edje object of the obj.
2932     * Globs can occur in either the emission or source name.
2933     *
2934     * @param obj The object
2935     * @param emission The signal's name.
2936     * @param source The signal's source.
2937     * @param func The callback function to be executed when the signal is
2938     * emitted.
2939     * @param data A pointer to data to pass in to the callback function.
2940     * @ingroup General
2941     */
2942    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);
2943
2944    /**
2945     * Remove a signal-triggered callback from a widget edje object.
2946     *
2947     * This function removes a callback, previoulsy attached to a
2948     * signal emitted by the edje object of the obj.  The parameters
2949     * emission, source and func must match exactly those passed to a
2950     * previous call to elm_object_signal_callback_add(). The data
2951     * pointer that was passed to this call will be returned.
2952     *
2953     * @param obj The object
2954     * @param emission The signal's name.
2955     * @param source The signal's source.
2956     * @param func The callback function to be executed when the signal is
2957     * emitted.
2958     * @return The data pointer
2959     * @ingroup General
2960     */
2961    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);
2962
2963    /**
2964     * Add a callback for input events (key up, key down, mouse wheel)
2965     * on a given Elementary widget
2966     *
2967     * @param obj The widget to add an event callback on
2968     * @param func The callback function to be executed when the event
2969     * happens
2970     * @param data Data to pass in to @p func
2971     *
2972     * Every widget in an Elementary interface set to receive focus,
2973     * with elm_object_focus_allow_set(), will propagate @b all of its
2974     * key up, key down and mouse wheel input events up to its parent
2975     * object, and so on. All of the focusable ones in this chain which
2976     * had an event callback set, with this call, will be able to treat
2977     * those events. There are two ways of making the propagation of
2978     * these event upwards in the tree of widgets to @b cease:
2979     * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
2980     *   the event was @b not processed, so the propagation will go on.
2981     * - The @c event_info pointer passed to @p func will contain the
2982     *   event's structure and, if you OR its @c event_flags inner
2983     *   value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
2984     *   one has already handled it, thus killing the event's
2985     *   propagation, too.
2986     *
2987     * @note Your event callback will be issued on those events taking
2988     * place only if no other child widget of @obj has consumed the
2989     * event already.
2990     *
2991     * @note Not to be confused with @c
2992     * evas_object_event_callback_add(), which will add event callbacks
2993     * per type on general Evas objects (no event propagation
2994     * infrastructure taken in account).
2995     *
2996     * @note Not to be confused with @c
2997     * elm_object_signal_callback_add(), which will add callbacks to @b
2998     * signals coming from a widget's theme, not input events.
2999     *
3000     * @note Not to be confused with @c
3001     * edje_object_signal_callback_add(), which does the same as
3002     * elm_object_signal_callback_add(), but directly on an Edje
3003     * object.
3004     *
3005     * @note Not to be confused with @c
3006     * evas_object_smart_callback_add(), which adds callbacks to smart
3007     * objects' <b>smart events</b>, and not input events.
3008     *
3009     * @see elm_object_event_callback_del()
3010     *
3011     * @ingroup General
3012     */
3013    EAPI void             elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3014
3015    /**
3016     * Remove an event callback from a widget.
3017     *
3018     * This function removes a callback, previoulsy attached to event emission
3019     * by the @p obj.
3020     * The parameters func and data must match exactly those passed to
3021     * a previous call to elm_object_event_callback_add(). The data pointer that
3022     * was passed to this call will be returned.
3023     *
3024     * @param obj The object
3025     * @param func The callback function to be executed when the event is
3026     * emitted.
3027     * @param data Data to pass in to the callback function.
3028     * @return The data pointer
3029     * @ingroup General
3030     */
3031    EAPI void            *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3032
3033    /**
3034     * Adjust size of an element for finger usage.
3035     *
3036     * @param times_w How many fingers should fit horizontally
3037     * @param w Pointer to the width size to adjust
3038     * @param times_h How many fingers should fit vertically
3039     * @param h Pointer to the height size to adjust
3040     *
3041     * This takes width and height sizes (in pixels) as input and a
3042     * size multiple (which is how many fingers you want to place
3043     * within the area, being "finger" the size set by
3044     * elm_finger_size_set()), and adjusts the size to be large enough
3045     * to accommodate the resulting size -- if it doesn't already
3046     * accommodate it. On return the @p w and @p h sizes pointed to by
3047     * these parameters will be modified, on those conditions.
3048     *
3049     * @note This is kind of a low level Elementary call, most useful
3050     * on size evaluation times for widgets. An external user wouldn't
3051     * be calling, most of the time.
3052     *
3053     * @ingroup Fingers
3054     */
3055    EAPI void             elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3056
3057    /**
3058     * Get the duration for occuring long press event.
3059     *
3060     * @return Timeout for long press event
3061     * @ingroup Longpress
3062     */
3063    EAPI double           elm_longpress_timeout_get(void);
3064
3065    /**
3066     * Set the duration for occuring long press event.
3067     *
3068     * @param lonpress_timeout Timeout for long press event
3069     * @ingroup Longpress
3070     */
3071    EAPI void             elm_longpress_timeout_set(double longpress_timeout);
3072
3073    /**
3074     * @defgroup Debug Debug
3075     * don't use it unless you are sure
3076     *
3077     * @{
3078     */
3079
3080    /**
3081     * Print Tree object hierarchy in stdout
3082     *
3083     * @param obj The root object
3084     * @ingroup Debug
3085     */
3086    EAPI void             elm_object_tree_dump(const Evas_Object *top);
3087
3088    /**
3089     * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3090     *
3091     * @param obj The root object
3092     * @param file The path of output file
3093     * @ingroup Debug
3094     */
3095    EAPI void             elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3096
3097    /**
3098     * @}
3099     */
3100
3101    /**
3102     * @defgroup Theme Theme
3103     *
3104     * Elementary uses Edje to theme its widgets, naturally. But for the most
3105     * part this is hidden behind a simpler interface that lets the user set
3106     * extensions and choose the style of widgets in a much easier way.
3107     *
3108     * Instead of thinking in terms of paths to Edje files and their groups
3109     * each time you want to change the appearance of a widget, Elementary
3110     * works so you can add any theme file with extensions or replace the
3111     * main theme at one point in the application, and then just set the style
3112     * of widgets with elm_object_style_set() and related functions. Elementary
3113     * will then look in its list of themes for a matching group and apply it,
3114     * and when the theme changes midway through the application, all widgets
3115     * will be updated accordingly.
3116     *
3117     * There are three concepts you need to know to understand how Elementary
3118     * theming works: default theme, extensions and overlays.
3119     *
3120     * Default theme, obviously enough, is the one that provides the default
3121     * look of all widgets. End users can change the theme used by Elementary
3122     * by setting the @c ELM_THEME environment variable before running an
3123     * application, or globally for all programs using the @c elementary_config
3124     * utility. Applications can change the default theme using elm_theme_set(),
3125     * but this can go against the user wishes, so it's not an adviced practice.
3126     *
3127     * Ideally, applications should find everything they need in the already
3128     * provided theme, but there may be occasions when that's not enough and
3129     * custom styles are required to correctly express the idea. For this
3130     * cases, Elementary has extensions.
3131     *
3132     * Extensions allow the application developer to write styles of its own
3133     * to apply to some widgets. This requires knowledge of how each widget
3134     * is themed, as extensions will always replace the entire group used by
3135     * the widget, so important signals and parts need to be there for the
3136     * object to behave properly (see documentation of Edje for details).
3137     * Once the theme for the extension is done, the application needs to add
3138     * it to the list of themes Elementary will look into, using
3139     * elm_theme_extension_add(), and set the style of the desired widgets as
3140     * he would normally with elm_object_style_set().
3141     *
3142     * Overlays, on the other hand, can replace the look of all widgets by
3143     * overriding the default style. Like extensions, it's up to the application
3144     * developer to write the theme for the widgets it wants, the difference
3145     * being that when looking for the theme, Elementary will check first the
3146     * list of overlays, then the set theme and lastly the list of extensions,
3147     * so with overlays it's possible to replace the default view and every
3148     * widget will be affected. This is very much alike to setting the whole
3149     * theme for the application and will probably clash with the end user
3150     * options, not to mention the risk of ending up with not matching styles
3151     * across the program. Unless there's a very special reason to use them,
3152     * overlays should be avoided for the resons exposed before.
3153     *
3154     * All these theme lists are handled by ::Elm_Theme instances. Elementary
3155     * keeps one default internally and every function that receives one of
3156     * these can be called with NULL to refer to this default (except for
3157     * elm_theme_free()). It's possible to create a new instance of a
3158     * ::Elm_Theme to set other theme for a specific widget (and all of its
3159     * children), but this is as discouraged, if not even more so, than using
3160     * overlays. Don't use this unless you really know what you are doing.
3161     *
3162     * But to be less negative about things, you can look at the following
3163     * examples:
3164     * @li @ref theme_example_01 "Using extensions"
3165     * @li @ref theme_example_02 "Using overlays"
3166     *
3167     * @{
3168     */
3169    /**
3170     * @typedef Elm_Theme
3171     *
3172     * Opaque handler for the list of themes Elementary looks for when
3173     * rendering widgets.
3174     *
3175     * Stay out of this unless you really know what you are doing. For most
3176     * cases, sticking to the default is all a developer needs.
3177     */
3178    typedef struct _Elm_Theme Elm_Theme;
3179
3180    /**
3181     * Create a new specific theme
3182     *
3183     * This creates an empty specific theme that only uses the default theme. A
3184     * specific theme has its own private set of extensions and overlays too
3185     * (which are empty by default). Specific themes do not fall back to themes
3186     * of parent objects. They are not intended for this use. Use styles, overlays
3187     * and extensions when needed, but avoid specific themes unless there is no
3188     * other way (example: you want to have a preview of a new theme you are
3189     * selecting in a "theme selector" window. The preview is inside a scroller
3190     * and should display what the theme you selected will look like, but not
3191     * actually apply it yet. The child of the scroller will have a specific
3192     * theme set to show this preview before the user decides to apply it to all
3193     * applications).
3194     */
3195    EAPI Elm_Theme       *elm_theme_new(void);
3196    /**
3197     * Free a specific theme
3198     *
3199     * @param th The theme to free
3200     *
3201     * This frees a theme created with elm_theme_new().
3202     */
3203    EAPI void             elm_theme_free(Elm_Theme *th);
3204    /**
3205     * Copy the theme fom the source to the destination theme
3206     *
3207     * @param th The source theme to copy from
3208     * @param thdst The destination theme to copy data to
3209     *
3210     * This makes a one-time static copy of all the theme config, extensions
3211     * and overlays from @p th to @p thdst. If @p th references a theme, then
3212     * @p thdst is also set to reference it, with all the theme settings,
3213     * overlays and extensions that @p th had.
3214     */
3215    EAPI void             elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3216    /**
3217     * Tell the source theme to reference the ref theme
3218     *
3219     * @param th The theme that will do the referencing
3220     * @param thref The theme that is the reference source
3221     *
3222     * This clears @p th to be empty and then sets it to refer to @p thref
3223     * so @p th acts as an override to @p thref, but where its overrides
3224     * don't apply, it will fall through to @p thref for configuration.
3225     */
3226    EAPI void             elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3227    /**
3228     * Return the theme referred to
3229     *
3230     * @param th The theme to get the reference from
3231     * @return The referenced theme handle
3232     *
3233     * This gets the theme set as the reference theme by elm_theme_ref_set().
3234     * If no theme is set as a reference, NULL is returned.
3235     */
3236    EAPI Elm_Theme       *elm_theme_ref_get(Elm_Theme *th);
3237    /**
3238     * Return the default theme
3239     *
3240     * @return The default theme handle
3241     *
3242     * This returns the internal default theme setup handle that all widgets
3243     * use implicitly unless a specific theme is set. This is also often use
3244     * as a shorthand of NULL.
3245     */
3246    EAPI Elm_Theme       *elm_theme_default_get(void);
3247    /**
3248     * Prepends a theme overlay to the list of overlays
3249     *
3250     * @param th The theme to add to, or if NULL, the default theme
3251     * @param item The Edje file path to be used
3252     *
3253     * Use this if your application needs to provide some custom overlay theme
3254     * (An Edje file that replaces some default styles of widgets) where adding
3255     * new styles, or changing system theme configuration is not possible. Do
3256     * NOT use this instead of a proper system theme configuration. Use proper
3257     * configuration files, profiles, environment variables etc. to set a theme
3258     * so that the theme can be altered by simple confiugration by a user. Using
3259     * this call to achieve that effect is abusing the API and will create lots
3260     * of trouble.
3261     *
3262     * @see elm_theme_extension_add()
3263     */
3264    EAPI void             elm_theme_overlay_add(Elm_Theme *th, const char *item);
3265    /**
3266     * Delete a theme overlay from the list of overlays
3267     *
3268     * @param th The theme to delete from, or if NULL, the default theme
3269     * @param item The name of the theme overlay
3270     *
3271     * @see elm_theme_overlay_add()
3272     */
3273    EAPI void             elm_theme_overlay_del(Elm_Theme *th, const char *item);
3274    /**
3275     * Appends a theme extension to the list of extensions.
3276     *
3277     * @param th The theme to add to, or if NULL, the default theme
3278     * @param item The Edje file path to be used
3279     *
3280     * This is intended when an application needs more styles of widgets or new
3281     * widget themes that the default does not provide (or may not provide). The
3282     * application has "extended" usage by coming up with new custom style names
3283     * for widgets for specific uses, but as these are not "standard", they are
3284     * not guaranteed to be provided by a default theme. This means the
3285     * application is required to provide these extra elements itself in specific
3286     * Edje files. This call adds one of those Edje files to the theme search
3287     * path to be search after the default theme. The use of this call is
3288     * encouraged when default styles do not meet the needs of the application.
3289     * Use this call instead of elm_theme_overlay_add() for almost all cases.
3290     *
3291     * @see elm_object_style_set()
3292     */
3293    EAPI void             elm_theme_extension_add(Elm_Theme *th, const char *item);
3294    /**
3295     * Deletes a theme extension from the list of extensions.
3296     *
3297     * @param th The theme to delete from, or if NULL, the default theme
3298     * @param item The name of the theme extension
3299     *
3300     * @see elm_theme_extension_add()
3301     */
3302    EAPI void             elm_theme_extension_del(Elm_Theme *th, const char *item);
3303    /**
3304     * Set the theme search order for the given theme
3305     *
3306     * @param th The theme to set the search order, or if NULL, the default theme
3307     * @param theme Theme search string
3308     *
3309     * This sets the search string for the theme in path-notation from first
3310     * theme to search, to last, delimited by the : character. Example:
3311     *
3312     * "shiny:/path/to/file.edj:default"
3313     *
3314     * See the ELM_THEME environment variable for more information.
3315     *
3316     * @see elm_theme_get()
3317     * @see elm_theme_list_get()
3318     */
3319    EAPI void             elm_theme_set(Elm_Theme *th, const char *theme);
3320    /**
3321     * Return the theme search order
3322     *
3323     * @param th The theme to get the search order, or if NULL, the default theme
3324     * @return The internal search order path
3325     *
3326     * This function returns a colon separated string of theme elements as
3327     * returned by elm_theme_list_get().
3328     *
3329     * @see elm_theme_set()
3330     * @see elm_theme_list_get()
3331     */
3332    EAPI const char      *elm_theme_get(Elm_Theme *th);
3333    /**
3334     * Return a list of theme elements to be used in a theme.
3335     *
3336     * @param th Theme to get the list of theme elements from.
3337     * @return The internal list of theme elements
3338     *
3339     * This returns the internal list of theme elements (will only be valid as
3340     * long as the theme is not modified by elm_theme_set() or theme is not
3341     * freed by elm_theme_free(). This is a list of strings which must not be
3342     * altered as they are also internal. If @p th is NULL, then the default
3343     * theme element list is returned.
3344     *
3345     * A theme element can consist of a full or relative path to a .edj file,
3346     * or a name, without extension, for a theme to be searched in the known
3347     * theme paths for Elemementary.
3348     *
3349     * @see elm_theme_set()
3350     * @see elm_theme_get()
3351     */
3352    EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3353    /**
3354     * Return the full patrh for a theme element
3355     *
3356     * @param f The theme element name
3357     * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3358     * @return The full path to the file found.
3359     *
3360     * This returns a string you should free with free() on success, NULL on
3361     * failure. This will search for the given theme element, and if it is a
3362     * full or relative path element or a simple searchable name. The returned
3363     * path is the full path to the file, if searched, and the file exists, or it
3364     * is simply the full path given in the element or a resolved path if
3365     * relative to home. The @p in_search_path boolean pointed to is set to
3366     * EINA_TRUE if the file was a searchable file andis in the search path,
3367     * and EINA_FALSE otherwise.
3368     */
3369    EAPI char            *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3370    /**
3371     * Flush the current theme.
3372     *
3373     * @param th Theme to flush
3374     *
3375     * This flushes caches that let elementary know where to find theme elements
3376     * in the given theme. If @p th is NULL, then the default theme is flushed.
3377     * Call this function if source theme data has changed in such a way as to
3378     * make any caches Elementary kept invalid.
3379     */
3380    EAPI void             elm_theme_flush(Elm_Theme *th);
3381    /**
3382     * This flushes all themes (default and specific ones).
3383     *
3384     * This will flush all themes in the current application context, by calling
3385     * elm_theme_flush() on each of them.
3386     */
3387    EAPI void             elm_theme_full_flush(void);
3388    /**
3389     * Set the theme for all elementary using applications on the current display
3390     *
3391     * @param theme The name of the theme to use. Format same as the ELM_THEME
3392     * environment variable.
3393     */
3394    EAPI void             elm_theme_all_set(const char *theme);
3395    /**
3396     * Return a list of theme elements in the theme search path
3397     *
3398     * @return A list of strings that are the theme element names.
3399     *
3400     * This lists all available theme files in the standard Elementary search path
3401     * for theme elements, and returns them in alphabetical order as theme
3402     * element names in a list of strings. Free this with
3403     * elm_theme_name_available_list_free() when you are done with the list.
3404     */
3405    EAPI Eina_List       *elm_theme_name_available_list_new(void);
3406    /**
3407     * Free the list returned by elm_theme_name_available_list_new()
3408     *
3409     * This frees the list of themes returned by
3410     * elm_theme_name_available_list_new(). Once freed the list should no longer
3411     * be used. a new list mys be created.
3412     */
3413    EAPI void             elm_theme_name_available_list_free(Eina_List *list);
3414    /**
3415     * Set a specific theme to be used for this object and its children
3416     *
3417     * @param obj The object to set the theme on
3418     * @param th The theme to set
3419     *
3420     * This sets a specific theme that will be used for the given object and any
3421     * child objects it has. If @p th is NULL then the theme to be used is
3422     * cleared and the object will inherit its theme from its parent (which
3423     * ultimately will use the default theme if no specific themes are set).
3424     *
3425     * Use special themes with great care as this will annoy users and make
3426     * configuration difficult. Avoid any custom themes at all if it can be
3427     * helped.
3428     */
3429    EAPI void             elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3430    /**
3431     * Get the specific theme to be used
3432     *
3433     * @param obj The object to get the specific theme from
3434     * @return The specifc theme set.
3435     *
3436     * This will return a specific theme set, or NULL if no specific theme is
3437     * set on that object. It will not return inherited themes from parents, only
3438     * the specific theme set for that specific object. See elm_object_theme_set()
3439     * for more information.
3440     */
3441    EAPI Elm_Theme       *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3442
3443    /**
3444     * Get a data item from a theme
3445     *
3446     * @param th The theme, or NULL for default theme
3447     * @param key The data key to search with
3448     * @return The data value, or NULL on failure
3449     *
3450     * This function is used to return data items from edc in @p th, an overlay, or an extension.
3451     * It works the same way as edje_file_data_get() except that the return is stringshared.
3452     */
3453    EAPI const char      *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3454    /**
3455     * @}
3456     */
3457
3458    /* win */
3459    /** @defgroup Win Win
3460     *
3461     * @image html img/widget/win/preview-00.png
3462     * @image latex img/widget/win/preview-00.eps
3463     *
3464     * The window class of Elementary.  Contains functions to manipulate
3465     * windows. The Evas engine used to render the window contents is specified
3466     * in the system or user elementary config files (whichever is found last),
3467     * and can be overridden with the ELM_ENGINE environment variable for
3468     * testing.  Engines that may be supported (depending on Evas and Ecore-Evas
3469     * compilation setup and modules actually installed at runtime) are (listed
3470     * in order of best supported and most likely to be complete and work to
3471     * lowest quality).
3472     *
3473     * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3474     * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3475     * rendering in X11)
3476     * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3477     * exits)
3478     * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3479     * rendering)
3480     * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3481     * buffer)
3482     * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3483     * rendering using SDL as the buffer)
3484     * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3485     * GDI with software)
3486     * @li "dfb", "directfb" (Rendering to a DirectFB window)
3487     * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3488     * grayscale using dedicated 8bit software engine in X11)
3489     * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3490     * X11 using 16bit software engine)
3491     * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3492     * (Windows CE rendering via GDI with 16bit software renderer)
3493     * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3494     * buffer with 16bit software renderer)
3495     *
3496     * All engines use a simple string to select the engine to render, EXCEPT
3497     * the "shot" engine. This actually encodes the output of the virtual
3498     * screenshot and how long to delay in the engine string. The engine string
3499     * is encoded in the following way:
3500     *
3501     *   "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3502     *
3503     * Where options are separated by a ":" char if more than one option is
3504     * given, with delay, if provided being the first option and file the last
3505     * (order is important). The delay specifies how long to wait after the
3506     * window is shown before doing the virtual "in memory" rendering and then
3507     * save the output to the file specified by the file option (and then exit).
3508     * If no delay is given, the default is 0.5 seconds. If no file is given the
3509     * default output file is "out.png". Repeat option is for continous
3510     * capturing screenshots. Repeat range is from 1 to 999 and filename is
3511     * fixed to "out001.png" Some examples of using the shot engine:
3512     *
3513     *   ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3514     *   ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3515     *   ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3516     *   ELM_ENGINE="shot:delay=2.0" elementary_test
3517     *   ELM_ENGINE="shot:" elementary_test
3518     *
3519     * Signals that you can add callbacks for are:
3520     *
3521     * @li "delete,request": the user requested to close the window. See
3522     * elm_win_autodel_set().
3523     * @li "focus,in": window got focus
3524     * @li "focus,out": window lost focus
3525     * @li "moved": window that holds the canvas was moved
3526     *
3527     * Examples:
3528     * @li @ref win_example_01
3529     *
3530     * @{
3531     */
3532    /**
3533     * Defines the types of window that can be created
3534     *
3535     * These are hints set on the window so that a running Window Manager knows
3536     * how the window should be handled and/or what kind of decorations it
3537     * should have.
3538     *
3539     * Currently, only the X11 backed engines use them.
3540     */
3541    typedef enum _Elm_Win_Type
3542      {
3543         ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3544                          window. Almost every window will be created with this
3545                          type. */
3546         ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3547         ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3548                            window holding desktop icons. */
3549         ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3550                         be kept on top of any other window by the Window
3551                         Manager. */
3552         ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3553                            similar. */
3554         ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3555         ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3556                            pallete. */
3557         ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3558         ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3559                                  entry in a menubar is clicked. Typically used
3560                                  with elm_win_override_set(). This hint exists
3561                                  for completion only, as the EFL way of
3562                                  implementing a menu would not normally use a
3563                                  separate window for its contents. */
3564         ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3565                               triggered by right-clicking an object. */
3566         ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3567                            explanatory text that typically appear after the
3568                            mouse cursor hovers over an object for a while.
3569                            Typically used with elm_win_override_set() and also
3570                            not very commonly used in the EFL. */
3571         ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3572                                 battery life or a new E-Mail received. */
3573         ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3574                          usually used in the EFL. */
3575         ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3576                        object being dragged across different windows, or even
3577                        applications. Typically used with
3578                        elm_win_override_set(). */
3579         ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3580                                  buffer. No actual window is created for this
3581                                  type, instead the window and all of its
3582                                  contents will be rendered to an image buffer.
3583                                  This allows to have children window inside a
3584                                  parent one just like any other object would
3585                                  be, and do other things like applying @c
3586                                  Evas_Map effects to it. This is the only type
3587                                  of window that requires the @c parent
3588                                  parameter of elm_win_add() to be a valid @c
3589                                  Evas_Object. */
3590      } Elm_Win_Type;
3591
3592    /**
3593     * The differents layouts that can be requested for the virtual keyboard.
3594     *
3595     * When the application window is being managed by Illume, it may request
3596     * any of the following layouts for the virtual keyboard.
3597     */
3598    typedef enum _Elm_Win_Keyboard_Mode
3599      {
3600         ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3601         ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3602         ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3603         ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3604         ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3605         ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3606         ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3607         ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3608         ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3609         ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3610         ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3611         ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3612         ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3613         ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3614         ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3615         ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3616      } Elm_Win_Keyboard_Mode;
3617
3618    /**
3619     * Available commands that can be sent to the Illume manager.
3620     *
3621     * When running under an Illume session, a window may send commands to the
3622     * Illume manager to perform different actions.
3623     */
3624    typedef enum _Elm_Illume_Command
3625      {
3626         ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3627                                          window */
3628         ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3629                                             in the list */
3630         ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3631                                          screen */
3632         ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3633      } Elm_Illume_Command;
3634
3635    /**
3636     * Adds a window object. If this is the first window created, pass NULL as
3637     * @p parent.
3638     *
3639     * @param parent Parent object to add the window to, or NULL
3640     * @param name The name of the window
3641     * @param type The window type, one of #Elm_Win_Type.
3642     *
3643     * The @p parent paramter can be @c NULL for every window @p type except
3644     * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3645     * which the image object will be created.
3646     *
3647     * @return The created object, or NULL on failure
3648     */
3649    EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3650    /**
3651     * Add @p subobj as a resize object of window @p obj.
3652     *
3653     *
3654     * Setting an object as a resize object of the window means that the
3655     * @p subobj child's size and position will be controlled by the window
3656     * directly. That is, the object will be resized to match the window size
3657     * and should never be moved or resized manually by the developer.
3658     *
3659     * In addition, resize objects of the window control what the minimum size
3660     * of it will be, as well as whether it can or not be resized by the user.
3661     *
3662     * For the end user to be able to resize a window by dragging the handles
3663     * or borders provided by the Window Manager, or using any other similar
3664     * mechanism, all of the resize objects in the window should have their
3665     * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3666     *
3667     * @param obj The window object
3668     * @param subobj The resize object to add
3669     */
3670    EAPI void         elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3671    /**
3672     * Delete @p subobj as a resize object of window @p obj.
3673     *
3674     * This function removes the object @p subobj from the resize objects of
3675     * the window @p obj. It will not delete the object itself, which will be
3676     * left unmanaged and should be deleted by the developer, manually handled
3677     * or set as child of some other container.
3678     *
3679     * @param obj The window object
3680     * @param subobj The resize object to add
3681     */
3682    EAPI void         elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3683    /**
3684     * Set the title of the window
3685     *
3686     * @param obj The window object
3687     * @param title The title to set
3688     */
3689    EAPI void         elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3690    /**
3691     * Get the title of the window
3692     *
3693     * The returned string is an internal one and should not be freed or
3694     * modified. It will also be rendered invalid if a new title is set or if
3695     * the window is destroyed.
3696     *
3697     * @param obj The window object
3698     * @return The title
3699     */
3700    EAPI const char  *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3701    /**
3702     * Set the window's autodel state.
3703     *
3704     * When closing the window in any way outside of the program control, like
3705     * pressing the X button in the titlebar or using a command from the
3706     * Window Manager, a "delete,request" signal is emitted to indicate that
3707     * this event occurred and the developer can take any action, which may
3708     * include, or not, destroying the window object.
3709     *
3710     * When the @p autodel parameter is set, the window will be automatically
3711     * destroyed when this event occurs, after the signal is emitted.
3712     * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3713     * and is up to the program to do so when it's required.
3714     *
3715     * @param obj The window object
3716     * @param autodel If true, the window will automatically delete itself when
3717     * closed
3718     */
3719    EAPI void         elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3720    /**
3721     * Get the window's autodel state.
3722     *
3723     * @param obj The window object
3724     * @return If the window will automatically delete itself when closed
3725     *
3726     * @see elm_win_autodel_set()
3727     */
3728    EAPI Eina_Bool    elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3729    /**
3730     * Activate a window object.
3731     *
3732     * This function sends a request to the Window Manager to activate the
3733     * window pointed by @p obj. If honored by the WM, the window will receive
3734     * the keyboard focus.
3735     *
3736     * @note This is just a request that a Window Manager may ignore, so calling
3737     * this function does not ensure in any way that the window will be the
3738     * active one after it.
3739     *
3740     * @param obj The window object
3741     */
3742    EAPI void         elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3743    /**
3744     * Lower a window object.
3745     *
3746     * Places the window pointed by @p obj at the bottom of the stack, so that
3747     * no other window is covered by it.
3748     *
3749     * If elm_win_override_set() is not set, the Window Manager may ignore this
3750     * request.
3751     *
3752     * @param obj The window object
3753     */
3754    EAPI void         elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3755    /**
3756     * Raise a window object.
3757     *
3758     * Places the window pointed by @p obj at the top of the stack, so that it's
3759     * not covered by any other window.
3760     *
3761     * If elm_win_override_set() is not set, the Window Manager may ignore this
3762     * request.
3763     *
3764     * @param obj The window object
3765     */
3766    EAPI void         elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3767    /**
3768     * Set the borderless state of a window.
3769     *
3770     * This function requests the Window Manager to not draw any decoration
3771     * around the window.
3772     *
3773     * @param obj The window object
3774     * @param borderless If true, the window is borderless
3775     */
3776    EAPI void         elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3777    /**
3778     * Get the borderless state of a window.
3779     *
3780     * @param obj The window object
3781     * @return If true, the window is borderless
3782     */
3783    EAPI Eina_Bool    elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3784    /**
3785     * Set the shaped state of a window.
3786     *
3787     * Shaped windows, when supported, will render the parts of the window that
3788     * has no content, transparent.
3789     *
3790     * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3791     * background object or cover the entire window in any other way, or the
3792     * parts of the canvas that have no data will show framebuffer artifacts.
3793     *
3794     * @param obj The window object
3795     * @param shaped If true, the window is shaped
3796     *
3797     * @see elm_win_alpha_set()
3798     */
3799    EAPI void         elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3800    /**
3801     * Get the shaped state of a window.
3802     *
3803     * @param obj The window object
3804     * @return If true, the window is shaped
3805     *
3806     * @see elm_win_shaped_set()
3807     */
3808    EAPI Eina_Bool    elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3809    /**
3810     * Set the alpha channel state of a window.
3811     *
3812     * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3813     * possibly making parts of the window completely or partially transparent.
3814     * This is also subject to the underlying system supporting it, like for
3815     * example, running under a compositing manager. If no compositing is
3816     * available, enabling this option will instead fallback to using shaped
3817     * windows, with elm_win_shaped_set().
3818     *
3819     * @param obj The window object
3820     * @param alpha If true, the window has an alpha channel
3821     *
3822     * @see elm_win_alpha_set()
3823     */
3824    EAPI void         elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
3825    /**
3826     * Get the transparency state of a window.
3827     *
3828     * @param obj The window object
3829     * @return If true, the window is transparent
3830     *
3831     * @see elm_win_transparent_set()
3832     */
3833    EAPI Eina_Bool    elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3834    /**
3835     * Set the transparency state of a window.
3836     *
3837     * Use elm_win_alpha_set() instead.
3838     *
3839     * @param obj The window object
3840     * @param transparent If true, the window is transparent
3841     *
3842     * @see elm_win_alpha_set()
3843     */
3844    EAPI void         elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
3845    /**
3846     * Get the alpha channel state of a window.
3847     *
3848     * @param obj The window object
3849     * @return If true, the window has an alpha channel
3850     */
3851    EAPI Eina_Bool    elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3852    /**
3853     * Set the override state of a window.
3854     *
3855     * A window with @p override set to EINA_TRUE will not be managed by the
3856     * Window Manager. This means that no decorations of any kind will be shown
3857     * for it, moving and resizing must be handled by the application, as well
3858     * as the window visibility.
3859     *
3860     * This should not be used for normal windows, and even for not so normal
3861     * ones, it should only be used when there's a good reason and with a lot
3862     * of care. Mishandling override windows may result situations that
3863     * disrupt the normal workflow of the end user.
3864     *
3865     * @param obj The window object
3866     * @param override If true, the window is overridden
3867     */
3868    EAPI void         elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
3869    /**
3870     * Get the override state of a window.
3871     *
3872     * @param obj The window object
3873     * @return If true, the window is overridden
3874     *
3875     * @see elm_win_override_set()
3876     */
3877    EAPI Eina_Bool    elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3878    /**
3879     * Set the fullscreen state of a window.
3880     *
3881     * @param obj The window object
3882     * @param fullscreen If true, the window is fullscreen
3883     */
3884    EAPI void         elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
3885    /**
3886     * Get the fullscreen state of a window.
3887     *
3888     * @param obj The window object
3889     * @return If true, the window is fullscreen
3890     */
3891    EAPI Eina_Bool    elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3892    /**
3893     * Set the maximized state of a window.
3894     *
3895     * @param obj The window object
3896     * @param maximized If true, the window is maximized
3897     */
3898    EAPI void         elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
3899    /**
3900     * Get the maximized state of a window.
3901     *
3902     * @param obj The window object
3903     * @return If true, the window is maximized
3904     */
3905    EAPI Eina_Bool    elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3906    /**
3907     * Set the iconified state of a window.
3908     *
3909     * @param obj The window object
3910     * @param iconified If true, the window is iconified
3911     */
3912    EAPI void         elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
3913    /**
3914     * Get the iconified state of a window.
3915     *
3916     * @param obj The window object
3917     * @return If true, the window is iconified
3918     */
3919    EAPI Eina_Bool    elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3920    /**
3921     * Set the layer of the window.
3922     *
3923     * What this means exactly will depend on the underlying engine used.
3924     *
3925     * In the case of X11 backed engines, the value in @p layer has the
3926     * following meanings:
3927     * @li < 3: The window will be placed below all others.
3928     * @li > 5: The window will be placed above all others.
3929     * @li other: The window will be placed in the default layer.
3930     *
3931     * @param obj The window object
3932     * @param layer The layer of the window
3933     */
3934    EAPI void         elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
3935    /**
3936     * Get the layer of the window.
3937     *
3938     * @param obj The window object
3939     * @return The layer of the window
3940     *
3941     * @see elm_win_layer_set()
3942     */
3943    EAPI int          elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3944    /**
3945     * Set the rotation of the window.
3946     *
3947     * Most engines only work with multiples of 90.
3948     *
3949     * This function is used to set the orientation of the window @p obj to
3950     * match that of the screen. The window itself will be resized to adjust
3951     * to the new geometry of its contents. If you want to keep the window size,
3952     * see elm_win_rotation_with_resize_set().
3953     *
3954     * @param obj The window object
3955     * @param rotation The rotation of the window, in degrees (0-360),
3956     * counter-clockwise.
3957     */
3958    EAPI void         elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3959    /**
3960     * Rotates the window and resizes it.
3961     *
3962     * Like elm_win_rotation_set(), but it also resizes the window's contents so
3963     * that they fit inside the current window geometry.
3964     *
3965     * @param obj The window object
3966     * @param layer The rotation of the window in degrees (0-360),
3967     * counter-clockwise.
3968     */
3969    EAPI void         elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3970    /**
3971     * Get the rotation of the window.
3972     *
3973     * @param obj The window object
3974     * @return The rotation of the window in degrees (0-360)
3975     *
3976     * @see elm_win_rotation_set()
3977     * @see elm_win_rotation_with_resize_set()
3978     */
3979    EAPI int          elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3980    /**
3981     * Set the sticky state of the window.
3982     *
3983     * Hints the Window Manager that the window in @p obj should be left fixed
3984     * at its position even when the virtual desktop it's on moves or changes.
3985     *
3986     * @param obj The window object
3987     * @param sticky If true, the window's sticky state is enabled
3988     */
3989    EAPI void         elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
3990    /**
3991     * Get the sticky state of the window.
3992     *
3993     * @param obj The window object
3994     * @return If true, the window's sticky state is enabled
3995     *
3996     * @see elm_win_sticky_set()
3997     */
3998    EAPI Eina_Bool    elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3999    /**
4000     * Set if this window is an illume conformant window
4001     *
4002     * @param obj The window object
4003     * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4004     */
4005    EAPI void         elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4006    /**
4007     * Get if this window is an illume conformant window
4008     *
4009     * @param obj The window object
4010     * @return A boolean if this window is illume conformant or not
4011     */
4012    EAPI Eina_Bool    elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4013    /**
4014     * Set a window to be an illume quickpanel window
4015     *
4016     * By default window objects are not quickpanel windows.
4017     *
4018     * @param obj The window object
4019     * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4020     */
4021    EAPI void         elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4022    /**
4023     * Get if this window is a quickpanel or not
4024     *
4025     * @param obj The window object
4026     * @return A boolean if this window is a quickpanel or not
4027     */
4028    EAPI Eina_Bool    elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4029    /**
4030     * Set the major priority of a quickpanel window
4031     *
4032     * @param obj The window object
4033     * @param priority The major priority for this quickpanel
4034     */
4035    EAPI void         elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4036    /**
4037     * Get the major priority of a quickpanel window
4038     *
4039     * @param obj The window object
4040     * @return The major priority of this quickpanel
4041     */
4042    EAPI int          elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4043    /**
4044     * Set the minor priority of a quickpanel window
4045     *
4046     * @param obj The window object
4047     * @param priority The minor priority for this quickpanel
4048     */
4049    EAPI void         elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4050    /**
4051     * Get the minor priority of a quickpanel window
4052     *
4053     * @param obj The window object
4054     * @return The minor priority of this quickpanel
4055     */
4056    EAPI int          elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4057    /**
4058     * Set which zone this quickpanel should appear in
4059     *
4060     * @param obj The window object
4061     * @param zone The requested zone for this quickpanel
4062     */
4063    EAPI void         elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4064    /**
4065     * Get which zone this quickpanel should appear in
4066     *
4067     * @param obj The window object
4068     * @return The requested zone for this quickpanel
4069     */
4070    EAPI int          elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4071    /**
4072     * Set the window to be skipped by keyboard focus
4073     *
4074     * This sets the window to be skipped by normal keyboard input. This means
4075     * a window manager will be asked to not focus this window as well as omit
4076     * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4077     *
4078     * Call this and enable it on a window BEFORE you show it for the first time,
4079     * otherwise it may have no effect.
4080     *
4081     * Use this for windows that have only output information or might only be
4082     * interacted with by the mouse or fingers, and never for typing input.
4083     * Be careful that this may have side-effects like making the window
4084     * non-accessible in some cases unless the window is specially handled. Use
4085     * this with care.
4086     *
4087     * @param obj The window object
4088     * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4089     */
4090    EAPI void         elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4091    /**
4092     * Send a command to the windowing environment
4093     *
4094     * This is intended to work in touchscreen or small screen device
4095     * environments where there is a more simplistic window management policy in
4096     * place. This uses the window object indicated to select which part of the
4097     * environment to control (the part that this window lives in), and provides
4098     * a command and an optional parameter structure (use NULL for this if not
4099     * needed).
4100     *
4101     * @param obj The window object that lives in the environment to control
4102     * @param command The command to send
4103     * @param params Optional parameters for the command
4104     */
4105    EAPI void         elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4106    /**
4107     * Get the inlined image object handle
4108     *
4109     * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4110     * then the window is in fact an evas image object inlined in the parent
4111     * canvas. You can get this object (be careful to not manipulate it as it
4112     * is under control of elementary), and use it to do things like get pixel
4113     * data, save the image to a file, etc.
4114     *
4115     * @param obj The window object to get the inlined image from
4116     * @return The inlined image object, or NULL if none exists
4117     */
4118    EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4119    /**
4120     * Set the enabled status for the focus highlight in a window
4121     *
4122     * This function will enable or disable the focus highlight only for the
4123     * given window, regardless of the global setting for it
4124     *
4125     * @param obj The window where to enable the highlight
4126     * @param enabled The enabled value for the highlight
4127     */
4128    EAPI void         elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4129    /**
4130     * Get the enabled value of the focus highlight for this window
4131     *
4132     * @param obj The window in which to check if the focus highlight is enabled
4133     *
4134     * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4135     */
4136    EAPI Eina_Bool    elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4137    /**
4138     * Set the style for the focus highlight on this window
4139     *
4140     * Sets the style to use for theming the highlight of focused objects on
4141     * the given window. If @p style is NULL, the default will be used.
4142     *
4143     * @param obj The window where to set the style
4144     * @param style The style to set
4145     */
4146    EAPI void         elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4147    /**
4148     * Get the style set for the focus highlight object
4149     *
4150     * Gets the style set for this windows highilght object, or NULL if none
4151     * is set.
4152     *
4153     * @param obj The window to retrieve the highlights style from
4154     *
4155     * @return The style set or NULL if none was. Default is used in that case.
4156     */
4157    EAPI const char  *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4158    /*...
4159     * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4160     * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4161     * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4162     * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4163     * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4164     * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4165     * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4166     *
4167     * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4168     * (blank mouse, private mouse obj, defaultmouse)
4169     *
4170     */
4171    /**
4172     * Sets the keyboard mode of the window.
4173     *
4174     * @param obj The window object
4175     * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4176     */
4177    EAPI void                  elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4178    /**
4179     * Gets the keyboard mode of the window.
4180     *
4181     * @param obj The window object
4182     * @return The mode, one of #Elm_Win_Keyboard_Mode
4183     */
4184    EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4185    /**
4186     * Sets whether the window is a keyboard.
4187     *
4188     * @param obj The window object
4189     * @param is_keyboard If true, the window is a virtual keyboard
4190     */
4191    EAPI void                  elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4192    /**
4193     * Gets whether the window is a keyboard.
4194     *
4195     * @param obj The window object
4196     * @return If the window is a virtual keyboard
4197     */
4198    EAPI Eina_Bool             elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4199
4200    /**
4201     * Get the screen position of a window.
4202     *
4203     * @param obj The window object
4204     * @param x The int to store the x coordinate to
4205     * @param y The int to store the y coordinate to
4206     */
4207    EAPI void                  elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4208    /**
4209     * @}
4210     */
4211
4212    /**
4213     * @defgroup Inwin Inwin
4214     *
4215     * @image html img/widget/inwin/preview-00.png
4216     * @image latex img/widget/inwin/preview-00.eps
4217     * @image html img/widget/inwin/preview-01.png
4218     * @image latex img/widget/inwin/preview-01.eps
4219     * @image html img/widget/inwin/preview-02.png
4220     * @image latex img/widget/inwin/preview-02.eps
4221     *
4222     * An inwin is a window inside a window that is useful for a quick popup.
4223     * It does not hover.
4224     *
4225     * It works by creating an object that will occupy the entire window, so it
4226     * must be created using an @ref Win "elm_win" as parent only. The inwin
4227     * object can be hidden or restacked below every other object if it's
4228     * needed to show what's behind it without destroying it. If this is done,
4229     * the elm_win_inwin_activate() function can be used to bring it back to
4230     * full visibility again.
4231     *
4232     * There are three styles available in the default theme. These are:
4233     * @li default: The inwin is sized to take over most of the window it's
4234     * placed in.
4235     * @li minimal: The size of the inwin will be the minimum necessary to show
4236     * its contents.
4237     * @li minimal_vertical: Horizontally, the inwin takes as much space as
4238     * possible, but it's sized vertically the most it needs to fit its\
4239     * contents.
4240     *
4241     * Some examples of Inwin can be found in the following:
4242     * @li @ref inwin_example_01
4243     *
4244     * @{
4245     */
4246    /**
4247     * Adds an inwin to the current window
4248     *
4249     * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4250     * Never call this function with anything other than the top-most window
4251     * as its parameter, unless you are fond of undefined behavior.
4252     *
4253     * After creating the object, the widget will set itself as resize object
4254     * for the window with elm_win_resize_object_add(), so when shown it will
4255     * appear to cover almost the entire window (how much of it depends on its
4256     * content and the style used). It must not be added into other container
4257     * objects and it needs not be moved or resized manually.
4258     *
4259     * @param parent The parent object
4260     * @return The new object or NULL if it cannot be created
4261     */
4262    EAPI Evas_Object          *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4263    /**
4264     * Activates an inwin object, ensuring its visibility
4265     *
4266     * This function will make sure that the inwin @p obj is completely visible
4267     * by calling evas_object_show() and evas_object_raise() on it, to bring it
4268     * to the front. It also sets the keyboard focus to it, which will be passed
4269     * onto its content.
4270     *
4271     * The object's theme will also receive the signal "elm,action,show" with
4272     * source "elm".
4273     *
4274     * @param obj The inwin to activate
4275     */
4276    EAPI void                  elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4277    /**
4278     * Set the content of an inwin object.
4279     *
4280     * Once the content object is set, a previously set one will be deleted.
4281     * If you want to keep that old content object, use the
4282     * elm_win_inwin_content_unset() function.
4283     *
4284     * @param obj The inwin object
4285     * @param content The object to set as content
4286     */
4287    EAPI void                  elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4288    /**
4289     * Get the content of an inwin object.
4290     *
4291     * Return the content object which is set for this widget.
4292     *
4293     * The returned object is valid as long as the inwin is still alive and no
4294     * other content is set on it. Deleting the object will notify the inwin
4295     * about it and this one will be left empty.
4296     *
4297     * If you need to remove an inwin's content to be reused somewhere else,
4298     * see elm_win_inwin_content_unset().
4299     *
4300     * @param obj The inwin object
4301     * @return The content that is being used
4302     */
4303    EAPI Evas_Object          *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4304    /**
4305     * Unset the content of an inwin object.
4306     *
4307     * Unparent and return the content object which was set for this widget.
4308     *
4309     * @param obj The inwin object
4310     * @return The content that was being used
4311     */
4312    EAPI Evas_Object          *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4313    /**
4314     * @}
4315     */
4316    /* X specific calls - won't work on non-x engines (return 0) */
4317
4318    /**
4319     * Get the Ecore_X_Window of an Evas_Object
4320     *
4321     * @param obj The object
4322     *
4323     * @return The Ecore_X_Window of @p obj
4324     *
4325     * @ingroup Win
4326     */
4327    EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4328
4329    /* smart callbacks called:
4330     * "delete,request" - the user requested to delete the window
4331     * "focus,in" - window got focus
4332     * "focus,out" - window lost focus
4333     * "moved" - window that holds the canvas was moved
4334     */
4335
4336    /**
4337     * @defgroup Bg Bg
4338     *
4339     * @image html img/widget/bg/preview-00.png
4340     * @image latex img/widget/bg/preview-00.eps
4341     *
4342     * @brief Background object, used for setting a solid color, image or Edje
4343     * group as background to a window or any container object.
4344     *
4345     * The bg object is used for setting a solid background to a window or
4346     * packing into any container object. It works just like an image, but has
4347     * some properties useful to a background, like setting it to tiled,
4348     * centered, scaled or stretched.
4349     *
4350     * Here is some sample code using it:
4351     * @li @ref bg_01_example_page
4352     * @li @ref bg_02_example_page
4353     * @li @ref bg_03_example_page
4354     */
4355
4356    /* bg */
4357    typedef enum _Elm_Bg_Option
4358      {
4359         ELM_BG_OPTION_CENTER,  /**< center the background */
4360         ELM_BG_OPTION_SCALE,   /**< scale the background retaining aspect ratio */
4361         ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4362         ELM_BG_OPTION_TILE     /**< tile background at its original size */
4363      } Elm_Bg_Option;
4364
4365    /**
4366     * Add a new background to the parent
4367     *
4368     * @param parent The parent object
4369     * @return The new object or NULL if it cannot be created
4370     *
4371     * @ingroup Bg
4372     */
4373    EAPI Evas_Object  *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4374
4375    /**
4376     * Set the file (image or edje) used for the background
4377     *
4378     * @param obj The bg object
4379     * @param file The file path
4380     * @param group Optional key (group in Edje) within the file
4381     *
4382     * This sets the image file used in the background object. The image (or edje)
4383     * will be stretched (retaining aspect if its an image file) to completely fill
4384     * the bg object. This may mean some parts are not visible.
4385     *
4386     * @note  Once the image of @p obj is set, a previously set one will be deleted,
4387     * even if @p file is NULL.
4388     *
4389     * @ingroup Bg
4390     */
4391    EAPI void          elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4392
4393    /**
4394     * Get the file (image or edje) used for the background
4395     *
4396     * @param obj The bg object
4397     * @param file The file path
4398     * @param group Optional key (group in Edje) within the file
4399     *
4400     * @ingroup Bg
4401     */
4402    EAPI void          elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4403
4404    /**
4405     * Set the option used for the background image
4406     *
4407     * @param obj The bg object
4408     * @param option The desired background option (TILE, SCALE)
4409     *
4410     * This sets the option used for manipulating the display of the background
4411     * image. The image can be tiled or scaled.
4412     *
4413     * @ingroup Bg
4414     */
4415    EAPI void          elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4416
4417    /**
4418     * Get the option used for the background image
4419     *
4420     * @param obj The bg object
4421     * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4422     *
4423     * @ingroup Bg
4424     */
4425    EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4426    /**
4427     * Set the option used for the background color
4428     *
4429     * @param obj The bg object
4430     * @param r
4431     * @param g
4432     * @param b
4433     *
4434     * This sets the color used for the background rectangle. Its range goes
4435     * from 0 to 255.
4436     *
4437     * @ingroup Bg
4438     */
4439    EAPI void          elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4440    /**
4441     * Get the option used for the background color
4442     *
4443     * @param obj The bg object
4444     * @param r
4445     * @param g
4446     * @param b
4447     *
4448     * @ingroup Bg
4449     */
4450    EAPI void          elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4451
4452    /**
4453     * Set the overlay object used for the background object.
4454     *
4455     * @param obj The bg object
4456     * @param overlay The overlay object
4457     *
4458     * This provides a way for elm_bg to have an 'overlay' that will be on top
4459     * of the bg. Once the over object is set, a previously set one will be
4460     * deleted, even if you set the new one to NULL. If you want to keep that
4461     * old content object, use the elm_bg_overlay_unset() function.
4462     *
4463     * @ingroup Bg
4464     */
4465
4466    EAPI void          elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4467
4468    /**
4469     * Get the overlay object used for the background object.
4470     *
4471     * @param obj The bg object
4472     * @return The content that is being used
4473     *
4474     * Return the content object which is set for this widget
4475     *
4476     * @ingroup Bg
4477     */
4478    EAPI Evas_Object  *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4479
4480    /**
4481     * Get the overlay object used for the background object.
4482     *
4483     * @param obj The bg object
4484     * @return The content that was being used
4485     *
4486     * Unparent and return the overlay object which was set for this widget
4487     *
4488     * @ingroup Bg
4489     */
4490    EAPI Evas_Object  *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4491
4492    /**
4493     * Set the size of the pixmap representation of the image.
4494     *
4495     * This option just makes sense if an image is going to be set in the bg.
4496     *
4497     * @param obj The bg object
4498     * @param w The new width of the image pixmap representation.
4499     * @param h The new height of the image pixmap representation.
4500     *
4501     * This function sets a new size for pixmap representation of the given bg
4502     * image. It allows the image to be loaded already in the specified size,
4503     * reducing the memory usage and load time when loading a big image with load
4504     * size set to a smaller size.
4505     *
4506     * NOTE: this is just a hint, the real size of the pixmap may differ
4507     * depending on the type of image being loaded, being bigger than requested.
4508     *
4509     * @ingroup Bg
4510     */
4511    EAPI void          elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4512    /* smart callbacks called:
4513     */
4514
4515    /**
4516     * @defgroup Icon Icon
4517     *
4518     * @image html img/widget/icon/preview-00.png
4519     * @image latex img/widget/icon/preview-00.eps
4520     *
4521     * An object that provides standard icon images (delete, edit, arrows, etc.)
4522     * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4523     *
4524     * The icon image requested can be in the elementary theme, or in the
4525     * freedesktop.org paths. It's possible to set the order of preference from
4526     * where the image will be used.
4527     *
4528     * This API is very similar to @ref Image, but with ready to use images.
4529     *
4530     * Default images provided by the theme are described below.
4531     *
4532     * The first list contains icons that were first intended to be used in
4533     * toolbars, but can be used in many other places too:
4534     * @li home
4535     * @li close
4536     * @li apps
4537     * @li arrow_up
4538     * @li arrow_down
4539     * @li arrow_left
4540     * @li arrow_right
4541     * @li chat
4542     * @li clock
4543     * @li delete
4544     * @li edit
4545     * @li refresh
4546     * @li folder
4547     * @li file
4548     *
4549     * Now some icons that were designed to be used in menus (but again, you can
4550     * use them anywhere else):
4551     * @li menu/home
4552     * @li menu/close
4553     * @li menu/apps
4554     * @li menu/arrow_up
4555     * @li menu/arrow_down
4556     * @li menu/arrow_left
4557     * @li menu/arrow_right
4558     * @li menu/chat
4559     * @li menu/clock
4560     * @li menu/delete
4561     * @li menu/edit
4562     * @li menu/refresh
4563     * @li menu/folder
4564     * @li menu/file
4565     *
4566     * And here we have some media player specific icons:
4567     * @li media_player/forward
4568     * @li media_player/info
4569     * @li media_player/next
4570     * @li media_player/pause
4571     * @li media_player/play
4572     * @li media_player/prev
4573     * @li media_player/rewind
4574     * @li media_player/stop
4575     *
4576     * Signals that you can add callbacks for are:
4577     *
4578     * "clicked" - This is called when a user has clicked the icon
4579     *
4580     * An example of usage for this API follows:
4581     * @li @ref tutorial_icon
4582     */
4583
4584    /**
4585     * @addtogroup Icon
4586     * @{
4587     */
4588
4589    typedef enum _Elm_Icon_Type
4590      {
4591         ELM_ICON_NONE,
4592         ELM_ICON_FILE,
4593         ELM_ICON_STANDARD
4594      } Elm_Icon_Type;
4595    /**
4596     * @enum _Elm_Icon_Lookup_Order
4597     * @typedef Elm_Icon_Lookup_Order
4598     *
4599     * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4600     * theme, FDO paths, or both?
4601     *
4602     * @ingroup Icon
4603     */
4604    typedef enum _Elm_Icon_Lookup_Order
4605      {
4606         ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4607         ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4608         ELM_ICON_LOOKUP_FDO,       /**< icon look up order: freedesktop */
4609         ELM_ICON_LOOKUP_THEME      /**< icon look up order: theme */
4610      } Elm_Icon_Lookup_Order;
4611
4612    /**
4613     * Add a new icon object to the parent.
4614     *
4615     * @param parent The parent object
4616     * @return The new object or NULL if it cannot be created
4617     *
4618     * @see elm_icon_file_set()
4619     *
4620     * @ingroup Icon
4621     */
4622    EAPI Evas_Object          *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4623    /**
4624     * Set the file that will be used as icon.
4625     *
4626     * @param obj The icon object
4627     * @param file The path to file that will be used as icon image
4628     * @param group The group that the icon belongs to in edje file
4629     *
4630     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4631     *
4632     * @note The icon image set by this function can be changed by
4633     * elm_icon_standard_set().
4634     *
4635     * @see elm_icon_file_get()
4636     *
4637     * @ingroup Icon
4638     */
4639    EAPI Eina_Bool             elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4640    /**
4641     * Set a location in memory to be used as an icon
4642     *
4643     * @param obj The icon object
4644     * @param img The binary data that will be used as an image
4645     * @param size The size of binary data @p img
4646     * @param format Optional format of @p img to pass to the image loader
4647     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4648     *
4649     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4650     *
4651     * @note The icon image set by this function can be changed by
4652     * elm_icon_standard_set().
4653     *
4654     * @ingroup Icon
4655     */
4656    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);
4657    /**
4658     * Get the file that will be used as icon.
4659     *
4660     * @param obj The icon object
4661     * @param file The path to file that will be used as icon icon image
4662     * @param group The group that the icon belongs to in edje file
4663     *
4664     * @see elm_icon_file_set()
4665     *
4666     * @ingroup Icon
4667     */
4668    EAPI void                  elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4669    EAPI void                  elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4670    /**
4671     * Set the icon by icon standards names.
4672     *
4673     * @param obj The icon object
4674     * @param name The icon name
4675     *
4676     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4677     *
4678     * For example, freedesktop.org defines standard icon names such as "home",
4679     * "network", etc. There can be different icon sets to match those icon
4680     * keys. The @p name given as parameter is one of these "keys", and will be
4681     * used to look in the freedesktop.org paths and elementary theme. One can
4682     * change the lookup order with elm_icon_order_lookup_set().
4683     *
4684     * If name is not found in any of the expected locations and it is the
4685     * absolute path of an image file, this image will be used.
4686     *
4687     * @note The icon image set by this function can be changed by
4688     * elm_icon_file_set().
4689     *
4690     * @see elm_icon_standard_get()
4691     * @see elm_icon_file_set()
4692     *
4693     * @ingroup Icon
4694     */
4695    EAPI Eina_Bool             elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4696    /**
4697     * Get the icon name set by icon standard names.
4698     *
4699     * @param obj The icon object
4700     * @return The icon name
4701     *
4702     * If the icon image was set using elm_icon_file_set() instead of
4703     * elm_icon_standard_set(), then this function will return @c NULL.
4704     *
4705     * @see elm_icon_standard_set()
4706     *
4707     * @ingroup Icon
4708     */
4709    EAPI const char           *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4710    /**
4711     * Set the smooth effect for an icon object.
4712     *
4713     * @param obj The icon object
4714     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4715     * otherwise. Default is @c EINA_TRUE.
4716     *
4717     * Set the scaling algorithm to be used when scaling the icon image. Smooth
4718     * scaling provides a better resulting image, but is slower.
4719     *
4720     * The smooth scaling should be disabled when making animations that change
4721     * the icon size, since they will be faster. Animations that don't require
4722     * resizing of the icon can keep the smooth scaling enabled (even if the icon
4723     * is already scaled, since the scaled icon image will be cached).
4724     *
4725     * @see elm_icon_smooth_get()
4726     *
4727     * @ingroup Icon
4728     */
4729    EAPI void                  elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4730    /**
4731     * Get the smooth effect for an icon object.
4732     *
4733     * @param obj The icon object
4734     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4735     *
4736     * @see elm_icon_smooth_set()
4737     *
4738     * @ingroup Icon
4739     */
4740    EAPI Eina_Bool             elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4741    /**
4742     * Disable scaling of this object.
4743     *
4744     * @param obj The icon object.
4745     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4746     * otherwise. Default is @c EINA_FALSE.
4747     *
4748     * This function disables scaling of the icon object through the function
4749     * elm_object_scale_set(). However, this does not affect the object
4750     * size/resize in any way. For that effect, take a look at
4751     * elm_icon_scale_set().
4752     *
4753     * @see elm_icon_no_scale_get()
4754     * @see elm_icon_scale_set()
4755     * @see elm_object_scale_set()
4756     *
4757     * @ingroup Icon
4758     */
4759    EAPI void                  elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4760    /**
4761     * Get whether scaling is disabled on the object.
4762     *
4763     * @param obj The icon object
4764     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4765     *
4766     * @see elm_icon_no_scale_set()
4767     *
4768     * @ingroup Icon
4769     */
4770    EAPI Eina_Bool             elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4771    /**
4772     * Set if the object is (up/down) resizable.
4773     *
4774     * @param obj The icon object
4775     * @param scale_up A bool to set if the object is resizable up. Default is
4776     * @c EINA_TRUE.
4777     * @param scale_down A bool to set if the object is resizable down. Default
4778     * is @c EINA_TRUE.
4779     *
4780     * This function limits the icon object resize ability. If @p scale_up is set to
4781     * @c EINA_FALSE, the object can't have its height or width resized to a value
4782     * higher than the original icon size. Same is valid for @p scale_down.
4783     *
4784     * @see elm_icon_scale_get()
4785     *
4786     * @ingroup Icon
4787     */
4788    EAPI void                  elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4789    /**
4790     * Get if the object is (up/down) resizable.
4791     *
4792     * @param obj The icon object
4793     * @param scale_up A bool to set if the object is resizable up
4794     * @param scale_down A bool to set if the object is resizable down
4795     *
4796     * @see elm_icon_scale_set()
4797     *
4798     * @ingroup Icon
4799     */
4800    EAPI void                  elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4801    /**
4802     * Get the object's image size
4803     *
4804     * @param obj The icon object
4805     * @param w A pointer to store the width in
4806     * @param h A pointer to store the height in
4807     *
4808     * @ingroup Icon
4809     */
4810    EAPI void                  elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4811    /**
4812     * Set if the icon fill the entire object area.
4813     *
4814     * @param obj The icon object
4815     * @param fill_outside @c EINA_TRUE if the object is filled outside,
4816     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4817     *
4818     * When the icon object is resized to a different aspect ratio from the
4819     * original icon image, the icon image will still keep its aspect. This flag
4820     * tells how the image should fill the object's area. They are: keep the
4821     * entire icon inside the limits of height and width of the object (@p
4822     * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
4823     * of the object, and the icon will fill the entire object (@p fill_outside
4824     * is @c EINA_TRUE).
4825     *
4826     * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
4827     * retain property to false. Thus, the icon image will always keep its
4828     * original aspect ratio.
4829     *
4830     * @see elm_icon_fill_outside_get()
4831     * @see elm_image_fill_outside_set()
4832     *
4833     * @ingroup Icon
4834     */
4835    EAPI void                  elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
4836    /**
4837     * Get if the object is filled outside.
4838     *
4839     * @param obj The icon object
4840     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
4841     *
4842     * @see elm_icon_fill_outside_set()
4843     *
4844     * @ingroup Icon
4845     */
4846    EAPI Eina_Bool             elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4847    /**
4848     * Set the prescale size for the icon.
4849     *
4850     * @param obj The icon object
4851     * @param size The prescale size. This value is used for both width and
4852     * height.
4853     *
4854     * This function sets a new size for pixmap representation of the given
4855     * icon. It allows the icon to be loaded already in the specified size,
4856     * reducing the memory usage and load time when loading a big icon with load
4857     * size set to a smaller size.
4858     *
4859     * It's equivalent to the elm_bg_load_size_set() function for bg.
4860     *
4861     * @note this is just a hint, the real size of the pixmap may differ
4862     * depending on the type of icon being loaded, being bigger than requested.
4863     *
4864     * @see elm_icon_prescale_get()
4865     * @see elm_bg_load_size_set()
4866     *
4867     * @ingroup Icon
4868     */
4869    EAPI void                  elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
4870    /**
4871     * Get the prescale size for the icon.
4872     *
4873     * @param obj The icon object
4874     * @return The prescale size
4875     *
4876     * @see elm_icon_prescale_set()
4877     *
4878     * @ingroup Icon
4879     */
4880    EAPI int                   elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4881    /**
4882     * Sets the icon lookup order used by elm_icon_standard_set().
4883     *
4884     * @param obj The icon object
4885     * @param order The icon lookup order (can be one of
4886     * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
4887     * or ELM_ICON_LOOKUP_THEME)
4888     *
4889     * @see elm_icon_order_lookup_get()
4890     * @see Elm_Icon_Lookup_Order
4891     *
4892     * @ingroup Icon
4893     */
4894    EAPI void                  elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
4895    /**
4896     * Gets the icon lookup order.
4897     *
4898     * @param obj The icon object
4899     * @return The icon lookup order
4900     *
4901     * @see elm_icon_order_lookup_set()
4902     * @see Elm_Icon_Lookup_Order
4903     *
4904     * @ingroup Icon
4905     */
4906    EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4907    /**
4908     * Get if the icon supports animation or not.
4909     *
4910     * @param obj The icon object
4911     * @return @c EINA_TRUE if the icon supports animation,
4912     *         @c EINA_FALSE otherwise.
4913     *
4914     * Return if this elm icon's image can be animated. Currently Evas only
4915     * supports gif animation. If the return value is EINA_FALSE, other
4916     * elm_icon_animated_XXX APIs won't work.
4917     * @ingroup Icon
4918     */
4919    EAPI Eina_Bool           elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4920    /**
4921     * Set animation mode of the icon.
4922     *
4923     * @param obj The icon object
4924     * @param anim @c EINA_TRUE if the object do animation job,
4925     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4926     *
4927     * Even though elm icon's file can be animated,
4928     * sometimes appication developer want to just first page of image.
4929     * In that time, don't call this function, because default value is EINA_FALSE
4930     * Only when you want icon support anition,
4931     * use this function and set animated to EINA_TURE
4932     * @ingroup Icon
4933     */
4934    EAPI void                elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
4935    /**
4936     * Get animation mode of the icon.
4937     *
4938     * @param obj The icon object
4939     * @return The animation mode of the icon object
4940     * @see elm_icon_animated_set
4941     * @ingroup Icon
4942     */
4943    EAPI Eina_Bool           elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4944    /**
4945     * Set animation play mode of the icon.
4946     *
4947     * @param obj The icon object
4948     * @param play @c EINA_TRUE the object play animation images,
4949     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4950     *
4951     * If you want to play elm icon's animation, you set play to EINA_TURE.
4952     * For example, you make gif player using this set/get API and click event.
4953     *
4954     * 1. Click event occurs
4955     * 2. Check play flag using elm_icon_animaged_play_get
4956     * 3. If elm icon was playing, set play to EINA_FALSE.
4957     *    Then animation will be stopped and vice versa
4958     * @ingroup Icon
4959     */
4960    EAPI void                elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
4961    /**
4962     * Get animation play mode of the icon.
4963     *
4964     * @param obj The icon object
4965     * @return The play mode of the icon object
4966     *
4967     * @see elm_icon_animated_lay_get
4968     * @ingroup Icon
4969     */
4970    EAPI Eina_Bool           elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4971
4972    /**
4973     * @}
4974     */
4975
4976    /**
4977     * @defgroup Image Image
4978     *
4979     * @image html img/widget/image/preview-00.png
4980     * @image latex img/widget/image/preview-00.eps
4981
4982     *
4983     * An object that allows one to load an image file to it. It can be used
4984     * anywhere like any other elementary widget.
4985     *
4986     * This widget provides most of the functionality provided from @ref Bg or @ref
4987     * Icon, but with a slightly different API (use the one that fits better your
4988     * needs).
4989     *
4990     * The features not provided by those two other image widgets are:
4991     * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
4992     * @li change the object orientation with elm_image_orient_set();
4993     * @li and turning the image editable with elm_image_editable_set().
4994     *
4995     * Signals that you can add callbacks for are:
4996     *
4997     * @li @c "clicked" - This is called when a user has clicked the image
4998     *
4999     * An example of usage for this API follows:
5000     * @li @ref tutorial_image
5001     */
5002
5003    /**
5004     * @addtogroup Image
5005     * @{
5006     */
5007
5008    /**
5009     * @enum _Elm_Image_Orient
5010     * @typedef Elm_Image_Orient
5011     *
5012     * Possible orientation options for elm_image_orient_set().
5013     *
5014     * @image html elm_image_orient_set.png
5015     * @image latex elm_image_orient_set.eps width=\textwidth
5016     *
5017     * @ingroup Image
5018     */
5019    typedef enum _Elm_Image_Orient
5020      {
5021         ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5022         ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5023         ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5024         ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5025         ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5026         ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5027         ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5028         ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5029      } Elm_Image_Orient;
5030
5031    /**
5032     * Add a new image to the parent.
5033     *
5034     * @param parent The parent object
5035     * @return The new object or NULL if it cannot be created
5036     *
5037     * @see elm_image_file_set()
5038     *
5039     * @ingroup Image
5040     */
5041    EAPI Evas_Object     *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5042    /**
5043     * Set the file that will be used as image.
5044     *
5045     * @param obj The image object
5046     * @param file The path to file that will be used as image
5047     * @param group The group that the image belongs in edje file (if it's an
5048     * edje image)
5049     *
5050     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5051     *
5052     * @see elm_image_file_get()
5053     *
5054     * @ingroup Image
5055     */
5056    EAPI Eina_Bool        elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5057    /**
5058     * Get the file that will be used as image.
5059     *
5060     * @param obj The image object
5061     * @param file The path to file
5062     * @param group The group that the image belongs in edje file
5063     *
5064     * @see elm_image_file_set()
5065     *
5066     * @ingroup Image
5067     */
5068    EAPI void             elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5069    /**
5070     * Set the smooth effect for an image.
5071     *
5072     * @param obj The image object
5073     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5074     * otherwise. Default is @c EINA_TRUE.
5075     *
5076     * Set the scaling algorithm to be used when scaling the image. Smooth
5077     * scaling provides a better resulting image, but is slower.
5078     *
5079     * The smooth scaling should be disabled when making animations that change
5080     * the image size, since it will be faster. Animations that don't require
5081     * resizing of the image can keep the smooth scaling enabled (even if the
5082     * image is already scaled, since the scaled image will be cached).
5083     *
5084     * @see elm_image_smooth_get()
5085     *
5086     * @ingroup Image
5087     */
5088    EAPI void             elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5089    /**
5090     * Get the smooth effect for an image.
5091     *
5092     * @param obj The image object
5093     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5094     *
5095     * @see elm_image_smooth_get()
5096     *
5097     * @ingroup Image
5098     */
5099    EAPI Eina_Bool        elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5100    /**
5101     * Gets the current size of the image.
5102     *
5103     * @param obj The image object.
5104     * @param w Pointer to store width, or NULL.
5105     * @param h Pointer to store height, or NULL.
5106     *
5107     * This is the real size of the image, not the size of the object.
5108     *
5109     * On error, neither w or h will be written.
5110     *
5111     * @ingroup Image
5112     */
5113    EAPI void             elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5114    /**
5115     * Disable scaling of this object.
5116     *
5117     * @param obj The image object.
5118     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5119     * otherwise. Default is @c EINA_FALSE.
5120     *
5121     * This function disables scaling of the elm_image widget through the
5122     * function elm_object_scale_set(). However, this does not affect the widget
5123     * size/resize in any way. For that effect, take a look at
5124     * elm_image_scale_set().
5125     *
5126     * @see elm_image_no_scale_get()
5127     * @see elm_image_scale_set()
5128     * @see elm_object_scale_set()
5129     *
5130     * @ingroup Image
5131     */
5132    EAPI void             elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5133    /**
5134     * Get whether scaling is disabled on the object.
5135     *
5136     * @param obj The image object
5137     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5138     *
5139     * @see elm_image_no_scale_set()
5140     *
5141     * @ingroup Image
5142     */
5143    EAPI Eina_Bool        elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5144    /**
5145     * Set if the object is (up/down) resizable.
5146     *
5147     * @param obj The image object
5148     * @param scale_up A bool to set if the object is resizable up. Default is
5149     * @c EINA_TRUE.
5150     * @param scale_down A bool to set if the object is resizable down. Default
5151     * is @c EINA_TRUE.
5152     *
5153     * This function limits the image resize ability. If @p scale_up is set to
5154     * @c EINA_FALSE, the object can't have its height or width resized to a value
5155     * higher than the original image size. Same is valid for @p scale_down.
5156     *
5157     * @see elm_image_scale_get()
5158     *
5159     * @ingroup Image
5160     */
5161    EAPI void             elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5162    /**
5163     * Get if the object is (up/down) resizable.
5164     *
5165     * @param obj The image object
5166     * @param scale_up A bool to set if the object is resizable up
5167     * @param scale_down A bool to set if the object is resizable down
5168     *
5169     * @see elm_image_scale_set()
5170     *
5171     * @ingroup Image
5172     */
5173    EAPI void             elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5174    /**
5175     * Set if the image fill the entire object area when keeping the aspect ratio.
5176     *
5177     * @param obj The image object
5178     * @param fill_outside @c EINA_TRUE if the object is filled outside,
5179     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5180     *
5181     * When the image should keep its aspect ratio even if resized to another
5182     * aspect ratio, there are two possibilities to resize it: keep the entire
5183     * image inside the limits of height and width of the object (@p fill_outside
5184     * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5185     * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5186     *
5187     * @note This option will have no effect if
5188     * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5189     *
5190     * @see elm_image_fill_outside_get()
5191     * @see elm_image_aspect_ratio_retained_set()
5192     *
5193     * @ingroup Image
5194     */
5195    EAPI void             elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5196    /**
5197     * Get if the object is filled outside
5198     *
5199     * @param obj The image object
5200     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5201     *
5202     * @see elm_image_fill_outside_set()
5203     *
5204     * @ingroup Image
5205     */
5206    EAPI Eina_Bool        elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5207    /**
5208     * Set the prescale size for the image
5209     *
5210     * @param obj The image object
5211     * @param size The prescale size. This value is used for both width and
5212     * height.
5213     *
5214     * This function sets a new size for pixmap representation of the given
5215     * image. It allows the image to be loaded already in the specified size,
5216     * reducing the memory usage and load time when loading a big image with load
5217     * size set to a smaller size.
5218     *
5219     * It's equivalent to the elm_bg_load_size_set() function for bg.
5220     *
5221     * @note this is just a hint, the real size of the pixmap may differ
5222     * depending on the type of image being loaded, being bigger than requested.
5223     *
5224     * @see elm_image_prescale_get()
5225     * @see elm_bg_load_size_set()
5226     *
5227     * @ingroup Image
5228     */
5229    EAPI void             elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5230    /**
5231     * Get the prescale size for the image
5232     *
5233     * @param obj The image object
5234     * @return The prescale size
5235     *
5236     * @see elm_image_prescale_set()
5237     *
5238     * @ingroup Image
5239     */
5240    EAPI int              elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5241    /**
5242     * Set the image orientation.
5243     *
5244     * @param obj The image object
5245     * @param orient The image orientation
5246     * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5247     *  #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5248     *  #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5249     *  #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
5250     *  Default is #ELM_IMAGE_ORIENT_NONE.
5251     *
5252     * This function allows to rotate or flip the given image.
5253     *
5254     * @see elm_image_orient_get()
5255     * @see @ref Elm_Image_Orient
5256     *
5257     * @ingroup Image
5258     */
5259    EAPI void             elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5260    /**
5261     * Get the image orientation.
5262     *
5263     * @param obj The image object
5264     * @return The image orientation
5265     * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5266     *  #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5267     *  #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5268     *  #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
5269     *
5270     * @see elm_image_orient_set()
5271     * @see @ref Elm_Image_Orient
5272     *
5273     * @ingroup Image
5274     */
5275    EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5276    /**
5277     * Make the image 'editable'.
5278     *
5279     * @param obj Image object.
5280     * @param set Turn on or off editability. Default is @c EINA_FALSE.
5281     *
5282     * This means the image is a valid drag target for drag and drop, and can be
5283     * cut or pasted too.
5284     *
5285     * @ingroup Image
5286     */
5287    EAPI void             elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5288    /**
5289     * Make the image 'editable'.
5290     *
5291     * @param obj Image object.
5292     * @return Editability.
5293     *
5294     * This means the image is a valid drag target for drag and drop, and can be
5295     * cut or pasted too.
5296     *
5297     * @ingroup Image
5298     */
5299    EAPI Eina_Bool        elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5300    /**
5301     * Get the basic Evas_Image object from this object (widget).
5302     *
5303     * @param obj The image object to get the inlined image from
5304     * @return The inlined image object, or NULL if none exists
5305     *
5306     * This function allows one to get the underlying @c Evas_Object of type
5307     * Image from this elementary widget. It can be useful to do things like get
5308     * the pixel data, save the image to a file, etc.
5309     *
5310     * @note Be careful to not manipulate it, as it is under control of
5311     * elementary.
5312     *
5313     * @ingroup Image
5314     */
5315    EAPI Evas_Object     *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5316    /**
5317     * Set whether the original aspect ratio of the image should be kept on resize.
5318     *
5319     * @param obj The image object.
5320     * @param retained @c EINA_TRUE if the image should retain the aspect,
5321     * @c EINA_FALSE otherwise.
5322     *
5323     * The original aspect ratio (width / height) of the image is usually
5324     * distorted to match the object's size. Enabling this option will retain
5325     * this original aspect, and the way that the image is fit into the object's
5326     * area depends on the option set by elm_image_fill_outside_set().
5327     *
5328     * @see elm_image_aspect_ratio_retained_get()
5329     * @see elm_image_fill_outside_set()
5330     *
5331     * @ingroup Image
5332     */
5333    EAPI void             elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5334    /**
5335     * Get if the object retains the original aspect ratio.
5336     *
5337     * @param obj The image object.
5338     * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5339     * otherwise.
5340     *
5341     * @ingroup Image
5342     */
5343    EAPI Eina_Bool        elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5344
5345    /**
5346     * @}
5347     */
5348
5349    /* glview */
5350    typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5351
5352    typedef enum _Elm_GLView_Mode
5353      {
5354         ELM_GLVIEW_ALPHA   = 1,
5355         ELM_GLVIEW_DEPTH   = 2,
5356         ELM_GLVIEW_STENCIL = 4
5357      } Elm_GLView_Mode;
5358
5359    /**
5360     * Defines a policy for the glview resizing.
5361     *
5362     * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5363     */
5364    typedef enum _Elm_GLView_Resize_Policy
5365      {
5366         ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1,      /**< Resize the internal surface along with the image */
5367         ELM_GLVIEW_RESIZE_POLICY_SCALE    = 2       /**< Only reize the internal image and not the surface */
5368      } Elm_GLView_Resize_Policy;
5369
5370    typedef enum _Elm_GLView_Render_Policy
5371      {
5372         ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1,     /**< Render only when there is a need for redrawing */
5373         ELM_GLVIEW_RENDER_POLICY_ALWAYS    = 2      /**< Render always even when it is not visible */
5374      } Elm_GLView_Render_Policy;
5375
5376    /**
5377     * @defgroup GLView
5378     *
5379     * A simple GLView widget that allows GL rendering.
5380     *
5381     * Signals that you can add callbacks for are:
5382     *
5383     * @{
5384     */
5385
5386    /**
5387     * Add a new glview to the parent
5388     *
5389     * @param parent The parent object
5390     * @return The new object or NULL if it cannot be created
5391     *
5392     * @ingroup GLView
5393     */
5394    EAPI Evas_Object     *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5395
5396    /**
5397     * Sets the size of the glview
5398     *
5399     * @param obj The glview object
5400     * @param width width of the glview object
5401     * @param height height of the glview object
5402     *
5403     * @ingroup GLView
5404     */
5405    EAPI void             elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5406
5407    /**
5408     * Gets the size of the glview.
5409     *
5410     * @param obj The glview object
5411     * @param width width of the glview object
5412     * @param height height of the glview object
5413     *
5414     * Note that this function returns the actual image size of the
5415     * glview.  This means that when the scale policy is set to
5416     * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5417     * size.
5418     *
5419     * @ingroup GLView
5420     */
5421    EAPI void             elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5422
5423    /**
5424     * Gets the gl api struct for gl rendering
5425     *
5426     * @param obj The glview object
5427     * @return The api object or NULL if it cannot be created
5428     *
5429     * @ingroup GLView
5430     */
5431    EAPI Evas_GL_API     *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5432
5433    /**
5434     * Set the mode of the GLView. Supports Three simple modes.
5435     *
5436     * @param obj The glview object
5437     * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5438     * @return True if set properly.
5439     *
5440     * @ingroup GLView
5441     */
5442    EAPI Eina_Bool        elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5443
5444    /**
5445     * Set the resize policy for the glview object.
5446     *
5447     * @param obj The glview object.
5448     * @param policy The scaling policy.
5449     *
5450     * By default, the resize policy is set to
5451     * ELM_GLVIEW_RESIZE_POLICY_RECREATE.  When resize is called it
5452     * destroys the previous surface and recreates the newly specified
5453     * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5454     * however, glview only scales the image object and not the underlying
5455     * GL Surface.
5456     *
5457     * @ingroup GLView
5458     */
5459    EAPI Eina_Bool        elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5460
5461    /**
5462     * Set the render policy for the glview object.
5463     *
5464     * @param obj The glview object.
5465     * @param policy The render policy.
5466     *
5467     * By default, the render policy is set to
5468     * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND.  This policy is set such
5469     * that during the render loop, glview is only redrawn if it needs
5470     * to be redrawn. (i.e. When it is visible) If the policy is set to
5471     * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5472     * whether it is visible/need redrawing or not.
5473     *
5474     * @ingroup GLView
5475     */
5476    EAPI Eina_Bool        elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5477
5478    /**
5479     * Set the init function that runs once in the main loop.
5480     *
5481     * @param obj The glview object.
5482     * @param func The init function to be registered.
5483     *
5484     * The registered init function gets called once during the render loop.
5485     *
5486     * @ingroup GLView
5487     */
5488    EAPI void             elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5489
5490    /**
5491     * Set the render function that runs in the main loop.
5492     *
5493     * @param obj The glview object.
5494     * @param func The delete function to be registered.
5495     *
5496     * The registered del function gets called when GLView object is deleted.
5497     *
5498     * @ingroup GLView
5499     */
5500    EAPI void             elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5501
5502    /**
5503     * Set the resize function that gets called when resize happens.
5504     *
5505     * @param obj The glview object.
5506     * @param func The resize function to be registered.
5507     *
5508     * @ingroup GLView
5509     */
5510    EAPI void             elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5511
5512    /**
5513     * Set the render function that runs in the main loop.
5514     *
5515     * @param obj The glview object.
5516     * @param func The render function to be registered.
5517     *
5518     * @ingroup GLView
5519     */
5520    EAPI void             elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5521
5522    /**
5523     * Notifies that there has been changes in the GLView.
5524     *
5525     * @param obj The glview object.
5526     *
5527     * @ingroup GLView
5528     */
5529    EAPI void             elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5530
5531    /**
5532     * @}
5533     */
5534
5535    /* box */
5536    /**
5537     * @defgroup Box Box
5538     *
5539     * @image html img/widget/box/preview-00.png
5540     * @image latex img/widget/box/preview-00.eps width=\textwidth
5541     *
5542     * @image html img/box.png
5543     * @image latex img/box.eps width=\textwidth
5544     *
5545     * A box arranges objects in a linear fashion, governed by a layout function
5546     * that defines the details of this arrangement.
5547     *
5548     * By default, the box will use an internal function to set the layout to
5549     * a single row, either vertical or horizontal. This layout is affected
5550     * by a number of parameters, such as the homogeneous flag set by
5551     * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5552     * elm_box_align_set() and the hints set to each object in the box.
5553     *
5554     * For this default layout, it's possible to change the orientation with
5555     * elm_box_horizontal_set(). The box will start in the vertical orientation,
5556     * placing its elements ordered from top to bottom. When horizontal is set,
5557     * the order will go from left to right. If the box is set to be
5558     * homogeneous, every object in it will be assigned the same space, that
5559     * of the largest object. Padding can be used to set some spacing between
5560     * the cell given to each object. The alignment of the box, set with
5561     * elm_box_align_set(), determines how the bounding box of all the elements
5562     * will be placed within the space given to the box widget itself.
5563     *
5564     * The size hints of each object also affect how they are placed and sized
5565     * within the box. evas_object_size_hint_min_set() will give the minimum
5566     * size the object can have, and the box will use it as the basis for all
5567     * latter calculations. Elementary widgets set their own minimum size as
5568     * needed, so there's rarely any need to use it manually.
5569     *
5570     * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5571     * used to tell whether the object will be allocated the minimum size it
5572     * needs or if the space given to it should be expanded. It's important
5573     * to realize that expanding the size given to the object is not the same
5574     * thing as resizing the object. It could very well end being a small
5575     * widget floating in a much larger empty space. If not set, the weight
5576     * for objects will normally be 0.0 for both axis, meaning the widget will
5577     * not be expanded. To take as much space possible, set the weight to
5578     * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5579     *
5580     * Besides how much space each object is allocated, it's possible to control
5581     * how the widget will be placed within that space using
5582     * evas_object_size_hint_align_set(). By default, this value will be 0.5
5583     * for both axis, meaning the object will be centered, but any value from
5584     * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5585     * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5586     * is -1.0, means the object will be resized to fill the entire space it
5587     * was allocated.
5588     *
5589     * In addition, customized functions to define the layout can be set, which
5590     * allow the application developer to organize the objects within the box
5591     * in any number of ways.
5592     *
5593     * The special elm_box_layout_transition() function can be used
5594     * to switch from one layout to another, animating the motion of the
5595     * children of the box.
5596     *
5597     * @note Objects should not be added to box objects using _add() calls.
5598     *
5599     * Some examples on how to use boxes follow:
5600     * @li @ref box_example_01
5601     * @li @ref box_example_02
5602     *
5603     * @{
5604     */
5605    /**
5606     * @typedef Elm_Box_Transition
5607     *
5608     * Opaque handler containing the parameters to perform an animated
5609     * transition of the layout the box uses.
5610     *
5611     * @see elm_box_transition_new()
5612     * @see elm_box_layout_set()
5613     * @see elm_box_layout_transition()
5614     */
5615    typedef struct _Elm_Box_Transition Elm_Box_Transition;
5616
5617    /**
5618     * Add a new box to the parent
5619     *
5620     * By default, the box will be in vertical mode and non-homogeneous.
5621     *
5622     * @param parent The parent object
5623     * @return The new object or NULL if it cannot be created
5624     */
5625    EAPI Evas_Object        *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5626    /**
5627     * Set the horizontal orientation
5628     *
5629     * By default, box object arranges their contents vertically from top to
5630     * bottom.
5631     * By calling this function with @p horizontal as EINA_TRUE, the box will
5632     * become horizontal, arranging contents from left to right.
5633     *
5634     * @note This flag is ignored if a custom layout function is set.
5635     *
5636     * @param obj The box object
5637     * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5638     * EINA_FALSE = vertical)
5639     */
5640    EAPI void                elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5641    /**
5642     * Get the horizontal orientation
5643     *
5644     * @param obj The box object
5645     * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5646     */
5647    EAPI Eina_Bool           elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5648    /**
5649     * Set the box to arrange its children homogeneously
5650     *
5651     * If enabled, homogeneous layout makes all items the same size, according
5652     * to the size of the largest of its children.
5653     *
5654     * @note This flag is ignored if a custom layout function is set.
5655     *
5656     * @param obj The box object
5657     * @param homogeneous The homogeneous flag
5658     */
5659    EAPI void                elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5660    /**
5661     * Get whether the box is using homogeneous mode or not
5662     *
5663     * @param obj The box object
5664     * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5665     */
5666    EAPI Eina_Bool           elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5667    EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5668    EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5669    /**
5670     * Add an object to the beginning of the pack list
5671     *
5672     * Pack @p subobj into the box @p obj, placing it first in the list of
5673     * children objects. The actual position the object will get on screen
5674     * depends on the layout used. If no custom layout is set, it will be at
5675     * the top or left, depending if the box is vertical or horizontal,
5676     * respectively.
5677     *
5678     * @param obj The box object
5679     * @param subobj The object to add to the box
5680     *
5681     * @see elm_box_pack_end()
5682     * @see elm_box_pack_before()
5683     * @see elm_box_pack_after()
5684     * @see elm_box_unpack()
5685     * @see elm_box_unpack_all()
5686     * @see elm_box_clear()
5687     */
5688    EAPI void                elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5689    /**
5690     * Add an object at the end of the pack list
5691     *
5692     * Pack @p subobj into the box @p obj, placing it last in the list of
5693     * children objects. The actual position the object will get on screen
5694     * depends on the layout used. If no custom layout is set, it will be at
5695     * the bottom or right, depending if the box is vertical or horizontal,
5696     * respectively.
5697     *
5698     * @param obj The box object
5699     * @param subobj The object to add to the box
5700     *
5701     * @see elm_box_pack_start()
5702     * @see elm_box_pack_before()
5703     * @see elm_box_pack_after()
5704     * @see elm_box_unpack()
5705     * @see elm_box_unpack_all()
5706     * @see elm_box_clear()
5707     */
5708    EAPI void                elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5709    /**
5710     * Adds an object to the box before the indicated object
5711     *
5712     * This will add the @p subobj to the box indicated before the object
5713     * indicated with @p before. If @p before is not already in the box, results
5714     * are undefined. Before means either to the left of the indicated object or
5715     * above it depending on orientation.
5716     *
5717     * @param obj The box object
5718     * @param subobj The object to add to the box
5719     * @param before The object before which to add it
5720     *
5721     * @see elm_box_pack_start()
5722     * @see elm_box_pack_end()
5723     * @see elm_box_pack_after()
5724     * @see elm_box_unpack()
5725     * @see elm_box_unpack_all()
5726     * @see elm_box_clear()
5727     */
5728    EAPI void                elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5729    /**
5730     * Adds an object to the box after the indicated object
5731     *
5732     * This will add the @p subobj to the box indicated after the object
5733     * indicated with @p after. If @p after is not already in the box, results
5734     * are undefined. After means either to the right of the indicated object or
5735     * below it depending on orientation.
5736     *
5737     * @param obj The box object
5738     * @param subobj The object to add to the box
5739     * @param after The object after which to add it
5740     *
5741     * @see elm_box_pack_start()
5742     * @see elm_box_pack_end()
5743     * @see elm_box_pack_before()
5744     * @see elm_box_unpack()
5745     * @see elm_box_unpack_all()
5746     * @see elm_box_clear()
5747     */
5748    EAPI void                elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5749    /**
5750     * Clear the box of all children
5751     *
5752     * Remove all the elements contained by the box, deleting the respective
5753     * objects.
5754     *
5755     * @param obj The box object
5756     *
5757     * @see elm_box_unpack()
5758     * @see elm_box_unpack_all()
5759     */
5760    EAPI void                elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5761    /**
5762     * Unpack a box item
5763     *
5764     * Remove the object given by @p subobj from the box @p obj without
5765     * deleting it.
5766     *
5767     * @param obj The box object
5768     *
5769     * @see elm_box_unpack_all()
5770     * @see elm_box_clear()
5771     */
5772    EAPI void                elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5773    /**
5774     * Remove all items from the box, without deleting them
5775     *
5776     * Clear the box from all children, but don't delete the respective objects.
5777     * If no other references of the box children exist, the objects will never
5778     * be deleted, and thus the application will leak the memory. Make sure
5779     * when using this function that you hold a reference to all the objects
5780     * in the box @p obj.
5781     *
5782     * @param obj The box object
5783     *
5784     * @see elm_box_clear()
5785     * @see elm_box_unpack()
5786     */
5787    EAPI void                elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5788    /**
5789     * Retrieve a list of the objects packed into the box
5790     *
5791     * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5792     * The order of the list corresponds to the packing order the box uses.
5793     *
5794     * You must free this list with eina_list_free() once you are done with it.
5795     *
5796     * @param obj The box object
5797     */
5798    EAPI const Eina_List    *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5799    /**
5800     * Set the space (padding) between the box's elements.
5801     *
5802     * Extra space in pixels that will be added between a box child and its
5803     * neighbors after its containing cell has been calculated. This padding
5804     * is set for all elements in the box, besides any possible padding that
5805     * individual elements may have through their size hints.
5806     *
5807     * @param obj The box object
5808     * @param horizontal The horizontal space between elements
5809     * @param vertical The vertical space between elements
5810     */
5811    EAPI void                elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5812    /**
5813     * Get the space (padding) between the box's elements.
5814     *
5815     * @param obj The box object
5816     * @param horizontal The horizontal space between elements
5817     * @param vertical The vertical space between elements
5818     *
5819     * @see elm_box_padding_set()
5820     */
5821    EAPI void                elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5822    /**
5823     * Set the alignment of the whole bouding box of contents.
5824     *
5825     * Sets how the bounding box containing all the elements of the box, after
5826     * their sizes and position has been calculated, will be aligned within
5827     * the space given for the whole box widget.
5828     *
5829     * @param obj The box object
5830     * @param horizontal The horizontal alignment of elements
5831     * @param vertical The vertical alignment of elements
5832     */
5833    EAPI void                elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
5834    /**
5835     * Get the alignment of the whole bouding box of contents.
5836     *
5837     * @param obj The box object
5838     * @param horizontal The horizontal alignment of elements
5839     * @param vertical The vertical alignment of elements
5840     *
5841     * @see elm_box_align_set()
5842     */
5843    EAPI void                elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
5844
5845    /**
5846     * Set the layout defining function to be used by the box
5847     *
5848     * Whenever anything changes that requires the box in @p obj to recalculate
5849     * the size and position of its elements, the function @p cb will be called
5850     * to determine what the layout of the children will be.
5851     *
5852     * Once a custom function is set, everything about the children layout
5853     * is defined by it. The flags set by elm_box_horizontal_set() and
5854     * elm_box_homogeneous_set() no longer have any meaning, and the values
5855     * given by elm_box_padding_set() and elm_box_align_set() are up to this
5856     * layout function to decide if they are used and how. These last two
5857     * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
5858     * passed to @p cb. The @c Evas_Object the function receives is not the
5859     * Elementary widget, but the internal Evas Box it uses, so none of the
5860     * functions described here can be used on it.
5861     *
5862     * Any of the layout functions in @c Evas can be used here, as well as the
5863     * special elm_box_layout_transition().
5864     *
5865     * The final @p data argument received by @p cb is the same @p data passed
5866     * here, and the @p free_data function will be called to free it
5867     * whenever the box is destroyed or another layout function is set.
5868     *
5869     * Setting @p cb to NULL will revert back to the default layout function.
5870     *
5871     * @param obj The box object
5872     * @param cb The callback function used for layout
5873     * @param data Data that will be passed to layout function
5874     * @param free_data Function called to free @p data
5875     *
5876     * @see elm_box_layout_transition()
5877     */
5878    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);
5879    /**
5880     * Special layout function that animates the transition from one layout to another
5881     *
5882     * Normally, when switching the layout function for a box, this will be
5883     * reflected immediately on screen on the next render, but it's also
5884     * possible to do this through an animated transition.
5885     *
5886     * This is done by creating an ::Elm_Box_Transition and setting the box
5887     * layout to this function.
5888     *
5889     * For example:
5890     * @code
5891     * Elm_Box_Transition *t = elm_box_transition_new(1.0,
5892     *                            evas_object_box_layout_vertical, // start
5893     *                            NULL, // data for initial layout
5894     *                            NULL, // free function for initial data
5895     *                            evas_object_box_layout_horizontal, // end
5896     *                            NULL, // data for final layout
5897     *                            NULL, // free function for final data
5898     *                            anim_end, // will be called when animation ends
5899     *                            NULL); // data for anim_end function\
5900     * elm_box_layout_set(box, elm_box_layout_transition, t,
5901     *                    elm_box_transition_free);
5902     * @endcode
5903     *
5904     * @note This function can only be used with elm_box_layout_set(). Calling
5905     * it directly will not have the expected results.
5906     *
5907     * @see elm_box_transition_new
5908     * @see elm_box_transition_free
5909     * @see elm_box_layout_set
5910     */
5911    EAPI void                elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
5912    /**
5913     * Create a new ::Elm_Box_Transition to animate the switch of layouts
5914     *
5915     * If you want to animate the change from one layout to another, you need
5916     * to set the layout function of the box to elm_box_layout_transition(),
5917     * passing as user data to it an instance of ::Elm_Box_Transition with the
5918     * necessary information to perform this animation. The free function to
5919     * set for the layout is elm_box_transition_free().
5920     *
5921     * The parameters to create an ::Elm_Box_Transition sum up to how long
5922     * will it be, in seconds, a layout function to describe the initial point,
5923     * another for the final position of the children and one function to be
5924     * called when the whole animation ends. This last function is useful to
5925     * set the definitive layout for the box, usually the same as the end
5926     * layout for the animation, but could be used to start another transition.
5927     *
5928     * @param start_layout The layout function that will be used to start the animation
5929     * @param start_layout_data The data to be passed the @p start_layout function
5930     * @param start_layout_free_data Function to free @p start_layout_data
5931     * @param end_layout The layout function that will be used to end the animation
5932     * @param end_layout_free_data The data to be passed the @p end_layout function
5933     * @param end_layout_free_data Function to free @p end_layout_data
5934     * @param transition_end_cb Callback function called when animation ends
5935     * @param transition_end_data Data to be passed to @p transition_end_cb
5936     * @return An instance of ::Elm_Box_Transition
5937     *
5938     * @see elm_box_transition_new
5939     * @see elm_box_layout_transition
5940     */
5941    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);
5942    /**
5943     * Free a Elm_Box_Transition instance created with elm_box_transition_new().
5944     *
5945     * This function is mostly useful as the @c free_data parameter in
5946     * elm_box_layout_set() when elm_box_layout_transition().
5947     *
5948     * @param data The Elm_Box_Transition instance to be freed.
5949     *
5950     * @see elm_box_transition_new
5951     * @see elm_box_layout_transition
5952     */
5953    EAPI void                elm_box_transition_free(void *data);
5954    /**
5955     * @}
5956     */
5957
5958    /* button */
5959    /**
5960     * @defgroup Button Button
5961     *
5962     * @image html img/widget/button/preview-00.png
5963     * @image latex img/widget/button/preview-00.eps
5964     * @image html img/widget/button/preview-01.png
5965     * @image latex img/widget/button/preview-01.eps
5966     * @image html img/widget/button/preview-02.png
5967     * @image latex img/widget/button/preview-02.eps
5968     *
5969     * This is a push-button. Press it and run some function. It can contain
5970     * a simple label and icon object and it also has an autorepeat feature.
5971     *
5972     * This widgets emits the following signals:
5973     * @li "clicked": the user clicked the button (press/release).
5974     * @li "repeated": the user pressed the button without releasing it.
5975     * @li "pressed": button was pressed.
5976     * @li "unpressed": button was released after being pressed.
5977     * In all three cases, the @c event parameter of the callback will be
5978     * @c NULL.
5979     *
5980     * Also, defined in the default theme, the button has the following styles
5981     * available:
5982     * @li default: a normal button.
5983     * @li anchor: Like default, but the button fades away when the mouse is not
5984     * over it, leaving only the text or icon.
5985     * @li hoversel_vertical: Internally used by @ref Hoversel to give a
5986     * continuous look across its options.
5987     * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
5988     *
5989     * Follow through a complete example @ref button_example_01 "here".
5990     * @{
5991     */
5992    /**
5993     * Add a new button to the parent's canvas
5994     *
5995     * @param parent The parent object
5996     * @return The new object or NULL if it cannot be created
5997     */
5998    EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5999    /**
6000     * Set the label used in the button
6001     *
6002     * The passed @p label can be NULL to clean any existing text in it and
6003     * leave the button as an icon only object.
6004     *
6005     * @param obj The button object
6006     * @param label The text will be written on the button
6007     * @deprecated use elm_object_text_set() instead.
6008     */
6009    EINA_DEPRECATED EAPI void         elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6010    /**
6011     * Get the label set for the button
6012     *
6013     * The string returned is an internal pointer and should not be freed or
6014     * altered. It will also become invalid when the button is destroyed.
6015     * The string returned, if not NULL, is a stringshare, so if you need to
6016     * keep it around even after the button is destroyed, you can use
6017     * eina_stringshare_ref().
6018     *
6019     * @param obj The button object
6020     * @return The text set to the label, or NULL if nothing is set
6021     * @deprecated use elm_object_text_set() instead.
6022     */
6023    EINA_DEPRECATED EAPI const char  *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6024    /**
6025     * Set the icon used for the button
6026     *
6027     * Setting a new icon will delete any other that was previously set, making
6028     * any reference to them invalid. If you need to maintain the previous
6029     * object alive, unset it first with elm_button_icon_unset().
6030     *
6031     * @param obj The button object
6032     * @param icon The icon object for the button
6033     */
6034    EAPI void         elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6035    /**
6036     * Get the icon used for the button
6037     *
6038     * Return the icon object which is set for this widget. If the button is
6039     * destroyed or another icon is set, the returned object will be deleted
6040     * and any reference to it will be invalid.
6041     *
6042     * @param obj The button object
6043     * @return The icon object that is being used
6044     *
6045     * @see elm_button_icon_unset()
6046     */
6047    EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6048    /**
6049     * Remove the icon set without deleting it and return the object
6050     *
6051     * This function drops the reference the button holds of the icon object
6052     * and returns this last object. It is used in case you want to remove any
6053     * icon, or set another one, without deleting the actual object. The button
6054     * will be left without an icon set.
6055     *
6056     * @param obj The button object
6057     * @return The icon object that was being used
6058     */
6059    EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6060    /**
6061     * Turn on/off the autorepeat event generated when the button is kept pressed
6062     *
6063     * When off, no autorepeat is performed and buttons emit a normal @c clicked
6064     * signal when they are clicked.
6065     *
6066     * When on, keeping a button pressed will continuously emit a @c repeated
6067     * signal until the button is released. The time it takes until it starts
6068     * emitting the signal is given by
6069     * elm_button_autorepeat_initial_timeout_set(), and the time between each
6070     * new emission by elm_button_autorepeat_gap_timeout_set().
6071     *
6072     * @param obj The button object
6073     * @param on  A bool to turn on/off the event
6074     */
6075    EAPI void         elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6076    /**
6077     * Get whether the autorepeat feature is enabled
6078     *
6079     * @param obj The button object
6080     * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6081     *
6082     * @see elm_button_autorepeat_set()
6083     */
6084    EAPI Eina_Bool    elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6085    /**
6086     * Set the initial timeout before the autorepeat event is generated
6087     *
6088     * Sets the timeout, in seconds, since the button is pressed until the
6089     * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6090     * won't be any delay and the even will be fired the moment the button is
6091     * pressed.
6092     *
6093     * @param obj The button object
6094     * @param t   Timeout in seconds
6095     *
6096     * @see elm_button_autorepeat_set()
6097     * @see elm_button_autorepeat_gap_timeout_set()
6098     */
6099    EAPI void         elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6100    /**
6101     * Get the initial timeout before the autorepeat event is generated
6102     *
6103     * @param obj The button object
6104     * @return Timeout in seconds
6105     *
6106     * @see elm_button_autorepeat_initial_timeout_set()
6107     */
6108    EAPI double       elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6109    /**
6110     * Set the interval between each generated autorepeat event
6111     *
6112     * After the first @c repeated event is fired, all subsequent ones will
6113     * follow after a delay of @p t seconds for each.
6114     *
6115     * @param obj The button object
6116     * @param t   Interval in seconds
6117     *
6118     * @see elm_button_autorepeat_initial_timeout_set()
6119     */
6120    EAPI void         elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6121    /**
6122     * Get the interval between each generated autorepeat event
6123     *
6124     * @param obj The button object
6125     * @return Interval in seconds
6126     */
6127    EAPI double       elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6128    /**
6129     * @}
6130     */
6131
6132    /**
6133     * @defgroup File_Selector_Button File Selector Button
6134     *
6135     * @image html img/widget/fileselector_button/preview-00.png
6136     * @image latex img/widget/fileselector_button/preview-00.eps
6137     * @image html img/widget/fileselector_button/preview-01.png
6138     * @image latex img/widget/fileselector_button/preview-01.eps
6139     * @image html img/widget/fileselector_button/preview-02.png
6140     * @image latex img/widget/fileselector_button/preview-02.eps
6141     *
6142     * This is a button that, when clicked, creates an Elementary
6143     * window (or inner window) <b> with a @ref Fileselector "file
6144     * selector widget" within</b>. When a file is chosen, the (inner)
6145     * window is closed and the button emits a signal having the
6146     * selected file as it's @c event_info.
6147     *
6148     * This widget encapsulates operations on its internal file
6149     * selector on its own API. There is less control over its file
6150     * selector than that one would have instatiating one directly.
6151     *
6152     * The following styles are available for this button:
6153     * @li @c "default"
6154     * @li @c "anchor"
6155     * @li @c "hoversel_vertical"
6156     * @li @c "hoversel_vertical_entry"
6157     *
6158     * Smart callbacks one can register to:
6159     * - @c "file,chosen" - the user has selected a path, whose string
6160     *   pointer comes as the @c event_info data (a stringshared
6161     *   string)
6162     *
6163     * Here is an example on its usage:
6164     * @li @ref fileselector_button_example
6165     *
6166     * @see @ref File_Selector_Entry for a similar widget.
6167     * @{
6168     */
6169
6170    /**
6171     * Add a new file selector button widget to the given parent
6172     * Elementary (container) object
6173     *
6174     * @param parent The parent object
6175     * @return a new file selector button widget handle or @c NULL, on
6176     * errors
6177     */
6178    EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6179
6180    /**
6181     * Set the label for a given file selector button widget
6182     *
6183     * @param obj The file selector button widget
6184     * @param label The text label to be displayed on @p obj
6185     *
6186     * @deprecated use elm_object_text_set() instead.
6187     */
6188    EINA_DEPRECATED EAPI void         elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6189
6190    /**
6191     * Get the label set for a given file selector button widget
6192     *
6193     * @param obj The file selector button widget
6194     * @return The button label
6195     *
6196     * @deprecated use elm_object_text_set() instead.
6197     */
6198    EINA_DEPRECATED EAPI const char  *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6199
6200    /**
6201     * Set the icon on a given file selector button widget
6202     *
6203     * @param obj The file selector button widget
6204     * @param icon The icon object for the button
6205     *
6206     * Once the icon object is set, a previously set one will be
6207     * deleted. If you want to keep the latter, use the
6208     * elm_fileselector_button_icon_unset() function.
6209     *
6210     * @see elm_fileselector_button_icon_get()
6211     */
6212    EAPI void         elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6213
6214    /**
6215     * Get the icon set for a given file selector button widget
6216     *
6217     * @param obj The file selector button widget
6218     * @return The icon object currently set on @p obj or @c NULL, if
6219     * none is
6220     *
6221     * @see elm_fileselector_button_icon_set()
6222     */
6223    EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6224
6225    /**
6226     * Unset the icon used in a given file selector button widget
6227     *
6228     * @param obj The file selector button widget
6229     * @return The icon object that was being used on @p obj or @c
6230     * NULL, on errors
6231     *
6232     * Unparent and return the icon object which was set for this
6233     * widget.
6234     *
6235     * @see elm_fileselector_button_icon_set()
6236     */
6237    EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6238
6239    /**
6240     * Set the title for a given file selector button widget's window
6241     *
6242     * @param obj The file selector button widget
6243     * @param title The title string
6244     *
6245     * This will change the window's title, when the file selector pops
6246     * out after a click on the button. Those windows have the default
6247     * (unlocalized) value of @c "Select a file" as titles.
6248     *
6249     * @note It will only take any effect if the file selector
6250     * button widget is @b not under "inwin mode".
6251     *
6252     * @see elm_fileselector_button_window_title_get()
6253     */
6254    EAPI void         elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6255
6256    /**
6257     * Get the title set for a given file selector button widget's
6258     * window
6259     *
6260     * @param obj The file selector button widget
6261     * @return Title of the file selector button's window
6262     *
6263     * @see elm_fileselector_button_window_title_get() for more details
6264     */
6265    EAPI const char  *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6266
6267    /**
6268     * Set the size of a given file selector button widget's window,
6269     * holding the file selector itself.
6270     *
6271     * @param obj The file selector button widget
6272     * @param width The window's width
6273     * @param height The window's height
6274     *
6275     * @note it will only take any effect if the file selector button
6276     * widget is @b not under "inwin mode". The default size for the
6277     * window (when applicable) is 400x400 pixels.
6278     *
6279     * @see elm_fileselector_button_window_size_get()
6280     */
6281    EAPI void         elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6282
6283    /**
6284     * Get the size of a given file selector button widget's window,
6285     * holding the file selector itself.
6286     *
6287     * @param obj The file selector button widget
6288     * @param width Pointer into which to store the width value
6289     * @param height Pointer into which to store the height value
6290     *
6291     * @note Use @c NULL pointers on the size values you're not
6292     * interested in: they'll be ignored by the function.
6293     *
6294     * @see elm_fileselector_button_window_size_set(), for more details
6295     */
6296    EAPI void         elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6297
6298    /**
6299     * Set the initial file system path for a given file selector
6300     * button widget
6301     *
6302     * @param obj The file selector button widget
6303     * @param path The path string
6304     *
6305     * It must be a <b>directory</b> path, which will have the contents
6306     * displayed initially in the file selector's view, when invoked
6307     * from @p obj. The default initial path is the @c "HOME"
6308     * environment variable's value.
6309     *
6310     * @see elm_fileselector_button_path_get()
6311     */
6312    EAPI void         elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6313
6314    /**
6315     * Get the initial file system path set for a given file selector
6316     * button widget
6317     *
6318     * @param obj The file selector button widget
6319     * @return path The path string
6320     *
6321     * @see elm_fileselector_button_path_set() for more details
6322     */
6323    EAPI const char  *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6324
6325    /**
6326     * Enable/disable a tree view in the given file selector button
6327     * widget's internal file selector
6328     *
6329     * @param obj The file selector button widget
6330     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6331     * disable
6332     *
6333     * This has the same effect as elm_fileselector_expandable_set(),
6334     * but now applied to a file selector button's internal file
6335     * selector.
6336     *
6337     * @note There's no way to put a file selector button's internal
6338     * file selector in "grid mode", as one may do with "pure" file
6339     * selectors.
6340     *
6341     * @see elm_fileselector_expandable_get()
6342     */
6343    EAPI void         elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6344
6345    /**
6346     * Get whether tree view is enabled for the given file selector
6347     * button widget's internal file selector
6348     *
6349     * @param obj The file selector button widget
6350     * @return @c EINA_TRUE if @p obj widget's internal file selector
6351     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6352     *
6353     * @see elm_fileselector_expandable_set() for more details
6354     */
6355    EAPI Eina_Bool    elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6356
6357    /**
6358     * Set whether a given file selector button widget's internal file
6359     * selector is to display folders only or the directory contents,
6360     * as well.
6361     *
6362     * @param obj The file selector button widget
6363     * @param only @c EINA_TRUE to make @p obj widget's internal file
6364     * selector only display directories, @c EINA_FALSE to make files
6365     * to be displayed in it too
6366     *
6367     * This has the same effect as elm_fileselector_folder_only_set(),
6368     * but now applied to a file selector button's internal file
6369     * selector.
6370     *
6371     * @see elm_fileselector_folder_only_get()
6372     */
6373    EAPI void         elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6374
6375    /**
6376     * Get whether a given file selector button widget's internal file
6377     * selector is displaying folders only or the directory contents,
6378     * as well.
6379     *
6380     * @param obj The file selector button widget
6381     * @return @c EINA_TRUE if @p obj widget's internal file
6382     * selector is only displaying directories, @c EINA_FALSE if files
6383     * are being displayed in it too (and on errors)
6384     *
6385     * @see elm_fileselector_button_folder_only_set() for more details
6386     */
6387    EAPI Eina_Bool    elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6388
6389    /**
6390     * Enable/disable the file name entry box where the user can type
6391     * in a name for a file, in a given file selector button widget's
6392     * internal file selector.
6393     *
6394     * @param obj The file selector button widget
6395     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6396     * file selector a "saving dialog", @c EINA_FALSE otherwise
6397     *
6398     * This has the same effect as elm_fileselector_is_save_set(),
6399     * but now applied to a file selector button's internal file
6400     * selector.
6401     *
6402     * @see elm_fileselector_is_save_get()
6403     */
6404    EAPI void         elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6405
6406    /**
6407     * Get whether the given file selector button widget's internal
6408     * file selector is in "saving dialog" mode
6409     *
6410     * @param obj The file selector button widget
6411     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6412     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6413     * errors)
6414     *
6415     * @see elm_fileselector_button_is_save_set() for more details
6416     */
6417    EAPI Eina_Bool    elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6418
6419    /**
6420     * Set whether a given file selector button widget's internal file
6421     * selector will raise an Elementary "inner window", instead of a
6422     * dedicated Elementary window. By default, it won't.
6423     *
6424     * @param obj The file selector button widget
6425     * @param value @c EINA_TRUE to make it use an inner window, @c
6426     * EINA_TRUE to make it use a dedicated window
6427     *
6428     * @see elm_win_inwin_add() for more information on inner windows
6429     * @see elm_fileselector_button_inwin_mode_get()
6430     */
6431    EAPI void         elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6432
6433    /**
6434     * Get whether a given file selector button widget's internal file
6435     * selector will raise an Elementary "inner window", instead of a
6436     * dedicated Elementary window.
6437     *
6438     * @param obj The file selector button widget
6439     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6440     * if it will use a dedicated window
6441     *
6442     * @see elm_fileselector_button_inwin_mode_set() for more details
6443     */
6444    EAPI Eina_Bool    elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6445
6446    /**
6447     * @}
6448     */
6449
6450     /**
6451     * @defgroup File_Selector_Entry File Selector Entry
6452     *
6453     * @image html img/widget/fileselector_entry/preview-00.png
6454     * @image latex img/widget/fileselector_entry/preview-00.eps
6455     *
6456     * This is an entry made to be filled with or display a <b>file
6457     * system path string</b>. Besides the entry itself, the widget has
6458     * a @ref File_Selector_Button "file selector button" on its side,
6459     * which will raise an internal @ref Fileselector "file selector widget",
6460     * when clicked, for path selection aided by file system
6461     * navigation.
6462     *
6463     * This file selector may appear in an Elementary window or in an
6464     * inner window. When a file is chosen from it, the (inner) window
6465     * is closed and the selected file's path string is exposed both as
6466     * an smart event and as the new text on the entry.
6467     *
6468     * This widget encapsulates operations on its internal file
6469     * selector on its own API. There is less control over its file
6470     * selector than that one would have instatiating one directly.
6471     *
6472     * Smart callbacks one can register to:
6473     * - @c "changed" - The text within the entry was changed
6474     * - @c "activated" - The entry has had editing finished and
6475     *   changes are to be "committed"
6476     * - @c "press" - The entry has been clicked
6477     * - @c "longpressed" - The entry has been clicked (and held) for a
6478     *   couple seconds
6479     * - @c "clicked" - The entry has been clicked
6480     * - @c "clicked,double" - The entry has been double clicked
6481     * - @c "focused" - The entry has received focus
6482     * - @c "unfocused" - The entry has lost focus
6483     * - @c "selection,paste" - A paste action has occurred on the
6484     *   entry
6485     * - @c "selection,copy" - A copy action has occurred on the entry
6486     * - @c "selection,cut" - A cut action has occurred on the entry
6487     * - @c "unpressed" - The file selector entry's button was released
6488     *   after being pressed.
6489     * - @c "file,chosen" - The user has selected a path via the file
6490     *   selector entry's internal file selector, whose string pointer
6491     *   comes as the @c event_info data (a stringshared string)
6492     *
6493     * Here is an example on its usage:
6494     * @li @ref fileselector_entry_example
6495     *
6496     * @see @ref File_Selector_Button for a similar widget.
6497     * @{
6498     */
6499
6500    /**
6501     * Add a new file selector entry widget to the given parent
6502     * Elementary (container) object
6503     *
6504     * @param parent The parent object
6505     * @return a new file selector entry widget handle or @c NULL, on
6506     * errors
6507     */
6508    EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6509
6510    /**
6511     * Set the label for a given file selector entry widget's button
6512     *
6513     * @param obj The file selector entry widget
6514     * @param label The text label to be displayed on @p obj widget's
6515     * button
6516     *
6517     * @deprecated use elm_object_text_set() instead.
6518     */
6519    EINA_DEPRECATED EAPI void         elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6520
6521    /**
6522     * Get the label set for a given file selector entry widget's button
6523     *
6524     * @param obj The file selector entry widget
6525     * @return The widget button's label
6526     *
6527     * @deprecated use elm_object_text_set() instead.
6528     */
6529    EINA_DEPRECATED EAPI const char  *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6530
6531    /**
6532     * Set the icon on a given file selector entry widget's button
6533     *
6534     * @param obj The file selector entry widget
6535     * @param icon The icon object for the entry's button
6536     *
6537     * Once the icon object is set, a previously set one will be
6538     * deleted. If you want to keep the latter, use the
6539     * elm_fileselector_entry_button_icon_unset() function.
6540     *
6541     * @see elm_fileselector_entry_button_icon_get()
6542     */
6543    EAPI void         elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6544
6545    /**
6546     * Get the icon set for a given file selector entry widget's button
6547     *
6548     * @param obj The file selector entry widget
6549     * @return The icon object currently set on @p obj widget's button
6550     * or @c NULL, if none is
6551     *
6552     * @see elm_fileselector_entry_button_icon_set()
6553     */
6554    EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6555
6556    /**
6557     * Unset the icon used in a given file selector entry widget's
6558     * button
6559     *
6560     * @param obj The file selector entry widget
6561     * @return The icon object that was being used on @p obj widget's
6562     * button or @c NULL, on errors
6563     *
6564     * Unparent and return the icon object which was set for this
6565     * widget's button.
6566     *
6567     * @see elm_fileselector_entry_button_icon_set()
6568     */
6569    EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6570
6571    /**
6572     * Set the title for a given file selector entry widget's window
6573     *
6574     * @param obj The file selector entry widget
6575     * @param title The title string
6576     *
6577     * This will change the window's title, when the file selector pops
6578     * out after a click on the entry's button. Those windows have the
6579     * default (unlocalized) value of @c "Select a file" as titles.
6580     *
6581     * @note It will only take any effect if the file selector
6582     * entry widget is @b not under "inwin mode".
6583     *
6584     * @see elm_fileselector_entry_window_title_get()
6585     */
6586    EAPI void         elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6587
6588    /**
6589     * Get the title set for a given file selector entry widget's
6590     * window
6591     *
6592     * @param obj The file selector entry widget
6593     * @return Title of the file selector entry's window
6594     *
6595     * @see elm_fileselector_entry_window_title_get() for more details
6596     */
6597    EAPI const char  *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6598
6599    /**
6600     * Set the size of a given file selector entry widget's window,
6601     * holding the file selector itself.
6602     *
6603     * @param obj The file selector entry widget
6604     * @param width The window's width
6605     * @param height The window's height
6606     *
6607     * @note it will only take any effect if the file selector entry
6608     * widget is @b not under "inwin mode". The default size for the
6609     * window (when applicable) is 400x400 pixels.
6610     *
6611     * @see elm_fileselector_entry_window_size_get()
6612     */
6613    EAPI void         elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6614
6615    /**
6616     * Get the size of a given file selector entry widget's window,
6617     * holding the file selector itself.
6618     *
6619     * @param obj The file selector entry widget
6620     * @param width Pointer into which to store the width value
6621     * @param height Pointer into which to store the height value
6622     *
6623     * @note Use @c NULL pointers on the size values you're not
6624     * interested in: they'll be ignored by the function.
6625     *
6626     * @see elm_fileselector_entry_window_size_set(), for more details
6627     */
6628    EAPI void         elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6629
6630    /**
6631     * Set the initial file system path and the entry's path string for
6632     * a given file selector entry widget
6633     *
6634     * @param obj The file selector entry widget
6635     * @param path The path string
6636     *
6637     * It must be a <b>directory</b> path, which will have the contents
6638     * displayed initially in the file selector's view, when invoked
6639     * from @p obj. The default initial path is the @c "HOME"
6640     * environment variable's value.
6641     *
6642     * @see elm_fileselector_entry_path_get()
6643     */
6644    EAPI void         elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6645
6646    /**
6647     * Get the entry's path string for a given file selector entry
6648     * widget
6649     *
6650     * @param obj The file selector entry widget
6651     * @return path The path string
6652     *
6653     * @see elm_fileselector_entry_path_set() for more details
6654     */
6655    EAPI const char  *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6656
6657    /**
6658     * Enable/disable a tree view in the given file selector entry
6659     * widget's internal file selector
6660     *
6661     * @param obj The file selector entry widget
6662     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6663     * disable
6664     *
6665     * This has the same effect as elm_fileselector_expandable_set(),
6666     * but now applied to a file selector entry's internal file
6667     * selector.
6668     *
6669     * @note There's no way to put a file selector entry's internal
6670     * file selector in "grid mode", as one may do with "pure" file
6671     * selectors.
6672     *
6673     * @see elm_fileselector_expandable_get()
6674     */
6675    EAPI void         elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6676
6677    /**
6678     * Get whether tree view is enabled for the given file selector
6679     * entry widget's internal file selector
6680     *
6681     * @param obj The file selector entry widget
6682     * @return @c EINA_TRUE if @p obj widget's internal file selector
6683     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6684     *
6685     * @see elm_fileselector_expandable_set() for more details
6686     */
6687    EAPI Eina_Bool    elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6688
6689    /**
6690     * Set whether a given file selector entry widget's internal file
6691     * selector is to display folders only or the directory contents,
6692     * as well.
6693     *
6694     * @param obj The file selector entry widget
6695     * @param only @c EINA_TRUE to make @p obj widget's internal file
6696     * selector only display directories, @c EINA_FALSE to make files
6697     * to be displayed in it too
6698     *
6699     * This has the same effect as elm_fileselector_folder_only_set(),
6700     * but now applied to a file selector entry's internal file
6701     * selector.
6702     *
6703     * @see elm_fileselector_folder_only_get()
6704     */
6705    EAPI void         elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6706
6707    /**
6708     * Get whether a given file selector entry widget's internal file
6709     * selector is displaying folders only or the directory contents,
6710     * as well.
6711     *
6712     * @param obj The file selector entry widget
6713     * @return @c EINA_TRUE if @p obj widget's internal file
6714     * selector is only displaying directories, @c EINA_FALSE if files
6715     * are being displayed in it too (and on errors)
6716     *
6717     * @see elm_fileselector_entry_folder_only_set() for more details
6718     */
6719    EAPI Eina_Bool    elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6720
6721    /**
6722     * Enable/disable the file name entry box where the user can type
6723     * in a name for a file, in a given file selector entry widget's
6724     * internal file selector.
6725     *
6726     * @param obj The file selector entry widget
6727     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6728     * file selector a "saving dialog", @c EINA_FALSE otherwise
6729     *
6730     * This has the same effect as elm_fileselector_is_save_set(),
6731     * but now applied to a file selector entry's internal file
6732     * selector.
6733     *
6734     * @see elm_fileselector_is_save_get()
6735     */
6736    EAPI void         elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6737
6738    /**
6739     * Get whether the given file selector entry widget's internal
6740     * file selector is in "saving dialog" mode
6741     *
6742     * @param obj The file selector entry widget
6743     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6744     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6745     * errors)
6746     *
6747     * @see elm_fileselector_entry_is_save_set() for more details
6748     */
6749    EAPI Eina_Bool    elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6750
6751    /**
6752     * Set whether a given file selector entry widget's internal file
6753     * selector will raise an Elementary "inner window", instead of a
6754     * dedicated Elementary window. By default, it won't.
6755     *
6756     * @param obj The file selector entry widget
6757     * @param value @c EINA_TRUE to make it use an inner window, @c
6758     * EINA_TRUE to make it use a dedicated window
6759     *
6760     * @see elm_win_inwin_add() for more information on inner windows
6761     * @see elm_fileselector_entry_inwin_mode_get()
6762     */
6763    EAPI void         elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6764
6765    /**
6766     * Get whether a given file selector entry widget's internal file
6767     * selector will raise an Elementary "inner window", instead of a
6768     * dedicated Elementary window.
6769     *
6770     * @param obj The file selector entry widget
6771     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6772     * if it will use a dedicated window
6773     *
6774     * @see elm_fileselector_entry_inwin_mode_set() for more details
6775     */
6776    EAPI Eina_Bool    elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6777
6778    /**
6779     * Set the initial file system path for a given file selector entry
6780     * widget
6781     *
6782     * @param obj The file selector entry widget
6783     * @param path The path string
6784     *
6785     * It must be a <b>directory</b> path, which will have the contents
6786     * displayed initially in the file selector's view, when invoked
6787     * from @p obj. The default initial path is the @c "HOME"
6788     * environment variable's value.
6789     *
6790     * @see elm_fileselector_entry_path_get()
6791     */
6792    EAPI void         elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6793
6794    /**
6795     * Get the parent directory's path to the latest file selection on
6796     * a given filer selector entry widget
6797     *
6798     * @param obj The file selector object
6799     * @return The (full) path of the directory of the last selection
6800     * on @p obj widget, a @b stringshared string
6801     *
6802     * @see elm_fileselector_entry_path_set()
6803     */
6804    EAPI const char  *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6805
6806    /**
6807     * @}
6808     */
6809
6810    /**
6811     * @defgroup Scroller Scroller
6812     *
6813     * A scroller holds a single object and "scrolls it around". This means that
6814     * it allows the user to use a scrollbar (or a finger) to drag the viewable
6815     * region around, allowing to move through a much larger object that is
6816     * contained in the scroller. The scroiller will always have a small minimum
6817     * size by default as it won't be limited by the contents of the scroller.
6818     *
6819     * Signals that you can add callbacks for are:
6820     * @li "edge,left" - the left edge of the content has been reached
6821     * @li "edge,right" - the right edge of the content has been reached
6822     * @li "edge,top" - the top edge of the content has been reached
6823     * @li "edge,bottom" - the bottom edge of the content has been reached
6824     * @li "scroll" - the content has been scrolled (moved)
6825     * @li "scroll,anim,start" - scrolling animation has started
6826     * @li "scroll,anim,stop" - scrolling animation has stopped
6827     * @li "scroll,drag,start" - dragging the contents around has started
6828     * @li "scroll,drag,stop" - dragging the contents around has stopped
6829     * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
6830     * user intervetion.
6831     *
6832     * @note When Elemementary is in embedded mode the scrollbars will not be
6833     * dragable, they appear merely as indicators of how much has been scrolled.
6834     * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
6835     * fingerscroll) won't work.
6836     *
6837     * In @ref tutorial_scroller you'll find an example of how to use most of
6838     * this API.
6839     * @{
6840     */
6841    /**
6842     * @brief Type that controls when scrollbars should appear.
6843     *
6844     * @see elm_scroller_policy_set()
6845     */
6846    typedef enum _Elm_Scroller_Policy
6847      {
6848         ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
6849         ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
6850         ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
6851         ELM_SCROLLER_POLICY_LAST
6852      } Elm_Scroller_Policy;
6853    /**
6854     * @brief Add a new scroller to the parent
6855     *
6856     * @param parent The parent object
6857     * @return The new object or NULL if it cannot be created
6858     */
6859    EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6860    /**
6861     * @brief Set the content of the scroller widget (the object to be scrolled around).
6862     *
6863     * @param obj The scroller object
6864     * @param content The new content object
6865     *
6866     * Once the content object is set, a previously set one will be deleted.
6867     * If you want to keep that old content object, use the
6868     * elm_scroller_content_unset() function.
6869     */
6870    EAPI void         elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
6871    /**
6872     * @brief Get the content of the scroller widget
6873     *
6874     * @param obj The slider object
6875     * @return The content that is being used
6876     *
6877     * Return the content object which is set for this widget
6878     *
6879     * @see elm_scroller_content_set()
6880     */
6881    EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6882    /**
6883     * @brief Unset the content of the scroller widget
6884     *
6885     * @param obj The slider object
6886     * @return The content that was being used
6887     *
6888     * Unparent and return the content object which was set for this widget
6889     *
6890     * @see elm_scroller_content_set()
6891     */
6892    EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6893    /**
6894     * @brief Set custom theme elements for the scroller
6895     *
6896     * @param obj The scroller object
6897     * @param widget The widget name to use (default is "scroller")
6898     * @param base The base name to use (default is "base")
6899     */
6900    EAPI void         elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
6901    /**
6902     * @brief Make the scroller minimum size limited to the minimum size of the content
6903     *
6904     * @param obj The scroller object
6905     * @param w Enable limiting minimum size horizontally
6906     * @param h Enable limiting minimum size vertically
6907     *
6908     * By default the scroller will be as small as its design allows,
6909     * irrespective of its content. This will make the scroller minimum size the
6910     * right size horizontally and/or vertically to perfectly fit its content in
6911     * that direction.
6912     */
6913    EAPI void         elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
6914    /**
6915     * @brief Show a specific virtual region within the scroller content object
6916     *
6917     * @param obj The scroller object
6918     * @param x X coordinate of the region
6919     * @param y Y coordinate of the region
6920     * @param w Width of the region
6921     * @param h Height of the region
6922     *
6923     * This will ensure all (or part if it does not fit) of the designated
6924     * region in the virtual content object (0, 0 starting at the top-left of the
6925     * virtual content object) is shown within the scroller.
6926     */
6927    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);
6928    /**
6929     * @brief Set the scrollbar visibility policy
6930     *
6931     * @param obj The scroller object
6932     * @param policy_h Horizontal scrollbar policy
6933     * @param policy_v Vertical scrollbar policy
6934     *
6935     * This sets the scrollbar visibility policy for the given scroller.
6936     * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
6937     * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
6938     * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
6939     * respectively for the horizontal and vertical scrollbars.
6940     */
6941    EAPI void         elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
6942    /**
6943     * @brief Gets scrollbar visibility policy
6944     *
6945     * @param obj The scroller object
6946     * @param policy_h Horizontal scrollbar policy
6947     * @param policy_v Vertical scrollbar policy
6948     *
6949     * @see elm_scroller_policy_set()
6950     */
6951    EAPI void         elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
6952    /**
6953     * @brief Get the currently visible content region
6954     *
6955     * @param obj The scroller object
6956     * @param x X coordinate of the region
6957     * @param y Y coordinate of the region
6958     * @param w Width of the region
6959     * @param h Height of the region
6960     *
6961     * This gets the current region in the content object that is visible through
6962     * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
6963     * w, @p h values pointed to.
6964     *
6965     * @note All coordinates are relative to the content.
6966     *
6967     * @see elm_scroller_region_show()
6968     */
6969    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);
6970    /**
6971     * @brief Get the size of the content object
6972     *
6973     * @param obj The scroller object
6974     * @param w Width return
6975     * @param h Height return
6976     *
6977     * This gets the size of the content object of the scroller.
6978     */
6979    EAPI void         elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
6980    /**
6981     * @brief Set bouncing behavior
6982     *
6983     * @param obj The scroller object
6984     * @param h_bounce Will the scroller bounce horizontally or not
6985     * @param v_bounce Will the scroller bounce vertically or not
6986     *
6987     * When scrolling, the scroller may "bounce" when reaching an edge of the
6988     * content object. This is a visual way to indicate the end has been reached.
6989     * This is enabled by default for both axis. This will set if it is enabled
6990     * for that axis with the boolean parameters for each axis.
6991     */
6992    EAPI void         elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6993    /**
6994     * @brief Get the bounce mode
6995     *
6996     * @param obj The Scroller object
6997     * @param h_bounce Allow bounce horizontally
6998     * @param v_bounce Allow bounce vertically
6999     *
7000     * @see elm_scroller_bounce_set()
7001     */
7002    EAPI void         elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7003    /**
7004     * @brief Set scroll page size relative to viewport size.
7005     *
7006     * @param obj The scroller object
7007     * @param h_pagerel The horizontal page relative size
7008     * @param v_pagerel The vertical page relative size
7009     *
7010     * The scroller is capable of limiting scrolling by the user to "pages". That
7011     * is to jump by and only show a "whole page" at a time as if the continuous
7012     * area of the scroller content is split into page sized pieces. This sets
7013     * the size of a page relative to the viewport of the scroller. 1.0 is "1
7014     * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7015     * axis. This is mutually exclusive with page size
7016     * (see elm_scroller_page_size_set()  for more information). Likewise 0.5
7017     * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
7018     * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7019     * the other axis.
7020     */
7021    EAPI void         elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7022    /**
7023     * @brief Set scroll page size.
7024     *
7025     * @param obj The scroller object
7026     * @param h_pagesize The horizontal page size
7027     * @param v_pagesize The vertical page size
7028     *
7029     * This sets the page size to an absolute fixed value, with 0 turning it off
7030     * for that axis.
7031     *
7032     * @see elm_scroller_page_relative_set()
7033     */
7034    EAPI void         elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7035    /**
7036     * @brief Get scroll current page number.
7037     *
7038     * @param obj The scroller object
7039     * @param h_pagenumber The horizoptal page number
7040     * @param v_pagenumber The vertical page number
7041     *
7042     * The page number starts from 0. 0 is the first page.
7043     * Current page means the page which meet the top-left of the viewport.
7044     * If there are two or more pages in the viewport, it returns the number of page
7045     * which meet the top-left of the viewport.
7046     *
7047     * @see elm_scroller_last_page_get()
7048     * @see elm_scroller_page_show()
7049     * @see elm_scroller_page_brint_in()
7050     */
7051    EAPI void         elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7052    /**
7053     * @brief Get scroll last page number.
7054     *
7055     * @param obj The scroller object
7056     * @param h_pagenumber The horizoptal page number
7057     * @param v_pagenumber The vertical page number
7058     *
7059     * The page number starts from 0. 0 is the first page.
7060     * This returns the last page number among the pages.
7061     *
7062     * @see elm_scroller_current_page_get()
7063     * @see elm_scroller_page_show()
7064     * @see elm_scroller_page_brint_in()
7065     */
7066    EAPI void         elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7067    /**
7068     * Show a specific virtual region within the scroller content object by page number.
7069     *
7070     * @param obj The scroller object
7071     * @param h_pagenumber The horizoptal page number
7072     * @param v_pagenumber The vertical page number
7073     *
7074     * 0, 0 of the indicated page is located at the top-left of the viewport.
7075     * This will jump to the page directly without animation.
7076     *
7077     * Example of usage:
7078     *
7079     * @code
7080     * sc = elm_scroller_add(win);
7081     * elm_scroller_content_set(sc, content);
7082     * elm_scroller_page_relative_set(sc, 1, 0);
7083     * elm_scroller_current_page_get(sc, &h_page, &v_page);
7084     * elm_scroller_page_show(sc, h_page + 1, v_page);
7085     * @endcode
7086     *
7087     * @see elm_scroller_page_bring_in()
7088     */
7089    EAPI void         elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7090    /**
7091     * Show a specific virtual region within the scroller content object by page number.
7092     *
7093     * @param obj The scroller object
7094     * @param h_pagenumber The horizoptal page number
7095     * @param v_pagenumber The vertical page number
7096     *
7097     * 0, 0 of the indicated page is located at the top-left of the viewport.
7098     * This will slide to the page with animation.
7099     *
7100     * Example of usage:
7101     *
7102     * @code
7103     * sc = elm_scroller_add(win);
7104     * elm_scroller_content_set(sc, content);
7105     * elm_scroller_page_relative_set(sc, 1, 0);
7106     * elm_scroller_last_page_get(sc, &h_page, &v_page);
7107     * elm_scroller_page_bring_in(sc, h_page, v_page);
7108     * @endcode
7109     *
7110     * @see elm_scroller_page_show()
7111     */
7112    EAPI void         elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7113    /**
7114     * @brief Show a specific virtual region within the scroller content object.
7115     *
7116     * @param obj The scroller object
7117     * @param x X coordinate of the region
7118     * @param y Y coordinate of the region
7119     * @param w Width of the region
7120     * @param h Height of the region
7121     *
7122     * This will ensure all (or part if it does not fit) of the designated
7123     * region in the virtual content object (0, 0 starting at the top-left of the
7124     * virtual content object) is shown within the scroller. Unlike
7125     * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7126     * to this location (if configuration in general calls for transitions). It
7127     * may not jump immediately to the new location and make take a while and
7128     * show other content along the way.
7129     *
7130     * @see elm_scroller_region_show()
7131     */
7132    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);
7133    /**
7134     * @brief Set event propagation on a scroller
7135     *
7136     * @param obj The scroller object
7137     * @param propagation If propagation is enabled or not
7138     *
7139     * This enables or disabled event propagation from the scroller content to
7140     * the scroller and its parent. By default event propagation is disabled.
7141     */
7142    EAPI void         elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
7143    /**
7144     * @brief Get event propagation for a scroller
7145     *
7146     * @param obj The scroller object
7147     * @return The propagation state
7148     *
7149     * This gets the event propagation for a scroller.
7150     *
7151     * @see elm_scroller_propagate_events_set()
7152     */
7153    EAPI Eina_Bool    elm_scroller_propagate_events_get(const Evas_Object *obj);
7154    /**
7155     * @}
7156     */
7157
7158    /**
7159     * @defgroup Label Label
7160     *
7161     * @image html img/widget/label/preview-00.png
7162     * @image latex img/widget/label/preview-00.eps
7163     *
7164     * @brief Widget to display text, with simple html-like markup.
7165     *
7166     * The Label widget @b doesn't allow text to overflow its boundaries, if the
7167     * text doesn't fit the geometry of the label it will be ellipsized or be
7168     * cut. Elementary provides several themes for this widget:
7169     * @li default - No animation
7170     * @li marker - Centers the text in the label and make it bold by default
7171     * @li slide_long - The entire text appears from the right of the screen and
7172     * slides until it disappears in the left of the screen(reappering on the
7173     * right again).
7174     * @li slide_short - The text appears in the left of the label and slides to
7175     * the right to show the overflow. When all of the text has been shown the
7176     * position is reset.
7177     * @li slide_bounce - The text appears in the left of the label and slides to
7178     * the right to show the overflow. When all of the text has been shown the
7179     * animation reverses, moving the text to the left.
7180     *
7181     * Custom themes can of course invent new markup tags and style them any way
7182     * they like.
7183     *
7184     * See @ref tutorial_label for a demonstration of how to use a label widget.
7185     * @{
7186     */
7187    /**
7188     * @brief Add a new label to the parent
7189     *
7190     * @param parent The parent object
7191     * @return The new object or NULL if it cannot be created
7192     */
7193    EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7194    /**
7195     * @brief Set the label on the label object
7196     *
7197     * @param obj The label object
7198     * @param label The label will be used on the label object
7199     * @deprecated See elm_object_text_set()
7200     */
7201    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 */
7202    /**
7203     * @brief Get the label used on the label object
7204     *
7205     * @param obj The label object
7206     * @return The string inside the label
7207     * @deprecated See elm_object_text_get()
7208     */
7209    EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7210    /**
7211     * @brief Set the wrapping behavior of the label
7212     *
7213     * @param obj The label object
7214     * @param wrap To wrap text or not
7215     *
7216     * By default no wrapping is done. Possible values for @p wrap are:
7217     * @li ELM_WRAP_NONE - No wrapping
7218     * @li ELM_WRAP_CHAR - wrap between characters
7219     * @li ELM_WRAP_WORD - wrap between words
7220     * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7221     */
7222    EAPI void         elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7223    /**
7224     * @brief Get the wrapping behavior of the label
7225     *
7226     * @param obj The label object
7227     * @return Wrap type
7228     *
7229     * @see elm_label_line_wrap_set()
7230     */
7231    EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7232    /**
7233     * @brief Set wrap width of the label
7234     *
7235     * @param obj The label object
7236     * @param w The wrap width in pixels at a minimum where words need to wrap
7237     *
7238     * This function sets the maximum width size hint of the label.
7239     *
7240     * @warning This is only relevant if the label is inside a container.
7241     */
7242    EAPI void         elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7243    /**
7244     * @brief Get wrap width of the label
7245     *
7246     * @param obj The label object
7247     * @return The wrap width in pixels at a minimum where words need to wrap
7248     *
7249     * @see elm_label_wrap_width_set()
7250     */
7251    EAPI Evas_Coord   elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7252    /**
7253     * @brief Set wrap height of the label
7254     *
7255     * @param obj The label object
7256     * @param h The wrap height in pixels at a minimum where words need to wrap
7257     *
7258     * This function sets the maximum height size hint of the label.
7259     *
7260     * @warning This is only relevant if the label is inside a container.
7261     */
7262    EAPI void         elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7263    /**
7264     * @brief get wrap width of the label
7265     *
7266     * @param obj The label object
7267     * @return The wrap height in pixels at a minimum where words need to wrap
7268     */
7269    EAPI Evas_Coord   elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7270    /**
7271     * @brief Set the font size on the label object.
7272     *
7273     * @param obj The label object
7274     * @param size font size
7275     *
7276     * @warning NEVER use this. It is for hyper-special cases only. use styles
7277     * instead. e.g. "big", "medium", "small" - or better name them by use:
7278     * "title", "footnote", "quote" etc.
7279     */
7280    EAPI void         elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7281    /**
7282     * @brief Set the text color on the label object
7283     *
7284     * @param obj The label object
7285     * @param r Red property background color of The label object
7286     * @param g Green property background color of The label object
7287     * @param b Blue property background color of The label object
7288     * @param a Alpha property background color of The label object
7289     *
7290     * @warning NEVER use this. It is for hyper-special cases only. use styles
7291     * instead. e.g. "big", "medium", "small" - or better name them by use:
7292     * "title", "footnote", "quote" etc.
7293     */
7294    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);
7295    /**
7296     * @brief Set the text align on the label object
7297     *
7298     * @param obj The label object
7299     * @param align align mode ("left", "center", "right")
7300     *
7301     * @warning NEVER use this. It is for hyper-special cases only. use styles
7302     * instead. e.g. "big", "medium", "small" - or better name them by use:
7303     * "title", "footnote", "quote" etc.
7304     */
7305    EAPI void         elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7306    /**
7307     * @brief Set background color of the label
7308     *
7309     * @param obj The label object
7310     * @param r Red property background color of The label object
7311     * @param g Green property background color of The label object
7312     * @param b Blue property background color of The label object
7313     * @param a Alpha property background alpha of The label object
7314     *
7315     * @warning NEVER use this. It is for hyper-special cases only. use styles
7316     * instead. e.g. "big", "medium", "small" - or better name them by use:
7317     * "title", "footnote", "quote" etc.
7318     */
7319    EAPI void         elm_label_background_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a) EINA_ARG_NONNULL(1);
7320    /**
7321     * @brief Set the ellipsis behavior of the label
7322     *
7323     * @param obj The label object
7324     * @param ellipsis To ellipsis text or not
7325     *
7326     * If set to true and the text doesn't fit in the label an ellipsis("...")
7327     * will be shown at the end of the widget.
7328     *
7329     * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7330     * choosen wrap method was ELM_WRAP_WORD.
7331     */
7332    EAPI void         elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7333    /**
7334     * @brief Set the text slide of the label
7335     *
7336     * @param obj The label object
7337     * @param slide To start slide or stop
7338     *
7339     * If set to true the text of the label will slide throught the length of
7340     * label.
7341     *
7342     * @warning This only work with the themes "slide_short", "slide_long" and
7343     * "slide_bounce".
7344     */
7345    EAPI void         elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7346    /**
7347     * @brief Get the text slide mode of the label
7348     *
7349     * @param obj The label object
7350     * @return slide slide mode value
7351     *
7352     * @see elm_label_slide_set()
7353     */
7354    EAPI Eina_Bool    elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7355    /**
7356     * @brief Set the slide duration(speed) of the label
7357     *
7358     * @param obj The label object
7359     * @return The duration in seconds in moving text from slide begin position
7360     * to slide end position
7361     */
7362    EAPI void         elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7363    /**
7364     * @brief Get the slide duration(speed) of the label
7365     *
7366     * @param obj The label object
7367     * @return The duration time in moving text from slide begin position to slide end position
7368     *
7369     * @see elm_label_slide_duration_set()
7370     */
7371    EAPI double       elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7372    /**
7373     * @}
7374     */
7375
7376    /**
7377     * @defgroup Toggle Toggle
7378     *
7379     * @image html img/widget/toggle/preview-00.png
7380     * @image latex img/widget/toggle/preview-00.eps
7381     *
7382     * @brief A toggle is a slider which can be used to toggle between
7383     * two values.  It has two states: on and off.
7384     *
7385     * Signals that you can add callbacks for are:
7386     * @li "changed" - Whenever the toggle value has been changed.  Is not called
7387     *                 until the toggle is released by the cursor (assuming it
7388     *                 has been triggered by the cursor in the first place).
7389     *
7390     * @ref tutorial_toggle show how to use a toggle.
7391     * @{
7392     */
7393    /**
7394     * @brief Add a toggle to @p parent.
7395     *
7396     * @param parent The parent object
7397     *
7398     * @return The toggle object
7399     */
7400    EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7401    /**
7402     * @brief Sets the label to be displayed with the toggle.
7403     *
7404     * @param obj The toggle object
7405     * @param label The label to be displayed
7406     *
7407     * @deprecated use elm_object_text_set() instead.
7408     */
7409    EINA_DEPRECATED EAPI void         elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7410    /**
7411     * @brief Gets the label of the toggle
7412     *
7413     * @param obj  toggle object
7414     * @return The label of the toggle
7415     *
7416     * @deprecated use elm_object_text_get() instead.
7417     */
7418    EINA_DEPRECATED EAPI const char  *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7419    /**
7420     * @brief Set the icon used for the toggle
7421     *
7422     * @param obj The toggle object
7423     * @param icon The icon object for the button
7424     *
7425     * Once the icon object is set, a previously set one will be deleted
7426     * If you want to keep that old content object, use the
7427     * elm_toggle_icon_unset() function.
7428     */
7429    EAPI void         elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7430    /**
7431     * @brief Get the icon used for the toggle
7432     *
7433     * @param obj The toggle object
7434     * @return The icon object that is being used
7435     *
7436     * Return the icon object which is set for this widget.
7437     *
7438     * @see elm_toggle_icon_set()
7439     */
7440    EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7441    /**
7442     * @brief Unset the icon used for the toggle
7443     *
7444     * @param obj The toggle object
7445     * @return The icon object that was being used
7446     *
7447     * Unparent and return the icon object which was set for this widget.
7448     *
7449     * @see elm_toggle_icon_set()
7450     */
7451    EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7452    /**
7453     * @brief Sets the labels to be associated with the on and off states of the toggle.
7454     *
7455     * @param obj The toggle object
7456     * @param onlabel The label displayed when the toggle is in the "on" state
7457     * @param offlabel The label displayed when the toggle is in the "off" state
7458     */
7459    EAPI void         elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7460    /**
7461     * @brief Gets the labels associated with the on and off states of the toggle.
7462     *
7463     * @param obj The toggle object
7464     * @param onlabel A char** to place the onlabel of @p obj into
7465     * @param offlabel A char** to place the offlabel of @p obj into
7466     */
7467    EAPI void         elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7468    /**
7469     * @brief Sets the state of the toggle to @p state.
7470     *
7471     * @param obj The toggle object
7472     * @param state The state of @p obj
7473     */
7474    EAPI void         elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7475    /**
7476     * @brief Gets the state of the toggle to @p state.
7477     *
7478     * @param obj The toggle object
7479     * @return The state of @p obj
7480     */
7481    EAPI Eina_Bool    elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7482    /**
7483     * @brief Sets the state pointer of the toggle to @p statep.
7484     *
7485     * @param obj The toggle object
7486     * @param statep The state pointer of @p obj
7487     */
7488    EAPI void         elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7489    /**
7490     * @}
7491     */
7492
7493    /**
7494     * @defgroup Frame Frame
7495     *
7496     * @image html img/widget/frame/preview-00.png
7497     * @image latex img/widget/frame/preview-00.eps
7498     *
7499     * @brief Frame is a widget that holds some content and has a title.
7500     *
7501     * The default look is a frame with a title, but Frame supports multple
7502     * styles:
7503     * @li default
7504     * @li pad_small
7505     * @li pad_medium
7506     * @li pad_large
7507     * @li pad_huge
7508     * @li outdent_top
7509     * @li outdent_bottom
7510     *
7511     * Of all this styles only default shows the title. Frame emits no signals.
7512     *
7513     * For a detailed example see the @ref tutorial_frame.
7514     *
7515     * @{
7516     */
7517    /**
7518     * @brief Add a new frame to the parent
7519     *
7520     * @param parent The parent object
7521     * @return The new object or NULL if it cannot be created
7522     */
7523    EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7524    /**
7525     * @brief Set the frame label
7526     *
7527     * @param obj The frame object
7528     * @param label The label of this frame object
7529     *
7530     * @deprecated use elm_object_text_set() instead.
7531     */
7532    EINA_DEPRECATED EAPI void         elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7533    /**
7534     * @brief Get the frame label
7535     *
7536     * @param obj The frame object
7537     *
7538     * @return The label of this frame objet or NULL if unable to get frame
7539     *
7540     * @deprecated use elm_object_text_get() instead.
7541     */
7542    EINA_DEPRECATED EAPI const char  *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7543    /**
7544     * @brief Set the content of the frame widget
7545     *
7546     * Once the content object is set, a previously set one will be deleted.
7547     * If you want to keep that old content object, use the
7548     * elm_frame_content_unset() function.
7549     *
7550     * @param obj The frame object
7551     * @param content The content will be filled in this frame object
7552     */
7553    EAPI void         elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7554    /**
7555     * @brief Get the content of the frame widget
7556     *
7557     * Return the content object which is set for this widget
7558     *
7559     * @param obj The frame object
7560     * @return The content that is being used
7561     */
7562    EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7563    /**
7564     * @brief Unset the content of the frame widget
7565     *
7566     * Unparent and return the content object which was set for this widget
7567     *
7568     * @param obj The frame object
7569     * @return The content that was being used
7570     */
7571    EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7572    /**
7573     * @}
7574     */
7575
7576    /**
7577     * @defgroup Table Table
7578     *
7579     * A container widget to arrange other widgets in a table where items can
7580     * also span multiple columns or rows - even overlap (and then be raised or
7581     * lowered accordingly to adjust stacking if they do overlap).
7582     *
7583     * The followin are examples of how to use a table:
7584     * @li @ref tutorial_table_01
7585     * @li @ref tutorial_table_02
7586     *
7587     * @{
7588     */
7589    /**
7590     * @brief Add a new table to the parent
7591     *
7592     * @param parent The parent object
7593     * @return The new object or NULL if it cannot be created
7594     */
7595    EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7596    /**
7597     * @brief Set the homogeneous layout in the table
7598     *
7599     * @param obj The layout object
7600     * @param homogeneous A boolean to set if the layout is homogeneous in the
7601     * table (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7602     */
7603    EAPI void         elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7604    /**
7605     * @brief Get the current table homogeneous mode.
7606     *
7607     * @param obj The table object
7608     * @return A boolean to indicating if the layout is homogeneous in the table
7609     * (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7610     */
7611    EAPI Eina_Bool    elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7612    /**
7613     * @warning <b>Use elm_table_homogeneous_set() instead</b>
7614     */
7615    EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7616    /**
7617     * @warning <b>Use elm_table_homogeneous_get() instead</b>
7618     */
7619    EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7620    /**
7621     * @brief Set padding between cells.
7622     *
7623     * @param obj The layout object.
7624     * @param horizontal set the horizontal padding.
7625     * @param vertical set the vertical padding.
7626     *
7627     * Default value is 0.
7628     */
7629    EAPI void         elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7630    /**
7631     * @brief Get padding between cells.
7632     *
7633     * @param obj The layout object.
7634     * @param horizontal set the horizontal padding.
7635     * @param vertical set the vertical padding.
7636     */
7637    EAPI void         elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7638    /**
7639     * @brief Add a subobject on the table with the coordinates passed
7640     *
7641     * @param obj The table object
7642     * @param subobj The subobject to be added to the table
7643     * @param x Row number
7644     * @param y Column number
7645     * @param w rowspan
7646     * @param h colspan
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(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7653    /**
7654     * @brief Remove child from table.
7655     *
7656     * @param obj The table object
7657     * @param subobj The subobject
7658     */
7659    EAPI void         elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7660    /**
7661     * @brief Faster way to remove all child objects from a table object.
7662     *
7663     * @param obj The table object
7664     * @param clear If true, will delete children, else just remove from table.
7665     */
7666    EAPI void         elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7667    /**
7668     * @brief Set the packing location of an existing child of the table
7669     *
7670     * @param subobj The subobject to be modified in the table
7671     * @param x Row number
7672     * @param y Column number
7673     * @param w rowspan
7674     * @param h colspan
7675     *
7676     * Modifies the position of an object already in the table.
7677     *
7678     * @note All positioning inside the table is relative to rows and columns, so
7679     * a value of 0 for x and y, means the top left cell of the table, and a
7680     * value of 1 for w and h means @p subobj only takes that 1 cell.
7681     */
7682    EAPI void         elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7683    /**
7684     * @brief Get the packing location of an existing child of the table
7685     *
7686     * @param subobj The subobject to be modified in the table
7687     * @param x Row number
7688     * @param y Column number
7689     * @param w rowspan
7690     * @param h colspan
7691     *
7692     * @see elm_table_pack_set()
7693     */
7694    EAPI void         elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7695    /**
7696     * @}
7697     */
7698
7699    /**
7700     * @defgroup Gengrid Gengrid (Generic grid)
7701     *
7702     * This widget aims to position objects in a grid layout while
7703     * actually creating and rendering only the visible ones, using the
7704     * same idea as the @ref Genlist "genlist": the user defines a @b
7705     * class for each item, specifying functions that will be called at
7706     * object creation, deletion, etc. When those items are selected by
7707     * the user, a callback function is issued. Users may interact with
7708     * a gengrid via the mouse (by clicking on items to select them and
7709     * clicking on the grid's viewport and swiping to pan the whole
7710     * view) or via the keyboard, navigating through item with the
7711     * arrow keys.
7712     *
7713     * @section Gengrid_Layouts Gengrid layouts
7714     *
7715     * Gengrids may layout its items in one of two possible layouts:
7716     * - horizontal or
7717     * - vertical.
7718     *
7719     * When in "horizontal mode", items will be placed in @b columns,
7720     * from top to bottom and, when the space for a column is filled,
7721     * another one is started on the right, thus expanding the grid
7722     * horizontally, making for horizontal scrolling. When in "vertical
7723     * mode" , though, items will be placed in @b rows, from left to
7724     * right and, when the space for a row is filled, another one is
7725     * started below, thus expanding the grid vertically (and making
7726     * for vertical scrolling).
7727     *
7728     * @section Gengrid_Items Gengrid items
7729     *
7730     * An item in a gengrid can have 0 or more text labels (they can be
7731     * regular text or textblock Evas objects - that's up to the style
7732     * to determine), 0 or more icons (which are simply objects
7733     * swallowed into the gengrid item's theming Edje object) and 0 or
7734     * more <b>boolean states</b>, which have the behavior left to the
7735     * user to define. The Edje part names for each of these properties
7736     * will be looked up, in the theme file for the gengrid, under the
7737     * Edje (string) data items named @c "labels", @c "icons" and @c
7738     * "states", respectively. For each of those properties, if more
7739     * than one part is provided, they must have names listed separated
7740     * by spaces in the data fields. For the default gengrid item
7741     * theme, we have @b one label part (@c "elm.text"), @b two icon
7742     * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
7743     * no state parts.
7744     *
7745     * A gengrid item may be at one of several styles. Elementary
7746     * provides one by default - "default", but this can be extended by
7747     * system or application custom themes/overlays/extensions (see
7748     * @ref Theme "themes" for more details).
7749     *
7750     * @section Gengrid_Item_Class Gengrid item classes
7751     *
7752     * In order to have the ability to add and delete items on the fly,
7753     * gengrid implements a class (callback) system where the
7754     * application provides a structure with information about that
7755     * type of item (gengrid may contain multiple different items with
7756     * different classes, states and styles). Gengrid will call the
7757     * functions in this struct (methods) when an item is "realized"
7758     * (i.e., created dynamically, while the user is scrolling the
7759     * grid). All objects will simply be deleted when no longer needed
7760     * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
7761     * contains the following members:
7762     * - @c item_style - This is a constant string and simply defines
7763     * the name of the item style. It @b must be specified and the
7764     * default should be @c "default".
7765     * - @c func.label_get - This function is called when an item
7766     * object is actually created. The @c data parameter will point to
7767     * the same data passed to elm_gengrid_item_append() and related
7768     * item creation functions. The @c obj parameter is the gengrid
7769     * object itself, while the @c part one is the name string of one
7770     * of the existing text parts in the Edje group implementing the
7771     * item's theme. This function @b must return a strdup'()ed string,
7772     * as the caller will free() it when done. See
7773     * #Elm_Gengrid_Item_Label_Get_Cb.
7774     * - @c func.icon_get - This function is called when an item object
7775     * is actually created. The @c data parameter will point to the
7776     * same data passed to elm_gengrid_item_append() and related item
7777     * creation functions. The @c obj parameter is the gengrid object
7778     * itself, while the @c part one is the name string of one of the
7779     * existing (icon) swallow parts in the Edje group implementing the
7780     * item's theme. It must return @c NULL, when no icon is desired,
7781     * or a valid object handle, otherwise. The object will be deleted
7782     * by the gengrid on its deletion or when the item is "unrealized".
7783     * See #Elm_Gengrid_Item_Icon_Get_Cb.
7784     * - @c func.state_get - This function is called when an item
7785     * object is actually created. The @c data parameter will point to
7786     * the same data passed to elm_gengrid_item_append() and related
7787     * item creation functions. The @c obj parameter is the gengrid
7788     * object itself, while the @c part one is the name string of one
7789     * of the state parts in the Edje group implementing the item's
7790     * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
7791     * true/on. Gengrids will emit a signal to its theming Edje object
7792     * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
7793     * "source" arguments, respectively, when the state is true (the
7794     * default is false), where @c XXX is the name of the (state) part.
7795     * See #Elm_Gengrid_Item_State_Get_Cb.
7796     * - @c func.del - This is called when elm_gengrid_item_del() is
7797     * called on an item or elm_gengrid_clear() is called on the
7798     * gengrid. This is intended for use when gengrid items are
7799     * deleted, so any data attached to the item (e.g. its data
7800     * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
7801     *
7802     * @section Gengrid_Usage_Hints Usage hints
7803     *
7804     * If the user wants to have multiple items selected at the same
7805     * time, elm_gengrid_multi_select_set() will permit it. If the
7806     * gengrid is single-selection only (the default), then
7807     * elm_gengrid_select_item_get() will return the selected item or
7808     * @c NULL, if none is selected. If the gengrid is under
7809     * multi-selection, then elm_gengrid_selected_items_get() will
7810     * return a list (that is only valid as long as no items are
7811     * modified (added, deleted, selected or unselected) of child items
7812     * on a gengrid.
7813     *
7814     * If an item changes (internal (boolean) state, label or icon
7815     * changes), then use elm_gengrid_item_update() to have gengrid
7816     * update the item with the new state. A gengrid will re-"realize"
7817     * the item, thus calling the functions in the
7818     * #Elm_Gengrid_Item_Class set for that item.
7819     *
7820     * To programmatically (un)select an item, use
7821     * elm_gengrid_item_selected_set(). To get its selected state use
7822     * elm_gengrid_item_selected_get(). To make an item disabled
7823     * (unable to be selected and appear differently) use
7824     * elm_gengrid_item_disabled_set() to set this and
7825     * elm_gengrid_item_disabled_get() to get the disabled state.
7826     *
7827     * Grid cells will only have their selection smart callbacks called
7828     * when firstly getting selected. Any further clicks will do
7829     * nothing, unless you enable the "always select mode", with
7830     * elm_gengrid_always_select_mode_set(), thus making every click to
7831     * issue selection callbacks. elm_gengrid_no_select_mode_set() will
7832     * turn off the ability to select items entirely in the widget and
7833     * they will neither appear selected nor call the selection smart
7834     * callbacks.
7835     *
7836     * Remember that you can create new styles and add your own theme
7837     * augmentation per application with elm_theme_extension_add(). If
7838     * you absolutely must have a specific style that overrides any
7839     * theme the user or system sets up you can use
7840     * elm_theme_overlay_add() to add such a file.
7841     *
7842     * @section Gengrid_Smart_Events Gengrid smart events
7843     *
7844     * Smart events that you can add callbacks for are:
7845     * - @c "activated" - The user has double-clicked or pressed
7846     *   (enter|return|spacebar) on an item. The @c event_info parameter
7847     *   is the gengrid item that was activated.
7848     * - @c "clicked,double" - The user has double-clicked an item.
7849     *   The @c event_info parameter is the gengrid item that was double-clicked.
7850     * - @c "longpressed" - This is called when the item is pressed for a certain
7851     *   amount of time. By default it's 1 second.
7852     * - @c "selected" - The user has made an item selected. The
7853     *   @c event_info parameter is the gengrid item that was selected.
7854     * - @c "unselected" - The user has made an item unselected. The
7855     *   @c event_info parameter is the gengrid item that was unselected.
7856     * - @c "realized" - This is called when the item in the gengrid
7857     *   has its implementing Evas object instantiated, de facto. @c
7858     *   event_info is the gengrid item that was created. The object
7859     *   may be deleted at any time, so it is highly advised to the
7860     *   caller @b not to use the object pointer returned from
7861     *   elm_gengrid_item_object_get(), because it may point to freed
7862     *   objects.
7863     * - @c "unrealized" - This is called when the implementing Evas
7864     *   object for this item is deleted. @c event_info is the gengrid
7865     *   item that was deleted.
7866     * - @c "changed" - Called when an item is added, removed, resized
7867     *   or moved and when the gengrid is resized or gets "horizontal"
7868     *   property changes.
7869     * - @c "scroll,anim,start" - This is called when scrolling animation has
7870     *   started.
7871     * - @c "scroll,anim,stop" - This is called when scrolling animation has
7872     *   stopped.
7873     * - @c "drag,start,up" - Called when the item in the gengrid has
7874     *   been dragged (not scrolled) up.
7875     * - @c "drag,start,down" - Called when the item in the gengrid has
7876     *   been dragged (not scrolled) down.
7877     * - @c "drag,start,left" - Called when the item in the gengrid has
7878     *   been dragged (not scrolled) left.
7879     * - @c "drag,start,right" - Called when the item in the gengrid has
7880     *   been dragged (not scrolled) right.
7881     * - @c "drag,stop" - Called when the item in the gengrid has
7882     *   stopped being dragged.
7883     * - @c "drag" - Called when the item in the gengrid is being
7884     *   dragged.
7885     * - @c "scroll" - called when the content has been scrolled
7886     *   (moved).
7887     * - @c "scroll,drag,start" - called when dragging the content has
7888     *   started.
7889     * - @c "scroll,drag,stop" - called when dragging the content has
7890     *   stopped.
7891     *
7892     * List of gengrid examples:
7893     * @li @ref gengrid_example
7894     */
7895
7896    /**
7897     * @addtogroup Gengrid
7898     * @{
7899     */
7900
7901    typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
7902    typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
7903    typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
7904    typedef char        *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
7905    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. */
7906    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. */
7907    typedef void         (*Elm_Gengrid_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
7908
7909    typedef char        *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Label_Get_Cb. */
7910    typedef Evas_Object *(*GridItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Icon_Get_Cb. */
7911    typedef Eina_Bool    (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_State_Get_Cb. */
7912    typedef void         (*GridItemDelFunc)      (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Del_Cb. */
7913
7914    /**
7915     * @struct _Elm_Gengrid_Item_Class
7916     *
7917     * Gengrid item class definition. See @ref Gengrid_Item_Class for
7918     * field details.
7919     */
7920    struct _Elm_Gengrid_Item_Class
7921      {
7922         const char             *item_style;
7923         struct _Elm_Gengrid_Item_Class_Func
7924           {
7925              Elm_Gengrid_Item_Label_Get_Cb label_get;
7926              Elm_Gengrid_Item_Icon_Get_Cb  icon_get;
7927              Elm_Gengrid_Item_State_Get_Cb state_get;
7928              Elm_Gengrid_Item_Del_Cb       del;
7929           } func;
7930      }; /**< #Elm_Gengrid_Item_Class member definitions */
7931
7932    /**
7933     * Add a new gengrid widget to the given parent Elementary
7934     * (container) object
7935     *
7936     * @param parent The parent object
7937     * @return a new gengrid widget handle or @c NULL, on errors
7938     *
7939     * This function inserts a new gengrid widget on the canvas.
7940     *
7941     * @see elm_gengrid_item_size_set()
7942     * @see elm_gengrid_group_item_size_set()
7943     * @see elm_gengrid_horizontal_set()
7944     * @see elm_gengrid_item_append()
7945     * @see elm_gengrid_item_del()
7946     * @see elm_gengrid_clear()
7947     *
7948     * @ingroup Gengrid
7949     */
7950    EAPI Evas_Object       *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7951
7952    /**
7953     * Set the size for the items of a given gengrid widget
7954     *
7955     * @param obj The gengrid object.
7956     * @param w The items' width.
7957     * @param h The items' height;
7958     *
7959     * A gengrid, after creation, has still no information on the size
7960     * to give to each of its cells. So, you most probably will end up
7961     * with squares one @ref Fingers "finger" wide, the default
7962     * size. Use this function to force a custom size for you items,
7963     * making them as big as you wish.
7964     *
7965     * @see elm_gengrid_item_size_get()
7966     *
7967     * @ingroup Gengrid
7968     */
7969    EAPI void               elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
7970
7971    /**
7972     * Get the size set for the items of a given gengrid widget
7973     *
7974     * @param obj The gengrid object.
7975     * @param w Pointer to a variable where to store the items' width.
7976     * @param h Pointer to a variable where to store the items' height.
7977     *
7978     * @note Use @c NULL pointers on the size values you're not
7979     * interested in: they'll be ignored by the function.
7980     *
7981     * @see elm_gengrid_item_size_get() for more details
7982     *
7983     * @ingroup Gengrid
7984     */
7985    EAPI void               elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7986
7987    /**
7988     * Set the size for the group items of a given gengrid widget
7989     *
7990     * @param obj The gengrid object.
7991     * @param w The group items' width.
7992     * @param h The group items' height;
7993     *
7994     * A gengrid, after creation, has still no information on the size
7995     * to give to each of its cells. So, you most probably will end up
7996     * with squares one @ref Fingers "finger" wide, the default
7997     * size. Use this function to force a custom size for you group items,
7998     * making them as big as you wish.
7999     *
8000     * @see elm_gengrid_group_item_size_get()
8001     *
8002     * @ingroup Gengrid
8003     */
8004    EAPI void               elm_gengrid_group_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8005
8006    /**
8007     * Get the size set for the group items of a given gengrid widget
8008     *
8009     * @param obj The gengrid object.
8010     * @param w Pointer to a variable where to store the group items' width.
8011     * @param h Pointer to a variable where to store the group items' height.
8012     *
8013     * @note Use @c NULL pointers on the size values you're not
8014     * interested in: they'll be ignored by the function.
8015     *
8016     * @see elm_gengrid_group_item_size_get() for more details
8017     *
8018     * @ingroup Gengrid
8019     */
8020    EAPI void               elm_gengrid_group_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8021
8022    /**
8023     * Set the items grid's alignment within a given gengrid widget
8024     *
8025     * @param obj The gengrid object.
8026     * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8027     * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8028     *
8029     * This sets the alignment of the whole grid of items of a gengrid
8030     * within its given viewport. By default, those values are both
8031     * 0.5, meaning that the gengrid will have its items grid placed
8032     * exactly in the middle of its viewport.
8033     *
8034     * @note If given alignment values are out of the cited ranges,
8035     * they'll be changed to the nearest boundary values on the valid
8036     * ranges.
8037     *
8038     * @see elm_gengrid_align_get()
8039     *
8040     * @ingroup Gengrid
8041     */
8042    EAPI void               elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8043
8044    /**
8045     * Get the items grid's alignment values within a given gengrid
8046     * widget
8047     *
8048     * @param obj The gengrid object.
8049     * @param align_x Pointer to a variable where to store the
8050     * horizontal alignment.
8051     * @param align_y Pointer to a variable where to store the vertical
8052     * alignment.
8053     *
8054     * @note Use @c NULL pointers on the alignment values you're not
8055     * interested in: they'll be ignored by the function.
8056     *
8057     * @see elm_gengrid_align_set() for more details
8058     *
8059     * @ingroup Gengrid
8060     */
8061    EAPI void               elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8062
8063    /**
8064     * Set whether a given gengrid widget is or not able have items
8065     * @b reordered
8066     *
8067     * @param obj The gengrid object
8068     * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8069     * @c EINA_FALSE to turn it off
8070     *
8071     * If a gengrid is set to allow reordering, a click held for more
8072     * than 0.5 over a given item will highlight it specially,
8073     * signalling the gengrid has entered the reordering state. From
8074     * that time on, the user will be able to, while still holding the
8075     * mouse button down, move the item freely in the gengrid's
8076     * viewport, replacing to said item to the locations it goes to.
8077     * The replacements will be animated and, whenever the user
8078     * releases the mouse button, the item being replaced gets a new
8079     * definitive place in the grid.
8080     *
8081     * @see elm_gengrid_reorder_mode_get()
8082     *
8083     * @ingroup Gengrid
8084     */
8085    EAPI void               elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8086
8087    /**
8088     * Get whether a given gengrid widget is or not able have items
8089     * @b reordered
8090     *
8091     * @param obj The gengrid object
8092     * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8093     * off
8094     *
8095     * @see elm_gengrid_reorder_mode_set() for more details
8096     *
8097     * @ingroup Gengrid
8098     */
8099    EAPI Eina_Bool          elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8100
8101    /**
8102     * Append a new item in a given gengrid widget.
8103     *
8104     * @param obj The gengrid object.
8105     * @param gic The item class for the item.
8106     * @param data The item data.
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 adds an item to the beginning of the gengrid.
8113     *
8114     * @see elm_gengrid_item_prepend()
8115     * @see elm_gengrid_item_insert_before()
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_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);
8122
8123    /**
8124     * Prepend a new item in a given gengrid widget.
8125     *
8126     * @param obj The gengrid object.
8127     * @param gic The item class for the item.
8128     * @param data The item data.
8129     * @param func Convenience function called when the item is
8130     * selected.
8131     * @param func_data Data to be passed to @p func.
8132     * @return A handle to the item added or @c NULL, on errors.
8133     *
8134     * This adds an item to the end of the gengrid.
8135     *
8136     * @see elm_gengrid_item_append()
8137     * @see elm_gengrid_item_insert_before()
8138     * @see elm_gengrid_item_insert_after()
8139     * @see elm_gengrid_item_del()
8140     *
8141     * @ingroup Gengrid
8142     */
8143    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);
8144
8145    /**
8146     * Insert an item before another in a gengrid widget
8147     *
8148     * @param obj The gengrid object.
8149     * @param gic The item class for the item.
8150     * @param data The item data.
8151     * @param relative The item to place this new one before.
8152     * @param func Convenience function called when the item is
8153     * selected.
8154     * @param func_data Data to be passed to @p func.
8155     * @return A handle to the item added or @c NULL, on errors.
8156     *
8157     * This inserts an item before another in the gengrid.
8158     *
8159     * @see elm_gengrid_item_append()
8160     * @see elm_gengrid_item_prepend()
8161     * @see elm_gengrid_item_insert_after()
8162     * @see elm_gengrid_item_del()
8163     *
8164     * @ingroup Gengrid
8165     */
8166    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);
8167
8168    /**
8169     * Insert an item after another in a gengrid widget
8170     *
8171     * @param obj The gengrid object.
8172     * @param gic The item class for the item.
8173     * @param data The item data.
8174     * @param relative The item to place this new one after.
8175     * @param func Convenience function called when the item is
8176     * selected.
8177     * @param func_data Data to be passed to @p func.
8178     * @return A handle to the item added or @c NULL, on errors.
8179     *
8180     * This inserts an item after another in the gengrid.
8181     *
8182     * @see elm_gengrid_item_append()
8183     * @see elm_gengrid_item_prepend()
8184     * @see elm_gengrid_item_insert_after()
8185     * @see elm_gengrid_item_del()
8186     *
8187     * @ingroup Gengrid
8188     */
8189    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);
8190
8191    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);
8192
8193    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);
8194
8195    /**
8196     * Set whether items on a given gengrid widget are to get their
8197     * selection callbacks issued for @b every subsequent selection
8198     * click on them or just for the first click.
8199     *
8200     * @param obj The gengrid object
8201     * @param always_select @c EINA_TRUE to make items "always
8202     * selected", @c EINA_FALSE, otherwise
8203     *
8204     * By default, grid items will only call their selection callback
8205     * function when firstly getting selected, any subsequent further
8206     * clicks will do nothing. With this call, you make those
8207     * subsequent clicks also to issue the selection callbacks.
8208     *
8209     * @note <b>Double clicks</b> will @b always be reported on items.
8210     *
8211     * @see elm_gengrid_always_select_mode_get()
8212     *
8213     * @ingroup Gengrid
8214     */
8215    EAPI void               elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8216
8217    /**
8218     * Get whether items on a given gengrid widget have their selection
8219     * callbacks issued for @b every subsequent selection click on them
8220     * or just for the first click.
8221     *
8222     * @param obj The gengrid object.
8223     * @return @c EINA_TRUE if the gengrid items are "always selected",
8224     * @c EINA_FALSE, otherwise
8225     *
8226     * @see elm_gengrid_always_select_mode_set() for more details
8227     *
8228     * @ingroup Gengrid
8229     */
8230    EAPI Eina_Bool          elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8231
8232    /**
8233     * Set whether items on a given gengrid widget can be selected or not.
8234     *
8235     * @param obj The gengrid object
8236     * @param no_select @c EINA_TRUE to make items selectable,
8237     * @c EINA_FALSE otherwise
8238     *
8239     * This will make items in @p obj selectable or not. In the latter
8240     * case, any user interaction on the gengrid items will neither make
8241     * them appear selected nor them call their selection callback
8242     * functions.
8243     *
8244     * @see elm_gengrid_no_select_mode_get()
8245     *
8246     * @ingroup Gengrid
8247     */
8248    EAPI void               elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8249
8250    /**
8251     * Get whether items on a given gengrid widget can be selected or
8252     * not.
8253     *
8254     * @param obj The gengrid object
8255     * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8256     * otherwise
8257     *
8258     * @see elm_gengrid_no_select_mode_set() for more details
8259     *
8260     * @ingroup Gengrid
8261     */
8262    EAPI Eina_Bool          elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8263
8264    /**
8265     * Enable or disable multi-selection in a given gengrid widget
8266     *
8267     * @param obj The gengrid object.
8268     * @param multi @c EINA_TRUE, to enable multi-selection,
8269     * @c EINA_FALSE to disable it.
8270     *
8271     * Multi-selection is the ability for one to have @b more than one
8272     * item selected, on a given gengrid, simultaneously. When it is
8273     * enabled, a sequence of clicks on different items will make them
8274     * all selected, progressively. A click on an already selected item
8275     * will unselect it. If interecting via the keyboard,
8276     * multi-selection is enabled while holding the "Shift" key.
8277     *
8278     * @note By default, multi-selection is @b disabled on gengrids
8279     *
8280     * @see elm_gengrid_multi_select_get()
8281     *
8282     * @ingroup Gengrid
8283     */
8284    EAPI void               elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8285
8286    /**
8287     * Get whether multi-selection is enabled or disabled for a given
8288     * gengrid widget
8289     *
8290     * @param obj The gengrid object.
8291     * @return @c EINA_TRUE, if multi-selection is enabled, @c
8292     * EINA_FALSE otherwise
8293     *
8294     * @see elm_gengrid_multi_select_set() for more details
8295     *
8296     * @ingroup Gengrid
8297     */
8298    EAPI Eina_Bool          elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8299
8300    /**
8301     * Enable or disable bouncing effect for a given gengrid widget
8302     *
8303     * @param obj The gengrid object
8304     * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8305     * @c EINA_FALSE to disable it
8306     * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8307     * @c EINA_FALSE to disable it
8308     *
8309     * The bouncing effect occurs whenever one reaches the gengrid's
8310     * edge's while panning it -- it will scroll past its limits a
8311     * little bit and return to the edge again, in a animated for,
8312     * automatically.
8313     *
8314     * @note By default, gengrids have bouncing enabled on both axis
8315     *
8316     * @see elm_gengrid_bounce_get()
8317     *
8318     * @ingroup Gengrid
8319     */
8320    EAPI void               elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8321
8322    /**
8323     * Get whether bouncing effects are enabled or disabled, for a
8324     * given gengrid widget, on each axis
8325     *
8326     * @param obj The gengrid object
8327     * @param h_bounce Pointer to a variable where to store the
8328     * horizontal bouncing flag.
8329     * @param v_bounce Pointer to a variable where to store the
8330     * vertical bouncing flag.
8331     *
8332     * @see elm_gengrid_bounce_set() for more details
8333     *
8334     * @ingroup Gengrid
8335     */
8336    EAPI void               elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8337
8338    /**
8339     * Set a given gengrid widget's scrolling page size, relative to
8340     * its viewport size.
8341     *
8342     * @param obj The gengrid object
8343     * @param h_pagerel The horizontal page (relative) size
8344     * @param v_pagerel The vertical page (relative) size
8345     *
8346     * The gengrid's scroller is capable of binding scrolling by the
8347     * user to "pages". It means that, while scrolling and, specially
8348     * after releasing the mouse button, the grid will @b snap to the
8349     * nearest displaying page's area. When page sizes are set, the
8350     * grid's continuous content area is split into (equal) page sized
8351     * pieces.
8352     *
8353     * This function sets the size of a page <b>relatively to the
8354     * viewport dimensions</b> of the gengrid, for each axis. A value
8355     * @c 1.0 means "the exact viewport's size", in that axis, while @c
8356     * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8357     * a viewport". Sane usable values are, than, between @c 0.0 and @c
8358     * 1.0. Values beyond those will make it behave behave
8359     * inconsistently. If you only want one axis to snap to pages, use
8360     * the value @c 0.0 for the other one.
8361     *
8362     * There is a function setting page size values in @b absolute
8363     * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8364     * is mutually exclusive to this one.
8365     *
8366     * @see elm_gengrid_page_relative_get()
8367     *
8368     * @ingroup Gengrid
8369     */
8370    EAPI void               elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8371
8372    /**
8373     * Get a given gengrid widget's scrolling page size, relative to
8374     * its viewport size.
8375     *
8376     * @param obj The gengrid object
8377     * @param h_pagerel Pointer to a variable where to store the
8378     * horizontal page (relative) size
8379     * @param v_pagerel Pointer to a variable where to store the
8380     * vertical page (relative) size
8381     *
8382     * @see elm_gengrid_page_relative_set() for more details
8383     *
8384     * @ingroup Gengrid
8385     */
8386    EAPI void               elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8387
8388    /**
8389     * Set a given gengrid widget's scrolling page size
8390     *
8391     * @param obj The gengrid object
8392     * @param h_pagerel The horizontal page size, in pixels
8393     * @param v_pagerel The vertical page size, in pixels
8394     *
8395     * The gengrid's scroller is capable of binding scrolling by the
8396     * user to "pages". It means that, while scrolling and, specially
8397     * after releasing the mouse button, the grid will @b snap to the
8398     * nearest displaying page's area. When page sizes are set, the
8399     * grid's continuous content area is split into (equal) page sized
8400     * pieces.
8401     *
8402     * This function sets the size of a page of the gengrid, in pixels,
8403     * for each axis. Sane usable values are, between @c 0 and the
8404     * dimensions of @p obj, for each axis. Values beyond those will
8405     * make it behave behave inconsistently. If you only want one axis
8406     * to snap to pages, use the value @c 0 for the other one.
8407     *
8408     * There is a function setting page size values in @b relative
8409     * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8410     * use is mutually exclusive to this one.
8411     *
8412     * @ingroup Gengrid
8413     */
8414    EAPI void               elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8415
8416    /**
8417     * @brief Get gengrid current page number.
8418     *
8419     * @param obj The gengrid object
8420     * @param h_pagenumber The horizontal page number
8421     * @param v_pagenumber The vertical page number
8422     *
8423     * The page number starts from 0. 0 is the first page.
8424     * Current page means the page which meet the top-left of the viewport.
8425     * If there are two or more pages in the viewport, it returns the number of page
8426     * which meet the top-left of the viewport.
8427     *
8428     * @see elm_gengrid_last_page_get()
8429     * @see elm_gengrid_page_show()
8430     * @see elm_gengrid_page_brint_in()
8431     */
8432    EAPI void         elm_gengrid_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8433
8434    /**
8435     * @brief Get scroll last page number.
8436     *
8437     * @param obj The gengrid object
8438     * @param h_pagenumber The horizoptal page number
8439     * @param v_pagenumber The vertical page number
8440     *
8441     * The page number starts from 0. 0 is the first page.
8442     * This returns the last page number among the pages.
8443     *
8444     * @see elm_gengrid_current_page_get()
8445     * @see elm_gengrid_page_show()
8446     * @see elm_gengrid_page_brint_in()
8447     */
8448    EAPI void         elm_gengrid_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8449
8450    /**
8451     * Show a specific virtual region within the gengrid content object by page number.
8452     *
8453     * @param obj The gengrid object
8454     * @param h_pagenumber The horizoptal page number
8455     * @param v_pagenumber The vertical page number
8456     *
8457     * 0, 0 of the indicated page is located at the top-left of the viewport.
8458     * This will jump to the page directly without animation.
8459     *
8460     * Example of usage:
8461     *
8462     * @code
8463     * sc = elm_gengrid_add(win);
8464     * elm_gengrid_content_set(sc, content);
8465     * elm_gengrid_page_relative_set(sc, 1, 0);
8466     * elm_gengrid_current_page_get(sc, &h_page, &v_page);
8467     * elm_gengrid_page_show(sc, h_page + 1, v_page);
8468     * @endcode
8469     *
8470     * @see elm_gengrid_page_bring_in()
8471     */
8472    EAPI void         elm_gengrid_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8473
8474    /**
8475     * Show a specific virtual region within the gengrid content object by page number.
8476     *
8477     * @param obj The gengrid object
8478     * @param h_pagenumber The horizoptal page number
8479     * @param v_pagenumber The vertical page number
8480     *
8481     * 0, 0 of the indicated page is located at the top-left of the viewport.
8482     * This will slide to the page with animation.
8483     *
8484     * Example of usage:
8485     *
8486     * @code
8487     * sc = elm_gengrid_add(win);
8488     * elm_gengrid_content_set(sc, content);
8489     * elm_gengrid_page_relative_set(sc, 1, 0);
8490     * elm_gengrid_last_page_get(sc, &h_page, &v_page);
8491     * elm_gengrid_page_bring_in(sc, h_page, v_page);
8492     * @endcode
8493     *
8494     * @see elm_gengrid_page_show()
8495     */
8496     EAPI void         elm_gengrid_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8497
8498    /**
8499     * Set for what direction a given gengrid widget will expand while
8500     * placing its items.
8501     *
8502     * @param obj The gengrid object.
8503     * @param setting @c EINA_TRUE to make the gengrid expand
8504     * horizontally, @c EINA_FALSE to expand vertically.
8505     *
8506     * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8507     * in @b columns, from top to bottom and, when the space for a
8508     * column is filled, another one is started on the right, thus
8509     * expanding the grid horizontally. When in "vertical mode"
8510     * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8511     * to right and, when the space for a row is filled, another one is
8512     * started below, thus expanding the grid vertically.
8513     *
8514     * @see elm_gengrid_horizontal_get()
8515     *
8516     * @ingroup Gengrid
8517     */
8518    EAPI void               elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8519
8520    /**
8521     * Get for what direction a given gengrid widget will expand while
8522     * placing its items.
8523     *
8524     * @param obj The gengrid object.
8525     * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8526     * @c EINA_FALSE if it's set to expand vertically.
8527     *
8528     * @see elm_gengrid_horizontal_set() for more detais
8529     *
8530     * @ingroup Gengrid
8531     */
8532    EAPI Eina_Bool          elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8533
8534    /**
8535     * Get the first item in a given gengrid widget
8536     *
8537     * @param obj The gengrid object
8538     * @return The first item's handle or @c NULL, if there are no
8539     * items in @p obj (and on errors)
8540     *
8541     * This returns the first item in the @p obj's internal list of
8542     * items.
8543     *
8544     * @see elm_gengrid_last_item_get()
8545     *
8546     * @ingroup Gengrid
8547     */
8548    EAPI Elm_Gengrid_Item  *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8549
8550    /**
8551     * Get the last item in a given gengrid widget
8552     *
8553     * @param obj The gengrid object
8554     * @return The last item's handle or @c NULL, if there are no
8555     * items in @p obj (and on errors)
8556     *
8557     * This returns the last item in the @p obj's internal list of
8558     * items.
8559     *
8560     * @see elm_gengrid_first_item_get()
8561     *
8562     * @ingroup Gengrid
8563     */
8564    EAPI Elm_Gengrid_Item  *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8565
8566    /**
8567     * Get the @b next item in a gengrid widget's internal list of items,
8568     * given a handle to one of those items.
8569     *
8570     * @param item The gengrid item to fetch next from
8571     * @return The item after @p item, or @c NULL if there's none (and
8572     * on errors)
8573     *
8574     * This returns the item placed after the @p item, on the container
8575     * gengrid.
8576     *
8577     * @see elm_gengrid_item_prev_get()
8578     *
8579     * @ingroup Gengrid
8580     */
8581    EAPI Elm_Gengrid_Item  *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8582
8583    /**
8584     * Get the @b previous item in a gengrid widget's internal list of items,
8585     * given a handle to one of those items.
8586     *
8587     * @param item The gengrid item to fetch previous from
8588     * @return The item before @p item, or @c NULL if there's none (and
8589     * on errors)
8590     *
8591     * This returns the item placed before the @p item, on the container
8592     * gengrid.
8593     *
8594     * @see elm_gengrid_item_next_get()
8595     *
8596     * @ingroup Gengrid
8597     */
8598    EAPI Elm_Gengrid_Item  *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8599
8600    /**
8601     * Get the gengrid object's handle which contains a given gengrid
8602     * item
8603     *
8604     * @param item The item to fetch the container from
8605     * @return The gengrid (parent) object
8606     *
8607     * This returns the gengrid object itself that an item belongs to.
8608     *
8609     * @ingroup Gengrid
8610     */
8611    EAPI Evas_Object       *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8612
8613    /**
8614     * Remove a gengrid item from the its parent, deleting it.
8615     *
8616     * @param item The item to be removed.
8617     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8618     *
8619     * @see elm_gengrid_clear(), to remove all items in a gengrid at
8620     * once.
8621     *
8622     * @ingroup Gengrid
8623     */
8624    EAPI void               elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8625
8626    /**
8627     * Update the contents of a given gengrid item
8628     *
8629     * @param item The gengrid item
8630     *
8631     * This updates an item by calling all the item class functions
8632     * again to get the icons, labels and states. Use this when the
8633     * original item data has changed and you want thta changes to be
8634     * reflected.
8635     *
8636     * @ingroup Gengrid
8637     */
8638    EAPI void               elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8639    EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8640    EAPI void               elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8641
8642    /**
8643     * Return the data associated to a given gengrid item
8644     *
8645     * @param item The gengrid item.
8646     * @return the data associated to this item.
8647     *
8648     * This returns the @c data value passed on the
8649     * elm_gengrid_item_append() and related item addition calls.
8650     *
8651     * @see elm_gengrid_item_append()
8652     * @see elm_gengrid_item_data_set()
8653     *
8654     * @ingroup Gengrid
8655     */
8656    EAPI void              *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8657
8658    /**
8659     * Set the data associated to a given gengrid item
8660     *
8661     * @param item The gengrid item
8662     * @param data The new data pointer to set on it
8663     *
8664     * This @b overrides the @c data value passed on the
8665     * elm_gengrid_item_append() and related item addition calls. This
8666     * function @b won't call elm_gengrid_item_update() automatically,
8667     * so you'd issue it afterwards if you want to hove the item
8668     * updated to reflect the that new data.
8669     *
8670     * @see elm_gengrid_item_data_get()
8671     *
8672     * @ingroup Gengrid
8673     */
8674    EAPI void               elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8675
8676    /**
8677     * Get a given gengrid item's position, relative to the whole
8678     * gengrid's grid area.
8679     *
8680     * @param item The Gengrid item.
8681     * @param x Pointer to variable where to store the item's <b>row
8682     * number</b>.
8683     * @param y Pointer to variable where to store the item's <b>column
8684     * number</b>.
8685     *
8686     * This returns the "logical" position of the item whithin the
8687     * gengrid. For example, @c (0, 1) would stand for first row,
8688     * second column.
8689     *
8690     * @ingroup Gengrid
8691     */
8692    EAPI void               elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
8693
8694    /**
8695     * Set whether a given gengrid item is selected or not
8696     *
8697     * @param item The gengrid item
8698     * @param selected Use @c EINA_TRUE, to make it selected, @c
8699     * EINA_FALSE to make it unselected
8700     *
8701     * This sets the selected state of an item. If multi selection is
8702     * not enabled on the containing gengrid and @p selected is @c
8703     * EINA_TRUE, any other previously selected items will get
8704     * unselected in favor of this new one.
8705     *
8706     * @see elm_gengrid_item_selected_get()
8707     *
8708     * @ingroup Gengrid
8709     */
8710    EAPI void               elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
8711
8712    /**
8713     * Get whether a given gengrid item is selected or not
8714     *
8715     * @param item The gengrid item
8716     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
8717     *
8718     * @see elm_gengrid_item_selected_set() for more details
8719     *
8720     * @ingroup Gengrid
8721     */
8722    EAPI Eina_Bool          elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8723
8724    /**
8725     * Get the real Evas object created to implement the view of a
8726     * given gengrid item
8727     *
8728     * @param item The gengrid item.
8729     * @return the Evas object implementing this item's view.
8730     *
8731     * This returns the actual Evas object used to implement the
8732     * specified gengrid item's view. This may be @c NULL, as it may
8733     * not have been created or may have been deleted, at any time, by
8734     * the gengrid. <b>Do not modify this object</b> (move, resize,
8735     * show, hide, etc.), as the gengrid is controlling it. This
8736     * function is for querying, emitting custom signals or hooking
8737     * lower level callbacks for events on that object. Do not delete
8738     * this object under any circumstances.
8739     *
8740     * @see elm_gengrid_item_data_get()
8741     *
8742     * @ingroup Gengrid
8743     */
8744    EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8745
8746    /**
8747     * Show the portion of a gengrid's internal grid containing a given
8748     * item, @b immediately.
8749     *
8750     * @param item The item to display
8751     *
8752     * This causes gengrid to @b redraw its viewport's contents to the
8753     * region contining the given @p item item, if it is not fully
8754     * visible.
8755     *
8756     * @see elm_gengrid_item_bring_in()
8757     *
8758     * @ingroup Gengrid
8759     */
8760    EAPI void               elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8761
8762    /**
8763     * Animatedly bring in, to the visible are of a gengrid, a given
8764     * item on it.
8765     *
8766     * @param item The gengrid item to display
8767     *
8768     * This causes gengrig to jump to the given @p item item and show
8769     * it (by scrolling), if it is not fully visible. This will use
8770     * animation to do so and take a period of time to complete.
8771     *
8772     * @see elm_gengrid_item_show()
8773     *
8774     * @ingroup Gengrid
8775     */
8776    EAPI void               elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8777
8778    /**
8779     * Set whether a given gengrid item is disabled or not.
8780     *
8781     * @param item The gengrid item
8782     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
8783     * to enable it back.
8784     *
8785     * A disabled item cannot be selected or unselected. It will also
8786     * change its appearance, to signal the user it's disabled.
8787     *
8788     * @see elm_gengrid_item_disabled_get()
8789     *
8790     * @ingroup Gengrid
8791     */
8792    EAPI void               elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8793
8794    /**
8795     * Get whether a given gengrid item is disabled or not.
8796     *
8797     * @param item The gengrid item
8798     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
8799     * (and on errors).
8800     *
8801     * @see elm_gengrid_item_disabled_set() for more details
8802     *
8803     * @ingroup Gengrid
8804     */
8805    EAPI Eina_Bool          elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8806
8807    /**
8808     * Set the text to be shown in a given gengrid item's tooltips.
8809     *
8810     * @param item The gengrid item
8811     * @param text The text to set in the content
8812     *
8813     * This call will setup the text to be used as tooltip to that item
8814     * (analogous to elm_object_tooltip_text_set(), but being item
8815     * tooltips with higher precedence than object tooltips). It can
8816     * have only one tooltip at a time, so any previous tooltip data
8817     * will get removed.
8818     *
8819     * @ingroup Gengrid
8820     */
8821    EAPI void               elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
8822
8823    /**
8824     * Set the content to be shown in a given gengrid item's tooltips
8825     *
8826     * @param item The gengrid item.
8827     * @param func The function returning the tooltip contents.
8828     * @param data What to provide to @a func as callback data/context.
8829     * @param del_cb Called when data is not needed anymore, either when
8830     *        another callback replaces @p func, the tooltip is unset with
8831     *        elm_gengrid_item_tooltip_unset() or the owner @p item
8832     *        dies. This callback receives as its first parameter the
8833     *        given @p data, being @c event_info the item handle.
8834     *
8835     * This call will setup the tooltip's contents to @p item
8836     * (analogous to elm_object_tooltip_content_cb_set(), but being
8837     * item tooltips with higher precedence than object tooltips). It
8838     * can have only one tooltip at a time, so any previous tooltip
8839     * content will get removed. @p func (with @p data) will be called
8840     * every time Elementary needs to show the tooltip and it should
8841     * return a valid Evas object, which will be fully managed by the
8842     * tooltip system, getting deleted when the tooltip is gone.
8843     *
8844     * @ingroup Gengrid
8845     */
8846    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);
8847
8848    /**
8849     * Unset a tooltip from a given gengrid item
8850     *
8851     * @param item gengrid item to remove a previously set tooltip from.
8852     *
8853     * This call removes any tooltip set on @p item. The callback
8854     * provided as @c del_cb to
8855     * elm_gengrid_item_tooltip_content_cb_set() will be called to
8856     * notify it is not used anymore (and have resources cleaned, if
8857     * need be).
8858     *
8859     * @see elm_gengrid_item_tooltip_content_cb_set()
8860     *
8861     * @ingroup Gengrid
8862     */
8863    EAPI void               elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8864
8865    /**
8866     * Set a different @b style for a given gengrid item's tooltip.
8867     *
8868     * @param item gengrid item with tooltip set
8869     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
8870     * "default", @c "transparent", etc)
8871     *
8872     * Tooltips can have <b>alternate styles</b> to be displayed on,
8873     * which are defined by the theme set on Elementary. This function
8874     * works analogously as elm_object_tooltip_style_set(), but here
8875     * applied only to gengrid item objects. The default style for
8876     * tooltips is @c "default".
8877     *
8878     * @note before you set a style you should define a tooltip with
8879     *       elm_gengrid_item_tooltip_content_cb_set() or
8880     *       elm_gengrid_item_tooltip_text_set()
8881     *
8882     * @see elm_gengrid_item_tooltip_style_get()
8883     *
8884     * @ingroup Gengrid
8885     */
8886    EAPI void               elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8887
8888    /**
8889     * Get the style set a given gengrid item's tooltip.
8890     *
8891     * @param item gengrid item with tooltip already set on.
8892     * @return style the theme style in use, which defaults to
8893     *         "default". If the object does not have a tooltip set,
8894     *         then @c NULL is returned.
8895     *
8896     * @see elm_gengrid_item_tooltip_style_set() for more details
8897     *
8898     * @ingroup Gengrid
8899     */
8900    EAPI const char        *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8901    /**
8902     * @brief Disable size restrictions on an object's tooltip
8903     * @param item The tooltip's anchor object
8904     * @param disable If EINA_TRUE, size restrictions are disabled
8905     * @return EINA_FALSE on failure, EINA_TRUE on success
8906     *
8907     * This function allows a tooltip to expand beyond its parant window's canvas.
8908     * It will instead be limited only by the size of the display.
8909     */
8910    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
8911    /**
8912     * @brief Retrieve size restriction state of an object's tooltip
8913     * @param item The tooltip's anchor object
8914     * @return If EINA_TRUE, size restrictions are disabled
8915     *
8916     * This function returns whether a tooltip is allowed to expand beyond
8917     * its parant window's canvas.
8918     * It will instead be limited only by the size of the display.
8919     */
8920    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
8921    /**
8922     * Set the type of mouse pointer/cursor decoration to be shown,
8923     * when the mouse pointer is over the given gengrid widget item
8924     *
8925     * @param item gengrid item to customize cursor on
8926     * @param cursor the cursor type's name
8927     *
8928     * This function works analogously as elm_object_cursor_set(), but
8929     * here the cursor's changing area is restricted to the item's
8930     * area, and not the whole widget's. Note that that item cursors
8931     * have precedence over widget cursors, so that a mouse over @p
8932     * item will always show cursor @p type.
8933     *
8934     * If this function is called twice for an object, a previously set
8935     * cursor will be unset on the second call.
8936     *
8937     * @see elm_object_cursor_set()
8938     * @see elm_gengrid_item_cursor_get()
8939     * @see elm_gengrid_item_cursor_unset()
8940     *
8941     * @ingroup Gengrid
8942     */
8943    EAPI void               elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
8944
8945    /**
8946     * Get the type of mouse pointer/cursor decoration set to be shown,
8947     * when the mouse pointer is over the given gengrid widget item
8948     *
8949     * @param item gengrid item with custom cursor set
8950     * @return the cursor type's name or @c NULL, if no custom cursors
8951     * were set to @p item (and on errors)
8952     *
8953     * @see elm_object_cursor_get()
8954     * @see elm_gengrid_item_cursor_set() for more details
8955     * @see elm_gengrid_item_cursor_unset()
8956     *
8957     * @ingroup Gengrid
8958     */
8959    EAPI const char        *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8960
8961    /**
8962     * Unset any custom mouse pointer/cursor decoration set to be
8963     * shown, when the mouse pointer is over the given gengrid widget
8964     * item, thus making it show the @b default cursor again.
8965     *
8966     * @param item a gengrid item
8967     *
8968     * Use this call to undo any custom settings on this item's cursor
8969     * decoration, bringing it back to defaults (no custom style set).
8970     *
8971     * @see elm_object_cursor_unset()
8972     * @see elm_gengrid_item_cursor_set() for more details
8973     *
8974     * @ingroup Gengrid
8975     */
8976    EAPI void               elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8977
8978    /**
8979     * Set a different @b style for a given custom cursor set for a
8980     * gengrid item.
8981     *
8982     * @param item gengrid item with custom cursor set
8983     * @param style the <b>theme style</b> to use (e.g. @c "default",
8984     * @c "transparent", etc)
8985     *
8986     * This function only makes sense when one is using custom mouse
8987     * cursor decorations <b>defined in a theme file</b> , which can
8988     * have, given a cursor name/type, <b>alternate styles</b> on
8989     * it. It works analogously as elm_object_cursor_style_set(), but
8990     * here applied only to gengrid item objects.
8991     *
8992     * @warning Before you set a cursor style you should have defined a
8993     *       custom cursor previously on the item, with
8994     *       elm_gengrid_item_cursor_set()
8995     *
8996     * @see elm_gengrid_item_cursor_engine_only_set()
8997     * @see elm_gengrid_item_cursor_style_get()
8998     *
8999     * @ingroup Gengrid
9000     */
9001    EAPI void               elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9002
9003    /**
9004     * Get the current @b style set for a given gengrid item's custom
9005     * cursor
9006     *
9007     * @param item gengrid item with custom cursor set.
9008     * @return style the cursor style in use. If the object does not
9009     *         have a cursor set, then @c NULL is returned.
9010     *
9011     * @see elm_gengrid_item_cursor_style_set() for more details
9012     *
9013     * @ingroup Gengrid
9014     */
9015    EAPI const char        *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9016
9017    /**
9018     * Set if the (custom) cursor for a given gengrid item should be
9019     * searched in its theme, also, or should only rely on the
9020     * rendering engine.
9021     *
9022     * @param item item with custom (custom) cursor already set on
9023     * @param engine_only Use @c EINA_TRUE to have cursors looked for
9024     * only on those provided by the rendering engine, @c EINA_FALSE to
9025     * have them searched on the widget's theme, as well.
9026     *
9027     * @note This call is of use only if you've set a custom cursor
9028     * for gengrid items, with elm_gengrid_item_cursor_set().
9029     *
9030     * @note By default, cursors will only be looked for between those
9031     * provided by the rendering engine.
9032     *
9033     * @ingroup Gengrid
9034     */
9035    EAPI void               elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9036
9037    /**
9038     * Get if the (custom) cursor for a given gengrid item is being
9039     * searched in its theme, also, or is only relying on the rendering
9040     * engine.
9041     *
9042     * @param item a gengrid item
9043     * @return @c EINA_TRUE, if cursors are being looked for only on
9044     * those provided by the rendering engine, @c EINA_FALSE if they
9045     * are being searched on the widget's theme, as well.
9046     *
9047     * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9048     *
9049     * @ingroup Gengrid
9050     */
9051    EAPI Eina_Bool          elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9052
9053    /**
9054     * Remove all items from a given gengrid widget
9055     *
9056     * @param obj The gengrid object.
9057     *
9058     * This removes (and deletes) all items in @p obj, leaving it
9059     * empty.
9060     *
9061     * @see elm_gengrid_item_del(), to remove just one item.
9062     *
9063     * @ingroup Gengrid
9064     */
9065    EAPI void               elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9066
9067    /**
9068     * Get the selected item in a given gengrid widget
9069     *
9070     * @param obj The gengrid object.
9071     * @return The selected item's handleor @c NULL, if none is
9072     * selected at the moment (and on errors)
9073     *
9074     * This returns the selected item in @p obj. If multi selection is
9075     * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9076     * the first item in the list is selected, which might not be very
9077     * useful. For that case, see elm_gengrid_selected_items_get().
9078     *
9079     * @ingroup Gengrid
9080     */
9081    EAPI Elm_Gengrid_Item  *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9082
9083    /**
9084     * Get <b>a list</b> of selected items in a given gengrid
9085     *
9086     * @param obj The gengrid object.
9087     * @return The list of selected items or @c NULL, if none is
9088     * selected at the moment (and on errors)
9089     *
9090     * This returns a list of the selected items, in the order that
9091     * they appear in the grid. This list is only valid as long as no
9092     * more items are selected or unselected (or unselected implictly
9093     * by deletion). The list contains #Elm_Gengrid_Item pointers as
9094     * data, naturally.
9095     *
9096     * @see elm_gengrid_selected_item_get()
9097     *
9098     * @ingroup Gengrid
9099     */
9100    EAPI const Eina_List   *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9101
9102    /**
9103     * @}
9104     */
9105
9106    /**
9107     * @defgroup Clock Clock
9108     *
9109     * @image html img/widget/clock/preview-00.png
9110     * @image latex img/widget/clock/preview-00.eps
9111     *
9112     * This is a @b digital clock widget. In its default theme, it has a
9113     * vintage "flipping numbers clock" appearance, which will animate
9114     * sheets of individual algarisms individually as time goes by.
9115     *
9116     * A newly created clock will fetch system's time (already
9117     * considering local time adjustments) to start with, and will tick
9118     * accondingly. It may or may not show seconds.
9119     *
9120     * Clocks have an @b edition mode. When in it, the sheets will
9121     * display extra arrow indications on the top and bottom and the
9122     * user may click on them to raise or lower the time values. After
9123     * it's told to exit edition mode, it will keep ticking with that
9124     * new time set (it keeps the difference from local time).
9125     *
9126     * Also, when under edition mode, user clicks on the cited arrows
9127     * which are @b held for some time will make the clock to flip the
9128     * sheet, thus editing the time, continuosly and automatically for
9129     * the user. The interval between sheet flips will keep growing in
9130     * time, so that it helps the user to reach a time which is distant
9131     * from the one set.
9132     *
9133     * The time display is, by default, in military mode (24h), but an
9134     * am/pm indicator may be optionally shown, too, when it will
9135     * switch to 12h.
9136     *
9137     * Smart callbacks one can register to:
9138     * - "changed" - the clock's user changed the time
9139     *
9140     * Here is an example on its usage:
9141     * @li @ref clock_example
9142     */
9143
9144    /**
9145     * @addtogroup Clock
9146     * @{
9147     */
9148
9149    /**
9150     * Identifiers for which clock digits should be editable, when a
9151     * clock widget is in edition mode. Values may be ORed together to
9152     * make a mask, naturally.
9153     *
9154     * @see elm_clock_edit_set()
9155     * @see elm_clock_digit_edit_set()
9156     */
9157    typedef enum _Elm_Clock_Digedit
9158      {
9159         ELM_CLOCK_NONE         = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9160         ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9161         ELM_CLOCK_HOUR_UNIT    = 1 << 1, /**< Unit algarism of hours value should be editable */
9162         ELM_CLOCK_MIN_DECIMAL  = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9163         ELM_CLOCK_MIN_UNIT     = 1 << 3, /**< Unit algarism of minutes value should be editable */
9164         ELM_CLOCK_SEC_DECIMAL  = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9165         ELM_CLOCK_SEC_UNIT     = 1 << 5, /**< Unit algarism of seconds value should be editable */
9166         ELM_CLOCK_ALL          = (1 << 6) - 1 /**< All digits should be editable */
9167      } Elm_Clock_Digedit;
9168
9169    /**
9170     * Add a new clock widget to the given parent Elementary
9171     * (container) object
9172     *
9173     * @param parent The parent object
9174     * @return a new clock widget handle or @c NULL, on errors
9175     *
9176     * This function inserts a new clock widget on the canvas.
9177     *
9178     * @ingroup Clock
9179     */
9180    EAPI Evas_Object      *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9181
9182    /**
9183     * Set a clock widget's time, programmatically
9184     *
9185     * @param obj The clock widget object
9186     * @param hrs The hours to set
9187     * @param min The minutes to set
9188     * @param sec The secondes to set
9189     *
9190     * This function updates the time that is showed by the clock
9191     * widget.
9192     *
9193     *  Values @b must be set within the following ranges:
9194     * - 0 - 23, for hours
9195     * - 0 - 59, for minutes
9196     * - 0 - 59, for seconds,
9197     *
9198     * even if the clock is not in "military" mode.
9199     *
9200     * @warning The behavior for values set out of those ranges is @b
9201     * indefined.
9202     *
9203     * @ingroup Clock
9204     */
9205    EAPI void              elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9206
9207    /**
9208     * Get a clock widget's time values
9209     *
9210     * @param obj The clock object
9211     * @param[out] hrs Pointer to the variable to get the hours value
9212     * @param[out] min Pointer to the variable to get the minutes value
9213     * @param[out] sec Pointer to the variable to get the seconds value
9214     *
9215     * This function gets the time set for @p obj, returning
9216     * it on the variables passed as the arguments to function
9217     *
9218     * @note Use @c NULL pointers on the time values you're not
9219     * interested in: they'll be ignored by the function.
9220     *
9221     * @ingroup Clock
9222     */
9223    EAPI void              elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9224
9225    /**
9226     * Set whether a given clock widget is under <b>edition mode</b> or
9227     * under (default) displaying-only mode.
9228     *
9229     * @param obj The clock object
9230     * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9231     * put it back to "displaying only" mode
9232     *
9233     * This function makes a clock's time to be editable or not <b>by
9234     * user interaction</b>. When in edition mode, clocks @b stop
9235     * ticking, until one brings them back to canonical mode. The
9236     * elm_clock_digit_edit_set() function will influence which digits
9237     * of the clock will be editable. By default, all of them will be
9238     * (#ELM_CLOCK_NONE).
9239     *
9240     * @note am/pm sheets, if being shown, will @b always be editable
9241     * under edition mode.
9242     *
9243     * @see elm_clock_edit_get()
9244     *
9245     * @ingroup Clock
9246     */
9247    EAPI void              elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9248
9249    /**
9250     * Retrieve whether a given clock widget is under <b>edition
9251     * mode</b> or under (default) displaying-only mode.
9252     *
9253     * @param obj The clock object
9254     * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9255     * otherwise
9256     *
9257     * This function retrieves whether the clock's time can be edited
9258     * or not by user interaction.
9259     *
9260     * @see elm_clock_edit_set() for more details
9261     *
9262     * @ingroup Clock
9263     */
9264    EAPI Eina_Bool         elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9265
9266    /**
9267     * Set what digits of the given clock widget should be editable
9268     * when in edition mode.
9269     *
9270     * @param obj The clock object
9271     * @param digedit Bit mask indicating the digits to be editable
9272     * (values in #Elm_Clock_Digedit).
9273     *
9274     * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9275     * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9276     * EINA_FALSE).
9277     *
9278     * @see elm_clock_digit_edit_get()
9279     *
9280     * @ingroup Clock
9281     */
9282    EAPI void              elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9283
9284    /**
9285     * Retrieve what digits of the given clock widget should be
9286     * editable when in edition mode.
9287     *
9288     * @param obj The clock object
9289     * @return Bit mask indicating the digits to be editable
9290     * (values in #Elm_Clock_Digedit).
9291     *
9292     * @see elm_clock_digit_edit_set() for more details
9293     *
9294     * @ingroup Clock
9295     */
9296    EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9297
9298    /**
9299     * Set if the given clock widget must show hours in military or
9300     * am/pm mode
9301     *
9302     * @param obj The clock object
9303     * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9304     * to military mode
9305     *
9306     * This function sets if the clock must show hours in military or
9307     * am/pm mode. In some countries like Brazil the military mode
9308     * (00-24h-format) is used, in opposition to the USA, where the
9309     * am/pm mode is more commonly used.
9310     *
9311     * @see elm_clock_show_am_pm_get()
9312     *
9313     * @ingroup Clock
9314     */
9315    EAPI void              elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9316
9317    /**
9318     * Get if the given clock widget shows hours in military or am/pm
9319     * mode
9320     *
9321     * @param obj The clock object
9322     * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9323     * military
9324     *
9325     * This function gets if the clock shows hours in military or am/pm
9326     * mode.
9327     *
9328     * @see elm_clock_show_am_pm_set() for more details
9329     *
9330     * @ingroup Clock
9331     */
9332    EAPI Eina_Bool         elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9333
9334    /**
9335     * Set if the given clock widget must show time with seconds or not
9336     *
9337     * @param obj The clock object
9338     * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9339     *
9340     * This function sets if the given clock must show or not elapsed
9341     * seconds. By default, they are @b not shown.
9342     *
9343     * @see elm_clock_show_seconds_get()
9344     *
9345     * @ingroup Clock
9346     */
9347    EAPI void              elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9348
9349    /**
9350     * Get whether the given clock widget is showing time with seconds
9351     * or not
9352     *
9353     * @param obj The clock object
9354     * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9355     *
9356     * This function gets whether @p obj is showing or not the elapsed
9357     * seconds.
9358     *
9359     * @see elm_clock_show_seconds_set()
9360     *
9361     * @ingroup Clock
9362     */
9363    EAPI Eina_Bool         elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9364
9365    /**
9366     * Set the interval on time updates for an user mouse button hold
9367     * on clock widgets' time edition.
9368     *
9369     * @param obj The clock object
9370     * @param interval The (first) interval value in seconds
9371     *
9372     * This interval value is @b decreased while the user holds the
9373     * mouse pointer either incrementing or decrementing a given the
9374     * clock digit's value.
9375     *
9376     * This helps the user to get to a given time distant from the
9377     * current one easier/faster, as it will start to flip quicker and
9378     * quicker on mouse button holds.
9379     *
9380     * The calculation for the next flip interval value, starting from
9381     * the one set with this call, is the previous interval divided by
9382     * 1.05, so it decreases a little bit.
9383     *
9384     * The default starting interval value for automatic flips is
9385     * @b 0.85 seconds.
9386     *
9387     * @see elm_clock_interval_get()
9388     *
9389     * @ingroup Clock
9390     */
9391    EAPI void              elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9392
9393    /**
9394     * Get the interval on time updates for an user mouse button hold
9395     * on clock widgets' time edition.
9396     *
9397     * @param obj The clock object
9398     * @return The (first) interval value, in seconds, set on it
9399     *
9400     * @see elm_clock_interval_set() for more details
9401     *
9402     * @ingroup Clock
9403     */
9404    EAPI double            elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9405
9406    /**
9407     * @}
9408     */
9409
9410    /**
9411     * @defgroup Layout Layout
9412     *
9413     * @image html img/widget/layout/preview-00.png
9414     * @image latex img/widget/layout/preview-00.eps width=\textwidth
9415     *
9416     * @image html img/layout-predefined.png
9417     * @image latex img/layout-predefined.eps width=\textwidth
9418     *
9419     * This is a container widget that takes a standard Edje design file and
9420     * wraps it very thinly in a widget.
9421     *
9422     * An Edje design (theme) file has a very wide range of possibilities to
9423     * describe the behavior of elements added to the Layout. Check out the Edje
9424     * documentation and the EDC reference to get more information about what can
9425     * be done with Edje.
9426     *
9427     * Just like @ref List, @ref Box, and other container widgets, any
9428     * object added to the Layout will become its child, meaning that it will be
9429     * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9430     *
9431     * The Layout widget can contain as many Contents, Boxes or Tables as
9432     * described in its theme file. For instance, objects can be added to
9433     * different Tables by specifying the respective Table part names. The same
9434     * is valid for Content and Box.
9435     *
9436     * The objects added as child of the Layout will behave as described in the
9437     * part description where they were added. There are 3 possible types of
9438     * parts where a child can be added:
9439     *
9440     * @section secContent Content (SWALLOW part)
9441     *
9442     * Only one object can be added to the @c SWALLOW part (but you still can
9443     * have many @c SWALLOW parts and one object on each of them). Use the @c
9444     * elm_layout_content_* set of functions to set, retrieve and unset objects
9445     * as content of the @c SWALLOW. After being set to this part, the object
9446     * size, position, visibility, clipping and other description properties
9447     * will be totally controled by the description of the given part (inside
9448     * the Edje theme file).
9449     *
9450     * One can use @c evas_object_size_hint_* functions on the child to have some
9451     * kind of control over its behavior, but the resulting behavior will still
9452     * depend heavily on the @c SWALLOW part description.
9453     *
9454     * The Edje theme also can change the part description, based on signals or
9455     * scripts running inside the theme. This change can also be animated. All of
9456     * this will affect the child object set as content accordingly. The object
9457     * size will be changed if the part size is changed, it will animate move if
9458     * the part is moving, and so on.
9459     *
9460     * The following picture demonstrates a Layout widget with a child object
9461     * added to its @c SWALLOW:
9462     *
9463     * @image html layout_swallow.png
9464     * @image latex layout_swallow.eps width=\textwidth
9465     *
9466     * @section secBox Box (BOX part)
9467     *
9468     * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9469     * allows one to add objects to the box and have them distributed along its
9470     * area, accordingly to the specified @a layout property (now by @a layout we
9471     * mean the chosen layouting design of the Box, not the Layout widget
9472     * itself).
9473     *
9474     * A similar effect for having a box with its position, size and other things
9475     * controled by the Layout theme would be to create an Elementary @ref Box
9476     * widget and add it as a Content in the @c SWALLOW part.
9477     *
9478     * The main difference of using the Layout Box is that its behavior, the box
9479     * properties like layouting format, padding, align, etc. will be all
9480     * controled by the theme. This means, for example, that a signal could be
9481     * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9482     * handled the signal by changing the box padding, or align, or both. Using
9483     * the Elementary @ref Box widget is not necessarily harder or easier, it
9484     * just depends on the circunstances and requirements.
9485     *
9486     * The Layout Box can be used through the @c elm_layout_box_* set of
9487     * functions.
9488     *
9489     * The following picture demonstrates a Layout widget with many child objects
9490     * added to its @c BOX part:
9491     *
9492     * @image html layout_box.png
9493     * @image latex layout_box.eps width=\textwidth
9494     *
9495     * @section secTable Table (TABLE part)
9496     *
9497     * Just like the @ref secBox, the Layout Table is very similar to the
9498     * Elementary @ref Table widget. It allows one to add objects to the Table
9499     * specifying the row and column where the object should be added, and any
9500     * column or row span if necessary.
9501     *
9502     * Again, we could have this design by adding a @ref Table widget to the @c
9503     * SWALLOW part using elm_layout_content_set(). The same difference happens
9504     * here when choosing to use the Layout Table (a @c TABLE part) instead of
9505     * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9506     *
9507     * The Layout Table can be used through the @c elm_layout_table_* set of
9508     * functions.
9509     *
9510     * The following picture demonstrates a Layout widget with many child objects
9511     * added to its @c TABLE part:
9512     *
9513     * @image html layout_table.png
9514     * @image latex layout_table.eps width=\textwidth
9515     *
9516     * @section secPredef Predefined Layouts
9517     *
9518     * Another interesting thing about the Layout widget is that it offers some
9519     * predefined themes that come with the default Elementary theme. These
9520     * themes can be set by the call elm_layout_theme_set(), and provide some
9521     * basic functionality depending on the theme used.
9522     *
9523     * Most of them already send some signals, some already provide a toolbar or
9524     * back and next buttons.
9525     *
9526     * These are available predefined theme layouts. All of them have class = @c
9527     * layout, group = @c application, and style = one of the following options:
9528     *
9529     * @li @c toolbar-content - application with toolbar and main content area
9530     * @li @c toolbar-content-back - application with toolbar and main content
9531     * area with a back button and title area
9532     * @li @c toolbar-content-back-next - application with toolbar and main
9533     * content area with a back and next buttons and title area
9534     * @li @c content-back - application with a main content area with a back
9535     * button and title area
9536     * @li @c content-back-next - application with a main content area with a
9537     * back and next buttons and title area
9538     * @li @c toolbar-vbox - application with toolbar and main content area as a
9539     * vertical box
9540     * @li @c toolbar-table - application with toolbar and main content area as a
9541     * table
9542     *
9543     * @section secExamples Examples
9544     *
9545     * Some examples of the Layout widget can be found here:
9546     * @li @ref layout_example_01
9547     * @li @ref layout_example_02
9548     * @li @ref layout_example_03
9549     * @li @ref layout_example_edc
9550     *
9551     */
9552
9553    /**
9554     * Add a new layout to the parent
9555     *
9556     * @param parent The parent object
9557     * @return The new object or NULL if it cannot be created
9558     *
9559     * @see elm_layout_file_set()
9560     * @see elm_layout_theme_set()
9561     *
9562     * @ingroup Layout
9563     */
9564    EAPI Evas_Object       *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9565    /**
9566     * Set the file that will be used as layout
9567     *
9568     * @param obj The layout object
9569     * @param file The path to file (edj) that will be used as layout
9570     * @param group The group that the layout belongs in edje file
9571     *
9572     * @return (1 = success, 0 = error)
9573     *
9574     * @ingroup Layout
9575     */
9576    EAPI Eina_Bool          elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9577    /**
9578     * Set the edje group from the elementary theme that will be used as layout
9579     *
9580     * @param obj The layout object
9581     * @param clas the clas of the group
9582     * @param group the group
9583     * @param style the style to used
9584     *
9585     * @return (1 = success, 0 = error)
9586     *
9587     * @ingroup Layout
9588     */
9589    EAPI Eina_Bool          elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9590    /**
9591     * Set the layout content.
9592     *
9593     * @param obj The layout object
9594     * @param swallow The swallow part name in the edje file
9595     * @param content The child that will be added in this layout object
9596     *
9597     * Once the content object is set, a previously set one will be deleted.
9598     * If you want to keep that old content object, use the
9599     * elm_layout_content_unset() function.
9600     *
9601     * @note In an Edje theme, the part used as a content container is called @c
9602     * SWALLOW. This is why the parameter name is called @p swallow, but it is
9603     * expected to be a part name just like the second parameter of
9604     * elm_layout_box_append().
9605     *
9606     * @see elm_layout_box_append()
9607     * @see elm_layout_content_get()
9608     * @see elm_layout_content_unset()
9609     * @see @ref secBox
9610     *
9611     * @ingroup Layout
9612     */
9613    EAPI void               elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9614    /**
9615     * Get the child object in the given content part.
9616     *
9617     * @param obj The layout object
9618     * @param swallow The SWALLOW part to get its content
9619     *
9620     * @return The swallowed object or NULL if none or an error occurred
9621     *
9622     * @see elm_layout_content_set()
9623     *
9624     * @ingroup Layout
9625     */
9626    EAPI Evas_Object       *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9627    /**
9628     * Unset the layout content.
9629     *
9630     * @param obj The layout object
9631     * @param swallow The swallow part name in the edje file
9632     * @return The content that was being used
9633     *
9634     * Unparent and return the content object which was set for this part.
9635     *
9636     * @see elm_layout_content_set()
9637     *
9638     * @ingroup Layout
9639     */
9640     EAPI Evas_Object       *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9641    /**
9642     * Set the text of the given part
9643     *
9644     * @param obj The layout object
9645     * @param part The TEXT part where to set the text
9646     * @param text The text to set
9647     *
9648     * @ingroup Layout
9649     * @deprecated use elm_object_text_* instead.
9650     */
9651    EINA_DEPRECATED EAPI void               elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9652    /**
9653     * Get the text set in the given part
9654     *
9655     * @param obj The layout object
9656     * @param part The TEXT part to retrieve the text off
9657     *
9658     * @return The text set in @p part
9659     *
9660     * @ingroup Layout
9661     * @deprecated use elm_object_text_* instead.
9662     */
9663    EINA_DEPRECATED EAPI const char        *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9664    /**
9665     * Append child to layout box part.
9666     *
9667     * @param obj the layout object
9668     * @param part the box part to which the object will be appended.
9669     * @param child the child object to append to box.
9670     *
9671     * Once the object is appended, it will become child of the layout. Its
9672     * lifetime will be bound to the layout, whenever the layout dies the child
9673     * will be deleted automatically. One should use elm_layout_box_remove() to
9674     * make this layout forget about the object.
9675     *
9676     * @see elm_layout_box_prepend()
9677     * @see elm_layout_box_insert_before()
9678     * @see elm_layout_box_insert_at()
9679     * @see elm_layout_box_remove()
9680     *
9681     * @ingroup Layout
9682     */
9683    EAPI void               elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9684    /**
9685     * Prepend child to layout box part.
9686     *
9687     * @param obj the layout object
9688     * @param part the box part to prepend.
9689     * @param child the child object to prepend to box.
9690     *
9691     * Once the object is prepended, it will become child of the layout. Its
9692     * lifetime will be bound to the layout, whenever the layout dies the child
9693     * will be deleted automatically. One should use elm_layout_box_remove() to
9694     * make this layout forget about the object.
9695     *
9696     * @see elm_layout_box_append()
9697     * @see elm_layout_box_insert_before()
9698     * @see elm_layout_box_insert_at()
9699     * @see elm_layout_box_remove()
9700     *
9701     * @ingroup Layout
9702     */
9703    EAPI void               elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9704    /**
9705     * Insert child to layout box part before a reference object.
9706     *
9707     * @param obj the layout object
9708     * @param part the box part to insert.
9709     * @param child the child object to insert into box.
9710     * @param reference another reference object to insert before in box.
9711     *
9712     * Once the object is inserted, it will become child of the layout. Its
9713     * lifetime will be bound to the layout, whenever the layout dies the child
9714     * will be deleted automatically. One should use elm_layout_box_remove() to
9715     * make this layout forget about the object.
9716     *
9717     * @see elm_layout_box_append()
9718     * @see elm_layout_box_prepend()
9719     * @see elm_layout_box_insert_before()
9720     * @see elm_layout_box_remove()
9721     *
9722     * @ingroup Layout
9723     */
9724    EAPI void               elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
9725    /**
9726     * Insert child to layout box part at a given position.
9727     *
9728     * @param obj the layout object
9729     * @param part the box part to insert.
9730     * @param child the child object to insert into box.
9731     * @param pos the numeric position >=0 to insert the child.
9732     *
9733     * Once the object is inserted, it will become child of the layout. Its
9734     * lifetime will be bound to the layout, whenever the layout dies the child
9735     * will be deleted automatically. One should use elm_layout_box_remove() to
9736     * make this layout forget about the object.
9737     *
9738     * @see elm_layout_box_append()
9739     * @see elm_layout_box_prepend()
9740     * @see elm_layout_box_insert_before()
9741     * @see elm_layout_box_remove()
9742     *
9743     * @ingroup Layout
9744     */
9745    EAPI void               elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
9746    /**
9747     * Remove a child of the given part box.
9748     *
9749     * @param obj The layout object
9750     * @param part The box part name to remove child.
9751     * @param child The object to remove from box.
9752     * @return The object that was being used, or NULL if not found.
9753     *
9754     * The object will be removed from the box part and its lifetime will
9755     * not be handled by the layout anymore. This is equivalent to
9756     * elm_layout_content_unset() for box.
9757     *
9758     * @see elm_layout_box_append()
9759     * @see elm_layout_box_remove_all()
9760     *
9761     * @ingroup Layout
9762     */
9763    EAPI Evas_Object       *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
9764    /**
9765     * Remove all child of the given part box.
9766     *
9767     * @param obj The layout object
9768     * @param part The box part name to remove child.
9769     * @param clear If EINA_TRUE, then all objects will be deleted as
9770     *        well, otherwise they will just be removed and will be
9771     *        dangling on the canvas.
9772     *
9773     * The objects will be removed from the box part and their lifetime will
9774     * not be handled by the layout anymore. This is equivalent to
9775     * elm_layout_box_remove() for all box children.
9776     *
9777     * @see elm_layout_box_append()
9778     * @see elm_layout_box_remove()
9779     *
9780     * @ingroup Layout
9781     */
9782    EAPI void               elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9783    /**
9784     * Insert child to layout table part.
9785     *
9786     * @param obj the layout object
9787     * @param part the box part to pack child.
9788     * @param child_obj the child object to pack into table.
9789     * @param col the column to which the child should be added. (>= 0)
9790     * @param row the row to which the child should be added. (>= 0)
9791     * @param colspan how many columns should be used to store this object. (>=
9792     *        1)
9793     * @param rowspan how many rows should be used to store this object. (>= 1)
9794     *
9795     * Once the object is inserted, it will become child of the table. Its
9796     * lifetime will be bound to the layout, and whenever the layout dies the
9797     * child will be deleted automatically. One should use
9798     * elm_layout_table_remove() to make this layout forget about the object.
9799     *
9800     * If @p colspan or @p rowspan are bigger than 1, that object will occupy
9801     * more space than a single cell. For instance, the following code:
9802     * @code
9803     * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
9804     * @endcode
9805     *
9806     * Would result in an object being added like the following picture:
9807     *
9808     * @image html layout_colspan.png
9809     * @image latex layout_colspan.eps width=\textwidth
9810     *
9811     * @see elm_layout_table_unpack()
9812     * @see elm_layout_table_clear()
9813     *
9814     * @ingroup Layout
9815     */
9816    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);
9817    /**
9818     * Unpack (remove) a child of the given part table.
9819     *
9820     * @param obj The layout object
9821     * @param part The table part name to remove child.
9822     * @param child_obj The object to remove from table.
9823     * @return The object that was being used, or NULL if not found.
9824     *
9825     * The object will be unpacked from the table part and its lifetime
9826     * will not be handled by the layout anymore. This is equivalent to
9827     * elm_layout_content_unset() for table.
9828     *
9829     * @see elm_layout_table_pack()
9830     * @see elm_layout_table_clear()
9831     *
9832     * @ingroup Layout
9833     */
9834    EAPI Evas_Object       *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
9835    /**
9836     * Remove all child of the given part table.
9837     *
9838     * @param obj The layout object
9839     * @param part The table part name to remove child.
9840     * @param clear If EINA_TRUE, then all objects will be deleted as
9841     *        well, otherwise they will just be removed and will be
9842     *        dangling on the canvas.
9843     *
9844     * The objects will be removed from the table part and their lifetime will
9845     * not be handled by the layout anymore. This is equivalent to
9846     * elm_layout_table_unpack() for all table children.
9847     *
9848     * @see elm_layout_table_pack()
9849     * @see elm_layout_table_unpack()
9850     *
9851     * @ingroup Layout
9852     */
9853    EAPI void               elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9854    /**
9855     * Get the edje layout
9856     *
9857     * @param obj The layout object
9858     *
9859     * @return A Evas_Object with the edje layout settings loaded
9860     * with function elm_layout_file_set
9861     *
9862     * This returns the edje object. It is not expected to be used to then
9863     * swallow objects via edje_object_part_swallow() for example. Use
9864     * elm_layout_content_set() instead so child object handling and sizing is
9865     * done properly.
9866     *
9867     * @note This function should only be used if you really need to call some
9868     * low level Edje function on this edje object. All the common stuff (setting
9869     * text, emitting signals, hooking callbacks to signals, etc.) can be done
9870     * with proper elementary functions.
9871     *
9872     * @see elm_object_signal_callback_add()
9873     * @see elm_object_signal_emit()
9874     * @see elm_object_text_part_set()
9875     * @see elm_layout_content_set()
9876     * @see elm_layout_box_append()
9877     * @see elm_layout_table_pack()
9878     * @see elm_layout_data_get()
9879     *
9880     * @ingroup Layout
9881     */
9882    EAPI Evas_Object       *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9883    /**
9884     * Get the edje data from the given layout
9885     *
9886     * @param obj The layout object
9887     * @param key The data key
9888     *
9889     * @return The edje data string
9890     *
9891     * This function fetches data specified inside the edje theme of this layout.
9892     * This function return NULL if data is not found.
9893     *
9894     * In EDC this comes from a data block within the group block that @p
9895     * obj was loaded from. E.g.
9896     *
9897     * @code
9898     * collections {
9899     *   group {
9900     *     name: "a_group";
9901     *     data {
9902     *       item: "key1" "value1";
9903     *       item: "key2" "value2";
9904     *     }
9905     *   }
9906     * }
9907     * @endcode
9908     *
9909     * @ingroup Layout
9910     */
9911    EAPI const char        *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
9912    /**
9913     * Eval sizing
9914     *
9915     * @param obj The layout object
9916     *
9917     * Manually forces a sizing re-evaluation. This is useful when the minimum
9918     * size required by the edje theme of this layout has changed. The change on
9919     * the minimum size required by the edje theme is not immediately reported to
9920     * the elementary layout, so one needs to call this function in order to tell
9921     * the widget (layout) that it needs to reevaluate its own size.
9922     *
9923     * The minimum size of the theme is calculated based on minimum size of
9924     * parts, the size of elements inside containers like box and table, etc. All
9925     * of this can change due to state changes, and that's when this function
9926     * should be called.
9927     *
9928     * Also note that a standard signal of "size,eval" "elm" emitted from the
9929     * edje object will cause this to happen too.
9930     *
9931     * @ingroup Layout
9932     */
9933    EAPI void               elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
9934
9935    /**
9936     * Sets a specific cursor for an edje part.
9937     *
9938     * @param obj The layout object.
9939     * @param part_name a part from loaded edje group.
9940     * @param cursor cursor name to use, see Elementary_Cursor.h
9941     *
9942     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9943     *         part not exists or it has "mouse_events: 0".
9944     *
9945     * @ingroup Layout
9946     */
9947    EAPI Eina_Bool          elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
9948
9949    /**
9950     * Get the cursor to be shown when mouse is over an edje part
9951     *
9952     * @param obj The layout object.
9953     * @param part_name a part from loaded edje group.
9954     * @return the cursor name.
9955     *
9956     * @ingroup Layout
9957     */
9958    EAPI const char        *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9959
9960    /**
9961     * Unsets a cursor previously set with elm_layout_part_cursor_set().
9962     *
9963     * @param obj The layout object.
9964     * @param part_name a part from loaded edje group, that had a cursor set
9965     *        with elm_layout_part_cursor_set().
9966     *
9967     * @ingroup Layout
9968     */
9969    EAPI void               elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9970
9971    /**
9972     * Sets a specific cursor style for an edje part.
9973     *
9974     * @param obj The layout object.
9975     * @param part_name a part from loaded edje group.
9976     * @param style the theme style to use (default, transparent, ...)
9977     *
9978     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9979     *         part not exists or it did not had a cursor set.
9980     *
9981     * @ingroup Layout
9982     */
9983    EAPI Eina_Bool          elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
9984
9985    /**
9986     * Gets a specific cursor style for an edje part.
9987     *
9988     * @param obj The layout object.
9989     * @param part_name a part from loaded edje group.
9990     *
9991     * @return the theme style in use, defaults to "default". If the
9992     *         object does not have a cursor set, then NULL is returned.
9993     *
9994     * @ingroup Layout
9995     */
9996    EAPI const char        *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9997
9998    /**
9999     * Sets if the cursor set should be searched on the theme or should use
10000     * the provided by the engine, only.
10001     *
10002     * @note before you set if should look on theme you should define a
10003     * cursor with elm_layout_part_cursor_set(). By default it will only
10004     * look for cursors provided by the engine.
10005     *
10006     * @param obj The layout object.
10007     * @param part_name a part from loaded edje group.
10008     * @param engine_only if cursors should be just provided by the engine
10009     *        or should also search on widget's theme as well
10010     *
10011     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10012     *         part not exists or it did not had a cursor set.
10013     *
10014     * @ingroup Layout
10015     */
10016    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);
10017
10018    /**
10019     * Gets a specific cursor engine_only for an edje part.
10020     *
10021     * @param obj The layout object.
10022     * @param part_name a part from loaded edje group.
10023     *
10024     * @return whenever the cursor is just provided by engine or also from theme.
10025     *
10026     * @ingroup Layout
10027     */
10028    EAPI Eina_Bool          elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10029
10030 /**
10031  * @def elm_layout_icon_set
10032  * Convienience macro to set the icon object in a layout that follows the
10033  * Elementary naming convention for its parts.
10034  *
10035  * @ingroup Layout
10036  */
10037 #define elm_layout_icon_set(_ly, _obj) \
10038   do { \
10039     const char *sig; \
10040     elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
10041     if ((_obj)) sig = "elm,state,icon,visible"; \
10042     else sig = "elm,state,icon,hidden"; \
10043     elm_object_signal_emit((_ly), sig, "elm"); \
10044   } while (0)
10045
10046 /**
10047  * @def elm_layout_icon_get
10048  * Convienience macro to get the icon object from a layout that follows the
10049  * Elementary naming convention for its parts.
10050  *
10051  * @ingroup Layout
10052  */
10053 #define elm_layout_icon_get(_ly) \
10054   elm_layout_content_get((_ly), "elm.swallow.icon")
10055
10056 /**
10057  * @def elm_layout_end_set
10058  * Convienience macro to set the end object in a layout that follows the
10059  * Elementary naming convention for its parts.
10060  *
10061  * @ingroup Layout
10062  */
10063 #define elm_layout_end_set(_ly, _obj) \
10064   do { \
10065     const char *sig; \
10066     elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
10067     if ((_obj)) sig = "elm,state,end,visible"; \
10068     else sig = "elm,state,end,hidden"; \
10069     elm_object_signal_emit((_ly), sig, "elm"); \
10070   } while (0)
10071
10072 /**
10073  * @def elm_layout_end_get
10074  * Convienience macro to get the end object in a layout that follows the
10075  * Elementary naming convention for its parts.
10076  *
10077  * @ingroup Layout
10078  */
10079 #define elm_layout_end_get(_ly) \
10080   elm_layout_content_get((_ly), "elm.swallow.end")
10081
10082 /**
10083  * @def elm_layout_label_set
10084  * Convienience macro to set the label in a layout that follows the
10085  * Elementary naming convention for its parts.
10086  *
10087  * @ingroup Layout
10088  * @deprecated use elm_object_text_* instead.
10089  */
10090 #define elm_layout_label_set(_ly, _txt) \
10091   elm_layout_text_set((_ly), "elm.text", (_txt))
10092
10093 /**
10094  * @def elm_layout_label_get
10095  * Convienience macro to get the label in a layout that follows the
10096  * Elementary naming convention for its parts.
10097  *
10098  * @ingroup Layout
10099  * @deprecated use elm_object_text_* instead.
10100  */
10101 #define elm_layout_label_get(_ly) \
10102   elm_layout_text_get((_ly), "elm.text")
10103
10104    /* smart callbacks called:
10105     * "theme,changed" - when elm theme is changed.
10106     */
10107
10108    /**
10109     * @defgroup Notify Notify
10110     *
10111     * @image html img/widget/notify/preview-00.png
10112     * @image latex img/widget/notify/preview-00.eps
10113     *
10114     * Display a container in a particular region of the parent(top, bottom,
10115     * etc.  A timeout can be set to automatically hide the notify. This is so
10116     * that, after an evas_object_show() on a notify object, if a timeout was set
10117     * on it, it will @b automatically get hidden after that time.
10118     *
10119     * Signals that you can add callbacks for are:
10120     * @li "timeout" - when timeout happens on notify and it's hidden
10121     * @li "block,clicked" - when a click outside of the notify happens
10122     *
10123     * @ref tutorial_notify show usage of the API.
10124     *
10125     * @{
10126     */
10127    /**
10128     * @brief Possible orient values for notify.
10129     *
10130     * This values should be used in conjunction to elm_notify_orient_set() to
10131     * set the position in which the notify should appear(relative to its parent)
10132     * and in conjunction with elm_notify_orient_get() to know where the notify
10133     * is appearing.
10134     */
10135    typedef enum _Elm_Notify_Orient
10136      {
10137         ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10138         ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10139         ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10140         ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10141         ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10142         ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10143         ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10144         ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10145         ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10146         ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10147      } Elm_Notify_Orient;
10148    /**
10149     * @brief Add a new notify to the parent
10150     *
10151     * @param parent The parent object
10152     * @return The new object or NULL if it cannot be created
10153     */
10154    EAPI Evas_Object      *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10155    /**
10156     * @brief Set the content of the notify widget
10157     *
10158     * @param obj The notify object
10159     * @param content The content will be filled in this notify object
10160     *
10161     * Once the content object is set, a previously set one will be deleted. If
10162     * you want to keep that old content object, use the
10163     * elm_notify_content_unset() function.
10164     */
10165    EAPI void              elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10166    /**
10167     * @brief Unset the content of the notify widget
10168     *
10169     * @param obj The notify object
10170     * @return The content that was being used
10171     *
10172     * Unparent and return the content object which was set for this widget
10173     *
10174     * @see elm_notify_content_set()
10175     */
10176    EAPI Evas_Object      *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10177    /**
10178     * @brief Return the content of the notify widget
10179     *
10180     * @param obj The notify object
10181     * @return The content that is being used
10182     *
10183     * @see elm_notify_content_set()
10184     */
10185    EAPI Evas_Object      *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10186    /**
10187     * @brief Set the notify parent
10188     *
10189     * @param obj The notify object
10190     * @param content The new parent
10191     *
10192     * Once the parent object is set, a previously set one will be disconnected
10193     * and replaced.
10194     */
10195    EAPI void              elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10196    /**
10197     * @brief Get the notify parent
10198     *
10199     * @param obj The notify object
10200     * @return The parent
10201     *
10202     * @see elm_notify_parent_set()
10203     */
10204    EAPI Evas_Object      *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10205    /**
10206     * @brief Set the orientation
10207     *
10208     * @param obj The notify object
10209     * @param orient The new orientation
10210     *
10211     * Sets the position in which the notify will appear in its parent.
10212     *
10213     * @see @ref Elm_Notify_Orient for possible values.
10214     */
10215    EAPI void              elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10216    /**
10217     * @brief Return the orientation
10218     * @param obj The notify object
10219     * @return The orientation of the notification
10220     *
10221     * @see elm_notify_orient_set()
10222     * @see Elm_Notify_Orient
10223     */
10224    EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10225    /**
10226     * @brief Set the time interval after which the notify window is going to be
10227     * hidden.
10228     *
10229     * @param obj The notify object
10230     * @param time The timeout in seconds
10231     *
10232     * This function sets a timeout and starts the timer controlling when the
10233     * notify is hidden. Since calling evas_object_show() on a notify restarts
10234     * the timer controlling when the notify is hidden, setting this before the
10235     * notify is shown will in effect mean starting the timer when the notify is
10236     * shown.
10237     *
10238     * @note Set a value <= 0.0 to disable a running timer.
10239     *
10240     * @note If the value > 0.0 and the notify is previously visible, the
10241     * timer will be started with this value, canceling any running timer.
10242     */
10243    EAPI void              elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10244    /**
10245     * @brief Return the timeout value (in seconds)
10246     * @param obj the notify object
10247     *
10248     * @see elm_notify_timeout_set()
10249     */
10250    EAPI double            elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10251    /**
10252     * @brief Sets whether events should be passed to by a click outside
10253     * its area.
10254     *
10255     * @param obj The notify object
10256     * @param repeats EINA_TRUE Events are repeats, else no
10257     *
10258     * When true if the user clicks outside the window the events will be caught
10259     * by the others widgets, else the events are blocked.
10260     *
10261     * @note The default value is EINA_TRUE.
10262     */
10263    EAPI void              elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10264    /**
10265     * @brief Return true if events are repeat below the notify object
10266     * @param obj the notify object
10267     *
10268     * @see elm_notify_repeat_events_set()
10269     */
10270    EAPI Eina_Bool         elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10271    /**
10272     * @}
10273     */
10274
10275    /**
10276     * @defgroup Hover Hover
10277     *
10278     * @image html img/widget/hover/preview-00.png
10279     * @image latex img/widget/hover/preview-00.eps
10280     *
10281     * A Hover object will hover over its @p parent object at the @p target
10282     * location. Anything in the background will be given a darker coloring to
10283     * indicate that the hover object is on top (at the default theme). When the
10284     * hover is clicked it is dismissed(hidden), if the contents of the hover are
10285     * clicked that @b doesn't cause the hover to be dismissed.
10286     *
10287     * @note The hover object will take up the entire space of @p target
10288     * object.
10289     *
10290     * Elementary has the following styles for the hover widget:
10291     * @li default
10292     * @li popout
10293     * @li menu
10294     * @li hoversel_vertical
10295     *
10296     * The following are the available position for content:
10297     * @li left
10298     * @li top-left
10299     * @li top
10300     * @li top-right
10301     * @li right
10302     * @li bottom-right
10303     * @li bottom
10304     * @li bottom-left
10305     * @li middle
10306     * @li smart
10307     *
10308     * Signals that you can add callbacks for are:
10309     * @li "clicked" - the user clicked the empty space in the hover to dismiss
10310     * @li "smart,changed" - a content object placed under the "smart"
10311     *                   policy was replaced to a new slot direction.
10312     *
10313     * See @ref tutorial_hover for more information.
10314     *
10315     * @{
10316     */
10317    typedef enum _Elm_Hover_Axis
10318      {
10319         ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10320         ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10321         ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10322         ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10323      } Elm_Hover_Axis;
10324    /**
10325     * @brief Adds a hover object to @p parent
10326     *
10327     * @param parent The parent object
10328     * @return The hover object or NULL if one could not be created
10329     */
10330    EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10331    /**
10332     * @brief Sets the target object for the hover.
10333     *
10334     * @param obj The hover object
10335     * @param target The object to center the hover onto. The hover
10336     *
10337     * This function will cause the hover to be centered on the target object.
10338     */
10339    EAPI void         elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10340    /**
10341     * @brief Gets the target object for the hover.
10342     *
10343     * @param obj The hover object
10344     * @param parent The object to locate the hover over.
10345     *
10346     * @see elm_hover_target_set()
10347     */
10348    EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10349    /**
10350     * @brief Sets the parent object for the hover.
10351     *
10352     * @param obj The hover object
10353     * @param parent The object to locate the hover over.
10354     *
10355     * This function will cause the hover to take up the entire space that the
10356     * parent object fills.
10357     */
10358    EAPI void         elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10359    /**
10360     * @brief Gets the parent object for the hover.
10361     *
10362     * @param obj The hover object
10363     * @return The parent object to locate the hover over.
10364     *
10365     * @see elm_hover_parent_set()
10366     */
10367    EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10368    /**
10369     * @brief Sets the content of the hover object and the direction in which it
10370     * will pop out.
10371     *
10372     * @param obj The hover object
10373     * @param swallow The direction that the object will be displayed
10374     * at. Accepted values are "left", "top-left", "top", "top-right",
10375     * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10376     * "smart".
10377     * @param content The content to place at @p swallow
10378     *
10379     * Once the content object is set for a given direction, a previously
10380     * set one (on the same direction) will be deleted. If you want to
10381     * keep that old content object, use the elm_hover_content_unset()
10382     * function.
10383     *
10384     * All directions may have contents at the same time, except for
10385     * "smart". This is a special placement hint and its use case
10386     * independs of the calculations coming from
10387     * elm_hover_best_content_location_get(). Its use is for cases when
10388     * one desires only one hover content, but with a dinamic special
10389     * placement within the hover area. The content's geometry, whenever
10390     * it changes, will be used to decide on a best location not
10391     * extrapolating the hover's parent object view to show it in (still
10392     * being the hover's target determinant of its medium part -- move and
10393     * resize it to simulate finger sizes, for example). If one of the
10394     * directions other than "smart" are used, a previously content set
10395     * using it will be deleted, and vice-versa.
10396     */
10397    EAPI void         elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10398    /**
10399     * @brief Get the content of the hover object, in a given direction.
10400     *
10401     * Return the content object which was set for this widget in the
10402     * @p swallow direction.
10403     *
10404     * @param obj The hover object
10405     * @param swallow The direction that the object was display at.
10406     * @return The content that was being used
10407     *
10408     * @see elm_hover_content_set()
10409     */
10410    EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10411    /**
10412     * @brief Unset the content of the hover object, in a given direction.
10413     *
10414     * Unparent and return the content object set at @p swallow direction.
10415     *
10416     * @param obj The hover object
10417     * @param swallow The direction that the object was display at.
10418     * @return The content that was being used.
10419     *
10420     * @see elm_hover_content_set()
10421     */
10422    EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10423    /**
10424     * @brief Returns the best swallow location for content in the hover.
10425     *
10426     * @param obj The hover object
10427     * @param pref_axis The preferred orientation axis for the hover object to use
10428     * @return The edje location to place content into the hover or @c
10429     *         NULL, on errors.
10430     *
10431     * Best is defined here as the location at which there is the most available
10432     * space.
10433     *
10434     * @p pref_axis may be one of
10435     * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10436     * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10437     * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10438     * - @c ELM_HOVER_AXIS_BOTH -- both
10439     *
10440     * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10441     * nescessarily be along the horizontal axis("left" or "right"). If
10442     * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10443     * be along the vertical axis("top" or "bottom"). Chossing
10444     * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10445     * returned position may be in either axis.
10446     *
10447     * @see elm_hover_content_set()
10448     */
10449    EAPI const char  *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10450    /**
10451     * @}
10452     */
10453
10454    /* entry */
10455    /**
10456     * @defgroup Entry Entry
10457     *
10458     * @image html img/widget/entry/preview-00.png
10459     * @image latex img/widget/entry/preview-00.eps width=\textwidth
10460     * @image html img/widget/entry/preview-01.png
10461     * @image latex img/widget/entry/preview-01.eps width=\textwidth
10462     * @image html img/widget/entry/preview-02.png
10463     * @image latex img/widget/entry/preview-02.eps width=\textwidth
10464     * @image html img/widget/entry/preview-03.png
10465     * @image latex img/widget/entry/preview-03.eps width=\textwidth
10466     *
10467     * An entry is a convenience widget which shows a box that the user can
10468     * enter text into. Entries by default don't scroll, so they grow to
10469     * accomodate the entire text, resizing the parent window as needed. This
10470     * can be changed with the elm_entry_scrollable_set() function.
10471     *
10472     * They can also be single line or multi line (the default) and when set
10473     * to multi line mode they support text wrapping in any of the modes
10474     * indicated by #Elm_Wrap_Type.
10475     *
10476     * Other features include password mode, filtering of inserted text with
10477     * elm_entry_text_filter_append() and related functions, inline "items" and
10478     * formatted markup text.
10479     *
10480     * @section entry-markup Formatted text
10481     *
10482     * The markup tags supported by the Entry are defined by the theme, but
10483     * even when writing new themes or extensions it's a good idea to stick to
10484     * a sane default, to maintain coherency and avoid application breakages.
10485     * Currently defined by the default theme are the following tags:
10486     * @li \<br\>: Inserts a line break.
10487     * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10488     * breaks.
10489     * @li \<tab\>: Inserts a tab.
10490     * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10491     * enclosed text.
10492     * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10493     * @li \<link\>...\</link\>: Underlines the enclosed text.
10494     * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10495     *
10496     * @section entry-special Special markups
10497     *
10498     * Besides those used to format text, entries support two special markup
10499     * tags used to insert clickable portions of text or items inlined within
10500     * the text.
10501     *
10502     * @subsection entry-anchors Anchors
10503     *
10504     * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10505     * \</a\> tags and an event will be generated when this text is clicked,
10506     * like this:
10507     *
10508     * @code
10509     * This text is outside <a href=anc-01>but this one is an anchor</a>
10510     * @endcode
10511     *
10512     * The @c href attribute in the opening tag gives the name that will be
10513     * used to identify the anchor and it can be any valid utf8 string.
10514     *
10515     * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10516     * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10517     * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10518     * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10519     * an anchor.
10520     *
10521     * @subsection entry-items Items
10522     *
10523     * Inlined in the text, any other @c Evas_Object can be inserted by using
10524     * \<item\> tags this way:
10525     *
10526     * @code
10527     * <item size=16x16 vsize=full href=emoticon/haha></item>
10528     * @endcode
10529     *
10530     * Just like with anchors, the @c href identifies each item, but these need,
10531     * in addition, to indicate their size, which is done using any one of
10532     * @c size, @c absize or @c relsize attributes. These attributes take their
10533     * value in the WxH format, where W is the width and H the height of the
10534     * item.
10535     *
10536     * @li absize: Absolute pixel size for the item. Whatever value is set will
10537     * be the item's size regardless of any scale value the object may have
10538     * been set to. The final line height will be adjusted to fit larger items.
10539     * @li size: Similar to @c absize, but it's adjusted to the scale value set
10540     * for the object.
10541     * @li relsize: Size is adjusted for the item to fit within the current
10542     * line height.
10543     *
10544     * Besides their size, items are specificed a @c vsize value that affects
10545     * how their final size and position are calculated. The possible values
10546     * are:
10547     * @li ascent: Item will be placed within the line's baseline and its
10548     * ascent. That is, the height between the line where all characters are
10549     * positioned and the highest point in the line. For @c size and @c absize
10550     * items, the descent value will be added to the total line height to make
10551     * them fit. @c relsize items will be adjusted to fit within this space.
10552     * @li full: Items will be placed between the descent and ascent, or the
10553     * lowest point in the line and its highest.
10554     *
10555     * The next image shows different configurations of items and how they
10556     * are the previously mentioned options affect their sizes. In all cases,
10557     * the green line indicates the ascent, blue for the baseline and red for
10558     * the descent.
10559     *
10560     * @image html entry_item.png
10561     * @image latex entry_item.eps width=\textwidth
10562     *
10563     * And another one to show how size differs from absize. In the first one,
10564     * the scale value is set to 1.0, while the second one is using one of 2.0.
10565     *
10566     * @image html entry_item_scale.png
10567     * @image latex entry_item_scale.eps width=\textwidth
10568     *
10569     * After the size for an item is calculated, the entry will request an
10570     * object to place in its space. For this, the functions set with
10571     * elm_entry_item_provider_append() and related functions will be called
10572     * in order until one of them returns a @c non-NULL value. If no providers
10573     * are available, or all of them return @c NULL, then the entry falls back
10574     * to one of the internal defaults, provided the name matches with one of
10575     * them.
10576     *
10577     * All of the following are currently supported:
10578     *
10579     * - emoticon/angry
10580     * - emoticon/angry-shout
10581     * - emoticon/crazy-laugh
10582     * - emoticon/evil-laugh
10583     * - emoticon/evil
10584     * - emoticon/goggle-smile
10585     * - emoticon/grumpy
10586     * - emoticon/grumpy-smile
10587     * - emoticon/guilty
10588     * - emoticon/guilty-smile
10589     * - emoticon/haha
10590     * - emoticon/half-smile
10591     * - emoticon/happy-panting
10592     * - emoticon/happy
10593     * - emoticon/indifferent
10594     * - emoticon/kiss
10595     * - emoticon/knowing-grin
10596     * - emoticon/laugh
10597     * - emoticon/little-bit-sorry
10598     * - emoticon/love-lots
10599     * - emoticon/love
10600     * - emoticon/minimal-smile
10601     * - emoticon/not-happy
10602     * - emoticon/not-impressed
10603     * - emoticon/omg
10604     * - emoticon/opensmile
10605     * - emoticon/smile
10606     * - emoticon/sorry
10607     * - emoticon/squint-laugh
10608     * - emoticon/surprised
10609     * - emoticon/suspicious
10610     * - emoticon/tongue-dangling
10611     * - emoticon/tongue-poke
10612     * - emoticon/uh
10613     * - emoticon/unhappy
10614     * - emoticon/very-sorry
10615     * - emoticon/what
10616     * - emoticon/wink
10617     * - emoticon/worried
10618     * - emoticon/wtf
10619     *
10620     * Alternatively, an item may reference an image by its path, using
10621     * the URI form @c file:///path/to/an/image.png and the entry will then
10622     * use that image for the item.
10623     *
10624     * @section entry-files Loading and saving files
10625     *
10626     * Entries have convinience functions to load text from a file and save
10627     * changes back to it after a short delay. The automatic saving is enabled
10628     * by default, but can be disabled with elm_entry_autosave_set() and files
10629     * can be loaded directly as plain text or have any markup in them
10630     * recognized. See elm_entry_file_set() for more details.
10631     *
10632     * @section entry-signals Emitted signals
10633     *
10634     * This widget emits the following signals:
10635     *
10636     * @li "changed": The text within the entry was changed.
10637     * @li "changed,user": The text within the entry was changed because of user interaction.
10638     * @li "activated": The enter key was pressed on a single line entry.
10639     * @li "press": A mouse button has been pressed on the entry.
10640     * @li "longpressed": A mouse button has been pressed and held for a couple
10641     * seconds.
10642     * @li "clicked": The entry has been clicked (mouse press and release).
10643     * @li "clicked,double": The entry has been double clicked.
10644     * @li "clicked,triple": The entry has been triple clicked.
10645     * @li "focused": The entry has received focus.
10646     * @li "unfocused": The entry has lost focus.
10647     * @li "selection,paste": A paste of the clipboard contents was requested.
10648     * @li "selection,copy": A copy of the selected text into the clipboard was
10649     * requested.
10650     * @li "selection,cut": A cut of the selected text into the clipboard was
10651     * requested.
10652     * @li "selection,start": A selection has begun and no previous selection
10653     * existed.
10654     * @li "selection,changed": The current selection has changed.
10655     * @li "selection,cleared": The current selection has been cleared.
10656     * @li "cursor,changed": The cursor has changed position.
10657     * @li "anchor,clicked": An anchor has been clicked. The event_info
10658     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10659     * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10660     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10661     * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10662     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10663     * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10664     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10665     * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10666     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10667     * @li "preedit,changed": The preedit string has changed.
10668     *
10669     * @section entry-examples
10670     *
10671     * An overview of the Entry API can be seen in @ref entry_example_01
10672     *
10673     * @{
10674     */
10675    /**
10676     * @typedef Elm_Entry_Anchor_Info
10677     *
10678     * The info sent in the callback for the "anchor,clicked" signals emitted
10679     * by entries.
10680     */
10681    typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10682    /**
10683     * @struct _Elm_Entry_Anchor_Info
10684     *
10685     * The info sent in the callback for the "anchor,clicked" signals emitted
10686     * by entries.
10687     */
10688    struct _Elm_Entry_Anchor_Info
10689      {
10690         const char *name; /**< The name of the anchor, as stated in its href */
10691         int         button; /**< The mouse button used to click on it */
10692         Evas_Coord  x, /**< Anchor geometry, relative to canvas */
10693                     y, /**< Anchor geometry, relative to canvas */
10694                     w, /**< Anchor geometry, relative to canvas */
10695                     h; /**< Anchor geometry, relative to canvas */
10696      };
10697    /**
10698     * @typedef Elm_Entry_Filter_Cb
10699     * This callback type is used by entry filters to modify text.
10700     * @param data The data specified as the last param when adding the filter
10701     * @param entry The entry object
10702     * @param text A pointer to the location of the text being filtered. This data can be modified,
10703     * but any additional allocations must be managed by the user.
10704     * @see elm_entry_text_filter_append
10705     * @see elm_entry_text_filter_prepend
10706     */
10707    typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
10708
10709    /**
10710     * This adds an entry to @p parent object.
10711     *
10712     * By default, entries are:
10713     * @li not scrolled
10714     * @li multi-line
10715     * @li word wrapped
10716     * @li autosave is enabled
10717     *
10718     * @param parent The parent object
10719     * @return The new object or NULL if it cannot be created
10720     */
10721    EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10722    /**
10723     * Sets the entry to single line mode.
10724     *
10725     * In single line mode, entries don't ever wrap when the text reaches the
10726     * edge, and instead they keep growing horizontally. Pressing the @c Enter
10727     * key will generate an @c "activate" event instead of adding a new line.
10728     *
10729     * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
10730     * and pressing enter will break the text into a different line
10731     * without generating any events.
10732     *
10733     * @param obj The entry object
10734     * @param single_line If true, the text in the entry
10735     * will be on a single line.
10736     */
10737    EAPI void         elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
10738    /**
10739     * Gets whether the entry is set to be single line.
10740     *
10741     * @param obj The entry object
10742     * @return single_line If true, the text in the entry is set to display
10743     * on a single line.
10744     *
10745     * @see elm_entry_single_line_set()
10746     */
10747    EAPI Eina_Bool    elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10748    /**
10749     * Sets the entry to password mode.
10750     *
10751     * In password mode, entries are implicitly single line and the display of
10752     * any text in them is replaced with asterisks (*).
10753     *
10754     * @param obj The entry object
10755     * @param password If true, password mode is enabled.
10756     */
10757    EAPI void         elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
10758    /**
10759     * Gets whether the entry is set to password mode.
10760     *
10761     * @param obj The entry object
10762     * @return If true, the entry is set to display all characters
10763     * as asterisks (*).
10764     *
10765     * @see elm_entry_password_set()
10766     */
10767    EAPI Eina_Bool    elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10768    /**
10769     * This sets the text displayed within the entry to @p entry.
10770     *
10771     * @param obj The entry object
10772     * @param entry The text to be displayed
10773     *
10774     * @deprecated Use elm_object_text_set() instead.
10775     */
10776    EAPI void         elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10777    /**
10778     * This returns the text currently shown in object @p entry.
10779     * See also elm_entry_entry_set().
10780     *
10781     * @param obj The entry object
10782     * @return The currently displayed text or NULL on failure
10783     *
10784     * @deprecated Use elm_object_text_get() instead.
10785     */
10786    EAPI const char  *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10787    /**
10788     * Appends @p entry to the text of the entry.
10789     *
10790     * Adds the text in @p entry to the end of any text already present in the
10791     * widget.
10792     *
10793     * The appended text is subject to any filters set for the widget.
10794     *
10795     * @param obj The entry object
10796     * @param entry The text to be displayed
10797     *
10798     * @see elm_entry_text_filter_append()
10799     */
10800    EAPI void         elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10801    /**
10802     * Gets whether the entry is empty.
10803     *
10804     * Empty means no text at all. If there are any markup tags, like an item
10805     * tag for which no provider finds anything, and no text is displayed, this
10806     * function still returns EINA_FALSE.
10807     *
10808     * @param obj The entry object
10809     * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
10810     */
10811    EAPI Eina_Bool    elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10812    /**
10813     * Gets any selected text within the entry.
10814     *
10815     * If there's any selected text in the entry, this function returns it as
10816     * a string in markup format. NULL is returned if no selection exists or
10817     * if an error occurred.
10818     *
10819     * The returned value points to an internal string and should not be freed
10820     * or modified in any way. If the @p entry object is deleted or its
10821     * contents are changed, the returned pointer should be considered invalid.
10822     *
10823     * @param obj The entry object
10824     * @return The selected text within the entry or NULL on failure
10825     */
10826    EAPI const char  *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10827    /**
10828     * Inserts the given text into the entry at the current cursor position.
10829     *
10830     * This inserts text at the cursor position as if it was typed
10831     * by the user (note that this also allows markup which a user
10832     * can't just "type" as it would be converted to escaped text, so this
10833     * call can be used to insert things like emoticon items or bold push/pop
10834     * tags, other font and color change tags etc.)
10835     *
10836     * If any selection exists, it will be replaced by the inserted text.
10837     *
10838     * The inserted text is subject to any filters set for the widget.
10839     *
10840     * @param obj The entry object
10841     * @param entry The text to insert
10842     *
10843     * @see elm_entry_text_filter_append()
10844     */
10845    EAPI void         elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10846    /**
10847     * Set the line wrap type to use on multi-line entries.
10848     *
10849     * Sets the wrap type used by the entry to any of the specified in
10850     * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
10851     * line (without inserting a line break or paragraph separator) when it
10852     * reaches the far edge of the widget.
10853     *
10854     * Note that this only makes sense for multi-line entries. A widget set
10855     * to be single line will never wrap.
10856     *
10857     * @param obj The entry object
10858     * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
10859     */
10860    EAPI void         elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
10861    /**
10862     * Gets the wrap mode the entry was set to use.
10863     *
10864     * @param obj The entry object
10865     * @return Wrap type
10866     *
10867     * @see also elm_entry_line_wrap_set()
10868     */
10869    EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10870    /**
10871     * Sets if the entry is to be editable or not.
10872     *
10873     * By default, entries are editable and when focused, any text input by the
10874     * user will be inserted at the current cursor position. But calling this
10875     * function with @p editable as EINA_FALSE will prevent the user from
10876     * inputting text into the entry.
10877     *
10878     * The only way to change the text of a non-editable entry is to use
10879     * elm_object_text_set(), elm_entry_entry_insert() and other related
10880     * functions.
10881     *
10882     * @param obj The entry object
10883     * @param editable If EINA_TRUE, user input will be inserted in the entry,
10884     * if not, the entry is read-only and no user input is allowed.
10885     */
10886    EAPI void         elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
10887    /**
10888     * Gets whether the entry is editable or not.
10889     *
10890     * @param obj The entry object
10891     * @return If true, the entry is editable by the user.
10892     * If false, it is not editable by the user
10893     *
10894     * @see elm_entry_editable_set()
10895     */
10896    EAPI Eina_Bool    elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10897    /**
10898     * This drops any existing text selection within the entry.
10899     *
10900     * @param obj The entry object
10901     */
10902    EAPI void         elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
10903    /**
10904     * This selects all text within the entry.
10905     *
10906     * @param obj The entry object
10907     */
10908    EAPI void         elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
10909    /**
10910     * This moves the cursor one place to the right within the entry.
10911     *
10912     * @param obj The entry object
10913     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10914     */
10915    EAPI Eina_Bool    elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
10916    /**
10917     * This moves the cursor one place to the left within the entry.
10918     *
10919     * @param obj The entry object
10920     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10921     */
10922    EAPI Eina_Bool    elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
10923    /**
10924     * This moves the cursor one line up within the entry.
10925     *
10926     * @param obj The entry object
10927     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10928     */
10929    EAPI Eina_Bool    elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
10930    /**
10931     * This moves the cursor one line down within the entry.
10932     *
10933     * @param obj The entry object
10934     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10935     */
10936    EAPI Eina_Bool    elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
10937    /**
10938     * This moves the cursor to the beginning of the entry.
10939     *
10940     * @param obj The entry object
10941     */
10942    EAPI void         elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10943    /**
10944     * This moves the cursor to the end of the entry.
10945     *
10946     * @param obj The entry object
10947     */
10948    EAPI void         elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10949    /**
10950     * This moves the cursor to the beginning of the current line.
10951     *
10952     * @param obj The entry object
10953     */
10954    EAPI void         elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10955    /**
10956     * This moves the cursor to the end of the current line.
10957     *
10958     * @param obj The entry object
10959     */
10960    EAPI void         elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10961    /**
10962     * This begins a selection within the entry as though
10963     * the user were holding down the mouse button to make a selection.
10964     *
10965     * @param obj The entry object
10966     */
10967    EAPI void         elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
10968    /**
10969     * This ends a selection within the entry as though
10970     * the user had just released the mouse button while making a selection.
10971     *
10972     * @param obj The entry object
10973     */
10974    EAPI void         elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
10975    /**
10976     * Gets whether a format node exists at the current cursor position.
10977     *
10978     * A format node is anything that defines how the text is rendered. It can
10979     * be a visible format node, such as a line break or a paragraph separator,
10980     * or an invisible one, such as bold begin or end tag.
10981     * This function returns whether any format node exists at the current
10982     * cursor position.
10983     *
10984     * @param obj The entry object
10985     * @return EINA_TRUE if the current cursor position contains a format node,
10986     * EINA_FALSE otherwise.
10987     *
10988     * @see elm_entry_cursor_is_visible_format_get()
10989     */
10990    EAPI Eina_Bool    elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10991    /**
10992     * Gets if the current cursor position holds a visible format node.
10993     *
10994     * @param obj The entry object
10995     * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
10996     * if it's an invisible one or no format exists.
10997     *
10998     * @see elm_entry_cursor_is_format_get()
10999     */
11000    EAPI Eina_Bool    elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11001    /**
11002     * Gets the character pointed by the cursor at its current position.
11003     *
11004     * This function returns a string with the utf8 character stored at the
11005     * current cursor position.
11006     * Only the text is returned, any format that may exist will not be part
11007     * of the return value.
11008     *
11009     * @param obj The entry object
11010     * @return The text pointed by the cursors.
11011     */
11012    EAPI const char  *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11013    /**
11014     * This function returns the geometry of the cursor.
11015     *
11016     * It's useful if you want to draw something on the cursor (or where it is),
11017     * or for example in the case of scrolled entry where you want to show the
11018     * cursor.
11019     *
11020     * @param obj The entry object
11021     * @param x returned geometry
11022     * @param y returned geometry
11023     * @param w returned geometry
11024     * @param h returned geometry
11025     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11026     */
11027    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);
11028    /**
11029     * Sets the cursor position in the entry to the given value
11030     *
11031     * The value in @p pos is the index of the character position within the
11032     * contents of the string as returned by elm_entry_cursor_pos_get().
11033     *
11034     * @param obj The entry object
11035     * @param pos The position of the cursor
11036     */
11037    EAPI void         elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11038    /**
11039     * Retrieves the current position of the cursor in the entry
11040     *
11041     * @param obj The entry object
11042     * @return The cursor position
11043     */
11044    EAPI int          elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11045    /**
11046     * This executes a "cut" action on the selected text in the entry.
11047     *
11048     * @param obj The entry object
11049     */
11050    EAPI void         elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11051    /**
11052     * This executes a "copy" action on the selected text in the entry.
11053     *
11054     * @param obj The entry object
11055     */
11056    EAPI void         elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11057    /**
11058     * This executes a "paste" action in the entry.
11059     *
11060     * @param obj The entry object
11061     */
11062    EAPI void         elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11063    /**
11064     * This clears and frees the items in a entry's contextual (longpress)
11065     * menu.
11066     *
11067     * @param obj The entry object
11068     *
11069     * @see elm_entry_context_menu_item_add()
11070     */
11071    EAPI void         elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11072    /**
11073     * This adds an item to the entry's contextual menu.
11074     *
11075     * A longpress on an entry will make the contextual menu show up, if this
11076     * hasn't been disabled with elm_entry_context_menu_disabled_set().
11077     * By default, this menu provides a few options like enabling selection mode,
11078     * which is useful on embedded devices that need to be explicit about it,
11079     * and when a selection exists it also shows the copy and cut actions.
11080     *
11081     * With this function, developers can add other options to this menu to
11082     * perform any action they deem necessary.
11083     *
11084     * @param obj The entry object
11085     * @param label The item's text label
11086     * @param icon_file The item's icon file
11087     * @param icon_type The item's icon type
11088     * @param func The callback to execute when the item is clicked
11089     * @param data The data to associate with the item for related functions
11090     */
11091    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);
11092    /**
11093     * This disables the entry's contextual (longpress) menu.
11094     *
11095     * @param obj The entry object
11096     * @param disabled If true, the menu is disabled
11097     */
11098    EAPI void         elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11099    /**
11100     * This returns whether the entry's contextual (longpress) menu is
11101     * disabled.
11102     *
11103     * @param obj The entry object
11104     * @return If true, the menu is disabled
11105     */
11106    EAPI Eina_Bool    elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11107    /**
11108     * This appends a custom item provider to the list for that entry
11109     *
11110     * This appends the given callback. The list is walked from beginning to end
11111     * with each function called given the item href string in the text. If the
11112     * function returns an object handle other than NULL (it should create an
11113     * object to do this), then this object is used to replace that item. If
11114     * not the next provider is called until one provides an item object, or the
11115     * default provider in entry does.
11116     *
11117     * @param obj The entry object
11118     * @param func The function called to provide the item object
11119     * @param data The data passed to @p func
11120     *
11121     * @see @ref entry-items
11122     */
11123    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);
11124    /**
11125     * This prepends a custom item provider to the list for that entry
11126     *
11127     * This prepends the given callback. See elm_entry_item_provider_append() for
11128     * more information
11129     *
11130     * @param obj The entry object
11131     * @param func The function called to provide the item object
11132     * @param data The data passed to @p func
11133     */
11134    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);
11135    /**
11136     * This removes a custom item provider to the list for that entry
11137     *
11138     * This removes the given callback. See elm_entry_item_provider_append() for
11139     * more information
11140     *
11141     * @param obj The entry object
11142     * @param func The function called to provide the item object
11143     * @param data The data passed to @p func
11144     */
11145    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);
11146    /**
11147     * Append a filter function for text inserted in the entry
11148     *
11149     * Append the given callback to the list. This functions will be called
11150     * whenever any text is inserted into the entry, with the text to be inserted
11151     * as a parameter. The callback function is free to alter the text in any way
11152     * it wants, but it must remember to free the given pointer and update it.
11153     * If the new text is to be discarded, the function can free it and set its
11154     * text parameter to NULL. This will also prevent any following filters from
11155     * being called.
11156     *
11157     * @param obj The entry object
11158     * @param func The function to use as text filter
11159     * @param data User data to pass to @p func
11160     */
11161    EAPI void         elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11162    /**
11163     * Prepend a filter function for text insdrted in the entry
11164     *
11165     * Prepend the given callback to the list. See elm_entry_text_filter_append()
11166     * for more information
11167     *
11168     * @param obj The entry object
11169     * @param func The function to use as text filter
11170     * @param data User data to pass to @p func
11171     */
11172    EAPI void         elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11173    /**
11174     * Remove a filter from the list
11175     *
11176     * Removes the given callback from the filter list. See
11177     * elm_entry_text_filter_append() for more information.
11178     *
11179     * @param obj The entry object
11180     * @param func The filter function to remove
11181     * @param data The user data passed when adding the function
11182     */
11183    EAPI void         elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11184    /**
11185     * This converts a markup (HTML-like) string into UTF-8.
11186     *
11187     * The returned string is a malloc'ed buffer and it should be freed when
11188     * not needed anymore.
11189     *
11190     * @param s The string (in markup) to be converted
11191     * @return The converted string (in UTF-8). It should be freed.
11192     */
11193    EAPI char        *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11194    /**
11195     * This converts a UTF-8 string into markup (HTML-like).
11196     *
11197     * The returned string is a malloc'ed buffer and it should be freed when
11198     * not needed anymore.
11199     *
11200     * @param s The string (in UTF-8) to be converted
11201     * @return The converted string (in markup). It should be freed.
11202     */
11203    EAPI char        *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11204    /**
11205     * This sets the file (and implicitly loads it) for the text to display and
11206     * then edit. All changes are written back to the file after a short delay if
11207     * the entry object is set to autosave (which is the default).
11208     *
11209     * If the entry had any other file set previously, any changes made to it
11210     * will be saved if the autosave feature is enabled, otherwise, the file
11211     * will be silently discarded and any non-saved changes will be lost.
11212     *
11213     * @param obj The entry object
11214     * @param file The path to the file to load and save
11215     * @param format The file format
11216     */
11217    EAPI void         elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11218    /**
11219     * Gets the file being edited by the entry.
11220     *
11221     * This function can be used to retrieve any file set on the entry for
11222     * edition, along with the format used to load and save it.
11223     *
11224     * @param obj The entry object
11225     * @param file The path to the file to load and save
11226     * @param format The file format
11227     */
11228    EAPI void         elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11229    /**
11230     * This function writes any changes made to the file set with
11231     * elm_entry_file_set()
11232     *
11233     * @param obj The entry object
11234     */
11235    EAPI void         elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11236    /**
11237     * This sets the entry object to 'autosave' the loaded text file or not.
11238     *
11239     * @param obj The entry object
11240     * @param autosave Autosave the loaded file or not
11241     *
11242     * @see elm_entry_file_set()
11243     */
11244    EAPI void         elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11245    /**
11246     * This gets the entry object's 'autosave' status.
11247     *
11248     * @param obj The entry object
11249     * @return Autosave the loaded file or not
11250     *
11251     * @see elm_entry_file_set()
11252     */
11253    EAPI Eina_Bool    elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11254    /**
11255     * Control pasting of text and images for the widget.
11256     *
11257     * Normally the entry allows both text and images to be pasted.  By setting
11258     * textonly to be true, this prevents images from being pasted.
11259     *
11260     * Note this only changes the behaviour of text.
11261     *
11262     * @param obj The entry object
11263     * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11264     * text+image+other.
11265     */
11266    EAPI void         elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11267    /**
11268     * Getting elm_entry text paste/drop mode.
11269     *
11270     * In textonly mode, only text may be pasted or dropped into the widget.
11271     *
11272     * @param obj The entry object
11273     * @return If the widget only accepts text from pastes.
11274     */
11275    EAPI Eina_Bool    elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11276    /**
11277     * Enable or disable scrolling in entry
11278     *
11279     * Normally the entry is not scrollable unless you enable it with this call.
11280     *
11281     * @param obj The entry object
11282     * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11283     */
11284    EAPI void         elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11285    /**
11286     * Get the scrollable state of the entry
11287     *
11288     * Normally the entry is not scrollable. This gets the scrollable state
11289     * of the entry. See elm_entry_scrollable_set() for more information.
11290     *
11291     * @param obj The entry object
11292     * @return The scrollable state
11293     */
11294    EAPI Eina_Bool    elm_entry_scrollable_get(const Evas_Object *obj);
11295    /**
11296     * This sets a widget to be displayed to the left of a scrolled entry.
11297     *
11298     * @param obj The scrolled entry object
11299     * @param icon The widget to display on the left side of the scrolled
11300     * entry.
11301     *
11302     * @note A previously set widget will be destroyed.
11303     * @note If the object being set does not have minimum size hints set,
11304     * it won't get properly displayed.
11305     *
11306     * @see elm_entry_end_set()
11307     */
11308    EAPI void         elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11309    /**
11310     * Gets the leftmost widget of the scrolled entry. This object is
11311     * owned by the scrolled entry and should not be modified.
11312     *
11313     * @param obj The scrolled entry object
11314     * @return the left widget inside the scroller
11315     */
11316    EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11317    /**
11318     * Unset the leftmost widget of the scrolled entry, unparenting and
11319     * returning it.
11320     *
11321     * @param obj The scrolled entry object
11322     * @return the previously set icon sub-object of this entry, on
11323     * success.
11324     *
11325     * @see elm_entry_icon_set()
11326     */
11327    EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11328    /**
11329     * Sets the visibility of the left-side widget of the scrolled entry,
11330     * set by elm_entry_icon_set().
11331     *
11332     * @param obj The scrolled entry object
11333     * @param setting EINA_TRUE if the object should be displayed,
11334     * EINA_FALSE if not.
11335     */
11336    EAPI void         elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11337    /**
11338     * This sets a widget to be displayed to the end of a scrolled entry.
11339     *
11340     * @param obj The scrolled entry object
11341     * @param end The widget to display on the right side of the scrolled
11342     * entry.
11343     *
11344     * @note A previously set widget will be destroyed.
11345     * @note If the object being set does not have minimum size hints set,
11346     * it won't get properly displayed.
11347     *
11348     * @see elm_entry_icon_set
11349     */
11350    EAPI void         elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11351    /**
11352     * Gets the endmost widget of the scrolled entry. This object is owned
11353     * by the scrolled entry and should not be modified.
11354     *
11355     * @param obj The scrolled entry object
11356     * @return the right widget inside the scroller
11357     */
11358    EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11359    /**
11360     * Unset the endmost widget of the scrolled entry, unparenting and
11361     * returning it.
11362     *
11363     * @param obj The scrolled entry object
11364     * @return the previously set icon sub-object of this entry, on
11365     * success.
11366     *
11367     * @see elm_entry_icon_set()
11368     */
11369    EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11370    /**
11371     * Sets the visibility of the end widget of the scrolled entry, set by
11372     * elm_entry_end_set().
11373     *
11374     * @param obj The scrolled entry object
11375     * @param setting EINA_TRUE if the object should be displayed,
11376     * EINA_FALSE if not.
11377     */
11378    EAPI void         elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11379    /**
11380     * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11381     * them).
11382     *
11383     * Setting an entry to single-line mode with elm_entry_single_line_set()
11384     * will automatically disable the display of scrollbars when the entry
11385     * moves inside its scroller.
11386     *
11387     * @param obj The scrolled entry object
11388     * @param h The horizontal scrollbar policy to apply
11389     * @param v The vertical scrollbar policy to apply
11390     */
11391    EAPI void         elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11392    /**
11393     * This enables/disables bouncing within the entry.
11394     *
11395     * This function sets whether the entry will bounce when scrolling reaches
11396     * the end of the contained entry.
11397     *
11398     * @param obj The scrolled entry object
11399     * @param h The horizontal bounce state
11400     * @param v The vertical bounce state
11401     */
11402    EAPI void         elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11403    /**
11404     * Get the bounce mode
11405     *
11406     * @param obj The Entry object
11407     * @param h_bounce Allow bounce horizontally
11408     * @param v_bounce Allow bounce vertically
11409     */
11410    EAPI void         elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11411
11412    /* pre-made filters for entries */
11413    /**
11414     * @typedef Elm_Entry_Filter_Limit_Size
11415     *
11416     * Data for the elm_entry_filter_limit_size() entry filter.
11417     */
11418    typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11419    /**
11420     * @struct _Elm_Entry_Filter_Limit_Size
11421     *
11422     * Data for the elm_entry_filter_limit_size() entry filter.
11423     */
11424    struct _Elm_Entry_Filter_Limit_Size
11425      {
11426         int max_char_count; /**< The maximum number of characters allowed. */
11427         int max_byte_count; /**< The maximum number of bytes allowed*/
11428      };
11429    /**
11430     * Filter inserted text based on user defined character and byte limits
11431     *
11432     * Add this filter to an entry to limit the characters that it will accept
11433     * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11434     * The funtion works on the UTF-8 representation of the string, converting
11435     * it from the set markup, thus not accounting for any format in it.
11436     *
11437     * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11438     * it as data when setting the filter. In it, it's possible to set limits
11439     * by character count or bytes (any of them is disabled if 0), and both can
11440     * be set at the same time. In that case, it first checks for characters,
11441     * then bytes.
11442     *
11443     * The function will cut the inserted text in order to allow only the first
11444     * number of characters that are still allowed. The cut is made in
11445     * characters, even when limiting by bytes, in order to always contain
11446     * valid ones and avoid half unicode characters making it in.
11447     *
11448     * This filter, like any others, does not apply when setting the entry text
11449     * directly with elm_object_text_set() (or the deprecated
11450     * elm_entry_entry_set()).
11451     */
11452    EAPI void         elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11453    /**
11454     * @typedef Elm_Entry_Filter_Accept_Set
11455     *
11456     * Data for the elm_entry_filter_accept_set() entry filter.
11457     */
11458    typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11459    /**
11460     * @struct _Elm_Entry_Filter_Accept_Set
11461     *
11462     * Data for the elm_entry_filter_accept_set() entry filter.
11463     */
11464    struct _Elm_Entry_Filter_Accept_Set
11465      {
11466         const char *accepted; /**< Set of characters accepted in the entry. */
11467         const char *rejected; /**< Set of characters rejected from the entry. */
11468      };
11469    /**
11470     * Filter inserted text based on accepted or rejected sets of characters
11471     *
11472     * Add this filter to an entry to restrict the set of accepted characters
11473     * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11474     * This structure contains both accepted and rejected sets, but they are
11475     * mutually exclusive.
11476     *
11477     * The @c accepted set takes preference, so if it is set, the filter will
11478     * only work based on the accepted characters, ignoring anything in the
11479     * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11480     *
11481     * In both cases, the function filters by matching utf8 characters to the
11482     * raw markup text, so it can be used to remove formatting tags.
11483     *
11484     * This filter, like any others, does not apply when setting the entry text
11485     * directly with elm_object_text_set() (or the deprecated
11486     * elm_entry_entry_set()).
11487     */
11488    EAPI void         elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11489    /**
11490     * Set the input panel layout of the entry
11491     *
11492     * @param obj The entry object
11493     * @param layout layout type
11494     */
11495    EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11496    /**
11497     * Get the input panel layout of the entry
11498     *
11499     * @param obj The entry object
11500     * @return layout type
11501     *
11502     * @see elm_entry_input_panel_layout_set
11503     */
11504    EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11505    /**
11506     * @}
11507     */
11508
11509    /* composite widgets - these basically put together basic widgets above
11510     * in convenient packages that do more than basic stuff */
11511
11512    /* anchorview */
11513    /**
11514     * @defgroup Anchorview Anchorview
11515     *
11516     * @image html img/widget/anchorview/preview-00.png
11517     * @image latex img/widget/anchorview/preview-00.eps
11518     *
11519     * Anchorview is for displaying text that contains markup with anchors
11520     * like <c>\<a href=1234\>something\</\></c> in it.
11521     *
11522     * Besides being styled differently, the anchorview widget provides the
11523     * necessary functionality so that clicking on these anchors brings up a
11524     * popup with user defined content such as "call", "add to contacts" or
11525     * "open web page". This popup is provided using the @ref Hover widget.
11526     *
11527     * This widget is very similar to @ref Anchorblock, so refer to that
11528     * widget for an example. The only difference Anchorview has is that the
11529     * widget is already provided with scrolling functionality, so if the
11530     * text set to it is too large to fit in the given space, it will scroll,
11531     * whereas the @ref Anchorblock widget will keep growing to ensure all the
11532     * text can be displayed.
11533     *
11534     * This widget emits the following signals:
11535     * @li "anchor,clicked": will be called when an anchor is clicked. The
11536     * @p event_info parameter on the callback will be a pointer of type
11537     * ::Elm_Entry_Anchorview_Info.
11538     *
11539     * See @ref Anchorblock for an example on how to use both of them.
11540     *
11541     * @see Anchorblock
11542     * @see Entry
11543     * @see Hover
11544     *
11545     * @{
11546     */
11547    /**
11548     * @typedef Elm_Entry_Anchorview_Info
11549     *
11550     * The info sent in the callback for "anchor,clicked" signals emitted by
11551     * the Anchorview widget.
11552     */
11553    typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11554    /**
11555     * @struct _Elm_Entry_Anchorview_Info
11556     *
11557     * The info sent in the callback for "anchor,clicked" signals emitted by
11558     * the Anchorview widget.
11559     */
11560    struct _Elm_Entry_Anchorview_Info
11561      {
11562         const char     *name; /**< Name of the anchor, as indicated in its href
11563                                    attribute */
11564         int             button; /**< The mouse button used to click on it */
11565         Evas_Object    *hover; /**< The hover object to use for the popup */
11566         struct {
11567              Evas_Coord    x, y, w, h;
11568         } anchor, /**< Geometry selection of text used as anchor */
11569           hover_parent; /**< Geometry of the object used as parent by the
11570                              hover */
11571         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
11572                                              for content on the left side of
11573                                              the hover. Before calling the
11574                                              callback, the widget will make the
11575                                              necessary calculations to check
11576                                              which sides are fit to be set with
11577                                              content, based on the position the
11578                                              hover is activated and its distance
11579                                              to the edges of its parent object
11580                                              */
11581         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
11582                                               the right side of the hover.
11583                                               See @ref hover_left */
11584         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
11585                                             of the hover. See @ref hover_left */
11586         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
11587                                                below the hover. See @ref
11588                                                hover_left */
11589      };
11590    /**
11591     * Add a new Anchorview object
11592     *
11593     * @param parent The parent object
11594     * @return The new object or NULL if it cannot be created
11595     */
11596    EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11597    /**
11598     * Set the text to show in the anchorview
11599     *
11600     * Sets the text of the anchorview to @p text. This text can include markup
11601     * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11602     * text that will be specially styled and react to click events, ended with
11603     * either of \</a\> or \</\>. When clicked, the anchor will emit an
11604     * "anchor,clicked" signal that you can attach a callback to with
11605     * evas_object_smart_callback_add(). The name of the anchor given in the
11606     * event info struct will be the one set in the href attribute, in this
11607     * case, anchorname.
11608     *
11609     * Other markup can be used to style the text in different ways, but it's
11610     * up to the style defined in the theme which tags do what.
11611     * @deprecated use elm_object_text_set() instead.
11612     */
11613    EINA_DEPRECATED EAPI void         elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11614    /**
11615     * Get the markup text set for the anchorview
11616     *
11617     * Retrieves the text set on the anchorview, with markup tags included.
11618     *
11619     * @param obj The anchorview object
11620     * @return The markup text set or @c NULL if nothing was set or an error
11621     * occurred
11622     * @deprecated use elm_object_text_set() instead.
11623     */
11624    EINA_DEPRECATED EAPI const char  *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11625    /**
11626     * Set the parent of the hover popup
11627     *
11628     * Sets the parent object to use by the hover created by the anchorview
11629     * when an anchor is clicked. See @ref Hover for more details on this.
11630     * If no parent is set, the same anchorview object will be used.
11631     *
11632     * @param obj The anchorview object
11633     * @param parent The object to use as parent for the hover
11634     */
11635    EAPI void         elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11636    /**
11637     * Get the parent of the hover popup
11638     *
11639     * Get the object used as parent for the hover created by the anchorview
11640     * widget. See @ref Hover for more details on this.
11641     *
11642     * @param obj The anchorview object
11643     * @return The object used as parent for the hover, NULL if none is set.
11644     */
11645    EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11646    /**
11647     * Set the style that the hover should use
11648     *
11649     * When creating the popup hover, anchorview will request that it's
11650     * themed according to @p style.
11651     *
11652     * @param obj The anchorview object
11653     * @param style The style to use for the underlying hover
11654     *
11655     * @see elm_object_style_set()
11656     */
11657    EAPI void         elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11658    /**
11659     * Get the style that the hover should use
11660     *
11661     * Get the style the hover created by anchorview will use.
11662     *
11663     * @param obj The anchorview object
11664     * @return The style to use by the hover. NULL means the default is used.
11665     *
11666     * @see elm_object_style_set()
11667     */
11668    EAPI const char  *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11669    /**
11670     * Ends the hover popup in the anchorview
11671     *
11672     * When an anchor is clicked, the anchorview widget will create a hover
11673     * object to use as a popup with user provided content. This function
11674     * terminates this popup, returning the anchorview to its normal state.
11675     *
11676     * @param obj The anchorview object
11677     */
11678    EAPI void         elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11679    /**
11680     * Set bouncing behaviour when the scrolled content reaches an edge
11681     *
11682     * Tell the internal scroller object whether it should bounce or not
11683     * when it reaches the respective edges for each axis.
11684     *
11685     * @param obj The anchorview object
11686     * @param h_bounce Whether to bounce or not in the horizontal axis
11687     * @param v_bounce Whether to bounce or not in the vertical axis
11688     *
11689     * @see elm_scroller_bounce_set()
11690     */
11691    EAPI void         elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
11692    /**
11693     * Get the set bouncing behaviour of the internal scroller
11694     *
11695     * Get whether the internal scroller should bounce when the edge of each
11696     * axis is reached scrolling.
11697     *
11698     * @param obj The anchorview object
11699     * @param h_bounce Pointer where to store the bounce state of the horizontal
11700     *                 axis
11701     * @param v_bounce Pointer where to store the bounce state of the vertical
11702     *                 axis
11703     *
11704     * @see elm_scroller_bounce_get()
11705     */
11706    EAPI void         elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
11707    /**
11708     * Appends a custom item provider to the given anchorview
11709     *
11710     * Appends the given function to the list of items providers. This list is
11711     * called, one function at a time, with the given @p data pointer, the
11712     * anchorview object and, in the @p item parameter, the item name as
11713     * referenced in its href string. Following functions in the list will be
11714     * called in order until one of them returns something different to NULL,
11715     * which should be an Evas_Object which will be used in place of the item
11716     * element.
11717     *
11718     * Items in the markup text take the form \<item relsize=16x16 vsize=full
11719     * href=item/name\>\</item\>
11720     *
11721     * @param obj The anchorview object
11722     * @param func The function to add to the list of providers
11723     * @param data User data that will be passed to the callback function
11724     *
11725     * @see elm_entry_item_provider_append()
11726     */
11727    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);
11728    /**
11729     * Prepend a custom item provider to the given anchorview
11730     *
11731     * Like elm_anchorview_item_provider_append(), but it adds the function
11732     * @p func to the beginning of the list, instead of the end.
11733     *
11734     * @param obj The anchorview object
11735     * @param func The function to add to the list of providers
11736     * @param data User data that will be passed to the callback function
11737     */
11738    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);
11739    /**
11740     * Remove a custom item provider from the list of the given anchorview
11741     *
11742     * Removes the function and data pairing that matches @p func and @p data.
11743     * That is, unless the same function and same user data are given, the
11744     * function will not be removed from the list. This allows us to add the
11745     * same callback several times, with different @p data pointers and be
11746     * able to remove them later without conflicts.
11747     *
11748     * @param obj The anchorview object
11749     * @param func The function to remove from the list
11750     * @param data The data matching the function to remove from the list
11751     */
11752    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);
11753    /**
11754     * @}
11755     */
11756
11757    /* anchorblock */
11758    /**
11759     * @defgroup Anchorblock Anchorblock
11760     *
11761     * @image html img/widget/anchorblock/preview-00.png
11762     * @image latex img/widget/anchorblock/preview-00.eps
11763     *
11764     * Anchorblock is for displaying text that contains markup with anchors
11765     * like <c>\<a href=1234\>something\</\></c> in it.
11766     *
11767     * Besides being styled differently, the anchorblock widget provides the
11768     * necessary functionality so that clicking on these anchors brings up a
11769     * popup with user defined content such as "call", "add to contacts" or
11770     * "open web page". This popup is provided using the @ref Hover widget.
11771     *
11772     * This widget emits the following signals:
11773     * @li "anchor,clicked": will be called when an anchor is clicked. The
11774     * @p event_info parameter on the callback will be a pointer of type
11775     * ::Elm_Entry_Anchorblock_Info.
11776     *
11777     * @see Anchorview
11778     * @see Entry
11779     * @see Hover
11780     *
11781     * Since examples are usually better than plain words, we might as well
11782     * try @ref tutorial_anchorblock_example "one".
11783     */
11784    /**
11785     * @addtogroup Anchorblock
11786     * @{
11787     */
11788    /**
11789     * @typedef Elm_Entry_Anchorblock_Info
11790     *
11791     * The info sent in the callback for "anchor,clicked" signals emitted by
11792     * the Anchorblock widget.
11793     */
11794    typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
11795    /**
11796     * @struct _Elm_Entry_Anchorblock_Info
11797     *
11798     * The info sent in the callback for "anchor,clicked" signals emitted by
11799     * the Anchorblock widget.
11800     */
11801    struct _Elm_Entry_Anchorblock_Info
11802      {
11803         const char     *name; /**< Name of the anchor, as indicated in its href
11804                                    attribute */
11805         int             button; /**< The mouse button used to click on it */
11806         Evas_Object    *hover; /**< The hover object to use for the popup */
11807         struct {
11808              Evas_Coord    x, y, w, h;
11809         } anchor, /**< Geometry selection of text used as anchor */
11810           hover_parent; /**< Geometry of the object used as parent by the
11811                              hover */
11812         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
11813                                              for content on the left side of
11814                                              the hover. Before calling the
11815                                              callback, the widget will make the
11816                                              necessary calculations to check
11817                                              which sides are fit to be set with
11818                                              content, based on the position the
11819                                              hover is activated and its distance
11820                                              to the edges of its parent object
11821                                              */
11822         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
11823                                               the right side of the hover.
11824                                               See @ref hover_left */
11825         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
11826                                             of the hover. See @ref hover_left */
11827         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
11828                                                below the hover. See @ref
11829                                                hover_left */
11830      };
11831    /**
11832     * Add a new Anchorblock object
11833     *
11834     * @param parent The parent object
11835     * @return The new object or NULL if it cannot be created
11836     */
11837    EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11838    /**
11839     * Set the text to show in the anchorblock
11840     *
11841     * Sets the text of the anchorblock to @p text. This text can include markup
11842     * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
11843     * of text that will be specially styled and react to click events, ended
11844     * with either of \</a\> or \</\>. When clicked, the anchor will emit an
11845     * "anchor,clicked" signal that you can attach a callback to with
11846     * evas_object_smart_callback_add(). The name of the anchor given in the
11847     * event info struct will be the one set in the href attribute, in this
11848     * case, anchorname.
11849     *
11850     * Other markup can be used to style the text in different ways, but it's
11851     * up to the style defined in the theme which tags do what.
11852     * @deprecated use elm_object_text_set() instead.
11853     */
11854    EINA_DEPRECATED EAPI void         elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11855    /**
11856     * Get the markup text set for the anchorblock
11857     *
11858     * Retrieves the text set on the anchorblock, with markup tags included.
11859     *
11860     * @param obj The anchorblock object
11861     * @return The markup text set or @c NULL if nothing was set or an error
11862     * occurred
11863     * @deprecated use elm_object_text_set() instead.
11864     */
11865    EINA_DEPRECATED EAPI const char  *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11866    /**
11867     * Set the parent of the hover popup
11868     *
11869     * Sets the parent object to use by the hover created by the anchorblock
11870     * when an anchor is clicked. See @ref Hover for more details on this.
11871     *
11872     * @param obj The anchorblock object
11873     * @param parent The object to use as parent for the hover
11874     */
11875    EAPI void         elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11876    /**
11877     * Get the parent of the hover popup
11878     *
11879     * Get the object used as parent for the hover created by the anchorblock
11880     * widget. See @ref Hover for more details on this.
11881     * If no parent is set, the same anchorblock object will be used.
11882     *
11883     * @param obj The anchorblock object
11884     * @return The object used as parent for the hover, NULL if none is set.
11885     */
11886    EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11887    /**
11888     * Set the style that the hover should use
11889     *
11890     * When creating the popup hover, anchorblock will request that it's
11891     * themed according to @p style.
11892     *
11893     * @param obj The anchorblock object
11894     * @param style The style to use for the underlying hover
11895     *
11896     * @see elm_object_style_set()
11897     */
11898    EAPI void         elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11899    /**
11900     * Get the style that the hover should use
11901     *
11902     * Get the style the hover created by anchorblock will use.
11903     *
11904     * @param obj The anchorblock object
11905     * @return The style to use by the hover. NULL means the default is used.
11906     *
11907     * @see elm_object_style_set()
11908     */
11909    EAPI const char  *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11910    /**
11911     * Ends the hover popup in the anchorblock
11912     *
11913     * When an anchor is clicked, the anchorblock widget will create a hover
11914     * object to use as a popup with user provided content. This function
11915     * terminates this popup, returning the anchorblock to its normal state.
11916     *
11917     * @param obj The anchorblock object
11918     */
11919    EAPI void         elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11920    /**
11921     * Appends a custom item provider to the given anchorblock
11922     *
11923     * Appends the given function to the list of items providers. This list is
11924     * called, one function at a time, with the given @p data pointer, the
11925     * anchorblock object and, in the @p item parameter, the item name as
11926     * referenced in its href string. Following functions in the list will be
11927     * called in order until one of them returns something different to NULL,
11928     * which should be an Evas_Object which will be used in place of the item
11929     * element.
11930     *
11931     * Items in the markup text take the form \<item relsize=16x16 vsize=full
11932     * href=item/name\>\</item\>
11933     *
11934     * @param obj The anchorblock object
11935     * @param func The function to add to the list of providers
11936     * @param data User data that will be passed to the callback function
11937     *
11938     * @see elm_entry_item_provider_append()
11939     */
11940    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);
11941    /**
11942     * Prepend a custom item provider to the given anchorblock
11943     *
11944     * Like elm_anchorblock_item_provider_append(), but it adds the function
11945     * @p func to the beginning of the list, instead of the end.
11946     *
11947     * @param obj The anchorblock object
11948     * @param func The function to add to the list of providers
11949     * @param data User data that will be passed to the callback function
11950     */
11951    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);
11952    /**
11953     * Remove a custom item provider from the list of the given anchorblock
11954     *
11955     * Removes the function and data pairing that matches @p func and @p data.
11956     * That is, unless the same function and same user data are given, the
11957     * function will not be removed from the list. This allows us to add the
11958     * same callback several times, with different @p data pointers and be
11959     * able to remove them later without conflicts.
11960     *
11961     * @param obj The anchorblock object
11962     * @param func The function to remove from the list
11963     * @param data The data matching the function to remove from the list
11964     */
11965    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);
11966    /**
11967     * @}
11968     */
11969
11970    /**
11971     * @defgroup Bubble Bubble
11972     *
11973     * @image html img/widget/bubble/preview-00.png
11974     * @image latex img/widget/bubble/preview-00.eps
11975     * @image html img/widget/bubble/preview-01.png
11976     * @image latex img/widget/bubble/preview-01.eps
11977     * @image html img/widget/bubble/preview-02.png
11978     * @image latex img/widget/bubble/preview-02.eps
11979     *
11980     * @brief The Bubble is a widget to show text similarly to how speech is
11981     * represented in comics.
11982     *
11983     * The bubble widget contains 5 important visual elements:
11984     * @li The frame is a rectangle with rounded rectangles and an "arrow".
11985     * @li The @p icon is an image to which the frame's arrow points to.
11986     * @li The @p label is a text which appears to the right of the icon if the
11987     * corner is "top_left" or "bottom_left" and is right aligned to the frame
11988     * otherwise.
11989     * @li The @p info is a text which appears to the right of the label. Info's
11990     * font is of a ligther color than label.
11991     * @li The @p content is an evas object that is shown inside the frame.
11992     *
11993     * The position of the arrow, icon, label and info depends on which corner is
11994     * selected. The four available corners are:
11995     * @li "top_left" - Default
11996     * @li "top_right"
11997     * @li "bottom_left"
11998     * @li "bottom_right"
11999     *
12000     * Signals that you can add callbacks for are:
12001     * @li "clicked" - This is called when a user has clicked the bubble.
12002     *
12003     * For an example of using a buble see @ref bubble_01_example_page "this".
12004     *
12005     * @{
12006     */
12007    /**
12008     * Add a new bubble to the parent
12009     *
12010     * @param parent The parent object
12011     * @return The new object or NULL if it cannot be created
12012     *
12013     * This function adds a text bubble to the given parent evas object.
12014     */
12015    EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12016    /**
12017     * Set the label of the bubble
12018     *
12019     * @param obj The bubble object
12020     * @param label The string to set in the label
12021     *
12022     * This function sets the title of the bubble. Where this appears depends on
12023     * the selected corner.
12024     * @deprecated use elm_object_text_set() instead.
12025     */
12026    EINA_DEPRECATED EAPI void         elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12027    /**
12028     * Get the label of the bubble
12029     *
12030     * @param obj The bubble object
12031     * @return The string of set in the label
12032     *
12033     * This function gets the title of the bubble.
12034     * @deprecated use elm_object_text_get() instead.
12035     */
12036    EINA_DEPRECATED EAPI const char  *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12037    /**
12038     * Set the info of the bubble
12039     *
12040     * @param obj The bubble object
12041     * @param info The given info about the bubble
12042     *
12043     * This function sets the info of the bubble. Where this appears depends on
12044     * the selected corner.
12045     * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
12046     */
12047    EINA_DEPRECATED EAPI void         elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12048    /**
12049     * Get the info of the bubble
12050     *
12051     * @param obj The bubble object
12052     *
12053     * @return The "info" string of the bubble
12054     *
12055     * This function gets the info text.
12056     * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
12057     */
12058    EINA_DEPRECATED EAPI const char  *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12059    /**
12060     * Set the content to be shown in the bubble
12061     *
12062     * Once the content object is set, a previously set one will be deleted.
12063     * If you want to keep the old content object, use the
12064     * elm_bubble_content_unset() function.
12065     *
12066     * @param obj The bubble object
12067     * @param content The given content of the bubble
12068     *
12069     * This function sets the content shown on the middle of the bubble.
12070     */
12071    EAPI void         elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12072    /**
12073     * Get the content shown in the bubble
12074     *
12075     * Return the content object which is set for this widget.
12076     *
12077     * @param obj The bubble object
12078     * @return The content that is being used
12079     */
12080    EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12081    /**
12082     * Unset the content shown in the bubble
12083     *
12084     * Unparent and return the content object which was set for this widget.
12085     *
12086     * @param obj The bubble object
12087     * @return The content that was being used
12088     */
12089    EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12090    /**
12091     * Set the icon of the bubble
12092     *
12093     * Once the icon object is set, a previously set one will be deleted.
12094     * If you want to keep the old content object, use the
12095     * elm_icon_content_unset() function.
12096     *
12097     * @param obj The bubble object
12098     * @param icon The given icon for the bubble
12099     */
12100    EAPI void         elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12101    /**
12102     * Get the icon of the bubble
12103     *
12104     * @param obj The bubble object
12105     * @return The icon for the bubble
12106     *
12107     * This function gets the icon shown on the top left of bubble.
12108     */
12109    EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12110    /**
12111     * Unset the icon of the bubble
12112     *
12113     * Unparent and return the icon object which was set for this widget.
12114     *
12115     * @param obj The bubble object
12116     * @return The icon that was being used
12117     */
12118    EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12119    /**
12120     * Set the corner of the bubble
12121     *
12122     * @param obj The bubble object.
12123     * @param corner The given corner for the bubble.
12124     *
12125     * This function sets the corner of the bubble. The corner will be used to
12126     * determine where the arrow in the frame points to and where label, icon and
12127     * info arre shown.
12128     *
12129     * Possible values for corner are:
12130     * @li "top_left" - Default
12131     * @li "top_right"
12132     * @li "bottom_left"
12133     * @li "bottom_right"
12134     */
12135    EAPI void         elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12136    /**
12137     * Get the corner of the bubble
12138     *
12139     * @param obj The bubble object.
12140     * @return The given corner for the bubble.
12141     *
12142     * This function gets the selected corner of the bubble.
12143     */
12144    EAPI const char  *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12145    /**
12146     * @}
12147     */
12148
12149    /**
12150     * @defgroup Photo Photo
12151     *
12152     * For displaying the photo of a person (contact). Simple yet
12153     * with a very specific purpose.
12154     *
12155     * Signals that you can add callbacks for are:
12156     *
12157     * "clicked" - This is called when a user has clicked the photo
12158     * "drag,start" - Someone started dragging the image out of the object
12159     * "drag,end" - Dragged item was dropped (somewhere)
12160     *
12161     * @{
12162     */
12163
12164    /**
12165     * Add a new photo to the parent
12166     *
12167     * @param parent The parent object
12168     * @return The new object or NULL if it cannot be created
12169     *
12170     * @ingroup Photo
12171     */
12172    EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12173
12174    /**
12175     * Set the file that will be used as photo
12176     *
12177     * @param obj The photo object
12178     * @param file The path to file that will be used as photo
12179     *
12180     * @return (1 = success, 0 = error)
12181     *
12182     * @ingroup Photo
12183     */
12184    EAPI Eina_Bool    elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12185
12186     /**
12187     * Set the file that will be used as thumbnail in the photo.
12188     *
12189     * @param obj The photo object.
12190     * @param file The path to file that will be used as thumb.
12191     * @param group The key used in case of an EET file.
12192     *
12193     * @ingroup Photo
12194     */
12195    EAPI void         elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12196
12197    /**
12198     * Set the size that will be used on the photo
12199     *
12200     * @param obj The photo object
12201     * @param size The size that the photo will be
12202     *
12203     * @ingroup Photo
12204     */
12205    EAPI void         elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12206
12207    /**
12208     * Set if the photo should be completely visible or not.
12209     *
12210     * @param obj The photo object
12211     * @param fill if true the photo will be completely visible
12212     *
12213     * @ingroup Photo
12214     */
12215    EAPI void         elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12216
12217    /**
12218     * Set editability of the photo.
12219     *
12220     * An editable photo can be dragged to or from, and can be cut or
12221     * pasted too.  Note that pasting an image or dropping an item on
12222     * the image will delete the existing content.
12223     *
12224     * @param obj The photo object.
12225     * @param set To set of clear editablity.
12226     */
12227    EAPI void         elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12228
12229    /**
12230     * @}
12231     */
12232
12233    /* gesture layer */
12234    /**
12235     * @defgroup Elm_Gesture_Layer Gesture Layer
12236     * Gesture Layer Usage:
12237     *
12238     * Use Gesture Layer to detect gestures.
12239     * The advantage is that you don't have to implement
12240     * gesture detection, just set callbacks of gesture state.
12241     * By using gesture layer we make standard interface.
12242     *
12243     * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12244     * with a parent object parameter.
12245     * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12246     * call. Usually with same object as target (2nd parameter).
12247     *
12248     * Now you need to tell gesture layer what gestures you follow.
12249     * This is done with @ref elm_gesture_layer_cb_set call.
12250     * By setting the callback you actually saying to gesture layer:
12251     * I would like to know when the gesture @ref Elm_Gesture_Types
12252     * switches to state @ref Elm_Gesture_State.
12253     *
12254     * Next, you need to implement the actual action that follows the input
12255     * in your callback.
12256     *
12257     * Note that if you like to stop being reported about a gesture, just set
12258     * all callbacks referring this gesture to NULL.
12259     * (again with @ref elm_gesture_layer_cb_set)
12260     *
12261     * The information reported by gesture layer to your callback is depending
12262     * on @ref Elm_Gesture_Types:
12263     * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12264     * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12265     * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12266     *
12267     * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12268     * @ref ELM_GESTURE_MOMENTUM.
12269     *
12270     * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12271     * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12272     * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12273     * Note that we consider a flick as a line-gesture that should be completed
12274     * in flick-time-limit as defined in @ref Config.
12275     *
12276     * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12277     *
12278     * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12279     *
12280     *
12281     * Gesture Layer Tweaks:
12282     *
12283     * Note that line, flick, gestures can start without the need to remove fingers from surface.
12284     * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12285     *
12286     * Setting glayer_continues_enable to false in @ref Config will change this behavior
12287     * so gesture starts when user touches (a *DOWN event) touch-surface
12288     * and ends when no fingers touches surface (a *UP event).
12289     */
12290
12291    /**
12292     * @enum _Elm_Gesture_Types
12293     * Enum of supported gesture types.
12294     * @ingroup Elm_Gesture_Layer
12295     */
12296    enum _Elm_Gesture_Types
12297      {
12298         ELM_GESTURE_FIRST = 0,
12299
12300         ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12301         ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12302         ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12303         ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12304
12305         ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12306
12307         ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12308         ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12309
12310         ELM_GESTURE_ZOOM, /**< Zoom */
12311         ELM_GESTURE_ROTATE, /**< Rotate */
12312
12313         ELM_GESTURE_LAST
12314      };
12315
12316    /**
12317     * @typedef Elm_Gesture_Types
12318     * gesture types enum
12319     * @ingroup Elm_Gesture_Layer
12320     */
12321    typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12322
12323    /**
12324     * @enum _Elm_Gesture_State
12325     * Enum of gesture states.
12326     * @ingroup Elm_Gesture_Layer
12327     */
12328    enum _Elm_Gesture_State
12329      {
12330         ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12331         ELM_GESTURE_STATE_START,          /**< Gesture STARTed     */
12332         ELM_GESTURE_STATE_MOVE,           /**< Gesture is ongoing  */
12333         ELM_GESTURE_STATE_END,            /**< Gesture completed   */
12334         ELM_GESTURE_STATE_ABORT    /**< Onging gesture was ABORTed */
12335      };
12336
12337    /**
12338     * @typedef Elm_Gesture_State
12339     * gesture states enum
12340     * @ingroup Elm_Gesture_Layer
12341     */
12342    typedef enum _Elm_Gesture_State Elm_Gesture_State;
12343
12344    /**
12345     * @struct _Elm_Gesture_Taps_Info
12346     * Struct holds taps info for user
12347     * @ingroup Elm_Gesture_Layer
12348     */
12349    struct _Elm_Gesture_Taps_Info
12350      {
12351         Evas_Coord x, y;         /**< Holds center point between fingers */
12352         unsigned int n;          /**< Number of fingers tapped           */
12353         unsigned int timestamp;  /**< event timestamp       */
12354      };
12355
12356    /**
12357     * @typedef Elm_Gesture_Taps_Info
12358     * holds taps info for user
12359     * @ingroup Elm_Gesture_Layer
12360     */
12361    typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12362
12363    /**
12364     * @struct _Elm_Gesture_Momentum_Info
12365     * Struct holds momentum info for user
12366     * x1 and y1 are not necessarily in sync
12367     * x1 holds x value of x direction starting point
12368     * and same holds for y1.
12369     * This is noticeable when doing V-shape movement
12370     * @ingroup Elm_Gesture_Layer
12371     */
12372    struct _Elm_Gesture_Momentum_Info
12373      {  /* Report line ends, timestamps, and momentum computed        */
12374         Evas_Coord x1; /**< Final-swipe direction starting point on X */
12375         Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12376         Evas_Coord x2; /**< Final-swipe direction ending point on X   */
12377         Evas_Coord y2; /**< Final-swipe direction ending point on Y   */
12378
12379         unsigned int tx; /**< Timestamp of start of final x-swipe */
12380         unsigned int ty; /**< Timestamp of start of final y-swipe */
12381
12382         Evas_Coord mx; /**< Momentum on X */
12383         Evas_Coord my; /**< Momentum on Y */
12384      };
12385
12386    /**
12387     * @typedef Elm_Gesture_Momentum_Info
12388     * holds momentum info for user
12389     * @ingroup Elm_Gesture_Layer
12390     */
12391     typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12392
12393    /**
12394     * @struct _Elm_Gesture_Line_Info
12395     * Struct holds line info for user
12396     * @ingroup Elm_Gesture_Layer
12397     */
12398    struct _Elm_Gesture_Line_Info
12399      {  /* Report line ends, timestamps, and momentum computed      */
12400         Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12401         unsigned int n;            /**< Number of fingers (lines)   */
12402         /* FIXME should be radians, bot degrees */
12403         double angle;              /**< Angle (direction) of lines  */
12404      };
12405
12406    /**
12407     * @typedef Elm_Gesture_Line_Info
12408     * Holds line info for user
12409     * @ingroup Elm_Gesture_Layer
12410     */
12411     typedef struct  _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12412
12413    /**
12414     * @struct _Elm_Gesture_Zoom_Info
12415     * Struct holds zoom info for user
12416     * @ingroup Elm_Gesture_Layer
12417     */
12418    struct _Elm_Gesture_Zoom_Info
12419      {
12420         Evas_Coord x, y;       /**< Holds zoom center point reported to user  */
12421         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12422         double zoom;            /**< Zoom value: 1.0 means no zoom             */
12423         double momentum;        /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12424      };
12425
12426    /**
12427     * @typedef Elm_Gesture_Zoom_Info
12428     * Holds zoom info for user
12429     * @ingroup Elm_Gesture_Layer
12430     */
12431    typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12432
12433    /**
12434     * @struct _Elm_Gesture_Rotate_Info
12435     * Struct holds rotation info for user
12436     * @ingroup Elm_Gesture_Layer
12437     */
12438    struct _Elm_Gesture_Rotate_Info
12439      {
12440         Evas_Coord x, y;   /**< Holds zoom center point reported to user      */
12441         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12442         double base_angle; /**< Holds start-angle */
12443         double angle;      /**< Rotation value: 0.0 means no rotation         */
12444         double momentum;   /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12445      };
12446
12447    /**
12448     * @typedef Elm_Gesture_Rotate_Info
12449     * Holds rotation info for user
12450     * @ingroup Elm_Gesture_Layer
12451     */
12452    typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12453
12454    /**
12455     * @typedef Elm_Gesture_Event_Cb
12456     * User callback used to stream gesture info from gesture layer
12457     * @param data user data
12458     * @param event_info gesture report info
12459     * Returns a flag field to be applied on the causing event.
12460     * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12461     * upon the event, in an irreversible way.
12462     *
12463     * @ingroup Elm_Gesture_Layer
12464     */
12465    typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12466
12467    /**
12468     * Use function to set callbacks to be notified about
12469     * change of state of gesture.
12470     * When a user registers a callback with this function
12471     * this means this gesture has to be tested.
12472     *
12473     * When ALL callbacks for a gesture are set to NULL
12474     * it means user isn't interested in gesture-state
12475     * and it will not be tested.
12476     *
12477     * @param obj Pointer to gesture-layer.
12478     * @param idx The gesture you would like to track its state.
12479     * @param cb callback function pointer.
12480     * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12481     * @param data user info to be sent to callback (usually, Smart Data)
12482     *
12483     * @ingroup Elm_Gesture_Layer
12484     */
12485    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);
12486
12487    /**
12488     * Call this function to get repeat-events settings.
12489     *
12490     * @param obj Pointer to gesture-layer.
12491     *
12492     * @return repeat events settings.
12493     * @see elm_gesture_layer_hold_events_set()
12494     * @ingroup Elm_Gesture_Layer
12495     */
12496    EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12497
12498    /**
12499     * This function called in order to make gesture-layer repeat events.
12500     * Set this of you like to get the raw events only if gestures were not detected.
12501     * Clear this if you like gesture layer to fwd events as testing gestures.
12502     *
12503     * @param obj Pointer to gesture-layer.
12504     * @param r Repeat: TRUE/FALSE
12505     *
12506     * @ingroup Elm_Gesture_Layer
12507     */
12508    EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12509
12510    /**
12511     * This function sets step-value for zoom action.
12512     * Set step to any positive value.
12513     * Cancel step setting by setting to 0.0
12514     *
12515     * @param obj Pointer to gesture-layer.
12516     * @param s new zoom step value.
12517     *
12518     * @ingroup Elm_Gesture_Layer
12519     */
12520    EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12521
12522    /**
12523     * This function sets step-value for rotate action.
12524     * Set step to any positive value.
12525     * Cancel step setting by setting to 0.0
12526     *
12527     * @param obj Pointer to gesture-layer.
12528     * @param s new roatate step value.
12529     *
12530     * @ingroup Elm_Gesture_Layer
12531     */
12532    EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12533
12534    /**
12535     * This function called to attach gesture-layer to an Evas_Object.
12536     * @param obj Pointer to gesture-layer.
12537     * @param t Pointer to underlying object (AKA Target)
12538     *
12539     * @return TRUE, FALSE on success, failure.
12540     *
12541     * @ingroup Elm_Gesture_Layer
12542     */
12543    EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12544
12545    /**
12546     * Call this function to construct a new gesture-layer object.
12547     * This does not activate the gesture layer. You have to
12548     * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12549     *
12550     * @param parent the parent object.
12551     *
12552     * @return Pointer to new gesture-layer object.
12553     *
12554     * @ingroup Elm_Gesture_Layer
12555     */
12556    EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12557
12558    /**
12559     * @defgroup Thumb Thumb
12560     *
12561     * @image html img/widget/thumb/preview-00.png
12562     * @image latex img/widget/thumb/preview-00.eps
12563     *
12564     * A thumb object is used for displaying the thumbnail of an image or video.
12565     * You must have compiled Elementary with Ethumb_Client support and the DBus
12566     * service must be present and auto-activated in order to have thumbnails to
12567     * be generated.
12568     *
12569     * Once the thumbnail object becomes visible, it will check if there is a
12570     * previously generated thumbnail image for the file set on it. If not, it
12571     * will start generating this thumbnail.
12572     *
12573     * Different config settings will cause different thumbnails to be generated
12574     * even on the same file.
12575     *
12576     * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12577     * Ethumb documentation to change this path, and to see other configuration
12578     * options.
12579     *
12580     * Signals that you can add callbacks for are:
12581     *
12582     * - "clicked" - This is called when a user has clicked the thumb without dragging
12583     *             around.
12584     * - "clicked,double" - This is called when a user has double-clicked the thumb.
12585     * - "press" - This is called when a user has pressed down the thumb.
12586     * - "generate,start" - The thumbnail generation started.
12587     * - "generate,stop" - The generation process stopped.
12588     * - "generate,error" - The generation failed.
12589     * - "load,error" - The thumbnail image loading failed.
12590     *
12591     * available styles:
12592     * - default
12593     * - noframe
12594     *
12595     * An example of use of thumbnail:
12596     *
12597     * - @ref thumb_example_01
12598     */
12599
12600    /**
12601     * @addtogroup Thumb
12602     * @{
12603     */
12604
12605    /**
12606     * @enum _Elm_Thumb_Animation_Setting
12607     * @typedef Elm_Thumb_Animation_Setting
12608     *
12609     * Used to set if a video thumbnail is animating or not.
12610     *
12611     * @ingroup Thumb
12612     */
12613    typedef enum _Elm_Thumb_Animation_Setting
12614      {
12615         ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12616         ELM_THUMB_ANIMATION_LOOP,      /**< Keep playing animation until stop is requested */
12617         ELM_THUMB_ANIMATION_STOP,      /**< Stop playing the animation */
12618         ELM_THUMB_ANIMATION_LAST
12619      } Elm_Thumb_Animation_Setting;
12620
12621    /**
12622     * Add a new thumb object to the parent.
12623     *
12624     * @param parent The parent object.
12625     * @return The new object or NULL if it cannot be created.
12626     *
12627     * @see elm_thumb_file_set()
12628     * @see elm_thumb_ethumb_client_get()
12629     *
12630     * @ingroup Thumb
12631     */
12632    EAPI Evas_Object                 *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12633    /**
12634     * Reload thumbnail if it was generated before.
12635     *
12636     * @param obj The thumb object to reload
12637     *
12638     * This is useful if the ethumb client configuration changed, like its
12639     * size, aspect or any other property one set in the handle returned
12640     * by elm_thumb_ethumb_client_get().
12641     *
12642     * If the options didn't change, the thumbnail won't be generated again, but
12643     * the old one will still be used.
12644     *
12645     * @see elm_thumb_file_set()
12646     *
12647     * @ingroup Thumb
12648     */
12649    EAPI void                         elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
12650    /**
12651     * Set the file that will be used as thumbnail.
12652     *
12653     * @param obj The thumb object.
12654     * @param file The path to file that will be used as thumb.
12655     * @param key The key used in case of an EET file.
12656     *
12657     * The file can be an image or a video (in that case, acceptable extensions are:
12658     * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
12659     * function elm_thumb_animate().
12660     *
12661     * @see elm_thumb_file_get()
12662     * @see elm_thumb_reload()
12663     * @see elm_thumb_animate()
12664     *
12665     * @ingroup Thumb
12666     */
12667    EAPI void                         elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
12668    /**
12669     * Get the image or video path and key used to generate the thumbnail.
12670     *
12671     * @param obj The thumb object.
12672     * @param file Pointer to filename.
12673     * @param key Pointer to key.
12674     *
12675     * @see elm_thumb_file_set()
12676     * @see elm_thumb_path_get()
12677     *
12678     * @ingroup Thumb
12679     */
12680    EAPI void                         elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12681    /**
12682     * Get the path and key to the image or video generated by ethumb.
12683     *
12684     * One just need to make sure that the thumbnail was generated before getting
12685     * its path; otherwise, the path will be NULL. One way to do that is by asking
12686     * for the path when/after the "generate,stop" smart callback is called.
12687     *
12688     * @param obj The thumb object.
12689     * @param file Pointer to thumb path.
12690     * @param key Pointer to thumb key.
12691     *
12692     * @see elm_thumb_file_get()
12693     *
12694     * @ingroup Thumb
12695     */
12696    EAPI void                         elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12697    /**
12698     * Set the animation state for the thumb object. If its content is an animated
12699     * video, you may start/stop the animation or tell it to play continuously and
12700     * looping.
12701     *
12702     * @param obj The thumb object.
12703     * @param setting The animation setting.
12704     *
12705     * @see elm_thumb_file_set()
12706     *
12707     * @ingroup Thumb
12708     */
12709    EAPI void                         elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
12710    /**
12711     * Get the animation state for the thumb object.
12712     *
12713     * @param obj The thumb object.
12714     * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
12715     * on errors.
12716     *
12717     * @see elm_thumb_animate_set()
12718     *
12719     * @ingroup Thumb
12720     */
12721    EAPI Elm_Thumb_Animation_Setting  elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12722    /**
12723     * Get the ethumb_client handle so custom configuration can be made.
12724     *
12725     * @return Ethumb_Client instance or NULL.
12726     *
12727     * This must be called before the objects are created to be sure no object is
12728     * visible and no generation started.
12729     *
12730     * Example of usage:
12731     *
12732     * @code
12733     * #include <Elementary.h>
12734     * #ifndef ELM_LIB_QUICKLAUNCH
12735     * EAPI_MAIN int
12736     * elm_main(int argc, char **argv)
12737     * {
12738     *    Ethumb_Client *client;
12739     *
12740     *    elm_need_ethumb();
12741     *
12742     *    // ... your code
12743     *
12744     *    client = elm_thumb_ethumb_client_get();
12745     *    if (!client)
12746     *      {
12747     *         ERR("could not get ethumb_client");
12748     *         return 1;
12749     *      }
12750     *    ethumb_client_size_set(client, 100, 100);
12751     *    ethumb_client_crop_align_set(client, 0.5, 0.5);
12752     *    // ... your code
12753     *
12754     *    // Create elm_thumb objects here
12755     *
12756     *    elm_run();
12757     *    elm_shutdown();
12758     *    return 0;
12759     * }
12760     * #endif
12761     * ELM_MAIN()
12762     * @endcode
12763     *
12764     * @note There's only one client handle for Ethumb, so once a configuration
12765     * change is done to it, any other request for thumbnails (for any thumbnail
12766     * object) will use that configuration. Thus, this configuration is global.
12767     *
12768     * @ingroup Thumb
12769     */
12770    EAPI void                        *elm_thumb_ethumb_client_get(void);
12771    /**
12772     * Get the ethumb_client connection state.
12773     *
12774     * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
12775     * otherwise.
12776     */
12777    EAPI Eina_Bool                    elm_thumb_ethumb_client_connected(void);
12778    /**
12779     * Make the thumbnail 'editable'.
12780     *
12781     * @param obj Thumb object.
12782     * @param set Turn on or off editability. Default is @c EINA_FALSE.
12783     *
12784     * This means the thumbnail is a valid drag target for drag and drop, and can be
12785     * cut or pasted too.
12786     *
12787     * @see elm_thumb_editable_get()
12788     *
12789     * @ingroup Thumb
12790     */
12791    EAPI Eina_Bool                    elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
12792    /**
12793     * Make the thumbnail 'editable'.
12794     *
12795     * @param obj Thumb object.
12796     * @return Editability.
12797     *
12798     * This means the thumbnail is a valid drag target for drag and drop, and can be
12799     * cut or pasted too.
12800     *
12801     * @see elm_thumb_editable_set()
12802     *
12803     * @ingroup Thumb
12804     */
12805    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12806
12807    /**
12808     * @}
12809     */
12810
12811    /**
12812     * @defgroup Hoversel Hoversel
12813     *
12814     * @image html img/widget/hoversel/preview-00.png
12815     * @image latex img/widget/hoversel/preview-00.eps
12816     *
12817     * A hoversel is a button that pops up a list of items (automatically
12818     * choosing the direction to display) that have a label and, optionally, an
12819     * icon to select from. It is a convenience widget to avoid the need to do
12820     * all the piecing together yourself. It is intended for a small number of
12821     * items in the hoversel menu (no more than 8), though is capable of many
12822     * more.
12823     *
12824     * Signals that you can add callbacks for are:
12825     * "clicked" - the user clicked the hoversel button and popped up the sel
12826     * "selected" - an item in the hoversel list is selected. event_info is the item
12827     * "dismissed" - the hover is dismissed
12828     *
12829     * See @ref tutorial_hoversel for an example.
12830     * @{
12831     */
12832    typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
12833    /**
12834     * @brief Add a new Hoversel object
12835     *
12836     * @param parent The parent object
12837     * @return The new object or NULL if it cannot be created
12838     */
12839    EAPI Evas_Object       *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12840    /**
12841     * @brief This sets the hoversel to expand horizontally.
12842     *
12843     * @param obj The hoversel object
12844     * @param horizontal If true, the hover will expand horizontally to the
12845     * right.
12846     *
12847     * @note The initial button will display horizontally regardless of this
12848     * setting.
12849     */
12850    EAPI void               elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
12851    /**
12852     * @brief This returns whether the hoversel is set to expand horizontally.
12853     *
12854     * @param obj The hoversel object
12855     * @return If true, the hover will expand horizontally to the right.
12856     *
12857     * @see elm_hoversel_horizontal_set()
12858     */
12859    EAPI Eina_Bool          elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12860    /**
12861     * @brief Set the Hover parent
12862     *
12863     * @param obj The hoversel object
12864     * @param parent The parent to use
12865     *
12866     * Sets the hover parent object, the area that will be darkened when the
12867     * hoversel is clicked. Should probably be the window that the hoversel is
12868     * in. See @ref Hover objects for more information.
12869     */
12870    EAPI void               elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12871    /**
12872     * @brief Get the Hover parent
12873     *
12874     * @param obj The hoversel object
12875     * @return The used parent
12876     *
12877     * Gets the hover parent object.
12878     *
12879     * @see elm_hoversel_hover_parent_set()
12880     */
12881    EAPI Evas_Object       *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12882    /**
12883     * @brief Set the hoversel button label
12884     *
12885     * @param obj The hoversel object
12886     * @param label The label text.
12887     *
12888     * This sets the label of the button that is always visible (before it is
12889     * clicked and expanded).
12890     *
12891     * @deprecated elm_object_text_set()
12892     */
12893    EINA_DEPRECATED EAPI void               elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12894    /**
12895     * @brief Get the hoversel button label
12896     *
12897     * @param obj The hoversel object
12898     * @return The label text.
12899     *
12900     * @deprecated elm_object_text_get()
12901     */
12902    EINA_DEPRECATED EAPI const char        *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12903    /**
12904     * @brief Set the icon of the hoversel button
12905     *
12906     * @param obj The hoversel object
12907     * @param icon The icon object
12908     *
12909     * Sets the icon of the button that is always visible (before it is clicked
12910     * and expanded).  Once the icon object is set, a previously set one will be
12911     * deleted, if you want to keep that old content object, use the
12912     * elm_hoversel_icon_unset() function.
12913     *
12914     * @see elm_button_icon_set()
12915     */
12916    EAPI void               elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12917    /**
12918     * @brief Get the icon of the hoversel button
12919     *
12920     * @param obj The hoversel object
12921     * @return The icon object
12922     *
12923     * Get the icon of the button that is always visible (before it is clicked
12924     * and expanded). Also see elm_button_icon_get().
12925     *
12926     * @see elm_hoversel_icon_set()
12927     */
12928    EAPI Evas_Object       *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12929    /**
12930     * @brief Get and unparent the icon of the hoversel button
12931     *
12932     * @param obj The hoversel object
12933     * @return The icon object that was being used
12934     *
12935     * Unparent and return the icon of the button that is always visible
12936     * (before it is clicked and expanded).
12937     *
12938     * @see elm_hoversel_icon_set()
12939     * @see elm_button_icon_unset()
12940     */
12941    EAPI Evas_Object       *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12942    /**
12943     * @brief This triggers the hoversel popup from code, the same as if the user
12944     * had clicked the button.
12945     *
12946     * @param obj The hoversel object
12947     */
12948    EAPI void               elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
12949    /**
12950     * @brief This dismisses the hoversel popup as if the user had clicked
12951     * outside the hover.
12952     *
12953     * @param obj The hoversel object
12954     */
12955    EAPI void               elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12956    /**
12957     * @brief Returns whether the hoversel is expanded.
12958     *
12959     * @param obj The hoversel object
12960     * @return  This will return EINA_TRUE if the hoversel is expanded or
12961     * EINA_FALSE if it is not expanded.
12962     */
12963    EAPI Eina_Bool          elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12964    /**
12965     * @brief This will remove all the children items from the hoversel.
12966     *
12967     * @param obj The hoversel object
12968     *
12969     * @warning Should @b not be called while the hoversel is active; use
12970     * elm_hoversel_expanded_get() to check first.
12971     *
12972     * @see elm_hoversel_item_del_cb_set()
12973     * @see elm_hoversel_item_del()
12974     */
12975    EAPI void               elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
12976    /**
12977     * @brief Get the list of items within the given hoversel.
12978     *
12979     * @param obj The hoversel object
12980     * @return Returns a list of Elm_Hoversel_Item*
12981     *
12982     * @see elm_hoversel_item_add()
12983     */
12984    EAPI const Eina_List   *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12985    /**
12986     * @brief Add an item to the hoversel button
12987     *
12988     * @param obj The hoversel object
12989     * @param label The text label to use for the item (NULL if not desired)
12990     * @param icon_file An image file path on disk to use for the icon or standard
12991     * icon name (NULL if not desired)
12992     * @param icon_type The icon type if relevant
12993     * @param func Convenience function to call when this item is selected
12994     * @param data Data to pass to item-related functions
12995     * @return A handle to the item added.
12996     *
12997     * This adds an item to the hoversel to show when it is clicked. Note: if you
12998     * need to use an icon from an edje file then use
12999     * elm_hoversel_item_icon_set() right after the this function, and set
13000     * icon_file to NULL here.
13001     *
13002     * For more information on what @p icon_file and @p icon_type are see the
13003     * @ref Icon "icon documentation".
13004     */
13005    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);
13006    /**
13007     * @brief Delete an item from the hoversel
13008     *
13009     * @param item The item to delete
13010     *
13011     * This deletes the item from the hoversel (should not be called while the
13012     * hoversel is active; use elm_hoversel_expanded_get() to check first).
13013     *
13014     * @see elm_hoversel_item_add()
13015     * @see elm_hoversel_item_del_cb_set()
13016     */
13017    EAPI void               elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
13018    /**
13019     * @brief Set the function to be called when an item from the hoversel is
13020     * freed.
13021     *
13022     * @param item The item to set the callback on
13023     * @param func The function called
13024     *
13025     * That function will receive these parameters:
13026     * @li void *item_data
13027     * @li Evas_Object *the_item_object
13028     * @li Elm_Hoversel_Item *the_object_struct
13029     *
13030     * @see elm_hoversel_item_add()
13031     */
13032    EAPI void               elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
13033    /**
13034     * @brief This returns the data pointer supplied with elm_hoversel_item_add()
13035     * that will be passed to associated function callbacks.
13036     *
13037     * @param item The item to get the data from
13038     * @return The data pointer set with elm_hoversel_item_add()
13039     *
13040     * @see elm_hoversel_item_add()
13041     */
13042    EAPI void              *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
13043    /**
13044     * @brief This returns the label text of the given hoversel item.
13045     *
13046     * @param item The item to get the label
13047     * @return The label text of the hoversel item
13048     *
13049     * @see elm_hoversel_item_add()
13050     */
13051    EAPI const char        *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
13052    /**
13053     * @brief This sets the icon for the given hoversel item.
13054     *
13055     * @param item The item to set the icon
13056     * @param icon_file An image file path on disk to use for the icon or standard
13057     * icon name
13058     * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
13059     * to NULL if the icon is not an edje file
13060     * @param icon_type The icon type
13061     *
13062     * The icon can be loaded from the standard set, from an image file, or from
13063     * an edje file.
13064     *
13065     * @see elm_hoversel_item_add()
13066     */
13067    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);
13068    /**
13069     * @brief Get the icon object of the hoversel item
13070     *
13071     * @param item The item to get the icon from
13072     * @param icon_file The image file path on disk used for the icon or standard
13073     * icon name
13074     * @param icon_group The edje group used if @p icon_file is an edje file. NULL
13075     * if the icon is not an edje file
13076     * @param icon_type The icon type
13077     *
13078     * @see elm_hoversel_item_icon_set()
13079     * @see elm_hoversel_item_add()
13080     */
13081    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);
13082    /**
13083     * @}
13084     */
13085
13086    /**
13087     * @defgroup Toolbar Toolbar
13088     * @ingroup Elementary
13089     *
13090     * @image html img/widget/toolbar/preview-00.png
13091     * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
13092     *
13093     * @image html img/toolbar.png
13094     * @image latex img/toolbar.eps width=\textwidth
13095     *
13096     * A toolbar is a widget that displays a list of items inside
13097     * a box. It can be scrollable, show a menu with items that don't fit
13098     * to toolbar size or even crop them.
13099     *
13100     * Only one item can be selected at a time.
13101     *
13102     * Items can have multiple states, or show menus when selected by the user.
13103     *
13104     * Smart callbacks one can listen to:
13105     * - "clicked" - when the user clicks on a toolbar item and becomes selected.
13106     *
13107     * Available styles for it:
13108     * - @c "default"
13109     * - @c "transparent" - no background or shadow, just show the content
13110     *
13111     * List of examples:
13112     * @li @ref toolbar_example_01
13113     * @li @ref toolbar_example_02
13114     * @li @ref toolbar_example_03
13115     */
13116
13117    /**
13118     * @addtogroup Toolbar
13119     * @{
13120     */
13121
13122    /**
13123     * @enum _Elm_Toolbar_Shrink_Mode
13124     * @typedef Elm_Toolbar_Shrink_Mode
13125     *
13126     * Set toolbar's items display behavior, it can be scrollabel,
13127     * show a menu with exceeding items, or simply hide them.
13128     *
13129     * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
13130     * from elm config.
13131     *
13132     * Values <b> don't </b> work as bitmask, only one can be choosen.
13133     *
13134     * @see elm_toolbar_mode_shrink_set()
13135     * @see elm_toolbar_mode_shrink_get()
13136     *
13137     * @ingroup Toolbar
13138     */
13139    typedef enum _Elm_Toolbar_Shrink_Mode
13140      {
13141         ELM_TOOLBAR_SHRINK_NONE,   /**< Set toolbar minimun size to fit all the items. */
13142         ELM_TOOLBAR_SHRINK_HIDE,   /**< Hide exceeding items. */
13143         ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
13144         ELM_TOOLBAR_SHRINK_MENU    /**< Inserts a button to pop up a menu with exceeding items. */
13145      } Elm_Toolbar_Shrink_Mode;
13146
13147    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(). */
13148
13149    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(). */
13150
13151    /**
13152     * Add a new toolbar widget to the given parent Elementary
13153     * (container) object.
13154     *
13155     * @param parent The parent object.
13156     * @return a new toolbar widget handle or @c NULL, on errors.
13157     *
13158     * This function inserts a new toolbar widget on the canvas.
13159     *
13160     * @ingroup Toolbar
13161     */
13162    EAPI Evas_Object            *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13163
13164    /**
13165     * Set the icon size, in pixels, to be used by toolbar items.
13166     *
13167     * @param obj The toolbar object
13168     * @param icon_size The icon size in pixels
13169     *
13170     * @note Default value is @c 32. It reads value from elm config.
13171     *
13172     * @see elm_toolbar_icon_size_get()
13173     *
13174     * @ingroup Toolbar
13175     */
13176    EAPI void                    elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
13177
13178    /**
13179     * Get the icon size, in pixels, to be used by toolbar items.
13180     *
13181     * @param obj The toolbar object.
13182     * @return The icon size in pixels.
13183     *
13184     * @see elm_toolbar_icon_size_set() for details.
13185     *
13186     * @ingroup Toolbar
13187     */
13188    EAPI int                     elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13189
13190    /**
13191     * Sets icon lookup order, for toolbar items' icons.
13192     *
13193     * @param obj The toolbar object.
13194     * @param order The icon lookup order.
13195     *
13196     * Icons added before calling this function will not be affected.
13197     * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
13198     *
13199     * @see elm_toolbar_icon_order_lookup_get()
13200     *
13201     * @ingroup Toolbar
13202     */
13203    EAPI void                    elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
13204
13205    /**
13206     * Gets the icon lookup order.
13207     *
13208     * @param obj The toolbar object.
13209     * @return The icon lookup order.
13210     *
13211     * @see elm_toolbar_icon_order_lookup_set() for details.
13212     *
13213     * @ingroup Toolbar
13214     */
13215    EAPI Elm_Icon_Lookup_Order   elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13216
13217    /**
13218     * Set whether the toolbar items' should be selected by the user or not.
13219     *
13220     * @param obj The toolbar object.
13221     * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
13222     * enable it.
13223     *
13224     * This will turn off the ability to select items entirely and they will
13225     * neither appear selected nor emit selected signals. The clicked
13226     * callback function will still be called.
13227     *
13228     * Selection is enabled by default.
13229     *
13230     * @see elm_toolbar_no_select_mode_get().
13231     *
13232     * @ingroup Toolbar
13233     */
13234    EAPI void                    elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
13235
13236    /**
13237     * Set whether the toolbar items' should be selected by the user or not.
13238     *
13239     * @param obj The toolbar object.
13240     * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
13241     * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
13242     *
13243     * @see elm_toolbar_no_select_mode_set() for details.
13244     *
13245     * @ingroup Toolbar
13246     */
13247    EAPI Eina_Bool               elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13248
13249    /**
13250     * Append item to the toolbar.
13251     *
13252     * @param obj The toolbar object.
13253     * @param icon A string with icon name or the absolute path of an image file.
13254     * @param label The label of the item.
13255     * @param func The function to call when the item is clicked.
13256     * @param data The data to associate with the item for related callbacks.
13257     * @return The created item or @c NULL upon failure.
13258     *
13259     * A new item will be created and appended to the toolbar, i.e., will
13260     * be set as @b last item.
13261     *
13262     * Items created with this method can be deleted with
13263     * elm_toolbar_item_del().
13264     *
13265     * Associated @p data can be properly freed when item is deleted if a
13266     * callback function is set with elm_toolbar_item_del_cb_set().
13267     *
13268     * If a function is passed as argument, it will be called everytime this item
13269     * is selected, i.e., the user clicks over an unselected item.
13270     * If such function isn't needed, just passing
13271     * @c NULL as @p func is enough. The same should be done for @p data.
13272     *
13273     * Toolbar will load icon image from fdo or current theme.
13274     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13275     * If an absolute path is provided it will load it direct from a file.
13276     *
13277     * @see elm_toolbar_item_icon_set()
13278     * @see elm_toolbar_item_del()
13279     * @see elm_toolbar_item_del_cb_set()
13280     *
13281     * @ingroup Toolbar
13282     */
13283    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);
13284
13285    /**
13286     * Prepend item to the toolbar.
13287     *
13288     * @param obj The toolbar object.
13289     * @param icon A string with icon name or the absolute path of an image file.
13290     * @param label The label of the item.
13291     * @param func The function to call when the item is clicked.
13292     * @param data The data to associate with the item for related callbacks.
13293     * @return The created item or @c NULL upon failure.
13294     *
13295     * A new item will be created and prepended to the toolbar, i.e., will
13296     * be set as @b first item.
13297     *
13298     * Items created with this method can be deleted with
13299     * elm_toolbar_item_del().
13300     *
13301     * Associated @p data can be properly freed when item is deleted if a
13302     * callback function is set with elm_toolbar_item_del_cb_set().
13303     *
13304     * If a function is passed as argument, it will be called everytime this item
13305     * is selected, i.e., the user clicks over an unselected item.
13306     * If such function isn't needed, just passing
13307     * @c NULL as @p func is enough. The same should be done for @p data.
13308     *
13309     * Toolbar will load icon image from fdo or current theme.
13310     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13311     * If an absolute path is provided it will load it direct from a file.
13312     *
13313     * @see elm_toolbar_item_icon_set()
13314     * @see elm_toolbar_item_del()
13315     * @see elm_toolbar_item_del_cb_set()
13316     *
13317     * @ingroup Toolbar
13318     */
13319    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);
13320
13321    /**
13322     * Insert a new item into the toolbar object before item @p before.
13323     *
13324     * @param obj The toolbar object.
13325     * @param before The toolbar item to insert before.
13326     * @param icon A string with icon name or the absolute path of an image file.
13327     * @param label The label of the item.
13328     * @param func The function to call when the item is clicked.
13329     * @param data The data to associate with the item for related callbacks.
13330     * @return The created item or @c NULL upon failure.
13331     *
13332     * A new item will be created and added to the toolbar. Its position in
13333     * this toolbar will be just before item @p before.
13334     *
13335     * Items created with this method can be deleted with
13336     * elm_toolbar_item_del().
13337     *
13338     * Associated @p data can be properly freed when item is deleted if a
13339     * callback function is set with elm_toolbar_item_del_cb_set().
13340     *
13341     * If a function is passed as argument, it will be called everytime this item
13342     * is selected, i.e., the user clicks over an unselected item.
13343     * If such function isn't needed, just passing
13344     * @c NULL as @p func is enough. The same should be done for @p data.
13345     *
13346     * Toolbar will load icon image from fdo or current theme.
13347     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13348     * If an absolute path is provided it will load it direct from a file.
13349     *
13350     * @see elm_toolbar_item_icon_set()
13351     * @see elm_toolbar_item_del()
13352     * @see elm_toolbar_item_del_cb_set()
13353     *
13354     * @ingroup Toolbar
13355     */
13356    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);
13357
13358    /**
13359     * Insert a new item into the toolbar object after item @p after.
13360     *
13361     * @param obj The toolbar object.
13362     * @param before The toolbar item to insert before.
13363     * @param icon A string with icon name or the absolute path of an image file.
13364     * @param label The label of the item.
13365     * @param func The function to call when the item is clicked.
13366     * @param data The data to associate with the item for related callbacks.
13367     * @return The created item or @c NULL upon failure.
13368     *
13369     * A new item will be created and added to the toolbar. Its position in
13370     * this toolbar will be just after item @p after.
13371     *
13372     * Items created with this method can be deleted with
13373     * elm_toolbar_item_del().
13374     *
13375     * Associated @p data can be properly freed when item is deleted if a
13376     * callback function is set with elm_toolbar_item_del_cb_set().
13377     *
13378     * If a function is passed as argument, it will be called everytime this item
13379     * is selected, i.e., the user clicks over an unselected item.
13380     * If such function isn't needed, just passing
13381     * @c NULL as @p func is enough. The same should be done for @p data.
13382     *
13383     * Toolbar will load icon image from fdo or current theme.
13384     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13385     * If an absolute path is provided it will load it direct from a file.
13386     *
13387     * @see elm_toolbar_item_icon_set()
13388     * @see elm_toolbar_item_del()
13389     * @see elm_toolbar_item_del_cb_set()
13390     *
13391     * @ingroup Toolbar
13392     */
13393    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);
13394
13395    /**
13396     * Get the first item in the given toolbar widget's list of
13397     * items.
13398     *
13399     * @param obj The toolbar object
13400     * @return The first item or @c NULL, if it has no items (and on
13401     * errors)
13402     *
13403     * @see elm_toolbar_item_append()
13404     * @see elm_toolbar_last_item_get()
13405     *
13406     * @ingroup Toolbar
13407     */
13408    EAPI Elm_Toolbar_Item       *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13409
13410    /**
13411     * Get the last item in the given toolbar widget's list of
13412     * items.
13413     *
13414     * @param obj The toolbar object
13415     * @return The last item or @c NULL, if it has no items (and on
13416     * errors)
13417     *
13418     * @see elm_toolbar_item_prepend()
13419     * @see elm_toolbar_first_item_get()
13420     *
13421     * @ingroup Toolbar
13422     */
13423    EAPI Elm_Toolbar_Item       *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13424
13425    /**
13426     * Get the item after @p item in toolbar.
13427     *
13428     * @param item The toolbar item.
13429     * @return The item after @p item, or @c NULL if none or on failure.
13430     *
13431     * @note If it is the last item, @c NULL will be returned.
13432     *
13433     * @see elm_toolbar_item_append()
13434     *
13435     * @ingroup Toolbar
13436     */
13437    EAPI Elm_Toolbar_Item       *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13438
13439    /**
13440     * Get the item before @p item in toolbar.
13441     *
13442     * @param item The toolbar item.
13443     * @return The item before @p item, or @c NULL if none or on failure.
13444     *
13445     * @note If it is the first item, @c NULL will be returned.
13446     *
13447     * @see elm_toolbar_item_prepend()
13448     *
13449     * @ingroup Toolbar
13450     */
13451    EAPI Elm_Toolbar_Item       *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13452
13453    /**
13454     * Get the toolbar object from an item.
13455     *
13456     * @param item The item.
13457     * @return The toolbar object.
13458     *
13459     * This returns the toolbar object itself that an item belongs to.
13460     *
13461     * @ingroup Toolbar
13462     */
13463    EAPI Evas_Object            *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13464
13465    /**
13466     * Set the priority of a toolbar item.
13467     *
13468     * @param item The toolbar item.
13469     * @param priority The item priority. The default is zero.
13470     *
13471     * This is used only when the toolbar shrink mode is set to
13472     * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
13473     * When space is less than required, items with low priority
13474     * will be removed from the toolbar and added to a dynamically-created menu,
13475     * while items with higher priority will remain on the toolbar,
13476     * with the same order they were added.
13477     *
13478     * @see elm_toolbar_item_priority_get()
13479     *
13480     * @ingroup Toolbar
13481     */
13482    EAPI void                    elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
13483
13484    /**
13485     * Get the priority of a toolbar item.
13486     *
13487     * @param item The toolbar item.
13488     * @return The @p item priority, or @c 0 on failure.
13489     *
13490     * @see elm_toolbar_item_priority_set() for details.
13491     *
13492     * @ingroup Toolbar
13493     */
13494    EAPI int                     elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13495
13496    /**
13497     * Get the label of item.
13498     *
13499     * @param item The item of toolbar.
13500     * @return The label of item.
13501     *
13502     * The return value is a pointer to the label associated to @p item when
13503     * it was created, with function elm_toolbar_item_append() or similar,
13504     * or later,
13505     * with function elm_toolbar_item_label_set. If no label
13506     * was passed as argument, it will return @c NULL.
13507     *
13508     * @see elm_toolbar_item_label_set() for more details.
13509     * @see elm_toolbar_item_append()
13510     *
13511     * @ingroup Toolbar
13512     */
13513    EAPI const char             *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13514
13515    /**
13516     * Set the label of item.
13517     *
13518     * @param item The item of toolbar.
13519     * @param text The label of item.
13520     *
13521     * The label to be displayed by the item.
13522     * Label will be placed at icons bottom (if set).
13523     *
13524     * If a label was passed as argument on item creation, with function
13525     * elm_toolbar_item_append() or similar, it will be already
13526     * displayed by the item.
13527     *
13528     * @see elm_toolbar_item_label_get()
13529     * @see elm_toolbar_item_append()
13530     *
13531     * @ingroup Toolbar
13532     */
13533    EAPI void                    elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
13534
13535    /**
13536     * Return the data associated with a given toolbar widget item.
13537     *
13538     * @param item The toolbar widget item handle.
13539     * @return The data associated with @p item.
13540     *
13541     * @see elm_toolbar_item_data_set()
13542     *
13543     * @ingroup Toolbar
13544     */
13545    EAPI void                   *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13546
13547    /**
13548     * Set the data associated with a given toolbar widget item.
13549     *
13550     * @param item The toolbar widget item handle.
13551     * @param data The new data pointer to set to @p item.
13552     *
13553     * This sets new item data on @p item.
13554     *
13555     * @warning The old data pointer won't be touched by this function, so
13556     * the user had better to free that old data himself/herself.
13557     *
13558     * @ingroup Toolbar
13559     */
13560    EAPI void                    elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
13561
13562    /**
13563     * Returns a pointer to a toolbar item by its label.
13564     *
13565     * @param obj The toolbar object.
13566     * @param label The label of the item to find.
13567     *
13568     * @return The pointer to the toolbar item matching @p label or @c NULL
13569     * on failure.
13570     *
13571     * @ingroup Toolbar
13572     */
13573    EAPI Elm_Toolbar_Item       *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13574
13575    /*
13576     * Get whether the @p item is selected or not.
13577     *
13578     * @param item The toolbar item.
13579     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
13580     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
13581     *
13582     * @see elm_toolbar_selected_item_set() for details.
13583     * @see elm_toolbar_item_selected_get()
13584     *
13585     * @ingroup Toolbar
13586     */
13587    EAPI Eina_Bool               elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13588
13589    /**
13590     * Set the selected state of an item.
13591     *
13592     * @param item The toolbar item
13593     * @param selected The selected state
13594     *
13595     * This sets the selected state of the given item @p it.
13596     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
13597     *
13598     * If a new item is selected the previosly selected will be unselected.
13599     * Previoulsy selected item can be get with function
13600     * elm_toolbar_selected_item_get().
13601     *
13602     * Selected items will be highlighted.
13603     *
13604     * @see elm_toolbar_item_selected_get()
13605     * @see elm_toolbar_selected_item_get()
13606     *
13607     * @ingroup Toolbar
13608     */
13609    EAPI void                    elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
13610
13611    /**
13612     * Get the selected item.
13613     *
13614     * @param obj The toolbar object.
13615     * @return The selected toolbar item.
13616     *
13617     * The selected item can be unselected with function
13618     * elm_toolbar_item_selected_set().
13619     *
13620     * The selected item always will be highlighted on toolbar.
13621     *
13622     * @see elm_toolbar_selected_items_get()
13623     *
13624     * @ingroup Toolbar
13625     */
13626    EAPI Elm_Toolbar_Item       *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13627
13628    /**
13629     * Set the icon associated with @p item.
13630     *
13631     * @param obj The parent of this item.
13632     * @param item The toolbar item.
13633     * @param icon A string with icon name or the absolute path of an image file.
13634     *
13635     * Toolbar will load icon image from fdo or current theme.
13636     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13637     * If an absolute path is provided it will load it direct from a file.
13638     *
13639     * @see elm_toolbar_icon_order_lookup_set()
13640     * @see elm_toolbar_icon_order_lookup_get()
13641     *
13642     * @ingroup Toolbar
13643     */
13644    EAPI void                    elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
13645
13646    /**
13647     * Get the string used to set the icon of @p item.
13648     *
13649     * @param item The toolbar item.
13650     * @return The string associated with the icon object.
13651     *
13652     * @see elm_toolbar_item_icon_set() for details.
13653     *
13654     * @ingroup Toolbar
13655     */
13656    EAPI const char             *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13657
13658    /**
13659     * Delete them item from the toolbar.
13660     *
13661     * @param item The item of toolbar to be deleted.
13662     *
13663     * @see elm_toolbar_item_append()
13664     * @see elm_toolbar_item_del_cb_set()
13665     *
13666     * @ingroup Toolbar
13667     */
13668    EAPI void                    elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13669
13670    /**
13671     * Set the function called when a toolbar item is freed.
13672     *
13673     * @param item The item to set the callback on.
13674     * @param func The function called.
13675     *
13676     * If there is a @p func, then it will be called prior item's memory release.
13677     * That will be called with the following arguments:
13678     * @li item's data;
13679     * @li item's Evas object;
13680     * @li item itself;
13681     *
13682     * This way, a data associated to a toolbar item could be properly freed.
13683     *
13684     * @ingroup Toolbar
13685     */
13686    EAPI void                    elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
13687
13688    /**
13689     * Get a value whether toolbar item is disabled or not.
13690     *
13691     * @param item The item.
13692     * @return The disabled state.
13693     *
13694     * @see elm_toolbar_item_disabled_set() for more details.
13695     *
13696     * @ingroup Toolbar
13697     */
13698    EAPI Eina_Bool               elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13699
13700    /**
13701     * Sets the disabled/enabled state of a toolbar item.
13702     *
13703     * @param item The item.
13704     * @param disabled The disabled state.
13705     *
13706     * A disabled item cannot be selected or unselected. It will also
13707     * change its appearance (generally greyed out). This sets the
13708     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
13709     * enabled).
13710     *
13711     * @ingroup Toolbar
13712     */
13713    EAPI void                    elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
13714
13715    /**
13716     * Set or unset item as a separator.
13717     *
13718     * @param item The toolbar item.
13719     * @param setting @c EINA_TRUE to set item @p item as separator or
13720     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
13721     *
13722     * Items aren't set as separator by default.
13723     *
13724     * If set as separator it will display separator theme, so won't display
13725     * icons or label.
13726     *
13727     * @see elm_toolbar_item_separator_get()
13728     *
13729     * @ingroup Toolbar
13730     */
13731    EAPI void                    elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
13732
13733    /**
13734     * Get a value whether item is a separator or not.
13735     *
13736     * @param item The toolbar item.
13737     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
13738     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
13739     *
13740     * @see elm_toolbar_item_separator_set() for details.
13741     *
13742     * @ingroup Toolbar
13743     */
13744    EAPI Eina_Bool               elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13745
13746    /**
13747     * Set the shrink state of toolbar @p obj.
13748     *
13749     * @param obj The toolbar object.
13750     * @param shrink_mode Toolbar's items display behavior.
13751     *
13752     * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
13753     * but will enforce a minimun size so all the items will fit, won't scroll
13754     * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
13755     * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
13756     * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
13757     *
13758     * @ingroup Toolbar
13759     */
13760    EAPI void                    elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
13761
13762    /**
13763     * Get the shrink mode of toolbar @p obj.
13764     *
13765     * @param obj The toolbar object.
13766     * @return Toolbar's items display behavior.
13767     *
13768     * @see elm_toolbar_mode_shrink_set() for details.
13769     *
13770     * @ingroup Toolbar
13771     */
13772    EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13773
13774    /**
13775     * Enable/disable homogenous mode.
13776     *
13777     * @param obj The toolbar object
13778     * @param homogeneous Assume the items within the toolbar are of the
13779     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
13780     *
13781     * This will enable the homogeneous mode where items are of the same size.
13782     * @see elm_toolbar_homogeneous_get()
13783     *
13784     * @ingroup Toolbar
13785     */
13786    EAPI void                    elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
13787
13788    /**
13789     * Get whether the homogenous mode is enabled.
13790     *
13791     * @param obj The toolbar object.
13792     * @return Assume the items within the toolbar are of the same height
13793     * and width (EINA_TRUE = on, EINA_FALSE = off).
13794     *
13795     * @see elm_toolbar_homogeneous_set()
13796     *
13797     * @ingroup Toolbar
13798     */
13799    EAPI Eina_Bool               elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13800
13801    /**
13802     * Enable/disable homogenous mode.
13803     *
13804     * @param obj The toolbar object
13805     * @param homogeneous Assume the items within the toolbar are of the
13806     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
13807     *
13808     * This will enable the homogeneous mode where items are of the same size.
13809     * @see elm_toolbar_homogeneous_get()
13810     *
13811     * @deprecated use elm_toolbar_homogeneous_set() instead.
13812     *
13813     * @ingroup Toolbar
13814     */
13815    EINA_DEPRECATED EAPI void    elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
13816
13817    /**
13818     * Get whether the homogenous mode is enabled.
13819     *
13820     * @param obj The toolbar object.
13821     * @return Assume the items within the toolbar are of the same height
13822     * and width (EINA_TRUE = on, EINA_FALSE = off).
13823     *
13824     * @see elm_toolbar_homogeneous_set()
13825     * @deprecated use elm_toolbar_homogeneous_get() instead.
13826     *
13827     * @ingroup Toolbar
13828     */
13829    EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13830
13831    /**
13832     * Set the parent object of the toolbar items' menus.
13833     *
13834     * @param obj The toolbar object.
13835     * @param parent The parent of the menu objects.
13836     *
13837     * Each item can be set as item menu, with elm_toolbar_item_menu_set().
13838     *
13839     * For more details about setting the parent for toolbar menus, see
13840     * elm_menu_parent_set().
13841     *
13842     * @see elm_menu_parent_set() for details.
13843     * @see elm_toolbar_item_menu_set() for details.
13844     *
13845     * @ingroup Toolbar
13846     */
13847    EAPI void                    elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
13848
13849    /**
13850     * Get the parent object of the toolbar items' menus.
13851     *
13852     * @param obj The toolbar object.
13853     * @return The parent of the menu objects.
13854     *
13855     * @see elm_toolbar_menu_parent_set() for details.
13856     *
13857     * @ingroup Toolbar
13858     */
13859    EAPI Evas_Object            *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13860
13861    /**
13862     * Set the alignment of the items.
13863     *
13864     * @param obj The toolbar object.
13865     * @param align The new alignment, a float between <tt> 0.0 </tt>
13866     * and <tt> 1.0 </tt>.
13867     *
13868     * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
13869     * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
13870     * items.
13871     *
13872     * Centered items by default.
13873     *
13874     * @see elm_toolbar_align_get()
13875     *
13876     * @ingroup Toolbar
13877     */
13878    EAPI void                    elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
13879
13880    /**
13881     * Get the alignment of the items.
13882     *
13883     * @param obj The toolbar object.
13884     * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
13885     * <tt> 1.0 </tt>.
13886     *
13887     * @see elm_toolbar_align_set() for details.
13888     *
13889     * @ingroup Toolbar
13890     */
13891    EAPI double                  elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13892
13893    /**
13894     * Set whether the toolbar item opens a menu.
13895     *
13896     * @param item The toolbar item.
13897     * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
13898     *
13899     * A toolbar item can be set to be a menu, using this function.
13900     *
13901     * Once it is set to be a menu, it can be manipulated through the
13902     * menu-like function elm_toolbar_menu_parent_set() and the other
13903     * elm_menu functions, using the Evas_Object @c menu returned by
13904     * elm_toolbar_item_menu_get().
13905     *
13906     * So, items to be displayed in this item's menu should be added with
13907     * elm_menu_item_add().
13908     *
13909     * The following code exemplifies the most basic usage:
13910     * @code
13911     * tb = elm_toolbar_add(win)
13912     * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
13913     * elm_toolbar_item_menu_set(item, EINA_TRUE);
13914     * elm_toolbar_menu_parent_set(tb, win);
13915     * menu = elm_toolbar_item_menu_get(item);
13916     * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
13917     * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
13918     * NULL);
13919     * @endcode
13920     *
13921     * @see elm_toolbar_item_menu_get()
13922     *
13923     * @ingroup Toolbar
13924     */
13925    EAPI void                    elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
13926
13927    /**
13928     * Get toolbar item's menu.
13929     *
13930     * @param item The toolbar item.
13931     * @return Item's menu object or @c NULL on failure.
13932     *
13933     * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
13934     * this function will set it.
13935     *
13936     * @see elm_toolbar_item_menu_set() for details.
13937     *
13938     * @ingroup Toolbar
13939     */
13940    EAPI Evas_Object            *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13941
13942    /**
13943     * Add a new state to @p item.
13944     *
13945     * @param item The item.
13946     * @param icon A string with icon name or the absolute path of an image file.
13947     * @param label The label of the new state.
13948     * @param func The function to call when the item is clicked when this
13949     * state is selected.
13950     * @param data The data to associate with the state.
13951     * @return The toolbar item state, or @c NULL upon failure.
13952     *
13953     * Toolbar will load icon image from fdo or current theme.
13954     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13955     * If an absolute path is provided it will load it direct from a file.
13956     *
13957     * States created with this function can be removed with
13958     * elm_toolbar_item_state_del().
13959     *
13960     * @see elm_toolbar_item_state_del()
13961     * @see elm_toolbar_item_state_sel()
13962     * @see elm_toolbar_item_state_get()
13963     *
13964     * @ingroup Toolbar
13965     */
13966    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);
13967
13968    /**
13969     * Delete a previoulsy added state to @p item.
13970     *
13971     * @param item The toolbar item.
13972     * @param state The state to be deleted.
13973     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
13974     *
13975     * @see elm_toolbar_item_state_add()
13976     */
13977    EAPI Eina_Bool               elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
13978
13979    /**
13980     * Set @p state as the current state of @p it.
13981     *
13982     * @param it The item.
13983     * @param state The state to use.
13984     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
13985     *
13986     * If @p state is @c NULL, it won't select any state and the default item's
13987     * icon and label will be used. It's the same behaviour than
13988     * elm_toolbar_item_state_unser().
13989     *
13990     * @see elm_toolbar_item_state_unset()
13991     *
13992     * @ingroup Toolbar
13993     */
13994    EAPI Eina_Bool               elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
13995
13996    /**
13997     * Unset the state of @p it.
13998     *
13999     * @param it The item.
14000     *
14001     * The default icon and label from this item will be displayed.
14002     *
14003     * @see elm_toolbar_item_state_set() for more details.
14004     *
14005     * @ingroup Toolbar
14006     */
14007    EAPI void                    elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
14008
14009    /**
14010     * Get the current state of @p it.
14011     *
14012     * @param item The item.
14013     * @return The selected state or @c NULL if none is selected or on failure.
14014     *
14015     * @see elm_toolbar_item_state_set() for details.
14016     * @see elm_toolbar_item_state_unset()
14017     * @see elm_toolbar_item_state_add()
14018     *
14019     * @ingroup Toolbar
14020     */
14021    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
14022
14023    /**
14024     * Get the state after selected state in toolbar's @p item.
14025     *
14026     * @param it The toolbar item to change state.
14027     * @return The state after current state, or @c NULL on failure.
14028     *
14029     * If last state is selected, this function will return first state.
14030     *
14031     * @see elm_toolbar_item_state_set()
14032     * @see elm_toolbar_item_state_add()
14033     *
14034     * @ingroup Toolbar
14035     */
14036    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
14037
14038    /**
14039     * Get the state before selected state in toolbar's @p item.
14040     *
14041     * @param it The toolbar item to change state.
14042     * @return The state before current state, or @c NULL on failure.
14043     *
14044     * If first state is selected, this function will return last state.
14045     *
14046     * @see elm_toolbar_item_state_set()
14047     * @see elm_toolbar_item_state_add()
14048     *
14049     * @ingroup Toolbar
14050     */
14051    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
14052
14053    /**
14054     * Set the text to be shown in a given toolbar item's tooltips.
14055     *
14056     * @param item Target item.
14057     * @param text The text to set in the content.
14058     *
14059     * Setup the text as tooltip to object. The item can have only one tooltip,
14060     * so any previous tooltip data - set with this function or
14061     * elm_toolbar_item_tooltip_content_cb_set() - is removed.
14062     *
14063     * @see elm_object_tooltip_text_set() for more details.
14064     *
14065     * @ingroup Toolbar
14066     */
14067    EAPI void             elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
14068
14069    /**
14070     * Set the content to be shown in the tooltip item.
14071     *
14072     * Setup the tooltip to item. The item can have only one tooltip,
14073     * so any previous tooltip data is removed. @p func(with @p data) will
14074     * be called every time that need show the tooltip and it should
14075     * return a valid Evas_Object. This object is then managed fully by
14076     * tooltip system and is deleted when the tooltip is gone.
14077     *
14078     * @param item the toolbar item being attached a tooltip.
14079     * @param func the function used to create the tooltip contents.
14080     * @param data what to provide to @a func as callback data/context.
14081     * @param del_cb called when data is not needed anymore, either when
14082     *        another callback replaces @a func, the tooltip is unset with
14083     *        elm_toolbar_item_tooltip_unset() or the owner @a item
14084     *        dies. This callback receives as the first parameter the
14085     *        given @a data, and @c event_info is the item.
14086     *
14087     * @see elm_object_tooltip_content_cb_set() for more details.
14088     *
14089     * @ingroup Toolbar
14090     */
14091    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);
14092
14093    /**
14094     * Unset tooltip from item.
14095     *
14096     * @param item toolbar item to remove previously set tooltip.
14097     *
14098     * Remove tooltip from item. The callback provided as del_cb to
14099     * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
14100     * it is not used anymore.
14101     *
14102     * @see elm_object_tooltip_unset() for more details.
14103     * @see elm_toolbar_item_tooltip_content_cb_set()
14104     *
14105     * @ingroup Toolbar
14106     */
14107    EAPI void             elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14108
14109    /**
14110     * Sets a different style for this item tooltip.
14111     *
14112     * @note before you set a style you should define a tooltip with
14113     *       elm_toolbar_item_tooltip_content_cb_set() or
14114     *       elm_toolbar_item_tooltip_text_set()
14115     *
14116     * @param item toolbar item with tooltip already set.
14117     * @param style the theme style to use (default, transparent, ...)
14118     *
14119     * @see elm_object_tooltip_style_set() for more details.
14120     *
14121     * @ingroup Toolbar
14122     */
14123    EAPI void             elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
14124
14125    /**
14126     * Get the style for this item tooltip.
14127     *
14128     * @param item toolbar item with tooltip already set.
14129     * @return style the theme style in use, defaults to "default". If the
14130     *         object does not have a tooltip set, then NULL is returned.
14131     *
14132     * @see elm_object_tooltip_style_get() for more details.
14133     * @see elm_toolbar_item_tooltip_style_set()
14134     *
14135     * @ingroup Toolbar
14136     */
14137    EAPI const char      *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14138
14139    /**
14140     * Set the type of mouse pointer/cursor decoration to be shown,
14141     * when the mouse pointer is over the given toolbar widget item
14142     *
14143     * @param item toolbar item to customize cursor on
14144     * @param cursor the cursor type's name
14145     *
14146     * This function works analogously as elm_object_cursor_set(), but
14147     * here the cursor's changing area is restricted to the item's
14148     * area, and not the whole widget's. Note that that item cursors
14149     * have precedence over widget cursors, so that a mouse over an
14150     * item with custom cursor set will always show @b that cursor.
14151     *
14152     * If this function is called twice for an object, a previously set
14153     * cursor will be unset on the second call.
14154     *
14155     * @see elm_object_cursor_set()
14156     * @see elm_toolbar_item_cursor_get()
14157     * @see elm_toolbar_item_cursor_unset()
14158     *
14159     * @ingroup Toolbar
14160     */
14161    EAPI void             elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
14162
14163    /*
14164     * Get the type of mouse pointer/cursor decoration set to be shown,
14165     * when the mouse pointer is over the given toolbar widget item
14166     *
14167     * @param item toolbar item with custom cursor set
14168     * @return the cursor type's name or @c NULL, if no custom cursors
14169     * were set to @p item (and on errors)
14170     *
14171     * @see elm_object_cursor_get()
14172     * @see elm_toolbar_item_cursor_set()
14173     * @see elm_toolbar_item_cursor_unset()
14174     *
14175     * @ingroup Toolbar
14176     */
14177    EAPI const char      *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14178
14179    /**
14180     * Unset any custom mouse pointer/cursor decoration set to be
14181     * shown, when the mouse pointer is over the given toolbar widget
14182     * item, thus making it show the @b default cursor again.
14183     *
14184     * @param item a toolbar item
14185     *
14186     * Use this call to undo any custom settings on this item's cursor
14187     * decoration, bringing it back to defaults (no custom style set).
14188     *
14189     * @see elm_object_cursor_unset()
14190     * @see elm_toolbar_item_cursor_set()
14191     *
14192     * @ingroup Toolbar
14193     */
14194    EAPI void             elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14195
14196    /**
14197     * Set a different @b style for a given custom cursor set for a
14198     * toolbar item.
14199     *
14200     * @param item toolbar item with custom cursor set
14201     * @param style the <b>theme style</b> to use (e.g. @c "default",
14202     * @c "transparent", etc)
14203     *
14204     * This function only makes sense when one is using custom mouse
14205     * cursor decorations <b>defined in a theme file</b>, which can have,
14206     * given a cursor name/type, <b>alternate styles</b> on it. It
14207     * works analogously as elm_object_cursor_style_set(), but here
14208     * applyed only to toolbar item objects.
14209     *
14210     * @warning Before you set a cursor style you should have definen a
14211     *       custom cursor previously on the item, with
14212     *       elm_toolbar_item_cursor_set()
14213     *
14214     * @see elm_toolbar_item_cursor_engine_only_set()
14215     * @see elm_toolbar_item_cursor_style_get()
14216     *
14217     * @ingroup Toolbar
14218     */
14219    EAPI void             elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
14220
14221    /**
14222     * Get the current @b style set for a given toolbar item's custom
14223     * cursor
14224     *
14225     * @param item toolbar item with custom cursor set.
14226     * @return style the cursor style in use. If the object does not
14227     *         have a cursor set, then @c NULL is returned.
14228     *
14229     * @see elm_toolbar_item_cursor_style_set() for more details
14230     *
14231     * @ingroup Toolbar
14232     */
14233    EAPI const char      *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14234
14235    /**
14236     * Set if the (custom)cursor for a given toolbar item should be
14237     * searched in its theme, also, or should only rely on the
14238     * rendering engine.
14239     *
14240     * @param item item with custom (custom) cursor already set on
14241     * @param engine_only Use @c EINA_TRUE to have cursors looked for
14242     * only on those provided by the rendering engine, @c EINA_FALSE to
14243     * have them searched on the widget's theme, as well.
14244     *
14245     * @note This call is of use only if you've set a custom cursor
14246     * for toolbar items, with elm_toolbar_item_cursor_set().
14247     *
14248     * @note By default, cursors will only be looked for between those
14249     * provided by the rendering engine.
14250     *
14251     * @ingroup Toolbar
14252     */
14253    EAPI void             elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
14254
14255    /**
14256     * Get if the (custom) cursor for a given toolbar item is being
14257     * searched in its theme, also, or is only relying on the rendering
14258     * engine.
14259     *
14260     * @param item a toolbar item
14261     * @return @c EINA_TRUE, if cursors are being looked for only on
14262     * those provided by the rendering engine, @c EINA_FALSE if they
14263     * are being searched on the widget's theme, as well.
14264     *
14265     * @see elm_toolbar_item_cursor_engine_only_set(), for more details
14266     *
14267     * @ingroup Toolbar
14268     */
14269    EAPI Eina_Bool        elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14270
14271    /**
14272     * Change a toolbar's orientation
14273     * @param obj The toolbar object
14274     * @param vertical If @c EINA_TRUE, the toolbar is vertical
14275     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
14276     * @ingroup Toolbar
14277     */
14278    EAPI void             elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
14279
14280    /**
14281     * Get a toolbar's orientation
14282     * @param obj The toolbar object
14283     * @return If @c EINA_TRUE, the toolbar is vertical
14284     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
14285     * @ingroup Toolbar
14286     */
14287    EAPI Eina_Bool        elm_toolbar_orientation_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
14288
14289    /**
14290     * @}
14291     */
14292
14293    /**
14294     * @defgroup Tooltips Tooltips
14295     *
14296     * The Tooltip is an (internal, for now) smart object used to show a
14297     * content in a frame on mouse hover of objects(or widgets), with
14298     * tips/information about them.
14299     *
14300     * @{
14301     */
14302
14303    EAPI double       elm_tooltip_delay_get(void);
14304    EAPI Eina_Bool    elm_tooltip_delay_set(double delay);
14305    EAPI void         elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
14306    EAPI void         elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
14307    EAPI void         elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
14308    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);
14309    EAPI void         elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14310    EAPI void         elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
14311    EAPI const char  *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14312    EAPI Eina_Bool    elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
14313    EAPI Eina_Bool    elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
14314
14315    /**
14316     * @}
14317     */
14318
14319    /**
14320     * @defgroup Cursors Cursors
14321     *
14322     * The Elementary cursor is an internal smart object used to
14323     * customize the mouse cursor displayed over objects (or
14324     * widgets). In the most common scenario, the cursor decoration
14325     * comes from the graphical @b engine Elementary is running
14326     * on. Those engines may provide different decorations for cursors,
14327     * and Elementary provides functions to choose them (think of X11
14328     * cursors, as an example).
14329     *
14330     * There's also the possibility of, besides using engine provided
14331     * cursors, also use ones coming from Edje theming files. Both
14332     * globally and per widget, Elementary makes it possible for one to
14333     * make the cursors lookup to be held on engines only or on
14334     * Elementary's theme file, too.
14335     *
14336     * @{
14337     */
14338
14339    /**
14340     * Set the cursor to be shown when mouse is over the object
14341     *
14342     * Set the cursor that will be displayed when mouse is over the
14343     * object. The object can have only one cursor set to it, so if
14344     * this function is called twice for an object, the previous set
14345     * will be unset.
14346     * If using X cursors, a definition of all the valid cursor names
14347     * is listed on Elementary_Cursors.h. If an invalid name is set
14348     * the default cursor will be used.
14349     *
14350     * @param obj the object being set a cursor.
14351     * @param cursor the cursor name to be used.
14352     *
14353     * @ingroup Cursors
14354     */
14355    EAPI void         elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
14356
14357    /**
14358     * Get the cursor to be shown when mouse is over the object
14359     *
14360     * @param obj an object with cursor already set.
14361     * @return the cursor name.
14362     *
14363     * @ingroup Cursors
14364     */
14365    EAPI const char  *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14366
14367    /**
14368     * Unset cursor for object
14369     *
14370     * Unset cursor for object, and set the cursor to default if the mouse
14371     * was over this object.
14372     *
14373     * @param obj Target object
14374     * @see elm_object_cursor_set()
14375     *
14376     * @ingroup Cursors
14377     */
14378    EAPI void         elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14379
14380    /**
14381     * Sets a different style for this object cursor.
14382     *
14383     * @note before you set a style you should define a cursor with
14384     *       elm_object_cursor_set()
14385     *
14386     * @param obj an object with cursor already set.
14387     * @param style the theme style to use (default, transparent, ...)
14388     *
14389     * @ingroup Cursors
14390     */
14391    EAPI void         elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
14392
14393    /**
14394     * Get the style for this object cursor.
14395     *
14396     * @param obj an object with cursor already set.
14397     * @return style the theme style in use, defaults to "default". If the
14398     *         object does not have a cursor set, then NULL is returned.
14399     *
14400     * @ingroup Cursors
14401     */
14402    EAPI const char  *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14403
14404    /**
14405     * Set if the cursor set should be searched on the theme or should use
14406     * the provided by the engine, only.
14407     *
14408     * @note before you set if should look on theme you should define a cursor
14409     * with elm_object_cursor_set(). By default it will only look for cursors
14410     * provided by the engine.
14411     *
14412     * @param obj an object with cursor already set.
14413     * @param engine_only boolean to define it cursors should be looked only
14414     * between the provided by the engine or searched on widget's theme as well.
14415     *
14416     * @ingroup Cursors
14417     */
14418    EAPI void         elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
14419
14420    /**
14421     * Get the cursor engine only usage for this object cursor.
14422     *
14423     * @param obj an object with cursor already set.
14424     * @return engine_only boolean to define it cursors should be
14425     * looked only between the provided by the engine or searched on
14426     * widget's theme as well. If the object does not have a cursor
14427     * set, then EINA_FALSE is returned.
14428     *
14429     * @ingroup Cursors
14430     */
14431    EAPI Eina_Bool    elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14432
14433    /**
14434     * Get the configured cursor engine only usage
14435     *
14436     * This gets the globally configured exclusive usage of engine cursors.
14437     *
14438     * @return 1 if only engine cursors should be used
14439     * @ingroup Cursors
14440     */
14441    EAPI int          elm_cursor_engine_only_get(void);
14442
14443    /**
14444     * Set the configured cursor engine only usage
14445     *
14446     * This sets the globally configured exclusive usage of engine cursors.
14447     * It won't affect cursors set before changing this value.
14448     *
14449     * @param engine_only If 1 only engine cursors will be enabled, if 0 will
14450     * look for them on theme before.
14451     * @return EINA_TRUE if value is valid and setted (0 or 1)
14452     * @ingroup Cursors
14453     */
14454    EAPI Eina_Bool    elm_cursor_engine_only_set(int engine_only);
14455
14456    /**
14457     * @}
14458     */
14459
14460    /**
14461     * @defgroup Menu Menu
14462     *
14463     * @image html img/widget/menu/preview-00.png
14464     * @image latex img/widget/menu/preview-00.eps
14465     *
14466     * A menu is a list of items displayed above its parent. When the menu is
14467     * showing its parent is darkened. Each item can have a sub-menu. The menu
14468     * object can be used to display a menu on a right click event, in a toolbar,
14469     * anywhere.
14470     *
14471     * Signals that you can add callbacks for are:
14472     * @li "clicked" - the user clicked the empty space in the menu to dismiss.
14473     *             event_info is NULL.
14474     *
14475     * @see @ref tutorial_menu
14476     * @{
14477     */
14478    typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
14479    /**
14480     * @brief Add a new menu to the parent
14481     *
14482     * @param parent The parent object.
14483     * @return The new object or NULL if it cannot be created.
14484     */
14485    EAPI Evas_Object       *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14486    /**
14487     * @brief Set the parent for the given menu widget
14488     *
14489     * @param obj The menu object.
14490     * @param parent The new parent.
14491     */
14492    EAPI void               elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14493    /**
14494     * @brief Get the parent for the given menu widget
14495     *
14496     * @param obj The menu object.
14497     * @return The parent.
14498     *
14499     * @see elm_menu_parent_set()
14500     */
14501    EAPI Evas_Object       *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14502    /**
14503     * @brief Move the menu to a new position
14504     *
14505     * @param obj The menu object.
14506     * @param x The new position.
14507     * @param y The new position.
14508     *
14509     * Sets the top-left position of the menu to (@p x,@p y).
14510     *
14511     * @note @p x and @p y coordinates are relative to parent.
14512     */
14513    EAPI void               elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
14514    /**
14515     * @brief Close a opened menu
14516     *
14517     * @param obj the menu object
14518     * @return void
14519     *
14520     * Hides the menu and all it's sub-menus.
14521     */
14522    EAPI void               elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
14523    /**
14524     * @brief Returns a list of @p item's items.
14525     *
14526     * @param obj The menu object
14527     * @return An Eina_List* of @p item's items
14528     */
14529    EAPI const Eina_List   *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14530    /**
14531     * @brief Get the Evas_Object of an Elm_Menu_Item
14532     *
14533     * @param item The menu item object.
14534     * @return The edje object containing the swallowed content
14535     *
14536     * @warning Don't manipulate this object!
14537     */
14538    EAPI Evas_Object       *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14539    /**
14540     * @brief Add an item at the end of the given menu widget
14541     *
14542     * @param obj The menu object.
14543     * @param parent The parent menu item (optional)
14544     * @param icon A icon display on the item. The icon will be destryed by the menu.
14545     * @param label The label of the item.
14546     * @param func Function called when the user select the item.
14547     * @param data Data sent by the callback.
14548     * @return Returns the new item.
14549     */
14550    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);
14551    /**
14552     * @brief Add an object swallowed in an item at the end of the given menu
14553     * widget
14554     *
14555     * @param obj The menu object.
14556     * @param parent The parent menu item (optional)
14557     * @param subobj The object to swallow
14558     * @param func Function called when the user select the item.
14559     * @param data Data sent by the callback.
14560     * @return Returns the new item.
14561     *
14562     * Add an evas object as an item to the menu.
14563     */
14564    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);
14565    /**
14566     * @brief Set the label of a menu item
14567     *
14568     * @param item The menu item object.
14569     * @param label The label to set for @p item
14570     *
14571     * @warning Don't use this funcion on items created with
14572     * elm_menu_item_add_object() or elm_menu_item_separator_add().
14573     */
14574    EAPI void               elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
14575    /**
14576     * @brief Get the label of a menu item
14577     *
14578     * @param item The menu item object.
14579     * @return The label of @p item
14580     */
14581    EAPI const char        *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14582    /**
14583     * @brief Set the icon of a menu item to the standard icon with name @p icon
14584     *
14585     * @param item The menu item object.
14586     * @param icon The icon object to set for the content of @p item
14587     *
14588     * Once this icon is set, any previously set icon will be deleted.
14589     */
14590    EAPI void               elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
14591    /**
14592     * @brief Get the string representation from the icon of a menu item
14593     *
14594     * @param item The menu item object.
14595     * @return The string representation of @p item's icon or NULL
14596     *
14597     * @see elm_menu_item_object_icon_name_set()
14598     */
14599    EAPI const char        *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14600    /**
14601     * @brief Set the content object of a menu item
14602     *
14603     * @param item The menu item object
14604     * @param The content object or NULL
14605     * @return EINA_TRUE on success, else EINA_FALSE
14606     *
14607     * Use this function to change the object swallowed by a menu item, deleting
14608     * any previously swallowed object.
14609     */
14610    EAPI Eina_Bool          elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
14611    /**
14612     * @brief Get the content object of a menu item
14613     *
14614     * @param item The menu item object
14615     * @return The content object or NULL
14616     * @note If @p item was added with elm_menu_item_add_object, this
14617     * function will return the object passed, else it will return the
14618     * icon object.
14619     *
14620     * @see elm_menu_item_object_content_set()
14621     */
14622    EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14623    /**
14624     * @brief Set the selected state of @p item.
14625     *
14626     * @param item The menu item object.
14627     * @param selected The selected/unselected state of the item
14628     */
14629    EAPI void               elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14630    /**
14631     * @brief Get the selected state of @p item.
14632     *
14633     * @param item The menu item object.
14634     * @return The selected/unselected state of the item
14635     *
14636     * @see elm_menu_item_selected_set()
14637     */
14638    EAPI Eina_Bool          elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14639    /**
14640     * @brief Set the disabled state of @p item.
14641     *
14642     * @param item The menu item object.
14643     * @param disabled The enabled/disabled state of the item
14644     */
14645    EAPI void               elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14646    /**
14647     * @brief Get the disabled state of @p item.
14648     *
14649     * @param item The menu item object.
14650     * @return The enabled/disabled state of the item
14651     *
14652     * @see elm_menu_item_disabled_set()
14653     */
14654    EAPI Eina_Bool          elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14655    /**
14656     * @brief Add a separator item to menu @p obj under @p parent.
14657     *
14658     * @param obj The menu object
14659     * @param parent The item to add the separator under
14660     * @return The created item or NULL on failure
14661     *
14662     * This is item is a @ref Separator.
14663     */
14664    EAPI Elm_Menu_Item     *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
14665    /**
14666     * @brief Returns whether @p item is a separator.
14667     *
14668     * @param item The item to check
14669     * @return If true, @p item is a separator
14670     *
14671     * @see elm_menu_item_separator_add()
14672     */
14673    EAPI Eina_Bool          elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14674    /**
14675     * @brief Deletes an item from the menu.
14676     *
14677     * @param item The item to delete.
14678     *
14679     * @see elm_menu_item_add()
14680     */
14681    EAPI void               elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14682    /**
14683     * @brief Set the function called when a menu item is deleted.
14684     *
14685     * @param item The item to set the callback on
14686     * @param func The function called
14687     *
14688     * @see elm_menu_item_add()
14689     * @see elm_menu_item_del()
14690     */
14691    EAPI void               elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14692    /**
14693     * @brief Returns the data associated with menu item @p item.
14694     *
14695     * @param item The item
14696     * @return The data associated with @p item or NULL if none was set.
14697     *
14698     * This is the data set with elm_menu_add() or elm_menu_item_data_set().
14699     */
14700    EAPI void              *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14701    /**
14702     * @brief Sets the data to be associated with menu item @p item.
14703     *
14704     * @param item The item
14705     * @param data The data to be associated with @p item
14706     */
14707    EAPI void               elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
14708    /**
14709     * @brief Returns a list of @p item's subitems.
14710     *
14711     * @param item The item
14712     * @return An Eina_List* of @p item's subitems
14713     *
14714     * @see elm_menu_add()
14715     */
14716    EAPI const Eina_List   *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14717    /**
14718     * @brief Get the position of a menu item
14719     *
14720     * @param item The menu item
14721     * @return The item's index
14722     *
14723     * This function returns the index position of a menu item in a menu.
14724     * For a sub-menu, this number is relative to the first item in the sub-menu.
14725     *
14726     * @note Index values begin with 0
14727     */
14728    EAPI unsigned int       elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
14729    /**
14730     * @brief @brief Return a menu item's owner menu
14731     *
14732     * @param item The menu item
14733     * @return The menu object owning @p item, or NULL on failure
14734     *
14735     * Use this function to get the menu object owning an item.
14736     */
14737    EAPI Evas_Object       *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
14738    /**
14739     * @brief Get the selected item in the menu
14740     *
14741     * @param obj The menu object
14742     * @return The selected item, or NULL if none
14743     *
14744     * @see elm_menu_item_selected_get()
14745     * @see elm_menu_item_selected_set()
14746     */
14747    EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14748    /**
14749     * @brief Get the last item in the menu
14750     *
14751     * @param obj The menu object
14752     * @return The last item, or NULL if none
14753     */
14754    EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14755    /**
14756     * @brief Get the first item in the menu
14757     *
14758     * @param obj The menu object
14759     * @return The first item, or NULL if none
14760     */
14761    EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14762    /**
14763     * @brief Get the next item in the menu.
14764     *
14765     * @param item The menu item object.
14766     * @return The item after it, or NULL if none
14767     */
14768    EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14769    /**
14770     * @brief Get the previous item in the menu.
14771     *
14772     * @param item The menu item object.
14773     * @return The item before it, or NULL if none
14774     */
14775    EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14776    /**
14777     * @}
14778     */
14779
14780    /**
14781     * @defgroup List List
14782     * @ingroup Elementary
14783     *
14784     * @image html img/widget/list/preview-00.png
14785     * @image latex img/widget/list/preview-00.eps width=\textwidth
14786     *
14787     * @image html img/list.png
14788     * @image latex img/list.eps width=\textwidth
14789     *
14790     * A list widget is a container whose children are displayed vertically or
14791     * horizontally, in order, and can be selected.
14792     * The list can accept only one or multiple items selection. Also has many
14793     * modes of items displaying.
14794     *
14795     * A list is a very simple type of list widget.  For more robust
14796     * lists, @ref Genlist should probably be used.
14797     *
14798     * Smart callbacks one can listen to:
14799     * - @c "activated" - The user has double-clicked or pressed
14800     *   (enter|return|spacebar) on an item. The @c event_info parameter
14801     *   is the item that was activated.
14802     * - @c "clicked,double" - The user has double-clicked an item.
14803     *   The @c event_info parameter is the item that was double-clicked.
14804     * - "selected" - when the user selected an item
14805     * - "unselected" - when the user unselected an item
14806     * - "longpressed" - an item in the list is long-pressed
14807     * - "scroll,edge,top" - the list is scrolled until the top edge
14808     * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
14809     * - "scroll,edge,left" - the list is scrolled until the left edge
14810     * - "scroll,edge,right" - the list is scrolled until the right edge
14811     *
14812     * Available styles for it:
14813     * - @c "default"
14814     *
14815     * List of examples:
14816     * @li @ref list_example_01
14817     * @li @ref list_example_02
14818     * @li @ref list_example_03
14819     */
14820
14821    /**
14822     * @addtogroup List
14823     * @{
14824     */
14825
14826    /**
14827     * @enum _Elm_List_Mode
14828     * @typedef Elm_List_Mode
14829     *
14830     * Set list's resize behavior, transverse axis scroll and
14831     * items cropping. See each mode's description for more details.
14832     *
14833     * @note Default value is #ELM_LIST_SCROLL.
14834     *
14835     * Values <b> don't </b> work as bitmask, only one can be choosen.
14836     *
14837     * @see elm_list_mode_set()
14838     * @see elm_list_mode_get()
14839     *
14840     * @ingroup List
14841     */
14842    typedef enum _Elm_List_Mode
14843      {
14844         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. */
14845         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). */
14846         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. */
14847         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. */
14848         ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
14849      } Elm_List_Mode;
14850
14851    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().  */
14852
14853    /**
14854     * Add a new list widget to the given parent Elementary
14855     * (container) object.
14856     *
14857     * @param parent The parent object.
14858     * @return a new list widget handle or @c NULL, on errors.
14859     *
14860     * This function inserts a new list widget on the canvas.
14861     *
14862     * @ingroup List
14863     */
14864    EAPI Evas_Object     *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14865
14866    /**
14867     * Starts the list.
14868     *
14869     * @param obj The list object
14870     *
14871     * @note Call before running show() on the list object.
14872     * @warning If not called, it won't display the list properly.
14873     *
14874     * @code
14875     * li = elm_list_add(win);
14876     * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
14877     * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
14878     * elm_list_go(li);
14879     * evas_object_show(li);
14880     * @endcode
14881     *
14882     * @ingroup List
14883     */
14884    EAPI void             elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
14885
14886    /**
14887     * Enable or disable multiple items selection on the list object.
14888     *
14889     * @param obj The list object
14890     * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
14891     * disable it.
14892     *
14893     * Disabled by default. If disabled, the user can select a single item of
14894     * the list each time. Selected items are highlighted on list.
14895     * If enabled, many items can be selected.
14896     *
14897     * If a selected item is selected again, it will be unselected.
14898     *
14899     * @see elm_list_multi_select_get()
14900     *
14901     * @ingroup List
14902     */
14903    EAPI void             elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
14904
14905    /**
14906     * Get a value whether multiple items selection is enabled or not.
14907     *
14908     * @see elm_list_multi_select_set() for details.
14909     *
14910     * @param obj The list object.
14911     * @return @c EINA_TRUE means multiple items selection is enabled.
14912     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14913     * @c EINA_FALSE is returned.
14914     *
14915     * @ingroup List
14916     */
14917    EAPI Eina_Bool        elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14918
14919    /**
14920     * Set which mode to use for the list object.
14921     *
14922     * @param obj The list object
14923     * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
14924     * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
14925     *
14926     * Set list's resize behavior, transverse axis scroll and
14927     * items cropping. See each mode's description for more details.
14928     *
14929     * @note Default value is #ELM_LIST_SCROLL.
14930     *
14931     * Only one can be set, if a previous one was set, it will be changed
14932     * by the new mode set. Bitmask won't work as well.
14933     *
14934     * @see elm_list_mode_get()
14935     *
14936     * @ingroup List
14937     */
14938    EAPI void             elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
14939
14940    /**
14941     * Get the mode the list is at.
14942     *
14943     * @param obj The list object
14944     * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
14945     * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
14946     *
14947     * @note see elm_list_mode_set() for more information.
14948     *
14949     * @ingroup List
14950     */
14951    EAPI Elm_List_Mode    elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14952
14953    /**
14954     * Enable or disable horizontal mode on the list object.
14955     *
14956     * @param obj The list object.
14957     * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
14958     * disable it, i.e., to enable vertical mode.
14959     *
14960     * @note Vertical mode is set by default.
14961     *
14962     * On horizontal mode items are displayed on list from left to right,
14963     * instead of from top to bottom. Also, the list will scroll horizontally.
14964     * Each item will presents left icon on top and right icon, or end, at
14965     * the bottom.
14966     *
14967     * @see elm_list_horizontal_get()
14968     *
14969     * @ingroup List
14970     */
14971    EAPI void             elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14972
14973    /**
14974     * Get a value whether horizontal mode is enabled or not.
14975     *
14976     * @param obj The list object.
14977     * @return @c EINA_TRUE means horizontal mode selection is enabled.
14978     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14979     * @c EINA_FALSE is returned.
14980     *
14981     * @see elm_list_horizontal_set() for details.
14982     *
14983     * @ingroup List
14984     */
14985    EAPI Eina_Bool        elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14986
14987    /**
14988     * Enable or disable always select mode on the list object.
14989     *
14990     * @param obj The list object
14991     * @param always_select @c EINA_TRUE to enable always select mode or
14992     * @c EINA_FALSE to disable it.
14993     *
14994     * @note Always select mode is disabled by default.
14995     *
14996     * Default behavior of list items is to only call its callback function
14997     * the first time it's pressed, i.e., when it is selected. If a selected
14998     * item is pressed again, and multi-select is disabled, it won't call
14999     * this function (if multi-select is enabled it will unselect the item).
15000     *
15001     * If always select is enabled, it will call the callback function
15002     * everytime a item is pressed, so it will call when the item is selected,
15003     * and again when a selected item is pressed.
15004     *
15005     * @see elm_list_always_select_mode_get()
15006     * @see elm_list_multi_select_set()
15007     *
15008     * @ingroup List
15009     */
15010    EAPI void             elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
15011
15012    /**
15013     * Get a value whether always select mode is enabled or not, meaning that
15014     * an item will always call its callback function, even if already selected.
15015     *
15016     * @param obj The list object
15017     * @return @c EINA_TRUE means horizontal mode selection is enabled.
15018     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
15019     * @c EINA_FALSE is returned.
15020     *
15021     * @see elm_list_always_select_mode_set() for details.
15022     *
15023     * @ingroup List
15024     */
15025    EAPI Eina_Bool        elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15026
15027    /**
15028     * Set bouncing behaviour when the scrolled content reaches an edge.
15029     *
15030     * Tell the internal scroller object whether it should bounce or not
15031     * when it reaches the respective edges for each axis.
15032     *
15033     * @param obj The list object
15034     * @param h_bounce Whether to bounce or not in the horizontal axis.
15035     * @param v_bounce Whether to bounce or not in the vertical axis.
15036     *
15037     * @see elm_scroller_bounce_set()
15038     *
15039     * @ingroup List
15040     */
15041    EAPI void             elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
15042
15043    /**
15044     * Get the bouncing behaviour of the internal scroller.
15045     *
15046     * Get whether the internal scroller should bounce when the edge of each
15047     * axis is reached scrolling.
15048     *
15049     * @param obj The list object.
15050     * @param h_bounce Pointer where to store the bounce state of the horizontal
15051     * axis.
15052     * @param v_bounce Pointer where to store the bounce state of the vertical
15053     * axis.
15054     *
15055     * @see elm_scroller_bounce_get()
15056     * @see elm_list_bounce_set()
15057     *
15058     * @ingroup List
15059     */
15060    EAPI void             elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
15061
15062    /**
15063     * Set the scrollbar policy.
15064     *
15065     * @param obj The list object
15066     * @param policy_h Horizontal scrollbar policy.
15067     * @param policy_v Vertical scrollbar policy.
15068     *
15069     * This sets the scrollbar visibility policy for the given scroller.
15070     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
15071     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
15072     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
15073     * This applies respectively for the horizontal and vertical scrollbars.
15074     *
15075     * The both are disabled by default, i.e., are set to
15076     * #ELM_SCROLLER_POLICY_OFF.
15077     *
15078     * @ingroup List
15079     */
15080    EAPI void             elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
15081
15082    /**
15083     * Get the scrollbar policy.
15084     *
15085     * @see elm_list_scroller_policy_get() for details.
15086     *
15087     * @param obj The list object.
15088     * @param policy_h Pointer where to store horizontal scrollbar policy.
15089     * @param policy_v Pointer where to store vertical scrollbar policy.
15090     *
15091     * @ingroup List
15092     */
15093    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);
15094
15095    /**
15096     * Append a new item to the list object.
15097     *
15098     * @param obj The list object.
15099     * @param label The label of the list item.
15100     * @param icon The icon object to use for the left side of the item. An
15101     * icon can be any Evas object, but usually it is an icon created
15102     * with elm_icon_add().
15103     * @param end The icon object to use for the right side of the item. An
15104     * icon can be any Evas object.
15105     * @param func The function to call when the item is clicked.
15106     * @param data The data to associate with the item for related callbacks.
15107     *
15108     * @return The created item or @c NULL upon failure.
15109     *
15110     * A new item will be created and appended to the list, i.e., will
15111     * be set as @b last item.
15112     *
15113     * Items created with this method can be deleted with
15114     * elm_list_item_del().
15115     *
15116     * Associated @p data can be properly freed when item is deleted if a
15117     * callback function is set with elm_list_item_del_cb_set().
15118     *
15119     * If a function is passed as argument, it will be called everytime this item
15120     * is selected, i.e., the user clicks over an unselected item.
15121     * If always select is enabled it will call this function every time
15122     * user clicks over an item (already selected or not).
15123     * If such function isn't needed, just passing
15124     * @c NULL as @p func is enough. The same should be done for @p data.
15125     *
15126     * Simple example (with no function callback or data associated):
15127     * @code
15128     * li = elm_list_add(win);
15129     * ic = elm_icon_add(win);
15130     * elm_icon_file_set(ic, "path/to/image", NULL);
15131     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
15132     * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
15133     * elm_list_go(li);
15134     * evas_object_show(li);
15135     * @endcode
15136     *
15137     * @see elm_list_always_select_mode_set()
15138     * @see elm_list_item_del()
15139     * @see elm_list_item_del_cb_set()
15140     * @see elm_list_clear()
15141     * @see elm_icon_add()
15142     *
15143     * @ingroup List
15144     */
15145    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);
15146
15147    /**
15148     * Prepend a new item to the list object.
15149     *
15150     * @param obj The list object.
15151     * @param label The label of the list item.
15152     * @param icon The icon object to use for the left side of the item. An
15153     * icon can be any Evas object, but usually it is an icon created
15154     * with elm_icon_add().
15155     * @param end The icon object to use for the right side of the item. An
15156     * icon can be any Evas object.
15157     * @param func The function to call when the item is clicked.
15158     * @param data The data to associate with the item for related callbacks.
15159     *
15160     * @return The created item or @c NULL upon failure.
15161     *
15162     * A new item will be created and prepended to the list, i.e., will
15163     * be set as @b first item.
15164     *
15165     * Items created with this method can be deleted with
15166     * elm_list_item_del().
15167     *
15168     * Associated @p data can be properly freed when item is deleted if a
15169     * callback function is set with elm_list_item_del_cb_set().
15170     *
15171     * If a function is passed as argument, it will be called everytime this item
15172     * is selected, i.e., the user clicks over an unselected item.
15173     * If always select is enabled it will call this function every time
15174     * user clicks over an item (already selected or not).
15175     * If such function isn't needed, just passing
15176     * @c NULL as @p func is enough. The same should be done for @p data.
15177     *
15178     * @see elm_list_item_append() for a simple code example.
15179     * @see elm_list_always_select_mode_set()
15180     * @see elm_list_item_del()
15181     * @see elm_list_item_del_cb_set()
15182     * @see elm_list_clear()
15183     * @see elm_icon_add()
15184     *
15185     * @ingroup List
15186     */
15187    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);
15188
15189    /**
15190     * Insert a new item into the list object before item @p before.
15191     *
15192     * @param obj The list object.
15193     * @param before The list item to insert before.
15194     * @param label The label of the list item.
15195     * @param icon The icon object to use for the left side of the item. An
15196     * icon can be any Evas object, but usually it is an icon created
15197     * with elm_icon_add().
15198     * @param end The icon object to use for the right side of the item. An
15199     * icon can be any Evas object.
15200     * @param func The function to call when the item is clicked.
15201     * @param data The data to associate with the item for related callbacks.
15202     *
15203     * @return The created item or @c NULL upon failure.
15204     *
15205     * A new item will be created and added to the list. Its position in
15206     * this list will be just before item @p before.
15207     *
15208     * Items created with this method can be deleted with
15209     * elm_list_item_del().
15210     *
15211     * Associated @p data can be properly freed when item is deleted if a
15212     * callback function is set with elm_list_item_del_cb_set().
15213     *
15214     * If a function is passed as argument, it will be called everytime this item
15215     * is selected, i.e., the user clicks over an unselected item.
15216     * If always select is enabled it will call this function every time
15217     * user clicks over an item (already selected or not).
15218     * If such function isn't needed, just passing
15219     * @c NULL as @p func is enough. The same should be done for @p data.
15220     *
15221     * @see elm_list_item_append() for a simple code example.
15222     * @see elm_list_always_select_mode_set()
15223     * @see elm_list_item_del()
15224     * @see elm_list_item_del_cb_set()
15225     * @see elm_list_clear()
15226     * @see elm_icon_add()
15227     *
15228     * @ingroup List
15229     */
15230    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);
15231
15232    /**
15233     * Insert a new item into the list object after item @p after.
15234     *
15235     * @param obj The list object.
15236     * @param after The list item to insert after.
15237     * @param label The label of the list item.
15238     * @param icon The icon object to use for the left side of the item. An
15239     * icon can be any Evas object, but usually it is an icon created
15240     * with elm_icon_add().
15241     * @param end The icon object to use for the right side of the item. An
15242     * icon can be any Evas object.
15243     * @param func The function to call when the item is clicked.
15244     * @param data The data to associate with the item for related callbacks.
15245     *
15246     * @return The created item or @c NULL upon failure.
15247     *
15248     * A new item will be created and added to the list. Its position in
15249     * this list will be just after item @p after.
15250     *
15251     * Items created with this method can be deleted with
15252     * elm_list_item_del().
15253     *
15254     * Associated @p data can be properly freed when item is deleted if a
15255     * callback function is set with elm_list_item_del_cb_set().
15256     *
15257     * If a function is passed as argument, it will be called everytime this item
15258     * is selected, i.e., the user clicks over an unselected item.
15259     * If always select is enabled it will call this function every time
15260     * user clicks over an item (already selected or not).
15261     * If such function isn't needed, just passing
15262     * @c NULL as @p func is enough. The same should be done for @p data.
15263     *
15264     * @see elm_list_item_append() for a simple code example.
15265     * @see elm_list_always_select_mode_set()
15266     * @see elm_list_item_del()
15267     * @see elm_list_item_del_cb_set()
15268     * @see elm_list_clear()
15269     * @see elm_icon_add()
15270     *
15271     * @ingroup List
15272     */
15273    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);
15274
15275    /**
15276     * Insert a new item into the sorted list object.
15277     *
15278     * @param obj The list object.
15279     * @param label The label of the list item.
15280     * @param icon The icon object to use for the left side of the item. An
15281     * icon can be any Evas object, but usually it is an icon created
15282     * with elm_icon_add().
15283     * @param end The icon object to use for the right side of the item. An
15284     * icon can be any Evas object.
15285     * @param func The function to call when the item is clicked.
15286     * @param data The data to associate with the item for related callbacks.
15287     * @param cmp_func The comparing function to be used to sort list
15288     * items <b>by #Elm_List_Item item handles</b>. This function will
15289     * receive two items and compare them, returning a non-negative integer
15290     * if the second item should be place after the first, or negative value
15291     * if should be placed before.
15292     *
15293     * @return The created item or @c NULL upon failure.
15294     *
15295     * @note This function inserts values into a list object assuming it was
15296     * sorted and the result will be sorted.
15297     *
15298     * A new item will be created and added to the list. Its position in
15299     * this list will be found comparing the new item with previously inserted
15300     * items using function @p cmp_func.
15301     *
15302     * Items created with this method can be deleted with
15303     * elm_list_item_del().
15304     *
15305     * Associated @p data can be properly freed when item is deleted if a
15306     * callback function is set with elm_list_item_del_cb_set().
15307     *
15308     * If a function is passed as argument, it will be called everytime this item
15309     * is selected, i.e., the user clicks over an unselected item.
15310     * If always select is enabled it will call this function every time
15311     * user clicks over an item (already selected or not).
15312     * If such function isn't needed, just passing
15313     * @c NULL as @p func is enough. The same should be done for @p data.
15314     *
15315     * @see elm_list_item_append() for a simple code example.
15316     * @see elm_list_always_select_mode_set()
15317     * @see elm_list_item_del()
15318     * @see elm_list_item_del_cb_set()
15319     * @see elm_list_clear()
15320     * @see elm_icon_add()
15321     *
15322     * @ingroup List
15323     */
15324    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);
15325
15326    /**
15327     * Remove all list's items.
15328     *
15329     * @param obj The list object
15330     *
15331     * @see elm_list_item_del()
15332     * @see elm_list_item_append()
15333     *
15334     * @ingroup List
15335     */
15336    EAPI void             elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
15337
15338    /**
15339     * Get a list of all the list items.
15340     *
15341     * @param obj The list object
15342     * @return An @c Eina_List of list items, #Elm_List_Item,
15343     * or @c NULL on failure.
15344     *
15345     * @see elm_list_item_append()
15346     * @see elm_list_item_del()
15347     * @see elm_list_clear()
15348     *
15349     * @ingroup List
15350     */
15351    EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15352
15353    /**
15354     * Get the selected item.
15355     *
15356     * @param obj The list object.
15357     * @return The selected list item.
15358     *
15359     * The selected item can be unselected with function
15360     * elm_list_item_selected_set().
15361     *
15362     * The selected item always will be highlighted on list.
15363     *
15364     * @see elm_list_selected_items_get()
15365     *
15366     * @ingroup List
15367     */
15368    EAPI Elm_List_Item   *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15369
15370    /**
15371     * Return a list of the currently selected list items.
15372     *
15373     * @param obj The list object.
15374     * @return An @c Eina_List of list items, #Elm_List_Item,
15375     * or @c NULL on failure.
15376     *
15377     * Multiple items can be selected if multi select is enabled. It can be
15378     * done with elm_list_multi_select_set().
15379     *
15380     * @see elm_list_selected_item_get()
15381     * @see elm_list_multi_select_set()
15382     *
15383     * @ingroup List
15384     */
15385    EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15386
15387    /**
15388     * Set the selected state of an item.
15389     *
15390     * @param item The list item
15391     * @param selected The selected state
15392     *
15393     * This sets the selected state of the given item @p it.
15394     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
15395     *
15396     * If a new item is selected the previosly selected will be unselected,
15397     * unless multiple selection is enabled with elm_list_multi_select_set().
15398     * Previoulsy selected item can be get with function
15399     * elm_list_selected_item_get().
15400     *
15401     * Selected items will be highlighted.
15402     *
15403     * @see elm_list_item_selected_get()
15404     * @see elm_list_selected_item_get()
15405     * @see elm_list_multi_select_set()
15406     *
15407     * @ingroup List
15408     */
15409    EAPI void             elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15410
15411    /*
15412     * Get whether the @p item is selected or not.
15413     *
15414     * @param item The list item.
15415     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
15416     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
15417     *
15418     * @see elm_list_selected_item_set() for details.
15419     * @see elm_list_item_selected_get()
15420     *
15421     * @ingroup List
15422     */
15423    EAPI Eina_Bool        elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15424
15425    /**
15426     * Set or unset item as a separator.
15427     *
15428     * @param it The list item.
15429     * @param setting @c EINA_TRUE to set item @p it as separator or
15430     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15431     *
15432     * Items aren't set as separator by default.
15433     *
15434     * If set as separator it will display separator theme, so won't display
15435     * icons or label.
15436     *
15437     * @see elm_list_item_separator_get()
15438     *
15439     * @ingroup List
15440     */
15441    EAPI void             elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
15442
15443    /**
15444     * Get a value whether item is a separator or not.
15445     *
15446     * @see elm_list_item_separator_set() for details.
15447     *
15448     * @param it The list item.
15449     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15450     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15451     *
15452     * @ingroup List
15453     */
15454    EAPI Eina_Bool        elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15455
15456    /**
15457     * Show @p item in the list view.
15458     *
15459     * @param item The list item to be shown.
15460     *
15461     * It won't animate list until item is visible. If such behavior is wanted,
15462     * use elm_list_bring_in() intead.
15463     *
15464     * @ingroup List
15465     */
15466    EAPI void             elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15467
15468    /**
15469     * Bring in the given item to list view.
15470     *
15471     * @param item The item.
15472     *
15473     * This causes list to jump to the given item @p item and show it
15474     * (by scrolling), if it is not fully visible.
15475     *
15476     * This may use animation to do so and take a period of time.
15477     *
15478     * If animation isn't wanted, elm_list_item_show() can be used.
15479     *
15480     * @ingroup List
15481     */
15482    EAPI void             elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15483
15484    /**
15485     * Delete them item from the list.
15486     *
15487     * @param item The item of list to be deleted.
15488     *
15489     * If deleting all list items is required, elm_list_clear()
15490     * should be used instead of getting items list and deleting each one.
15491     *
15492     * @see elm_list_clear()
15493     * @see elm_list_item_append()
15494     * @see elm_list_item_del_cb_set()
15495     *
15496     * @ingroup List
15497     */
15498    EAPI void             elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15499
15500    /**
15501     * Set the function called when a list item is freed.
15502     *
15503     * @param item The item to set the callback on
15504     * @param func The function called
15505     *
15506     * If there is a @p func, then it will be called prior item's memory release.
15507     * That will be called with the following arguments:
15508     * @li item's data;
15509     * @li item's Evas object;
15510     * @li item itself;
15511     *
15512     * This way, a data associated to a list item could be properly freed.
15513     *
15514     * @ingroup List
15515     */
15516    EAPI void             elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15517
15518    /**
15519     * Get the data associated to the item.
15520     *
15521     * @param item The list item
15522     * @return The data associated to @p item
15523     *
15524     * The return value is a pointer to data associated to @p item when it was
15525     * created, with function elm_list_item_append() or similar. If no data
15526     * was passed as argument, it will return @c NULL.
15527     *
15528     * @see elm_list_item_append()
15529     *
15530     * @ingroup List
15531     */
15532    EAPI void            *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15533
15534    /**
15535     * Get the left side icon associated to the item.
15536     *
15537     * @param item The list item
15538     * @return The left side icon associated to @p item
15539     *
15540     * The return value is a pointer to the icon associated to @p item when
15541     * it was
15542     * created, with function elm_list_item_append() or similar, or later
15543     * with function elm_list_item_icon_set(). If no icon
15544     * was passed as argument, it will return @c NULL.
15545     *
15546     * @see elm_list_item_append()
15547     * @see elm_list_item_icon_set()
15548     *
15549     * @ingroup List
15550     */
15551    EAPI Evas_Object     *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15552
15553    /**
15554     * Set the left side icon associated to the item.
15555     *
15556     * @param item The list item
15557     * @param icon The left side icon object to associate with @p item
15558     *
15559     * The icon object to use at left side of the item. An
15560     * icon can be any Evas object, but usually it is an icon created
15561     * with elm_icon_add().
15562     *
15563     * Once the icon object is set, a previously set one will be deleted.
15564     * @warning Setting the same icon for two items will cause the icon to
15565     * dissapear from the first item.
15566     *
15567     * If an icon was passed as argument on item creation, with function
15568     * elm_list_item_append() or similar, it will be already
15569     * associated to the item.
15570     *
15571     * @see elm_list_item_append()
15572     * @see elm_list_item_icon_get()
15573     *
15574     * @ingroup List
15575     */
15576    EAPI void             elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
15577
15578    /**
15579     * Get the right side icon associated to the item.
15580     *
15581     * @param item The list item
15582     * @return The right side icon associated to @p item
15583     *
15584     * The return value is a pointer to the icon associated to @p item when
15585     * it was
15586     * created, with function elm_list_item_append() or similar, or later
15587     * with function elm_list_item_icon_set(). If no icon
15588     * was passed as argument, it will return @c NULL.
15589     *
15590     * @see elm_list_item_append()
15591     * @see elm_list_item_icon_set()
15592     *
15593     * @ingroup List
15594     */
15595    EAPI Evas_Object     *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15596
15597    /**
15598     * Set the right side icon associated to the item.
15599     *
15600     * @param item The list item
15601     * @param end The right side icon object to associate with @p item
15602     *
15603     * The icon object to use at right side of the item. An
15604     * icon can be any Evas object, but usually it is an icon created
15605     * with elm_icon_add().
15606     *
15607     * Once the icon object is set, a previously set one will be deleted.
15608     * @warning Setting the same icon for two items will cause the icon to
15609     * dissapear from the first item.
15610     *
15611     * If an icon was passed as argument on item creation, with function
15612     * elm_list_item_append() or similar, it will be already
15613     * associated to the item.
15614     *
15615     * @see elm_list_item_append()
15616     * @see elm_list_item_end_get()
15617     *
15618     * @ingroup List
15619     */
15620    EAPI void             elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
15621
15622    /**
15623     * Gets the base object of the item.
15624     *
15625     * @param item The list item
15626     * @return The base object associated with @p item
15627     *
15628     * Base object is the @c Evas_Object that represents that item.
15629     *
15630     * @ingroup List
15631     */
15632    EAPI Evas_Object     *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15633    EINA_DEPRECATED EAPI Evas_Object     *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15634
15635    /**
15636     * Get the label of item.
15637     *
15638     * @param item The item of list.
15639     * @return The label of item.
15640     *
15641     * The return value is a pointer to the label associated to @p item when
15642     * it was created, with function elm_list_item_append(), or later
15643     * with function elm_list_item_label_set. If no label
15644     * was passed as argument, it will return @c NULL.
15645     *
15646     * @see elm_list_item_label_set() for more details.
15647     * @see elm_list_item_append()
15648     *
15649     * @ingroup List
15650     */
15651    EAPI const char      *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15652
15653    /**
15654     * Set the label of item.
15655     *
15656     * @param item The item of list.
15657     * @param text The label of item.
15658     *
15659     * The label to be displayed by the item.
15660     * Label will be placed between left and right side icons (if set).
15661     *
15662     * If a label was passed as argument on item creation, with function
15663     * elm_list_item_append() or similar, it will be already
15664     * displayed by the item.
15665     *
15666     * @see elm_list_item_label_get()
15667     * @see elm_list_item_append()
15668     *
15669     * @ingroup List
15670     */
15671    EAPI void             elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
15672
15673
15674    /**
15675     * Get the item before @p it in list.
15676     *
15677     * @param it The list item.
15678     * @return The item before @p it, or @c NULL if none or on failure.
15679     *
15680     * @note If it is the first item, @c NULL will be returned.
15681     *
15682     * @see elm_list_item_append()
15683     * @see elm_list_items_get()
15684     *
15685     * @ingroup List
15686     */
15687    EAPI Elm_List_Item   *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15688
15689    /**
15690     * Get the item after @p it in list.
15691     *
15692     * @param it The list item.
15693     * @return The item after @p it, or @c NULL if none or on failure.
15694     *
15695     * @note If it is the last item, @c NULL will be returned.
15696     *
15697     * @see elm_list_item_append()
15698     * @see elm_list_items_get()
15699     *
15700     * @ingroup List
15701     */
15702    EAPI Elm_List_Item   *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15703
15704    /**
15705     * Sets the disabled/enabled state of a list item.
15706     *
15707     * @param it The item.
15708     * @param disabled The disabled state.
15709     *
15710     * A disabled item cannot be selected or unselected. It will also
15711     * change its appearance (generally greyed out). This sets the
15712     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15713     * enabled).
15714     *
15715     * @ingroup List
15716     */
15717    EAPI void             elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15718
15719    /**
15720     * Get a value whether list item is disabled or not.
15721     *
15722     * @param it The item.
15723     * @return The disabled state.
15724     *
15725     * @see elm_list_item_disabled_set() for more details.
15726     *
15727     * @ingroup List
15728     */
15729    EAPI Eina_Bool        elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15730
15731    /**
15732     * Set the text to be shown in a given list item's tooltips.
15733     *
15734     * @param item Target item.
15735     * @param text The text to set in the content.
15736     *
15737     * Setup the text as tooltip to object. The item can have only one tooltip,
15738     * so any previous tooltip data - set with this function or
15739     * elm_list_item_tooltip_content_cb_set() - is removed.
15740     *
15741     * @see elm_object_tooltip_text_set() for more details.
15742     *
15743     * @ingroup List
15744     */
15745    EAPI void             elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
15746
15747
15748    /**
15749     * @brief Disable size restrictions on an object's tooltip
15750     * @param item The tooltip's anchor object
15751     * @param disable If EINA_TRUE, size restrictions are disabled
15752     * @return EINA_FALSE on failure, EINA_TRUE on success
15753     *
15754     * This function allows a tooltip to expand beyond its parant window's canvas.
15755     * It will instead be limited only by the size of the display.
15756     */
15757    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
15758    /**
15759     * @brief Retrieve size restriction state of an object's tooltip
15760     * @param obj The tooltip's anchor object
15761     * @return If EINA_TRUE, size restrictions are disabled
15762     *
15763     * This function returns whether a tooltip is allowed to expand beyond
15764     * its parant window's canvas.
15765     * It will instead be limited only by the size of the display.
15766     */
15767    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15768
15769    /**
15770     * Set the content to be shown in the tooltip item.
15771     *
15772     * Setup the tooltip to item. The item can have only one tooltip,
15773     * so any previous tooltip data is removed. @p func(with @p data) will
15774     * be called every time that need show the tooltip and it should
15775     * return a valid Evas_Object. This object is then managed fully by
15776     * tooltip system and is deleted when the tooltip is gone.
15777     *
15778     * @param item the list item being attached a tooltip.
15779     * @param func the function used to create the tooltip contents.
15780     * @param data what to provide to @a func as callback data/context.
15781     * @param del_cb called when data is not needed anymore, either when
15782     *        another callback replaces @a func, the tooltip is unset with
15783     *        elm_list_item_tooltip_unset() or the owner @a item
15784     *        dies. This callback receives as the first parameter the
15785     *        given @a data, and @c event_info is the item.
15786     *
15787     * @see elm_object_tooltip_content_cb_set() for more details.
15788     *
15789     * @ingroup List
15790     */
15791    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);
15792
15793    /**
15794     * Unset tooltip from item.
15795     *
15796     * @param item list item to remove previously set tooltip.
15797     *
15798     * Remove tooltip from item. The callback provided as del_cb to
15799     * elm_list_item_tooltip_content_cb_set() will be called to notify
15800     * it is not used anymore.
15801     *
15802     * @see elm_object_tooltip_unset() for more details.
15803     * @see elm_list_item_tooltip_content_cb_set()
15804     *
15805     * @ingroup List
15806     */
15807    EAPI void             elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15808
15809    /**
15810     * Sets a different style for this item tooltip.
15811     *
15812     * @note before you set a style you should define a tooltip with
15813     *       elm_list_item_tooltip_content_cb_set() or
15814     *       elm_list_item_tooltip_text_set()
15815     *
15816     * @param item list item with tooltip already set.
15817     * @param style the theme style to use (default, transparent, ...)
15818     *
15819     * @see elm_object_tooltip_style_set() for more details.
15820     *
15821     * @ingroup List
15822     */
15823    EAPI void             elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
15824
15825    /**
15826     * Get the style for this item tooltip.
15827     *
15828     * @param item list item with tooltip already set.
15829     * @return style the theme style in use, defaults to "default". If the
15830     *         object does not have a tooltip set, then NULL is returned.
15831     *
15832     * @see elm_object_tooltip_style_get() for more details.
15833     * @see elm_list_item_tooltip_style_set()
15834     *
15835     * @ingroup List
15836     */
15837    EAPI const char      *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15838
15839    /**
15840     * Set the type of mouse pointer/cursor decoration to be shown,
15841     * when the mouse pointer is over the given list widget item
15842     *
15843     * @param item list item to customize cursor on
15844     * @param cursor the cursor type's name
15845     *
15846     * This function works analogously as elm_object_cursor_set(), but
15847     * here the cursor's changing area is restricted to the item's
15848     * area, and not the whole widget's. Note that that item cursors
15849     * have precedence over widget cursors, so that a mouse over an
15850     * item with custom cursor set will always show @b that cursor.
15851     *
15852     * If this function is called twice for an object, a previously set
15853     * cursor will be unset on the second call.
15854     *
15855     * @see elm_object_cursor_set()
15856     * @see elm_list_item_cursor_get()
15857     * @see elm_list_item_cursor_unset()
15858     *
15859     * @ingroup List
15860     */
15861    EAPI void             elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15862
15863    /*
15864     * Get the type of mouse pointer/cursor decoration set to be shown,
15865     * when the mouse pointer is over the given list widget item
15866     *
15867     * @param item list item with custom cursor set
15868     * @return the cursor type's name or @c NULL, if no custom cursors
15869     * were set to @p item (and on errors)
15870     *
15871     * @see elm_object_cursor_get()
15872     * @see elm_list_item_cursor_set()
15873     * @see elm_list_item_cursor_unset()
15874     *
15875     * @ingroup List
15876     */
15877    EAPI const char      *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15878
15879    /**
15880     * Unset any custom mouse pointer/cursor decoration set to be
15881     * shown, when the mouse pointer is over the given list widget
15882     * item, thus making it show the @b default cursor again.
15883     *
15884     * @param item a list item
15885     *
15886     * Use this call to undo any custom settings on this item's cursor
15887     * decoration, bringing it back to defaults (no custom style set).
15888     *
15889     * @see elm_object_cursor_unset()
15890     * @see elm_list_item_cursor_set()
15891     *
15892     * @ingroup List
15893     */
15894    EAPI void             elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15895
15896    /**
15897     * Set a different @b style for a given custom cursor set for a
15898     * list item.
15899     *
15900     * @param item list item with custom cursor set
15901     * @param style the <b>theme style</b> to use (e.g. @c "default",
15902     * @c "transparent", etc)
15903     *
15904     * This function only makes sense when one is using custom mouse
15905     * cursor decorations <b>defined in a theme file</b>, which can have,
15906     * given a cursor name/type, <b>alternate styles</b> on it. It
15907     * works analogously as elm_object_cursor_style_set(), but here
15908     * applyed only to list item objects.
15909     *
15910     * @warning Before you set a cursor style you should have definen a
15911     *       custom cursor previously on the item, with
15912     *       elm_list_item_cursor_set()
15913     *
15914     * @see elm_list_item_cursor_engine_only_set()
15915     * @see elm_list_item_cursor_style_get()
15916     *
15917     * @ingroup List
15918     */
15919    EAPI void             elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
15920
15921    /**
15922     * Get the current @b style set for a given list item's custom
15923     * cursor
15924     *
15925     * @param item list item with custom cursor set.
15926     * @return style the cursor style in use. If the object does not
15927     *         have a cursor set, then @c NULL is returned.
15928     *
15929     * @see elm_list_item_cursor_style_set() for more details
15930     *
15931     * @ingroup List
15932     */
15933    EAPI const char      *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15934
15935    /**
15936     * Set if the (custom)cursor for a given list item should be
15937     * searched in its theme, also, or should only rely on the
15938     * rendering engine.
15939     *
15940     * @param item item with custom (custom) cursor already set on
15941     * @param engine_only Use @c EINA_TRUE to have cursors looked for
15942     * only on those provided by the rendering engine, @c EINA_FALSE to
15943     * have them searched on the widget's theme, as well.
15944     *
15945     * @note This call is of use only if you've set a custom cursor
15946     * for list items, with elm_list_item_cursor_set().
15947     *
15948     * @note By default, cursors will only be looked for between those
15949     * provided by the rendering engine.
15950     *
15951     * @ingroup List
15952     */
15953    EAPI void             elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15954
15955    /**
15956     * Get if the (custom) cursor for a given list item is being
15957     * searched in its theme, also, or is only relying on the rendering
15958     * engine.
15959     *
15960     * @param item a list item
15961     * @return @c EINA_TRUE, if cursors are being looked for only on
15962     * those provided by the rendering engine, @c EINA_FALSE if they
15963     * are being searched on the widget's theme, as well.
15964     *
15965     * @see elm_list_item_cursor_engine_only_set(), for more details
15966     *
15967     * @ingroup List
15968     */
15969    EAPI Eina_Bool        elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15970
15971    /**
15972     * @}
15973     */
15974
15975    /**
15976     * @defgroup Slider Slider
15977     * @ingroup Elementary
15978     *
15979     * @image html img/widget/slider/preview-00.png
15980     * @image latex img/widget/slider/preview-00.eps width=\textwidth
15981     *
15982     * The slider adds a dragable “slider” widget for selecting the value of
15983     * something within a range.
15984     *
15985     * A slider can be horizontal or vertical. It can contain an Icon and has a
15986     * primary label as well as a units label (that is formatted with floating
15987     * point values and thus accepts a printf-style format string, like
15988     * “%1.2f units”. There is also an indicator string that may be somewhere
15989     * else (like on the slider itself) that also accepts a format string like
15990     * units. Label, Icon Unit and Indicator strings/objects are optional.
15991     *
15992     * A slider may be inverted which means values invert, with high vales being
15993     * on the left or top and low values on the right or bottom (as opposed to
15994     * normally being low on the left or top and high on the bottom and right).
15995     *
15996     * The slider should have its minimum and maximum values set by the
15997     * application with  elm_slider_min_max_set() and value should also be set by
15998     * the application before use with  elm_slider_value_set(). The span of the
15999     * slider is its length (horizontally or vertically). This will be scaled by
16000     * the object or applications scaling factor. At any point code can query the
16001     * slider for its value with elm_slider_value_get().
16002     *
16003     * Smart callbacks one can listen to:
16004     * - "changed" - Whenever the slider value is changed by the user.
16005     * - "slider,drag,start" - dragging the slider indicator around has started.
16006     * - "slider,drag,stop" - dragging the slider indicator around has stopped.
16007     * - "delay,changed" - A short time after the value is changed by the user.
16008     * This will be called only when the user stops dragging for
16009     * a very short period or when they release their
16010     * finger/mouse, so it avoids possibly expensive reactions to
16011     * the value change.
16012     *
16013     * Available styles for it:
16014     * - @c "default"
16015     *
16016     * Here is an example on its usage:
16017     * @li @ref slider_example
16018     */
16019
16020    /**
16021     * @addtogroup Slider
16022     * @{
16023     */
16024
16025    /**
16026     * Add a new slider widget to the given parent Elementary
16027     * (container) object.
16028     *
16029     * @param parent The parent object.
16030     * @return a new slider widget handle or @c NULL, on errors.
16031     *
16032     * This function inserts a new slider widget on the canvas.
16033     *
16034     * @ingroup Slider
16035     */
16036    EAPI Evas_Object       *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16037
16038    /**
16039     * Set the label of a given slider widget
16040     *
16041     * @param obj The progress bar object
16042     * @param label The text label string, in UTF-8
16043     *
16044     * @ingroup Slider
16045     * @deprecated use elm_object_text_set() instead.
16046     */
16047    EINA_DEPRECATED EAPI void               elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
16048
16049    /**
16050     * Get the label of a given slider widget
16051     *
16052     * @param obj The progressbar object
16053     * @return The text label string, in UTF-8
16054     *
16055     * @ingroup Slider
16056     * @deprecated use elm_object_text_get() instead.
16057     */
16058    EINA_DEPRECATED EAPI const char        *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16059
16060    /**
16061     * Set the icon object of the slider object.
16062     *
16063     * @param obj The slider object.
16064     * @param icon The icon object.
16065     *
16066     * On horizontal mode, icon is placed at left, and on vertical mode,
16067     * placed at top.
16068     *
16069     * @note Once the icon object is set, a previously set one will be deleted.
16070     * If you want to keep that old content object, use the
16071     * elm_slider_icon_unset() function.
16072     *
16073     * @warning If the object being set does not have minimum size hints set,
16074     * it won't get properly displayed.
16075     *
16076     * @ingroup Slider
16077     */
16078    EAPI void               elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
16079
16080    /**
16081     * Unset an icon set on a given slider widget.
16082     *
16083     * @param obj The slider object.
16084     * @return The icon object that was being used, if any was set, or
16085     * @c NULL, otherwise (and on errors).
16086     *
16087     * On horizontal mode, icon is placed at left, and on vertical mode,
16088     * placed at top.
16089     *
16090     * This call will unparent and return the icon object which was set
16091     * for this widget, previously, on success.
16092     *
16093     * @see elm_slider_icon_set() for more details
16094     * @see elm_slider_icon_get()
16095     *
16096     * @ingroup Slider
16097     */
16098    EAPI Evas_Object       *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16099
16100    /**
16101     * Retrieve the icon object set for a given slider widget.
16102     *
16103     * @param obj The slider object.
16104     * @return The icon object's handle, if @p obj had one set, or @c NULL,
16105     * otherwise (and on errors).
16106     *
16107     * On horizontal mode, icon is placed at left, and on vertical mode,
16108     * placed at top.
16109     *
16110     * @see elm_slider_icon_set() for more details
16111     * @see elm_slider_icon_unset()
16112     *
16113     * @ingroup Slider
16114     */
16115    EAPI Evas_Object       *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16116
16117    /**
16118     * Set the end object of the slider object.
16119     *
16120     * @param obj The slider object.
16121     * @param end The end object.
16122     *
16123     * On horizontal mode, end is placed at left, and on vertical mode,
16124     * placed at bottom.
16125     *
16126     * @note Once the icon object is set, a previously set one will be deleted.
16127     * If you want to keep that old content object, use the
16128     * elm_slider_end_unset() function.
16129     *
16130     * @warning If the object being set does not have minimum size hints set,
16131     * it won't get properly displayed.
16132     *
16133     * @ingroup Slider
16134     */
16135    EAPI void               elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
16136
16137    /**
16138     * Unset an end object set on a given slider widget.
16139     *
16140     * @param obj The slider object.
16141     * @return The end object that was being used, if any was set, or
16142     * @c NULL, otherwise (and on errors).
16143     *
16144     * On horizontal mode, end is placed at left, and on vertical mode,
16145     * placed at bottom.
16146     *
16147     * This call will unparent and return the icon object which was set
16148     * for this widget, previously, on success.
16149     *
16150     * @see elm_slider_end_set() for more details.
16151     * @see elm_slider_end_get()
16152     *
16153     * @ingroup Slider
16154     */
16155    EAPI Evas_Object       *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16156
16157    /**
16158     * Retrieve the end object set for a given slider widget.
16159     *
16160     * @param obj The slider object.
16161     * @return The end object's handle, if @p obj had one set, or @c NULL,
16162     * otherwise (and on errors).
16163     *
16164     * On horizontal mode, icon is placed at right, and on vertical mode,
16165     * placed at bottom.
16166     *
16167     * @see elm_slider_end_set() for more details.
16168     * @see elm_slider_end_unset()
16169     *
16170     * @ingroup Slider
16171     */
16172    EAPI Evas_Object       *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16173
16174    /**
16175     * Set the (exact) length of the bar region of a given slider widget.
16176     *
16177     * @param obj The slider object.
16178     * @param size The length of the slider's bar region.
16179     *
16180     * This sets the minimum width (when in horizontal mode) or height
16181     * (when in vertical mode) of the actual bar area of the slider
16182     * @p obj. This in turn affects the object's minimum size. Use
16183     * this when you're not setting other size hints expanding on the
16184     * given direction (like weight and alignment hints) and you would
16185     * like it to have a specific size.
16186     *
16187     * @note Icon, end, label, indicator and unit text around @p obj
16188     * will require their
16189     * own space, which will make @p obj to require more the @p size,
16190     * actually.
16191     *
16192     * @see elm_slider_span_size_get()
16193     *
16194     * @ingroup Slider
16195     */
16196    EAPI void               elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
16197
16198    /**
16199     * Get the length set for the bar region of a given slider widget
16200     *
16201     * @param obj The slider object.
16202     * @return The length of the slider's bar region.
16203     *
16204     * If that size was not set previously, with
16205     * elm_slider_span_size_set(), this call will return @c 0.
16206     *
16207     * @ingroup Slider
16208     */
16209    EAPI Evas_Coord         elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16210
16211    /**
16212     * Set the format string for the unit label.
16213     *
16214     * @param obj The slider object.
16215     * @param format The format string for the unit display.
16216     *
16217     * Unit label is displayed all the time, if set, after slider's bar.
16218     * In horizontal mode, at right and in vertical mode, at bottom.
16219     *
16220     * If @c NULL, unit label won't be visible. If not it sets the format
16221     * string for the label text. To the label text is provided a floating point
16222     * value, so the label text can display up to 1 floating point value.
16223     * Note that this is optional.
16224     *
16225     * Use a format string such as "%1.2f meters" for example, and it will
16226     * display values like: "3.14 meters" for a value equal to 3.14159.
16227     *
16228     * Default is unit label disabled.
16229     *
16230     * @see elm_slider_indicator_format_get()
16231     *
16232     * @ingroup Slider
16233     */
16234    EAPI void               elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
16235
16236    /**
16237     * Get the unit label format of the slider.
16238     *
16239     * @param obj The slider object.
16240     * @return The unit label format string in UTF-8.
16241     *
16242     * Unit label is displayed all the time, if set, after slider's bar.
16243     * In horizontal mode, at right and in vertical mode, at bottom.
16244     *
16245     * @see elm_slider_unit_format_set() for more
16246     * information on how this works.
16247     *
16248     * @ingroup Slider
16249     */
16250    EAPI const char        *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16251
16252    /**
16253     * Set the format string for the indicator label.
16254     *
16255     * @param obj The slider object.
16256     * @param indicator The format string for the indicator display.
16257     *
16258     * The slider may display its value somewhere else then unit label,
16259     * for example, above the slider knob that is dragged around. This function
16260     * sets the format string used for this.
16261     *
16262     * If @c NULL, indicator label won't be visible. If not it sets the format
16263     * string for the label text. To the label text is provided a floating point
16264     * value, so the label text can display up to 1 floating point value.
16265     * Note that this is optional.
16266     *
16267     * Use a format string such as "%1.2f meters" for example, and it will
16268     * display values like: "3.14 meters" for a value equal to 3.14159.
16269     *
16270     * Default is indicator label disabled.
16271     *
16272     * @see elm_slider_indicator_format_get()
16273     *
16274     * @ingroup Slider
16275     */
16276    EAPI void               elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
16277
16278    /**
16279     * Get the indicator label format of the slider.
16280     *
16281     * @param obj The slider object.
16282     * @return The indicator label format string in UTF-8.
16283     *
16284     * The slider may display its value somewhere else then unit label,
16285     * for example, above the slider knob that is dragged around. This function
16286     * gets the format string used for this.
16287     *
16288     * @see elm_slider_indicator_format_set() for more
16289     * information on how this works.
16290     *
16291     * @ingroup Slider
16292     */
16293    EAPI const char        *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16294
16295    /**
16296     * Set the format function pointer for the indicator label
16297     *
16298     * @param obj The slider object.
16299     * @param func The indicator format function.
16300     * @param free_func The freeing function for the format string.
16301     *
16302     * Set the callback function to format the indicator string.
16303     *
16304     * @see elm_slider_indicator_format_set() for more info on how this works.
16305     *
16306     * @ingroup Slider
16307     */
16308   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);
16309
16310   /**
16311    * Set the format function pointer for the units label
16312    *
16313    * @param obj The slider object.
16314    * @param func The units format function.
16315    * @param free_func The freeing function for the format string.
16316    *
16317    * Set the callback function to format the indicator string.
16318    *
16319    * @see elm_slider_units_format_set() for more info on how this works.
16320    *
16321    * @ingroup Slider
16322    */
16323   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);
16324
16325   /**
16326    * Set the orientation of a given slider widget.
16327    *
16328    * @param obj The slider object.
16329    * @param horizontal Use @c EINA_TRUE to make @p obj to be
16330    * @b horizontal, @c EINA_FALSE to make it @b vertical.
16331    *
16332    * Use this function to change how your slider is to be
16333    * disposed: vertically or horizontally.
16334    *
16335    * By default it's displayed horizontally.
16336    *
16337    * @see elm_slider_horizontal_get()
16338    *
16339    * @ingroup Slider
16340    */
16341    EAPI void               elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16342
16343    /**
16344     * Retrieve the orientation of a given slider widget
16345     *
16346     * @param obj The slider object.
16347     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
16348     * @c EINA_FALSE if it's @b vertical (and on errors).
16349     *
16350     * @see elm_slider_horizontal_set() for more details.
16351     *
16352     * @ingroup Slider
16353     */
16354    EAPI Eina_Bool          elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16355
16356    /**
16357     * Set the minimum and maximum values for the slider.
16358     *
16359     * @param obj The slider object.
16360     * @param min The minimum value.
16361     * @param max The maximum value.
16362     *
16363     * Define the allowed range of values to be selected by the user.
16364     *
16365     * If actual value is less than @p min, it will be updated to @p min. If it
16366     * is bigger then @p max, will be updated to @p max. Actual value can be
16367     * get with elm_slider_value_get().
16368     *
16369     * By default, min is equal to 0.0, and max is equal to 1.0.
16370     *
16371     * @warning Maximum must be greater than minimum, otherwise behavior
16372     * is undefined.
16373     *
16374     * @see elm_slider_min_max_get()
16375     *
16376     * @ingroup Slider
16377     */
16378    EAPI void               elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
16379
16380    /**
16381     * Get the minimum and maximum values of the slider.
16382     *
16383     * @param obj The slider object.
16384     * @param min Pointer where to store the minimum value.
16385     * @param max Pointer where to store the maximum value.
16386     *
16387     * @note If only one value is needed, the other pointer can be passed
16388     * as @c NULL.
16389     *
16390     * @see elm_slider_min_max_set() for details.
16391     *
16392     * @ingroup Slider
16393     */
16394    EAPI void               elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
16395
16396    /**
16397     * Set the value the slider displays.
16398     *
16399     * @param obj The slider object.
16400     * @param val The value to be displayed.
16401     *
16402     * Value will be presented on the unit label following format specified with
16403     * elm_slider_unit_format_set() and on indicator with
16404     * elm_slider_indicator_format_set().
16405     *
16406     * @warning The value must to be between min and max values. This values
16407     * are set by elm_slider_min_max_set().
16408     *
16409     * @see elm_slider_value_get()
16410     * @see elm_slider_unit_format_set()
16411     * @see elm_slider_indicator_format_set()
16412     * @see elm_slider_min_max_set()
16413     *
16414     * @ingroup Slider
16415     */
16416    EAPI void               elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
16417
16418    /**
16419     * Get the value displayed by the spinner.
16420     *
16421     * @param obj The spinner object.
16422     * @return The value displayed.
16423     *
16424     * @see elm_spinner_value_set() for details.
16425     *
16426     * @ingroup Slider
16427     */
16428    EAPI double             elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16429
16430    /**
16431     * Invert a given slider widget's displaying values order
16432     *
16433     * @param obj The slider object.
16434     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
16435     * @c EINA_FALSE to bring it back to default, non-inverted values.
16436     *
16437     * A slider may be @b inverted, in which state it gets its
16438     * values inverted, with high vales being on the left or top and
16439     * low values on the right or bottom, as opposed to normally have
16440     * the low values on the former and high values on the latter,
16441     * respectively, for horizontal and vertical modes.
16442     *
16443     * @see elm_slider_inverted_get()
16444     *
16445     * @ingroup Slider
16446     */
16447    EAPI void               elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
16448
16449    /**
16450     * Get whether a given slider widget's displaying values are
16451     * inverted or not.
16452     *
16453     * @param obj The slider object.
16454     * @return @c EINA_TRUE, if @p obj has inverted values,
16455     * @c EINA_FALSE otherwise (and on errors).
16456     *
16457     * @see elm_slider_inverted_set() for more details.
16458     *
16459     * @ingroup Slider
16460     */
16461    EAPI Eina_Bool          elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16462
16463    /**
16464     * Set whether to enlarge slider indicator (augmented knob) or not.
16465     *
16466     * @param obj The slider object.
16467     * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
16468     * let the knob always at default size.
16469     *
16470     * By default, indicator will be bigger while dragged by the user.
16471     *
16472     * @warning It won't display values set with
16473     * elm_slider_indicator_format_set() if you disable indicator.
16474     *
16475     * @ingroup Slider
16476     */
16477    EAPI void               elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
16478
16479    /**
16480     * Get whether a given slider widget's enlarging indicator or not.
16481     *
16482     * @param obj The slider object.
16483     * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
16484     * @c EINA_FALSE otherwise (and on errors).
16485     *
16486     * @see elm_slider_indicator_show_set() for details.
16487     *
16488     * @ingroup Slider
16489     */
16490    EAPI Eina_Bool          elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16491
16492    /**
16493     * @}
16494     */
16495
16496    /**
16497     * @addtogroup Actionslider Actionslider
16498     *
16499     * @image html img/widget/actionslider/preview-00.png
16500     * @image latex img/widget/actionslider/preview-00.eps
16501     *
16502     * A actionslider is a switcher for 2 or 3 labels with customizable magnet
16503     * properties. The indicator is the element the user drags to choose a label.
16504     * When the position is set with magnet, when released the indicator will be
16505     * moved to it if it's nearest the magnetized position.
16506     *
16507     * @note By default all positions are set as enabled.
16508     *
16509     * Signals that you can add callbacks for are:
16510     *
16511     * "selected" - when user selects an enabled position (the label is passed
16512     *              as event info)".
16513     * @n
16514     * "pos_changed" - when the indicator reaches any of the positions("left",
16515     *                 "right" or "center").
16516     *
16517     * See an example of actionslider usage @ref actionslider_example_page "here"
16518     * @{
16519     */
16520    typedef enum _Elm_Actionslider_Pos
16521      {
16522         ELM_ACTIONSLIDER_NONE = 0,
16523         ELM_ACTIONSLIDER_LEFT = 1 << 0,
16524         ELM_ACTIONSLIDER_CENTER = 1 << 1,
16525         ELM_ACTIONSLIDER_RIGHT = 1 << 2,
16526         ELM_ACTIONSLIDER_ALL = (1 << 3) -1
16527      } Elm_Actionslider_Pos;
16528
16529    /**
16530     * Add a new actionslider to the parent.
16531     *
16532     * @param parent The parent object
16533     * @return The new actionslider object or NULL if it cannot be created
16534     */
16535    EAPI Evas_Object          *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16536    /**
16537     * Set actionslider labels.
16538     *
16539     * @param obj The actionslider object
16540     * @param left_label The label to be set on the left.
16541     * @param center_label The label to be set on the center.
16542     * @param right_label The label to be set on the right.
16543     * @deprecated use elm_object_text_set() instead.
16544     */
16545    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);
16546    /**
16547     * Get actionslider labels.
16548     *
16549     * @param obj The actionslider object
16550     * @param left_label A char** to place the left_label of @p obj into.
16551     * @param center_label A char** to place the center_label of @p obj into.
16552     * @param right_label A char** to place the right_label of @p obj into.
16553     * @deprecated use elm_object_text_set() instead.
16554     */
16555    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);
16556    /**
16557     * Get actionslider selected label.
16558     *
16559     * @param obj The actionslider object
16560     * @return The selected label
16561     */
16562    EAPI const char           *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16563    /**
16564     * Set actionslider indicator position.
16565     *
16566     * @param obj The actionslider object.
16567     * @param pos The position of the indicator.
16568     */
16569    EAPI void                  elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16570    /**
16571     * Get actionslider indicator position.
16572     *
16573     * @param obj The actionslider object.
16574     * @return The position of the indicator.
16575     */
16576    EAPI Elm_Actionslider_Pos  elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16577    /**
16578     * Set actionslider magnet position. To make multiple positions magnets @c or
16579     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
16580     *
16581     * @param obj The actionslider object.
16582     * @param pos Bit mask indicating the magnet positions.
16583     */
16584    EAPI void                  elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16585    /**
16586     * Get actionslider magnet position.
16587     *
16588     * @param obj The actionslider object.
16589     * @return The positions with magnet property.
16590     */
16591    EAPI Elm_Actionslider_Pos  elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16592    /**
16593     * Set actionslider enabled position. To set multiple positions as enabled @c or
16594     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
16595     *
16596     * @note All the positions are enabled by default.
16597     *
16598     * @param obj The actionslider object.
16599     * @param pos Bit mask indicating the enabled positions.
16600     */
16601    EAPI void                  elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16602    /**
16603     * Get actionslider enabled position.
16604     *
16605     * @param obj The actionslider object.
16606     * @return The enabled positions.
16607     */
16608    EAPI Elm_Actionslider_Pos  elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16609    /**
16610     * Set the label used on the indicator.
16611     *
16612     * @param obj The actionslider object
16613     * @param label The label to be set on the indicator.
16614     * @deprecated use elm_object_text_set() instead.
16615     */
16616    EINA_DEPRECATED EAPI void                  elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
16617    /**
16618     * Get the label used on the indicator object.
16619     *
16620     * @param obj The actionslider object
16621     * @return The indicator label
16622     * @deprecated use elm_object_text_get() instead.
16623     */
16624    EINA_DEPRECATED EAPI const char           *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
16625    /**
16626     * @}
16627     */
16628
16629    /**
16630     * @defgroup Genlist Genlist
16631     *
16632     * @image html img/widget/genlist/preview-00.png
16633     * @image latex img/widget/genlist/preview-00.eps
16634     * @image html img/genlist.png
16635     * @image latex img/genlist.eps
16636     *
16637     * This widget aims to have more expansive list than the simple list in
16638     * Elementary that could have more flexible items and allow many more entries
16639     * while still being fast and low on memory usage. At the same time it was
16640     * also made to be able to do tree structures. But the price to pay is more
16641     * complexity when it comes to usage. If all you want is a simple list with
16642     * icons and a single label, use the normal @ref List object.
16643     *
16644     * Genlist has a fairly large API, mostly because it's relatively complex,
16645     * trying to be both expansive, powerful and efficient. First we will begin
16646     * an overview on the theory behind genlist.
16647     *
16648     * @section Genlist_Item_Class Genlist item classes - creating items
16649     *
16650     * In order to have the ability to add and delete items on the fly, genlist
16651     * implements a class (callback) system where the application provides a
16652     * structure with information about that type of item (genlist may contain
16653     * multiple different items with different classes, states and styles).
16654     * Genlist will call the functions in this struct (methods) when an item is
16655     * "realized" (i.e., created dynamically, while the user is scrolling the
16656     * grid). All objects will simply be deleted when no longer needed with
16657     * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
16658     * following members:
16659     * - @c item_style - This is a constant string and simply defines the name
16660     *   of the item style. It @b must be specified and the default should be @c
16661     *   "default".
16662     * - @c mode_item_style - This is a constant string and simply defines the
16663     *   name of the style that will be used for mode animations. It can be left
16664     *   as @c NULL if you don't plan to use Genlist mode. See
16665     *   elm_genlist_item_mode_set() for more info.
16666     *
16667     * - @c func - A struct with pointers to functions that will be called when
16668     *   an item is going to be actually created. All of them receive a @c data
16669     *   parameter that will point to the same data passed to
16670     *   elm_genlist_item_append() and related item creation functions, and a @c
16671     *   obj parameter that points to the genlist object itself.
16672     *
16673     * The function pointers inside @c func are @c label_get, @c icon_get, @c
16674     * state_get and @c del. The 3 first functions also receive a @c part
16675     * parameter described below. A brief description of these functions follows:
16676     *
16677     * - @c label_get - The @c part parameter is the name string of one of the
16678     *   existing text parts in the Edje group implementing the item's theme.
16679     *   This function @b must return a strdup'()ed string, as the caller will
16680     *   free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
16681     * - @c icon_get - The @c part parameter is the name string of one of the
16682     *   existing (icon) swallow parts in the Edje group implementing the item's
16683     *   theme. It must return @c NULL, when no icon is desired, or a valid
16684     *   object handle, otherwise.  The object will be deleted by the genlist on
16685     *   its deletion or when the item is "unrealized".  See
16686     *   #Elm_Genlist_Item_Icon_Get_Cb.
16687     * - @c func.state_get - The @c part parameter is the name string of one of
16688     *   the state parts in the Edje group implementing the item's theme. Return
16689     *   @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
16690     *   emit a signal to its theming Edje object with @c "elm,state,XXX,active"
16691     *   and @c "elm" as "emission" and "source" arguments, respectively, when
16692     *   the state is true (the default is false), where @c XXX is the name of
16693     *   the (state) part.  See #Elm_Genlist_Item_State_Get_Cb.
16694     * - @c func.del - This is intended for use when genlist items are deleted,
16695     *   so any data attached to the item (e.g. its data parameter on creation)
16696     *   can be deleted. See #Elm_Genlist_Item_Del_Cb.
16697     *
16698     * available item styles:
16699     * - default
16700     * - default_style - The text part is a textblock
16701     *
16702     * @image html img/widget/genlist/preview-04.png
16703     * @image latex img/widget/genlist/preview-04.eps
16704     *
16705     * - double_label
16706     *
16707     * @image html img/widget/genlist/preview-01.png
16708     * @image latex img/widget/genlist/preview-01.eps
16709     *
16710     * - icon_top_text_bottom
16711     *
16712     * @image html img/widget/genlist/preview-02.png
16713     * @image latex img/widget/genlist/preview-02.eps
16714     *
16715     * - group_index
16716     *
16717     * @image html img/widget/genlist/preview-03.png
16718     * @image latex img/widget/genlist/preview-03.eps
16719     *
16720     * @section Genlist_Items Structure of items
16721     *
16722     * An item in a genlist can have 0 or more text labels (they can be regular
16723     * text or textblock Evas objects - that's up to the style to determine), 0
16724     * or more icons (which are simply objects swallowed into the genlist item's
16725     * theming Edje object) and 0 or more <b>boolean states</b>, which have the
16726     * behavior left to the user to define. The Edje part names for each of
16727     * these properties will be looked up, in the theme file for the genlist,
16728     * under the Edje (string) data items named @c "labels", @c "icons" and @c
16729     * "states", respectively. For each of those properties, if more than one
16730     * part is provided, they must have names listed separated by spaces in the
16731     * data fields. For the default genlist item theme, we have @b one label
16732     * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
16733     * "elm.swallow.end") and @b no state parts.
16734     *
16735     * A genlist item may be at one of several styles. Elementary provides one
16736     * by default - "default", but this can be extended by system or application
16737     * custom themes/overlays/extensions (see @ref Theme "themes" for more
16738     * details).
16739     *
16740     * @section Genlist_Manipulation Editing and Navigating
16741     *
16742     * Items can be added by several calls. All of them return a @ref
16743     * Elm_Genlist_Item handle that is an internal member inside the genlist.
16744     * They all take a data parameter that is meant to be used for a handle to
16745     * the applications internal data (eg the struct with the original item
16746     * data). The parent parameter is the parent genlist item this belongs to if
16747     * it is a tree or an indexed group, and NULL if there is no parent. The
16748     * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
16749     * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
16750     * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
16751     * that is able to expand and have child items.  If ELM_GENLIST_ITEM_GROUP
16752     * is set then this item is group index item that is displayed at the top
16753     * until the next group comes. The func parameter is a convenience callback
16754     * that is called when the item is selected and the data parameter will be
16755     * the func_data parameter, obj be the genlist object and event_info will be
16756     * the genlist item.
16757     *
16758     * elm_genlist_item_append() adds an item to the end of the list, or if
16759     * there is a parent, to the end of all the child items of the parent.
16760     * elm_genlist_item_prepend() is the same but adds to the beginning of
16761     * the list or children list. elm_genlist_item_insert_before() inserts at
16762     * item before another item and elm_genlist_item_insert_after() inserts after
16763     * the indicated item.
16764     *
16765     * The application can clear the list with elm_genlist_clear() which deletes
16766     * all the items in the list and elm_genlist_item_del() will delete a specific
16767     * item. elm_genlist_item_subitems_clear() will clear all items that are
16768     * children of the indicated parent item.
16769     *
16770     * To help inspect list items you can jump to the item at the top of the list
16771     * with elm_genlist_first_item_get() which will return the item pointer, and
16772     * similarly elm_genlist_last_item_get() gets the item at the end of the list.
16773     * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
16774     * and previous items respectively relative to the indicated item. Using
16775     * these calls you can walk the entire item list/tree. Note that as a tree
16776     * the items are flattened in the list, so elm_genlist_item_parent_get() will
16777     * let you know which item is the parent (and thus know how to skip them if
16778     * wanted).
16779     *
16780     * @section Genlist_Muti_Selection Multi-selection
16781     *
16782     * If the application wants multiple items to be able to be selected,
16783     * elm_genlist_multi_select_set() can enable this. If the list is
16784     * single-selection only (the default), then elm_genlist_selected_item_get()
16785     * will return the selected item, if any, or NULL I none is selected. If the
16786     * list is multi-select then elm_genlist_selected_items_get() will return a
16787     * list (that is only valid as long as no items are modified (added, deleted,
16788     * selected or unselected)).
16789     *
16790     * @section Genlist_Usage_Hints Usage hints
16791     *
16792     * There are also convenience functions. elm_genlist_item_genlist_get() will
16793     * return the genlist object the item belongs to. elm_genlist_item_show()
16794     * will make the scroller scroll to show that specific item so its visible.
16795     * elm_genlist_item_data_get() returns the data pointer set by the item
16796     * creation functions.
16797     *
16798     * If an item changes (state of boolean changes, label or icons change),
16799     * then use elm_genlist_item_update() to have genlist update the item with
16800     * the new state. Genlist will re-realize the item thus call the functions
16801     * in the _Elm_Genlist_Item_Class for that item.
16802     *
16803     * To programmatically (un)select an item use elm_genlist_item_selected_set().
16804     * To get its selected state use elm_genlist_item_selected_get(). Similarly
16805     * to expand/contract an item and get its expanded state, use
16806     * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
16807     * again to make an item disabled (unable to be selected and appear
16808     * differently) use elm_genlist_item_disabled_set() to set this and
16809     * elm_genlist_item_disabled_get() to get the disabled state.
16810     *
16811     * In general to indicate how the genlist should expand items horizontally to
16812     * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
16813     * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
16814     * mode means that if items are too wide to fit, the scroller will scroll
16815     * horizontally. Otherwise items are expanded to fill the width of the
16816     * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
16817     * to the viewport width and limited to that size. This can be combined with
16818     * a different style that uses edjes' ellipsis feature (cutting text off like
16819     * this: "tex...").
16820     *
16821     * Items will only call their selection func and callback when first becoming
16822     * selected. Any further clicks will do nothing, unless you enable always
16823     * select with elm_genlist_always_select_mode_set(). This means even if
16824     * selected, every click will make the selected callbacks be called.
16825     * elm_genlist_no_select_mode_set() will turn off the ability to select
16826     * items entirely and they will neither appear selected nor call selected
16827     * callback functions.
16828     *
16829     * Remember that you can create new styles and add your own theme augmentation
16830     * per application with elm_theme_extension_add(). If you absolutely must
16831     * have a specific style that overrides any theme the user or system sets up
16832     * you can use elm_theme_overlay_add() to add such a file.
16833     *
16834     * @section Genlist_Implementation Implementation
16835     *
16836     * Evas tracks every object you create. Every time it processes an event
16837     * (mouse move, down, up etc.) it needs to walk through objects and find out
16838     * what event that affects. Even worse every time it renders display updates,
16839     * in order to just calculate what to re-draw, it needs to walk through many
16840     * many many objects. Thus, the more objects you keep active, the more
16841     * overhead Evas has in just doing its work. It is advisable to keep your
16842     * active objects to the minimum working set you need. Also remember that
16843     * object creation and deletion carries an overhead, so there is a
16844     * middle-ground, which is not easily determined. But don't keep massive lists
16845     * of objects you can't see or use. Genlist does this with list objects. It
16846     * creates and destroys them dynamically as you scroll around. It groups them
16847     * into blocks so it can determine the visibility etc. of a whole block at
16848     * once as opposed to having to walk the whole list. This 2-level list allows
16849     * for very large numbers of items to be in the list (tests have used up to
16850     * 2,000,000 items). Also genlist employs a queue for adding items. As items
16851     * may be different sizes, every item added needs to be calculated as to its
16852     * size and thus this presents a lot of overhead on populating the list, this
16853     * genlist employs a queue. Any item added is queued and spooled off over
16854     * time, actually appearing some time later, so if your list has many members
16855     * you may find it takes a while for them to all appear, with your process
16856     * consuming a lot of CPU while it is busy spooling.
16857     *
16858     * Genlist also implements a tree structure, but it does so with callbacks to
16859     * the application, with the application filling in tree structures when
16860     * requested (allowing for efficient building of a very deep tree that could
16861     * even be used for file-management). See the above smart signal callbacks for
16862     * details.
16863     *
16864     * @section Genlist_Smart_Events Genlist smart events
16865     *
16866     * Signals that you can add callbacks for are:
16867     * - @c "activated" - The user has double-clicked or pressed
16868     *   (enter|return|spacebar) on an item. The @c event_info parameter is the
16869     *   item that was activated.
16870     * - @c "clicked,double" - The user has double-clicked an item.  The @c
16871     *   event_info parameter is the item that was double-clicked.
16872     * - @c "selected" - This is called when a user has made an item selected.
16873     *   The event_info parameter is the genlist item that was selected.
16874     * - @c "unselected" - This is called when a user has made an item
16875     *   unselected. The event_info parameter is the genlist item that was
16876     *   unselected.
16877     * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
16878     *   called and the item is now meant to be expanded. The event_info
16879     *   parameter is the genlist item that was indicated to expand.  It is the
16880     *   job of this callback to then fill in the child items.
16881     * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
16882     *   called and the item is now meant to be contracted. The event_info
16883     *   parameter is the genlist item that was indicated to contract. It is the
16884     *   job of this callback to then delete the child items.
16885     * - @c "expand,request" - This is called when a user has indicated they want
16886     *   to expand a tree branch item. The callback should decide if the item can
16887     *   expand (has any children) and then call elm_genlist_item_expanded_set()
16888     *   appropriately to set the state. The event_info parameter is the genlist
16889     *   item that was indicated to expand.
16890     * - @c "contract,request" - This is called when a user has indicated they
16891     *   want to contract a tree branch item. The callback should decide if the
16892     *   item can contract (has any children) and then call
16893     *   elm_genlist_item_expanded_set() appropriately to set the state. The
16894     *   event_info parameter is the genlist item that was indicated to contract.
16895     * - @c "realized" - This is called when the item in the list is created as a
16896     *   real evas object. event_info parameter is the genlist item that was
16897     *   created. The object may be deleted at any time, so it is up to the
16898     *   caller to not use the object pointer from elm_genlist_item_object_get()
16899     *   in a way where it may point to freed objects.
16900     * - @c "unrealized" - This is called just before an item is unrealized.
16901     *   After this call icon objects provided will be deleted and the item
16902     *   object itself delete or be put into a floating cache.
16903     * - @c "drag,start,up" - This is called when the item in the list has been
16904     *   dragged (not scrolled) up.
16905     * - @c "drag,start,down" - This is called when the item in the list has been
16906     *   dragged (not scrolled) down.
16907     * - @c "drag,start,left" - This is called when the item in the list has been
16908     *   dragged (not scrolled) left.
16909     * - @c "drag,start,right" - This is called when the item in the list has
16910     *   been dragged (not scrolled) right.
16911     * - @c "drag,stop" - This is called when the item in the list has stopped
16912     *   being dragged.
16913     * - @c "drag" - This is called when the item in the list is being dragged.
16914     * - @c "longpressed" - This is called when the item is pressed for a certain
16915     *   amount of time. By default it's 1 second.
16916     * - @c "scroll,anim,start" - This is called when scrolling animation has
16917     *   started.
16918     * - @c "scroll,anim,stop" - This is called when scrolling animation has
16919     *   stopped.
16920     * - @c "scroll,drag,start" - This is called when dragging the content has
16921     *   started.
16922     * - @c "scroll,drag,stop" - This is called when dragging the content has
16923     *   stopped.
16924     * - @c "scroll,edge,top" - This is called when the genlist is scrolled until
16925     *   the top edge.
16926     * - @c "scroll,edge,bottom" - This is called when the genlist is scrolled
16927     *   until the bottom edge.
16928     * - @c "scroll,edge,left" - This is called when the genlist is scrolled
16929     *   until the left edge.
16930     * - @c "scroll,edge,right" - This is called when the genlist is scrolled
16931     *   until the right edge.
16932     * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
16933     *   swiped left.
16934     * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
16935     *   swiped right.
16936     * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
16937     *   swiped up.
16938     * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
16939     *   swiped down.
16940     * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
16941     *   pinched out.  "- @c multi,pinch,in" - This is called when the genlist is
16942     *   multi-touch pinched in.
16943     * - @c "swipe" - This is called when the genlist is swiped.
16944     *
16945     * @section Genlist_Examples Examples
16946     *
16947     * Here is a list of examples that use the genlist, trying to show some of
16948     * its capabilities:
16949     * - @ref genlist_example_01
16950     * - @ref genlist_example_02
16951     * - @ref genlist_example_03
16952     * - @ref genlist_example_04
16953     * - @ref genlist_example_05
16954     */
16955
16956    /**
16957     * @addtogroup Genlist
16958     * @{
16959     */
16960
16961    /**
16962     * @enum _Elm_Genlist_Item_Flags
16963     * @typedef Elm_Genlist_Item_Flags
16964     *
16965     * Defines if the item is of any special type (has subitems or it's the
16966     * index of a group), or is just a simple item.
16967     *
16968     * @ingroup Genlist
16969     */
16970    typedef enum _Elm_Genlist_Item_Flags
16971      {
16972         ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
16973         ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
16974         ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
16975      } Elm_Genlist_Item_Flags;
16976    typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;  /**< Genlist item class definition structs */
16977    typedef struct _Elm_Genlist_Item       Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
16978    typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
16979    typedef char        *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
16980    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. */
16981    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. */
16982    typedef void         (*Elm_Genlist_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
16983    typedef void         (*GenlistItemMovedFunc)    (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after); /** TODO: remove this by SeoZ **/
16984
16985    typedef char        *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Label_Get_Cb instead. */
16986    typedef Evas_Object *(*GenlistItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Icon_Get_Cb instead. */
16987    typedef Eina_Bool    (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_State_Get_Cb instead. */
16988    typedef void         (*GenlistItemDelFunc)      (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Del_Cb instead. */
16989
16990    /**
16991     * @struct _Elm_Genlist_Item_Class
16992     *
16993     * Genlist item class definition structs.
16994     *
16995     * This struct contains the style and fetching functions that will define the
16996     * contents of each item.
16997     *
16998     * @see @ref Genlist_Item_Class
16999     */
17000    struct _Elm_Genlist_Item_Class
17001      {
17002         const char                *item_style; /**< style of this class. */
17003         struct
17004           {
17005              Elm_Genlist_Item_Label_Get_Cb  label_get; /**< Label fetching class function for genlist item classes.*/
17006              Elm_Genlist_Item_Icon_Get_Cb   icon_get; /**< Icon fetching class function for genlist item classes. */
17007              Elm_Genlist_Item_State_Get_Cb  state_get; /**< State fetching class function for genlist item classes. */
17008              Elm_Genlist_Item_Del_Cb        del; /**< Deletion class function for genlist item classes. */
17009              GenlistItemMovedFunc     moved; // TODO: do not use this. change this to smart callback.
17010           } func;
17011         const char                *mode_item_style;
17012      };
17013
17014    /**
17015     * Add a new genlist widget to the given parent Elementary
17016     * (container) object
17017     *
17018     * @param parent The parent object
17019     * @return a new genlist widget handle or @c NULL, on errors
17020     *
17021     * This function inserts a new genlist widget on the canvas.
17022     *
17023     * @see elm_genlist_item_append()
17024     * @see elm_genlist_item_del()
17025     * @see elm_genlist_clear()
17026     *
17027     * @ingroup Genlist
17028     */
17029    EAPI Evas_Object      *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17030    /**
17031     * Remove all items from a given genlist widget.
17032     *
17033     * @param obj The genlist object
17034     *
17035     * This removes (and deletes) all items in @p obj, leaving it empty.
17036     *
17037     * @see elm_genlist_item_del(), to remove just one item.
17038     *
17039     * @ingroup Genlist
17040     */
17041    EAPI void              elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
17042    /**
17043     * Enable or disable multi-selection in the genlist
17044     *
17045     * @param obj The genlist object
17046     * @param multi Multi-select enable/disable. Default is disabled.
17047     *
17048     * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
17049     * the list. This allows more than 1 item to be selected. To retrieve the list
17050     * of selected items, use elm_genlist_selected_items_get().
17051     *
17052     * @see elm_genlist_selected_items_get()
17053     * @see elm_genlist_multi_select_get()
17054     *
17055     * @ingroup Genlist
17056     */
17057    EAPI void              elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
17058    /**
17059     * Gets if multi-selection in genlist is enabled or disabled.
17060     *
17061     * @param obj The genlist object
17062     * @return Multi-select enabled/disabled
17063     * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
17064     *
17065     * @see elm_genlist_multi_select_set()
17066     *
17067     * @ingroup Genlist
17068     */
17069    EAPI Eina_Bool         elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17070    /**
17071     * This sets the horizontal stretching mode.
17072     *
17073     * @param obj The genlist object
17074     * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
17075     *
17076     * This sets the mode used for sizing items horizontally. Valid modes
17077     * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
17078     * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
17079     * the scroller will scroll horizontally. Otherwise items are expanded
17080     * to fill the width of the viewport of the scroller. If it is
17081     * ELM_LIST_LIMIT, items will be expanded to the viewport width and
17082     * limited to that size.
17083     *
17084     * @see elm_genlist_horizontal_get()
17085     *
17086     * @ingroup Genlist
17087     */
17088    EAPI void              elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
17089    EINA_DEPRECATED EAPI void              elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
17090    /**
17091     * Gets the horizontal stretching mode.
17092     *
17093     * @param obj The genlist object
17094     * @return The mode to use
17095     * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
17096     *
17097     * @see elm_genlist_horizontal_set()
17098     *
17099     * @ingroup Genlist
17100     */
17101    EAPI Elm_List_Mode     elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17102    EINA_DEPRECATED EAPI Elm_List_Mode     elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17103    /**
17104     * Set the always select mode.
17105     *
17106     * @param obj The genlist object
17107     * @param always_select The always select mode (@c EINA_TRUE = on, @c
17108     * EINA_FALSE = off). Default is @c EINA_FALSE.
17109     *
17110     * Items will only call their selection func and callback when first
17111     * becoming selected. Any further clicks will do nothing, unless you
17112     * enable always select with elm_genlist_always_select_mode_set().
17113     * This means that, even if selected, every click will make the selected
17114     * callbacks be called.
17115     *
17116     * @see elm_genlist_always_select_mode_get()
17117     *
17118     * @ingroup Genlist
17119     */
17120    EAPI void              elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
17121    /**
17122     * Get the always select mode.
17123     *
17124     * @param obj The genlist object
17125     * @return The always select mode
17126     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
17127     *
17128     * @see elm_genlist_always_select_mode_set()
17129     *
17130     * @ingroup Genlist
17131     */
17132    EAPI Eina_Bool         elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17133    /**
17134     * Enable/disable the no select mode.
17135     *
17136     * @param obj The genlist object
17137     * @param no_select The no select mode
17138     * (EINA_TRUE = on, EINA_FALSE = off)
17139     *
17140     * This will turn off the ability to select items entirely and they
17141     * will neither appear selected nor call selected callback functions.
17142     *
17143     * @see elm_genlist_no_select_mode_get()
17144     *
17145     * @ingroup Genlist
17146     */
17147    EAPI void              elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
17148    /**
17149     * Gets whether the no select mode is enabled.
17150     *
17151     * @param obj The genlist object
17152     * @return The no select mode
17153     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
17154     *
17155     * @see elm_genlist_no_select_mode_set()
17156     *
17157     * @ingroup Genlist
17158     */
17159    EAPI Eina_Bool         elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17160    /**
17161     * Enable/disable compress mode.
17162     *
17163     * @param obj The genlist object
17164     * @param compress The compress mode
17165     * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
17166     *
17167     * This will enable the compress mode where items are "compressed"
17168     * horizontally to fit the genlist scrollable viewport width. This is
17169     * special for genlist.  Do not rely on
17170     * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
17171     * work as genlist needs to handle it specially.
17172     *
17173     * @see elm_genlist_compress_mode_get()
17174     *
17175     * @ingroup Genlist
17176     */
17177    EAPI void              elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
17178    /**
17179     * Get whether the compress mode is enabled.
17180     *
17181     * @param obj The genlist object
17182     * @return The compress mode
17183     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
17184     *
17185     * @see elm_genlist_compress_mode_set()
17186     *
17187     * @ingroup Genlist
17188     */
17189    EAPI Eina_Bool         elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17190    /**
17191     * Enable/disable height-for-width mode.
17192     *
17193     * @param obj The genlist object
17194     * @param setting The height-for-width mode (@c EINA_TRUE = on,
17195     * @c EINA_FALSE = off). Default is @c EINA_FALSE.
17196     *
17197     * With height-for-width mode the item width will be fixed (restricted
17198     * to a minimum of) to the list width when calculating its size in
17199     * order to allow the height to be calculated based on it. This allows,
17200     * for instance, text block to wrap lines if the Edje part is
17201     * configured with "text.min: 0 1".
17202     *
17203     * @note This mode will make list resize slower as it will have to
17204     *       recalculate every item height again whenever the list width
17205     *       changes!
17206     *
17207     * @note When height-for-width mode is enabled, it also enables
17208     *       compress mode (see elm_genlist_compress_mode_set()) and
17209     *       disables homogeneous (see elm_genlist_homogeneous_set()).
17210     *
17211     * @ingroup Genlist
17212     */
17213    EAPI void              elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
17214    /**
17215     * Get whether the height-for-width mode is enabled.
17216     *
17217     * @param obj The genlist object
17218     * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
17219     * off)
17220     *
17221     * @ingroup Genlist
17222     */
17223    EAPI Eina_Bool         elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17224    /**
17225     * Enable/disable horizontal and vertical bouncing effect.
17226     *
17227     * @param obj The genlist object
17228     * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
17229     * EINA_FALSE = off). Default is @c EINA_FALSE.
17230     * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
17231     * EINA_FALSE = off). Default is @c EINA_TRUE.
17232     *
17233     * This will enable or disable the scroller bouncing effect for the
17234     * genlist. See elm_scroller_bounce_set() for details.
17235     *
17236     * @see elm_scroller_bounce_set()
17237     * @see elm_genlist_bounce_get()
17238     *
17239     * @ingroup Genlist
17240     */
17241    EAPI void              elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
17242    /**
17243     * Get whether the horizontal and vertical bouncing effect is enabled.
17244     *
17245     * @param obj The genlist object
17246     * @param h_bounce Pointer to a bool to receive if the bounce horizontally
17247     * option is set.
17248     * @param v_bounce Pointer to a bool to receive if the bounce vertically
17249     * option is set.
17250     *
17251     * @see elm_genlist_bounce_set()
17252     *
17253     * @ingroup Genlist
17254     */
17255    EAPI void              elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
17256    /**
17257     * Enable/disable homogenous mode.
17258     *
17259     * @param obj The genlist object
17260     * @param homogeneous Assume the items within the genlist are of the
17261     * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
17262     * EINA_FALSE.
17263     *
17264     * This will enable the homogeneous mode where items are of the same
17265     * height and width so that genlist may do the lazy-loading at its
17266     * maximum (which increases the performance for scrolling the list). This
17267     * implies 'compressed' mode.
17268     *
17269     * @see elm_genlist_compress_mode_set()
17270     * @see elm_genlist_homogeneous_get()
17271     *
17272     * @ingroup Genlist
17273     */
17274    EAPI void              elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
17275    /**
17276     * Get whether the homogenous mode is enabled.
17277     *
17278     * @param obj The genlist object
17279     * @return Assume the items within the genlist are of the same height
17280     * and width (EINA_TRUE = on, EINA_FALSE = off)
17281     *
17282     * @see elm_genlist_homogeneous_set()
17283     *
17284     * @ingroup Genlist
17285     */
17286    EAPI Eina_Bool         elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17287    /**
17288     * Set the maximum number of items within an item block
17289     *
17290     * @param obj The genlist object
17291     * @param n   Maximum number of items within an item block. Default is 32.
17292     *
17293     * This will configure the block count to tune to the target with
17294     * particular performance matrix.
17295     *
17296     * A block of objects will be used to reduce the number of operations due to
17297     * many objects in the screen. It can determine the visibility, or if the
17298     * object has changed, it theme needs to be updated, etc. doing this kind of
17299     * calculation to the entire block, instead of per object.
17300     *
17301     * The default value for the block count is enough for most lists, so unless
17302     * you know you will have a lot of objects visible in the screen at the same
17303     * time, don't try to change this.
17304     *
17305     * @see elm_genlist_block_count_get()
17306     * @see @ref Genlist_Implementation
17307     *
17308     * @ingroup Genlist
17309     */
17310    EAPI void              elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
17311    /**
17312     * Get the maximum number of items within an item block
17313     *
17314     * @param obj The genlist object
17315     * @return Maximum number of items within an item block
17316     *
17317     * @see elm_genlist_block_count_set()
17318     *
17319     * @ingroup Genlist
17320     */
17321    EAPI int               elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17322    /**
17323     * Set the timeout in seconds for the longpress event.
17324     *
17325     * @param obj The genlist object
17326     * @param timeout timeout in seconds. Default is 1.
17327     *
17328     * This option will change how long it takes to send an event "longpressed"
17329     * after the mouse down signal is sent to the list. If this event occurs, no
17330     * "clicked" event will be sent.
17331     *
17332     * @see elm_genlist_longpress_timeout_set()
17333     *
17334     * @ingroup Genlist
17335     */
17336    EAPI void              elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
17337    /**
17338     * Get the timeout in seconds for the longpress event.
17339     *
17340     * @param obj The genlist object
17341     * @return timeout in seconds
17342     *
17343     * @see elm_genlist_longpress_timeout_get()
17344     *
17345     * @ingroup Genlist
17346     */
17347    EAPI double            elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17348    /**
17349     * Append a new item in a given genlist widget.
17350     *
17351     * @param obj The genlist object
17352     * @param itc The item class for the item
17353     * @param data The item data
17354     * @param parent The parent item, or NULL if none
17355     * @param flags Item flags
17356     * @param func Convenience function called when the item is selected
17357     * @param func_data Data passed to @p func above.
17358     * @return A handle to the item added or @c NULL if not possible
17359     *
17360     * This adds the given item to the end of the list or the end of
17361     * the children list if the @p parent is given.
17362     *
17363     * @see elm_genlist_item_prepend()
17364     * @see elm_genlist_item_insert_before()
17365     * @see elm_genlist_item_insert_after()
17366     * @see elm_genlist_item_del()
17367     *
17368     * @ingroup Genlist
17369     */
17370    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);
17371    /**
17372     * Prepend a new item in a given genlist widget.
17373     *
17374     * @param obj The genlist object
17375     * @param itc The item class for the item
17376     * @param data The item data
17377     * @param parent The parent item, or NULL if none
17378     * @param flags Item flags
17379     * @param func Convenience function called when the item is selected
17380     * @param func_data Data passed to @p func above.
17381     * @return A handle to the item added or NULL if not possible
17382     *
17383     * This adds an item to the beginning of the list or beginning of the
17384     * children of the parent if given.
17385     *
17386     * @see elm_genlist_item_append()
17387     * @see elm_genlist_item_insert_before()
17388     * @see elm_genlist_item_insert_after()
17389     * @see elm_genlist_item_del()
17390     *
17391     * @ingroup Genlist
17392     */
17393    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);
17394    /**
17395     * Insert an item before another in a genlist widget
17396     *
17397     * @param obj The genlist object
17398     * @param itc The item class for the item
17399     * @param data The item data
17400     * @param before The item to place this new one before.
17401     * @param flags Item flags
17402     * @param func Convenience function called when the item is selected
17403     * @param func_data Data passed to @p func above.
17404     * @return A handle to the item added or @c NULL if not possible
17405     *
17406     * This inserts an item before another in the list. It will be in the
17407     * same tree level or group as the item it is inserted before.
17408     *
17409     * @see elm_genlist_item_append()
17410     * @see elm_genlist_item_prepend()
17411     * @see elm_genlist_item_insert_after()
17412     * @see elm_genlist_item_del()
17413     *
17414     * @ingroup Genlist
17415     */
17416    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);
17417    /**
17418     * Insert an item after another in a genlist widget
17419     *
17420     * @param obj The genlist object
17421     * @param itc The item class for the item
17422     * @param data The item data
17423     * @param after The item to place this new one after.
17424     * @param flags Item flags
17425     * @param func Convenience function called when the item is selected
17426     * @param func_data Data passed to @p func above.
17427     * @return A handle to the item added or @c NULL if not possible
17428     *
17429     * This inserts an item after another in the list. It will be in the
17430     * same tree level or group as the item it is inserted after.
17431     *
17432     * @see elm_genlist_item_append()
17433     * @see elm_genlist_item_prepend()
17434     * @see elm_genlist_item_insert_before()
17435     * @see elm_genlist_item_del()
17436     *
17437     * @ingroup Genlist
17438     */
17439    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);
17440    /**
17441     * Insert a new item into the sorted genlist object
17442     *
17443     * @param obj The genlist object
17444     * @param itc The item class for the item
17445     * @param data The item data
17446     * @param parent The parent item, or NULL if none
17447     * @param flags Item flags
17448     * @param comp The function called for the sort
17449     * @param func Convenience function called when item selected
17450     * @param func_data Data passed to @p func above.
17451     * @return A handle to the item added or NULL if not possible
17452     *
17453     * @ingroup Genlist
17454     */
17455    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);
17456    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);
17457    /* operations to retrieve existing items */
17458    /**
17459     * Get the selectd item in the genlist.
17460     *
17461     * @param obj The genlist object
17462     * @return The selected item, or NULL if none is selected.
17463     *
17464     * This gets the selected item in the list (if multi-selection is enabled, only
17465     * the item that was first selected in the list is returned - which is not very
17466     * useful, so see elm_genlist_selected_items_get() for when multi-selection is
17467     * used).
17468     *
17469     * If no item is selected, NULL is returned.
17470     *
17471     * @see elm_genlist_selected_items_get()
17472     *
17473     * @ingroup Genlist
17474     */
17475    EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17476    /**
17477     * Get a list of selected items in the genlist.
17478     *
17479     * @param obj The genlist object
17480     * @return The list of selected items, or NULL if none are selected.
17481     *
17482     * It returns a list of the selected items. This list pointer is only valid so
17483     * long as the selection doesn't change (no items are selected or unselected, or
17484     * unselected implicitly by deletion). The list contains Elm_Genlist_Item
17485     * pointers. The order of the items in this list is the order which they were
17486     * selected, i.e. the first item in this list is the first item that was
17487     * selected, and so on.
17488     *
17489     * @note If not in multi-select mode, consider using function
17490     * elm_genlist_selected_item_get() instead.
17491     *
17492     * @see elm_genlist_multi_select_set()
17493     * @see elm_genlist_selected_item_get()
17494     *
17495     * @ingroup Genlist
17496     */
17497    EAPI const Eina_List  *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17498    /**
17499     * Get a list of realized items in genlist
17500     *
17501     * @param obj The genlist object
17502     * @return The list of realized items, nor NULL if none are realized.
17503     *
17504     * This returns a list of the realized items in the genlist. The list
17505     * contains Elm_Genlist_Item pointers. The list must be freed by the
17506     * caller when done with eina_list_free(). The item pointers in the
17507     * list are only valid so long as those items are not deleted or the
17508     * genlist is not deleted.
17509     *
17510     * @see elm_genlist_realized_items_update()
17511     *
17512     * @ingroup Genlist
17513     */
17514    EAPI Eina_List        *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17515    /**
17516     * Get the item that is at the x, y canvas coords.
17517     *
17518     * @param obj The gelinst object.
17519     * @param x The input x coordinate
17520     * @param y The input y coordinate
17521     * @param posret The position relative to the item returned here
17522     * @return The item at the coordinates or NULL if none
17523     *
17524     * This returns the item at the given coordinates (which are canvas
17525     * relative, not object-relative). If an item is at that coordinate,
17526     * that item handle is returned, and if @p posret is not NULL, the
17527     * integer pointed to is set to a value of -1, 0 or 1, depending if
17528     * the coordinate is on the upper portion of that item (-1), on the
17529     * middle section (0) or on the lower part (1). If NULL is returned as
17530     * an item (no item found there), then posret may indicate -1 or 1
17531     * based if the coordinate is above or below all items respectively in
17532     * the genlist.
17533     *
17534     * @ingroup Genlist
17535     */
17536    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);
17537    /**
17538     * Get the first item in the genlist
17539     *
17540     * This returns the first item in the list.
17541     *
17542     * @param obj The genlist object
17543     * @return The first item, or NULL if none
17544     *
17545     * @ingroup Genlist
17546     */
17547    EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17548    /**
17549     * Get the last item in the genlist
17550     *
17551     * This returns the last item in the list.
17552     *
17553     * @return The last item, or NULL if none
17554     *
17555     * @ingroup Genlist
17556     */
17557    EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17558    /**
17559     * Set the scrollbar policy
17560     *
17561     * @param obj The genlist object
17562     * @param policy_h Horizontal scrollbar policy.
17563     * @param policy_v Vertical scrollbar policy.
17564     *
17565     * This sets the scrollbar visibility policy for the given genlist
17566     * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
17567     * made visible if it is needed, and otherwise kept hidden.
17568     * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
17569     * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
17570     * respectively for the horizontal and vertical scrollbars. Default is
17571     * #ELM_SMART_SCROLLER_POLICY_AUTO
17572     *
17573     * @see elm_genlist_scroller_policy_get()
17574     *
17575     * @ingroup Genlist
17576     */
17577    EAPI void              elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
17578    /**
17579     * Get the scrollbar policy
17580     *
17581     * @param obj The genlist object
17582     * @param policy_h Pointer to store the horizontal scrollbar policy.
17583     * @param policy_v Pointer to store the vertical scrollbar policy.
17584     *
17585     * @see elm_genlist_scroller_policy_set()
17586     *
17587     * @ingroup Genlist
17588     */
17589    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);
17590    /**
17591     * Get the @b next item in a genlist widget's internal list of items,
17592     * given a handle to one of those items.
17593     *
17594     * @param item The genlist item to fetch next from
17595     * @return The item after @p item, or @c NULL if there's none (and
17596     * on errors)
17597     *
17598     * This returns the item placed after the @p item, on the container
17599     * genlist.
17600     *
17601     * @see elm_genlist_item_prev_get()
17602     *
17603     * @ingroup Genlist
17604     */
17605    EAPI Elm_Genlist_Item  *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17606    /**
17607     * Get the @b previous item in a genlist widget's internal list of items,
17608     * given a handle to one of those items.
17609     *
17610     * @param item The genlist item to fetch previous from
17611     * @return The item before @p item, or @c NULL if there's none (and
17612     * on errors)
17613     *
17614     * This returns the item placed before the @p item, on the container
17615     * genlist.
17616     *
17617     * @see elm_genlist_item_next_get()
17618     *
17619     * @ingroup Genlist
17620     */
17621    EAPI Elm_Genlist_Item  *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17622    /**
17623     * Get the genlist object's handle which contains a given genlist
17624     * item
17625     *
17626     * @param item The item to fetch the container from
17627     * @return The genlist (parent) object
17628     *
17629     * This returns the genlist object itself that an item belongs to.
17630     *
17631     * @ingroup Genlist
17632     */
17633    EAPI Evas_Object       *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17634    /**
17635     * Get the parent item of the given item
17636     *
17637     * @param it The item
17638     * @return The parent of the item or @c NULL if it has no parent.
17639     *
17640     * This returns the item that was specified as parent of the item @p it on
17641     * elm_genlist_item_append() and insertion related functions.
17642     *
17643     * @ingroup Genlist
17644     */
17645    EAPI Elm_Genlist_Item  *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17646    /**
17647     * Remove all sub-items (children) of the given item
17648     *
17649     * @param it The item
17650     *
17651     * This removes all items that are children (and their descendants) of the
17652     * given item @p it.
17653     *
17654     * @see elm_genlist_clear()
17655     * @see elm_genlist_item_del()
17656     *
17657     * @ingroup Genlist
17658     */
17659    EAPI void               elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17660    /**
17661     * Set whether a given genlist item is selected or not
17662     *
17663     * @param it The item
17664     * @param selected Use @c EINA_TRUE, to make it selected, @c
17665     * EINA_FALSE to make it unselected
17666     *
17667     * This sets the selected state of an item. If multi selection is
17668     * not enabled on the containing genlist and @p selected is @c
17669     * EINA_TRUE, any other previously selected items will get
17670     * unselected in favor of this new one.
17671     *
17672     * @see elm_genlist_item_selected_get()
17673     *
17674     * @ingroup Genlist
17675     */
17676    EAPI void               elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
17677    /**
17678     * Get whether a given genlist item is selected or not
17679     *
17680     * @param it The item
17681     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
17682     *
17683     * @see elm_genlist_item_selected_set() for more details
17684     *
17685     * @ingroup Genlist
17686     */
17687    EAPI Eina_Bool          elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17688    /**
17689     * Sets the expanded state of an item.
17690     *
17691     * @param it The item
17692     * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
17693     *
17694     * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
17695     * expanded or not.
17696     *
17697     * The theme will respond to this change visually, and a signal "expanded" or
17698     * "contracted" will be sent from the genlist with a pointer to the item that
17699     * has been expanded/contracted.
17700     *
17701     * Calling this function won't show or hide any child of this item (if it is
17702     * a parent). You must manually delete and create them on the callbacks fo
17703     * the "expanded" or "contracted" signals.
17704     *
17705     * @see elm_genlist_item_expanded_get()
17706     *
17707     * @ingroup Genlist
17708     */
17709    EAPI void               elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
17710    /**
17711     * Get the expanded state of an item
17712     *
17713     * @param it The item
17714     * @return The expanded state
17715     *
17716     * This gets the expanded state of an item.
17717     *
17718     * @see elm_genlist_item_expanded_set()
17719     *
17720     * @ingroup Genlist
17721     */
17722    EAPI Eina_Bool          elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17723    /**
17724     * Get the depth of expanded item
17725     *
17726     * @param it The genlist item object
17727     * @return The depth of expanded item
17728     *
17729     * @ingroup Genlist
17730     */
17731    EAPI int                elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17732    /**
17733     * Set whether a given genlist item is disabled or not.
17734     *
17735     * @param it The item
17736     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
17737     * to enable it back.
17738     *
17739     * A disabled item cannot be selected or unselected. It will also
17740     * change its appearance, to signal the user it's disabled.
17741     *
17742     * @see elm_genlist_item_disabled_get()
17743     *
17744     * @ingroup Genlist
17745     */
17746    EAPI void               elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17747    /**
17748     * Get whether a given genlist item is disabled or not.
17749     *
17750     * @param it The item
17751     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
17752     * (and on errors).
17753     *
17754     * @see elm_genlist_item_disabled_set() for more details
17755     *
17756     * @ingroup Genlist
17757     */
17758    EAPI Eina_Bool          elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17759    /**
17760     * Sets the display only state of an item.
17761     *
17762     * @param it The item
17763     * @param display_only @c EINA_TRUE if the item is display only, @c
17764     * EINA_FALSE otherwise.
17765     *
17766     * A display only item cannot be selected or unselected. It is for
17767     * display only and not selecting or otherwise clicking, dragging
17768     * etc. by the user, thus finger size rules will not be applied to
17769     * this item.
17770     *
17771     * It's good to set group index items to display only state.
17772     *
17773     * @see elm_genlist_item_display_only_get()
17774     *
17775     * @ingroup Genlist
17776     */
17777    EAPI void               elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
17778    /**
17779     * Get the display only state of an item
17780     *
17781     * @param it The item
17782     * @return @c EINA_TRUE if the item is display only, @c
17783     * EINA_FALSE otherwise.
17784     *
17785     * @see elm_genlist_item_display_only_set()
17786     *
17787     * @ingroup Genlist
17788     */
17789    EAPI Eina_Bool          elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17790    /**
17791     * Show the portion of a genlist's internal list containing a given
17792     * item, immediately.
17793     *
17794     * @param it The item to display
17795     *
17796     * This causes genlist to jump to the given item @p it and show it (by
17797     * immediately scrolling to that position), if it is not fully visible.
17798     *
17799     * @see elm_genlist_item_bring_in()
17800     * @see elm_genlist_item_top_show()
17801     * @see elm_genlist_item_middle_show()
17802     *
17803     * @ingroup Genlist
17804     */
17805    EAPI void               elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17806    /**
17807     * Animatedly bring in, to the visible are of a genlist, a given
17808     * item on it.
17809     *
17810     * @param it The item to display
17811     *
17812     * This causes genlist to jump to the given item @p it and show it (by
17813     * animatedly scrolling), if it is not fully visible. This may use animation
17814     * to do so and take a period of time
17815     *
17816     * @see elm_genlist_item_show()
17817     * @see elm_genlist_item_top_bring_in()
17818     * @see elm_genlist_item_middle_bring_in()
17819     *
17820     * @ingroup Genlist
17821     */
17822    EAPI void               elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17823    /**
17824     * Show the portion of a genlist's internal list containing a given
17825     * item, immediately.
17826     *
17827     * @param it The item to display
17828     *
17829     * This causes genlist to jump to the given item @p it and show it (by
17830     * immediately scrolling to that position), if it is not fully visible.
17831     *
17832     * The item will be positioned at the top of the genlist viewport.
17833     *
17834     * @see elm_genlist_item_show()
17835     * @see elm_genlist_item_top_bring_in()
17836     *
17837     * @ingroup Genlist
17838     */
17839    EAPI void               elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17840    /**
17841     * Animatedly bring in, to the visible are of a genlist, a given
17842     * item on it.
17843     *
17844     * @param it The item
17845     *
17846     * This causes genlist to jump to the given item @p it and show it (by
17847     * animatedly scrolling), if it is not fully visible. This may use animation
17848     * to do so and take a period of time
17849     *
17850     * The item will be positioned at the top of the genlist viewport.
17851     *
17852     * @see elm_genlist_item_bring_in()
17853     * @see elm_genlist_item_top_show()
17854     *
17855     * @ingroup Genlist
17856     */
17857    EAPI void               elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17858    /**
17859     * Show the portion of a genlist's internal list containing a given
17860     * item, immediately.
17861     *
17862     * @param it The item to display
17863     *
17864     * This causes genlist to jump to the given item @p it and show it (by
17865     * immediately scrolling to that position), if it is not fully visible.
17866     *
17867     * The item will be positioned at the middle of the genlist viewport.
17868     *
17869     * @see elm_genlist_item_show()
17870     * @see elm_genlist_item_middle_bring_in()
17871     *
17872     * @ingroup Genlist
17873     */
17874    EAPI void               elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17875    /**
17876     * Animatedly bring in, to the visible are of a genlist, a given
17877     * item on it.
17878     *
17879     * @param it The item
17880     *
17881     * This causes genlist to jump to the given item @p it and show it (by
17882     * animatedly scrolling), if it is not fully visible. This may use animation
17883     * to do so and take a period of time
17884     *
17885     * The item will be positioned at the middle of the genlist viewport.
17886     *
17887     * @see elm_genlist_item_bring_in()
17888     * @see elm_genlist_item_middle_show()
17889     *
17890     * @ingroup Genlist
17891     */
17892    EAPI void               elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17893    /**
17894     * Remove a genlist item from the its parent, deleting it.
17895     *
17896     * @param item The item to be removed.
17897     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
17898     *
17899     * @see elm_genlist_clear(), to remove all items in a genlist at
17900     * once.
17901     *
17902     * @ingroup Genlist
17903     */
17904    EAPI void               elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17905    /**
17906     * Return the data associated to a given genlist item
17907     *
17908     * @param item The genlist item.
17909     * @return the data associated to this item.
17910     *
17911     * This returns the @c data value passed on the
17912     * elm_genlist_item_append() and related item addition calls.
17913     *
17914     * @see elm_genlist_item_append()
17915     * @see elm_genlist_item_data_set()
17916     *
17917     * @ingroup Genlist
17918     */
17919    EAPI void              *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17920    /**
17921     * Set the data associated to a given genlist item
17922     *
17923     * @param item The genlist item
17924     * @param data The new data pointer to set on it
17925     *
17926     * This @b overrides the @c data value passed on the
17927     * elm_genlist_item_append() and related item addition calls. This
17928     * function @b won't call elm_genlist_item_update() automatically,
17929     * so you'd issue it afterwards if you want to hove the item
17930     * updated to reflect the that new data.
17931     *
17932     * @see elm_genlist_item_data_get()
17933     *
17934     * @ingroup Genlist
17935     */
17936    EAPI void               elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
17937    /**
17938     * Tells genlist to "orphan" icons fetchs by the item class
17939     *
17940     * @param it The item
17941     *
17942     * This instructs genlist to release references to icons in the item,
17943     * meaning that they will no longer be managed by genlist and are
17944     * floating "orphans" that can be re-used elsewhere if the user wants
17945     * to.
17946     *
17947     * @ingroup Genlist
17948     */
17949    EAPI void               elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17950    /**
17951     * Get the real Evas object created to implement the view of a
17952     * given genlist item
17953     *
17954     * @param item The genlist item.
17955     * @return the Evas object implementing this item's view.
17956     *
17957     * This returns the actual Evas object used to implement the
17958     * specified genlist item's view. This may be @c NULL, as it may
17959     * not have been created or may have been deleted, at any time, by
17960     * the genlist. <b>Do not modify this object</b> (move, resize,
17961     * show, hide, etc.), as the genlist is controlling it. This
17962     * function is for querying, emitting custom signals or hooking
17963     * lower level callbacks for events on that object. Do not delete
17964     * this object under any circumstances.
17965     *
17966     * @see elm_genlist_item_data_get()
17967     *
17968     * @ingroup Genlist
17969     */
17970    EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17971    /**
17972     * Update the contents of an item
17973     *
17974     * @param it The item
17975     *
17976     * This updates an item by calling all the item class functions again
17977     * to get the icons, labels and states. Use this when the original
17978     * item data has changed and the changes are desired to be reflected.
17979     *
17980     * Use elm_genlist_realized_items_update() to update all already realized
17981     * items.
17982     *
17983     * @see elm_genlist_realized_items_update()
17984     *
17985     * @ingroup Genlist
17986     */
17987    EAPI void               elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17988    /**
17989     * Update the item class of an item
17990     *
17991     * @param it The item
17992     * @param itc The item class for the item
17993     *
17994     * This sets another class fo the item, changing the way that it is
17995     * displayed. After changing the item class, elm_genlist_item_update() is
17996     * called on the item @p it.
17997     *
17998     * @ingroup Genlist
17999     */
18000    EAPI void               elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
18001    EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18002    /**
18003     * Set the text to be shown in a given genlist item's tooltips.
18004     *
18005     * @param item The genlist item
18006     * @param text The text to set in the content
18007     *
18008     * This call will setup the text to be used as tooltip to that item
18009     * (analogous to elm_object_tooltip_text_set(), but being item
18010     * tooltips with higher precedence than object tooltips). It can
18011     * have only one tooltip at a time, so any previous tooltip data
18012     * will get removed.
18013     *
18014     * In order to set an icon or something else as a tooltip, look at
18015     * elm_genlist_item_tooltip_content_cb_set().
18016     *
18017     * @ingroup Genlist
18018     */
18019    EAPI void               elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
18020    /**
18021     * Set the content to be shown in a given genlist item's tooltips
18022     *
18023     * @param item The genlist item.
18024     * @param func The function returning the tooltip contents.
18025     * @param data What to provide to @a func as callback data/context.
18026     * @param del_cb Called when data is not needed anymore, either when
18027     *        another callback replaces @p func, the tooltip is unset with
18028     *        elm_genlist_item_tooltip_unset() or the owner @p item
18029     *        dies. This callback receives as its first parameter the
18030     *        given @p data, being @c event_info the item handle.
18031     *
18032     * This call will setup the tooltip's contents to @p item
18033     * (analogous to elm_object_tooltip_content_cb_set(), but being
18034     * item tooltips with higher precedence than object tooltips). It
18035     * can have only one tooltip at a time, so any previous tooltip
18036     * content will get removed. @p func (with @p data) will be called
18037     * every time Elementary needs to show the tooltip and it should
18038     * return a valid Evas object, which will be fully managed by the
18039     * tooltip system, getting deleted when the tooltip is gone.
18040     *
18041     * In order to set just a text as a tooltip, look at
18042     * elm_genlist_item_tooltip_text_set().
18043     *
18044     * @ingroup Genlist
18045     */
18046    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);
18047    /**
18048     * Unset a tooltip from a given genlist item
18049     *
18050     * @param item genlist item to remove a previously set tooltip from.
18051     *
18052     * This call removes any tooltip set on @p item. The callback
18053     * provided as @c del_cb to
18054     * elm_genlist_item_tooltip_content_cb_set() will be called to
18055     * notify it is not used anymore (and have resources cleaned, if
18056     * need be).
18057     *
18058     * @see elm_genlist_item_tooltip_content_cb_set()
18059     *
18060     * @ingroup Genlist
18061     */
18062    EAPI void               elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18063    /**
18064     * Set a different @b style for a given genlist item's tooltip.
18065     *
18066     * @param item genlist item with tooltip set
18067     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
18068     * "default", @c "transparent", etc)
18069     *
18070     * Tooltips can have <b>alternate styles</b> to be displayed on,
18071     * which are defined by the theme set on Elementary. This function
18072     * works analogously as elm_object_tooltip_style_set(), but here
18073     * applied only to genlist item objects. The default style for
18074     * tooltips is @c "default".
18075     *
18076     * @note before you set a style you should define a tooltip with
18077     *       elm_genlist_item_tooltip_content_cb_set() or
18078     *       elm_genlist_item_tooltip_text_set()
18079     *
18080     * @see elm_genlist_item_tooltip_style_get()
18081     *
18082     * @ingroup Genlist
18083     */
18084    EAPI void               elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
18085    /**
18086     * Get the style set a given genlist item's tooltip.
18087     *
18088     * @param item genlist item with tooltip already set on.
18089     * @return style the theme style in use, which defaults to
18090     *         "default". If the object does not have a tooltip set,
18091     *         then @c NULL is returned.
18092     *
18093     * @see elm_genlist_item_tooltip_style_set() for more details
18094     *
18095     * @ingroup Genlist
18096     */
18097    EAPI const char        *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18098    /**
18099     * @brief Disable size restrictions on an object's tooltip
18100     * @param item The tooltip's anchor object
18101     * @param disable If EINA_TRUE, size restrictions are disabled
18102     * @return EINA_FALSE on failure, EINA_TRUE on success
18103     *
18104     * This function allows a tooltip to expand beyond its parant window's canvas.
18105     * It will instead be limited only by the size of the display.
18106     */
18107    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
18108    /**
18109     * @brief Retrieve size restriction state of an object's tooltip
18110     * @param item The tooltip's anchor object
18111     * @return If EINA_TRUE, size restrictions are disabled
18112     *
18113     * This function returns whether a tooltip is allowed to expand beyond
18114     * its parant window's canvas.
18115     * It will instead be limited only by the size of the display.
18116     */
18117    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
18118    /**
18119     * Set the type of mouse pointer/cursor decoration to be shown,
18120     * when the mouse pointer is over the given genlist widget item
18121     *
18122     * @param item genlist item to customize cursor on
18123     * @param cursor the cursor type's name
18124     *
18125     * This function works analogously as elm_object_cursor_set(), but
18126     * here the cursor's changing area is restricted to the item's
18127     * area, and not the whole widget's. Note that that item cursors
18128     * have precedence over widget cursors, so that a mouse over @p
18129     * item will always show cursor @p type.
18130     *
18131     * If this function is called twice for an object, a previously set
18132     * cursor will be unset on the second call.
18133     *
18134     * @see elm_object_cursor_set()
18135     * @see elm_genlist_item_cursor_get()
18136     * @see elm_genlist_item_cursor_unset()
18137     *
18138     * @ingroup Genlist
18139     */
18140    EAPI void               elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
18141    /**
18142     * Get the type of mouse pointer/cursor decoration set to be shown,
18143     * when the mouse pointer is over the given genlist widget item
18144     *
18145     * @param item genlist item with custom cursor set
18146     * @return the cursor type's name or @c NULL, if no custom cursors
18147     * were set to @p item (and on errors)
18148     *
18149     * @see elm_object_cursor_get()
18150     * @see elm_genlist_item_cursor_set() for more details
18151     * @see elm_genlist_item_cursor_unset()
18152     *
18153     * @ingroup Genlist
18154     */
18155    EAPI const char        *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18156    /**
18157     * Unset any custom mouse pointer/cursor decoration set to be
18158     * shown, when the mouse pointer is over the given genlist widget
18159     * item, thus making it show the @b default cursor again.
18160     *
18161     * @param item a genlist item
18162     *
18163     * Use this call to undo any custom settings on this item's cursor
18164     * decoration, bringing it back to defaults (no custom style set).
18165     *
18166     * @see elm_object_cursor_unset()
18167     * @see elm_genlist_item_cursor_set() for more details
18168     *
18169     * @ingroup Genlist
18170     */
18171    EAPI void               elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18172    /**
18173     * Set a different @b style for a given custom cursor set for a
18174     * genlist item.
18175     *
18176     * @param item genlist item with custom cursor set
18177     * @param style the <b>theme style</b> to use (e.g. @c "default",
18178     * @c "transparent", etc)
18179     *
18180     * This function only makes sense when one is using custom mouse
18181     * cursor decorations <b>defined in a theme file</b> , which can
18182     * have, given a cursor name/type, <b>alternate styles</b> on
18183     * it. It works analogously as elm_object_cursor_style_set(), but
18184     * here applied only to genlist item objects.
18185     *
18186     * @warning Before you set a cursor style you should have defined a
18187     *       custom cursor previously on the item, with
18188     *       elm_genlist_item_cursor_set()
18189     *
18190     * @see elm_genlist_item_cursor_engine_only_set()
18191     * @see elm_genlist_item_cursor_style_get()
18192     *
18193     * @ingroup Genlist
18194     */
18195    EAPI void               elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
18196    /**
18197     * Get the current @b style set for a given genlist item's custom
18198     * cursor
18199     *
18200     * @param item genlist item with custom cursor set.
18201     * @return style the cursor style in use. If the object does not
18202     *         have a cursor set, then @c NULL is returned.
18203     *
18204     * @see elm_genlist_item_cursor_style_set() for more details
18205     *
18206     * @ingroup Genlist
18207     */
18208    EAPI const char        *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18209    /**
18210     * Set if the (custom) cursor for a given genlist item should be
18211     * searched in its theme, also, or should only rely on the
18212     * rendering engine.
18213     *
18214     * @param item item with custom (custom) cursor already set on
18215     * @param engine_only Use @c EINA_TRUE to have cursors looked for
18216     * only on those provided by the rendering engine, @c EINA_FALSE to
18217     * have them searched on the widget's theme, as well.
18218     *
18219     * @note This call is of use only if you've set a custom cursor
18220     * for genlist items, with elm_genlist_item_cursor_set().
18221     *
18222     * @note By default, cursors will only be looked for between those
18223     * provided by the rendering engine.
18224     *
18225     * @ingroup Genlist
18226     */
18227    EAPI void               elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
18228    /**
18229     * Get if the (custom) cursor for a given genlist item is being
18230     * searched in its theme, also, or is only relying on the rendering
18231     * engine.
18232     *
18233     * @param item a genlist item
18234     * @return @c EINA_TRUE, if cursors are being looked for only on
18235     * those provided by the rendering engine, @c EINA_FALSE if they
18236     * are being searched on the widget's theme, as well.
18237     *
18238     * @see elm_genlist_item_cursor_engine_only_set(), for more details
18239     *
18240     * @ingroup Genlist
18241     */
18242    EAPI Eina_Bool          elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18243    /**
18244     * Update the contents of all realized items.
18245     *
18246     * @param obj The genlist object.
18247     *
18248     * This updates all realized items by calling all the item class functions again
18249     * to get the icons, labels and states. Use this when the original
18250     * item data has changed and the changes are desired to be reflected.
18251     *
18252     * To update just one item, use elm_genlist_item_update().
18253     *
18254     * @see elm_genlist_realized_items_get()
18255     * @see elm_genlist_item_update()
18256     *
18257     * @ingroup Genlist
18258     */
18259    EAPI void               elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
18260    /**
18261     * Activate a genlist mode on an item
18262     *
18263     * @param item The genlist item
18264     * @param mode Mode name
18265     * @param mode_set Boolean to define set or unset mode.
18266     *
18267     * A genlist mode is a different way of selecting an item. Once a mode is
18268     * activated on an item, any other selected item is immediately unselected.
18269     * This feature provides an easy way of implementing a new kind of animation
18270     * for selecting an item, without having to entirely rewrite the item style
18271     * theme. However, the elm_genlist_selected_* API can't be used to get what
18272     * item is activate for a mode.
18273     *
18274     * The current item style will still be used, but applying a genlist mode to
18275     * an item will select it using a different kind of animation.
18276     *
18277     * The current active item for a mode can be found by
18278     * elm_genlist_mode_item_get().
18279     *
18280     * The characteristics of genlist mode are:
18281     * - Only one mode can be active at any time, and for only one item.
18282     * - Genlist handles deactivating other items when one item is activated.
18283     * - A mode is defined in the genlist theme (edc), and more modes can easily
18284     *   be added.
18285     * - A mode style and the genlist item style are different things. They
18286     *   can be combined to provide a default style to the item, with some kind
18287     *   of animation for that item when the mode is activated.
18288     *
18289     * When a mode is activated on an item, a new view for that item is created.
18290     * The theme of this mode defines the animation that will be used to transit
18291     * the item from the old view to the new view. This second (new) view will be
18292     * active for that item while the mode is active on the item, and will be
18293     * destroyed after the mode is totally deactivated from that item.
18294     *
18295     * @see elm_genlist_mode_get()
18296     * @see elm_genlist_mode_item_get()
18297     *
18298     * @ingroup Genlist
18299     */
18300    EAPI void               elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
18301    /**
18302     * Get the last (or current) genlist mode used.
18303     *
18304     * @param obj The genlist object
18305     *
18306     * This function just returns the name of the last used genlist mode. It will
18307     * be the current mode if it's still active.
18308     *
18309     * @see elm_genlist_item_mode_set()
18310     * @see elm_genlist_mode_item_get()
18311     *
18312     * @ingroup Genlist
18313     */
18314    EAPI const char        *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18315    /**
18316     * Get active genlist mode item
18317     *
18318     * @param obj The genlist object
18319     * @return The active item for that current mode. Or @c NULL if no item is
18320     * activated with any mode.
18321     *
18322     * This function returns the item that was activated with a mode, by the
18323     * function elm_genlist_item_mode_set().
18324     *
18325     * @see elm_genlist_item_mode_set()
18326     * @see elm_genlist_mode_get()
18327     *
18328     * @ingroup Genlist
18329     */
18330    EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18331
18332    /**
18333     * Set reorder mode
18334     *
18335     * @param obj The genlist object
18336     * @param reorder_mode The reorder mode
18337     * (EINA_TRUE = on, EINA_FALSE = off)
18338     *
18339     * @ingroup Genlist
18340     */
18341    EAPI void               elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
18342
18343    /**
18344     * Get the reorder mode
18345     *
18346     * @param obj The genlist object
18347     * @return The reorder mode
18348     * (EINA_TRUE = on, EINA_FALSE = off)
18349     *
18350     * @ingroup Genlist
18351     */
18352    EAPI Eina_Bool          elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18353
18354    /**
18355     * @}
18356     */
18357
18358    /**
18359     * @defgroup Check Check
18360     *
18361     * @image html img/widget/check/preview-00.png
18362     * @image latex img/widget/check/preview-00.eps
18363     * @image html img/widget/check/preview-01.png
18364     * @image latex img/widget/check/preview-01.eps
18365     * @image html img/widget/check/preview-02.png
18366     * @image latex img/widget/check/preview-02.eps
18367     *
18368     * @brief The check widget allows for toggling a value between true and
18369     * false.
18370     *
18371     * Check objects are a lot like radio objects in layout and functionality
18372     * except they do not work as a group, but independently and only toggle the
18373     * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
18374     * the boolean state (1 for true, 0 for false), and elm_check_state_get()
18375     * returns the current state. For convenience, like the radio objects, you
18376     * can set a pointer to a boolean directly with elm_check_state_pointer_set()
18377     * for it to modify.
18378     *
18379     * Signals that you can add callbacks for are:
18380     * "changed" - This is called whenever the user changes the state of one of
18381     *             the check object(event_info is NULL).
18382     *
18383     * @ref tutorial_check should give you a firm grasp of how to use this widget.
18384     * @{
18385     */
18386    /**
18387     * @brief Add a new Check object
18388     *
18389     * @param parent The parent object
18390     * @return The new object or NULL if it cannot be created
18391     */
18392    EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18393    /**
18394     * @brief Set the text label of the check object
18395     *
18396     * @param obj The check object
18397     * @param label The text label string in UTF-8
18398     *
18399     * @deprecated use elm_object_text_set() instead.
18400     */
18401    EINA_DEPRECATED EAPI void         elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18402    /**
18403     * @brief Get the text label of the check object
18404     *
18405     * @param obj The check object
18406     * @return The text label string in UTF-8
18407     *
18408     * @deprecated use elm_object_text_get() instead.
18409     */
18410    EINA_DEPRECATED EAPI const char  *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18411    /**
18412     * @brief Set the icon object of the check object
18413     *
18414     * @param obj The check object
18415     * @param icon The icon object
18416     *
18417     * Once the icon object is set, a previously set one will be deleted.
18418     * If you want to keep that old content object, use the
18419     * elm_check_icon_unset() function.
18420     */
18421    EAPI void         elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18422    /**
18423     * @brief Get the icon object of the check object
18424     *
18425     * @param obj The check object
18426     * @return The icon object
18427     */
18428    EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18429    /**
18430     * @brief Unset the icon used for the check object
18431     *
18432     * @param obj The check object
18433     * @return The icon object that was being used
18434     *
18435     * Unparent and return the icon object which was set for this widget.
18436     */
18437    EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18438    /**
18439     * @brief Set the on/off state of the check object
18440     *
18441     * @param obj The check object
18442     * @param state The state to use (1 == on, 0 == off)
18443     *
18444     * This sets the state of the check. If set
18445     * with elm_check_state_pointer_set() the state of that variable is also
18446     * changed. Calling this @b doesn't cause the "changed" signal to be emited.
18447     */
18448    EAPI void         elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
18449    /**
18450     * @brief Get the state of the check object
18451     *
18452     * @param obj The check object
18453     * @return The boolean state
18454     */
18455    EAPI Eina_Bool    elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18456    /**
18457     * @brief Set a convenience pointer to a boolean to change
18458     *
18459     * @param obj The check object
18460     * @param statep Pointer to the boolean to modify
18461     *
18462     * This sets a pointer to a boolean, that, in addition to the check objects
18463     * state will also be modified directly. To stop setting the object pointed
18464     * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
18465     * then when this is called, the check objects state will also be modified to
18466     * reflect the value of the boolean @p statep points to, just like calling
18467     * elm_check_state_set().
18468     */
18469    EAPI void         elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
18470    /**
18471     * @}
18472     */
18473
18474    /**
18475     * @defgroup Radio Radio
18476     *
18477     * @image html img/widget/radio/preview-00.png
18478     * @image latex img/widget/radio/preview-00.eps
18479     *
18480     * @brief Radio is a widget that allows for 1 or more options to be displayed
18481     * and have the user choose only 1 of them.
18482     *
18483     * A radio object contains an indicator, an optional Label and an optional
18484     * icon object. While it's possible to have a group of only one radio they,
18485     * are normally used in groups of 2 or more. To add a radio to a group use
18486     * elm_radio_group_add(). The radio object(s) will select from one of a set
18487     * of integer values, so any value they are configuring needs to be mapped to
18488     * a set of integers. To configure what value that radio object represents,
18489     * use  elm_radio_state_value_set() to set the integer it represents. To set
18490     * the value the whole group(which one is currently selected) is to indicate
18491     * use elm_radio_value_set() on any group member, and to get the groups value
18492     * use elm_radio_value_get(). For convenience the radio objects are also able
18493     * to directly set an integer(int) to the value that is selected. To specify
18494     * the pointer to this integer to modify, use elm_radio_value_pointer_set().
18495     * The radio objects will modify this directly. That implies the pointer must
18496     * point to valid memory for as long as the radio objects exist.
18497     *
18498     * Signals that you can add callbacks for are:
18499     * @li changed - This is called whenever the user changes the state of one of
18500     * the radio objects within the group of radio objects that work together.
18501     *
18502     * @ref tutorial_radio show most of this API in action.
18503     * @{
18504     */
18505    /**
18506     * @brief Add a new radio to the parent
18507     *
18508     * @param parent The parent object
18509     * @return The new object or NULL if it cannot be created
18510     */
18511    EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18512    /**
18513     * @brief Set the text label of the radio object
18514     *
18515     * @param obj The radio object
18516     * @param label The text label string in UTF-8
18517     *
18518     * @deprecated use elm_object_text_set() instead.
18519     */
18520    EINA_DEPRECATED EAPI void         elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18521    /**
18522     * @brief Get the text label of the radio object
18523     *
18524     * @param obj The radio object
18525     * @return The text label string in UTF-8
18526     *
18527     * @deprecated use elm_object_text_set() instead.
18528     */
18529    EINA_DEPRECATED EAPI const char  *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18530    /**
18531     * @brief Set the icon object of the radio object
18532     *
18533     * @param obj The radio object
18534     * @param icon The icon object
18535     *
18536     * Once the icon object is set, a previously set one will be deleted. If you
18537     * want to keep that old content object, use the elm_radio_icon_unset()
18538     * function.
18539     */
18540    EAPI void         elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18541    /**
18542     * @brief Get the icon object of the radio object
18543     *
18544     * @param obj The radio object
18545     * @return The icon object
18546     *
18547     * @see elm_radio_icon_set()
18548     */
18549    EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18550    /**
18551     * @brief Unset the icon used for the radio object
18552     *
18553     * @param obj The radio object
18554     * @return The icon object that was being used
18555     *
18556     * Unparent and return the icon object which was set for this widget.
18557     *
18558     * @see elm_radio_icon_set()
18559     */
18560    EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18561    /**
18562     * @brief Add this radio to a group of other radio objects
18563     *
18564     * @param obj The radio object
18565     * @param group Any object whose group the @p obj is to join.
18566     *
18567     * Radio objects work in groups. Each member should have a different integer
18568     * value assigned. In order to have them work as a group, they need to know
18569     * about each other. This adds the given radio object to the group of which
18570     * the group object indicated is a member.
18571     */
18572    EAPI void         elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
18573    /**
18574     * @brief Set the integer value that this radio object represents
18575     *
18576     * @param obj The radio object
18577     * @param value The value to use if this radio object is selected
18578     *
18579     * This sets the value of the radio.
18580     */
18581    EAPI void         elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
18582    /**
18583     * @brief Get the integer value that this radio object represents
18584     *
18585     * @param obj The radio object
18586     * @return The value used if this radio object is selected
18587     *
18588     * This gets the value of the radio.
18589     *
18590     * @see elm_radio_value_set()
18591     */
18592    EAPI int          elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18593    /**
18594     * @brief Set the value of the radio.
18595     *
18596     * @param obj The radio object
18597     * @param value The value to use for the group
18598     *
18599     * This sets the value of the radio group and will also set the value if
18600     * pointed to, to the value supplied, but will not call any callbacks.
18601     */
18602    EAPI void         elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
18603    /**
18604     * @brief Get the state of the radio object
18605     *
18606     * @param obj The radio object
18607     * @return The integer state
18608     */
18609    EAPI int          elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18610    /**
18611     * @brief Set a convenience pointer to a integer to change
18612     *
18613     * @param obj The radio object
18614     * @param valuep Pointer to the integer to modify
18615     *
18616     * This sets a pointer to a integer, that, in addition to the radio objects
18617     * state will also be modified directly. To stop setting the object pointed
18618     * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
18619     * when this is called, the radio objects state will also be modified to
18620     * reflect the value of the integer valuep points to, just like calling
18621     * elm_radio_value_set().
18622     */
18623    EAPI void         elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
18624    /**
18625     * @}
18626     */
18627
18628    /**
18629     * @defgroup Pager Pager
18630     *
18631     * @image html img/widget/pager/preview-00.png
18632     * @image latex img/widget/pager/preview-00.eps
18633     *
18634     * @brief Widget that allows flipping between 1 or more “pages” of objects.
18635     *
18636     * The flipping between “pages” of objects is animated. All content in pager
18637     * is kept in a stack, the last content to be added will be on the top of the
18638     * stack(be visible).
18639     *
18640     * Objects can be pushed or popped from the stack or deleted as normal.
18641     * Pushes and pops will animate (and a pop will delete the object once the
18642     * animation is finished). Any object already in the pager can be promoted to
18643     * the top(from its current stacking position) through the use of
18644     * elm_pager_content_promote(). Objects are pushed to the top with
18645     * elm_pager_content_push() and when the top item is no longer wanted, simply
18646     * pop it with elm_pager_content_pop() and it will also be deleted. If an
18647     * object is no longer needed and is not the top item, just delete it as
18648     * normal. You can query which objects are the top and bottom with
18649     * elm_pager_content_bottom_get() and elm_pager_content_top_get().
18650     *
18651     * Signals that you can add callbacks for are:
18652     * "hide,finished" - when the previous page is hided
18653     *
18654     * This widget has the following styles available:
18655     * @li default
18656     * @li fade
18657     * @li fade_translucide
18658     * @li fade_invisible
18659     * @note This styles affect only the flipping animations, the appearance when
18660     * not animating is unaffected by styles.
18661     *
18662     * @ref tutorial_pager gives a good overview of the usage of the API.
18663     * @{
18664     */
18665    /**
18666     * Add a new pager to the parent
18667     *
18668     * @param parent The parent object
18669     * @return The new object or NULL if it cannot be created
18670     *
18671     * @ingroup Pager
18672     */
18673    EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18674    /**
18675     * @brief Push an object to the top of the pager stack (and show it).
18676     *
18677     * @param obj The pager object
18678     * @param content The object to push
18679     *
18680     * The object pushed becomes a child of the pager, it will be controlled and
18681     * deleted when the pager is deleted.
18682     *
18683     * @note If the content is already in the stack use
18684     * elm_pager_content_promote().
18685     * @warning Using this function on @p content already in the stack results in
18686     * undefined behavior.
18687     */
18688    EAPI void         elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18689    /**
18690     * @brief Pop the object that is on top of the stack
18691     *
18692     * @param obj The pager object
18693     *
18694     * This pops the object that is on the top(visible) of the pager, makes it
18695     * disappear, then deletes the object. The object that was underneath it on
18696     * the stack will become visible.
18697     */
18698    EAPI void         elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
18699    /**
18700     * @brief Moves an object already in the pager stack to the top of the stack.
18701     *
18702     * @param obj The pager object
18703     * @param content The object to promote
18704     *
18705     * This will take the @p content and move it to the top of the stack as
18706     * if it had been pushed there.
18707     *
18708     * @note If the content isn't already in the stack use
18709     * elm_pager_content_push().
18710     * @warning Using this function on @p content not already in the stack
18711     * results in undefined behavior.
18712     */
18713    EAPI void         elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18714    /**
18715     * @brief Return the object at the bottom of the pager stack
18716     *
18717     * @param obj The pager object
18718     * @return The bottom object or NULL if none
18719     */
18720    EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18721    /**
18722     * @brief  Return the object at the top of the pager stack
18723     *
18724     * @param obj The pager object
18725     * @return The top object or NULL if none
18726     */
18727    EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18728    /**
18729     * @}
18730     */
18731
18732    /**
18733     * @defgroup Slideshow Slideshow
18734     *
18735     * @image html img/widget/slideshow/preview-00.png
18736     * @image latex img/widget/slideshow/preview-00.eps
18737     *
18738     * This widget, as the name indicates, is a pre-made image
18739     * slideshow panel, with API functions acting on (child) image
18740     * items presentation. Between those actions, are:
18741     * - advance to next/previous image
18742     * - select the style of image transition animation
18743     * - set the exhibition time for each image
18744     * - start/stop the slideshow
18745     *
18746     * The transition animations are defined in the widget's theme,
18747     * consequently new animations can be added without having to
18748     * update the widget's code.
18749     *
18750     * @section Slideshow_Items Slideshow items
18751     *
18752     * For slideshow items, just like for @ref Genlist "genlist" ones,
18753     * the user defines a @b classes, specifying functions that will be
18754     * called on the item's creation and deletion times.
18755     *
18756     * The #Elm_Slideshow_Item_Class structure contains the following
18757     * members:
18758     *
18759     * - @c func.get - When an item is displayed, this function is
18760     *   called, and it's where one should create the item object, de
18761     *   facto. For example, the object can be a pure Evas image object
18762     *   or an Elementary @ref Photocam "photocam" widget. See
18763     *   #SlideshowItemGetFunc.
18764     * - @c func.del - When an item is no more displayed, this function
18765     *   is called, where the user must delete any data associated to
18766     *   the item. See #SlideshowItemDelFunc.
18767     *
18768     * @section Slideshow_Caching Slideshow caching
18769     *
18770     * The slideshow provides facilities to have items adjacent to the
18771     * one being displayed <b>already "realized"</b> (i.e. loaded) for
18772     * you, so that the system does not have to decode image data
18773     * anymore at the time it has to actually switch images on its
18774     * viewport. The user is able to set the numbers of items to be
18775     * cached @b before and @b after the current item, in the widget's
18776     * item list.
18777     *
18778     * Smart events one can add callbacks for are:
18779     *
18780     * - @c "changed" - when the slideshow switches its view to a new
18781     *   item
18782     *
18783     * List of examples for the slideshow widget:
18784     * @li @ref slideshow_example
18785     */
18786
18787    /**
18788     * @addtogroup Slideshow
18789     * @{
18790     */
18791
18792    typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
18793    typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
18794    typedef struct _Elm_Slideshow_Item       Elm_Slideshow_Item; /**< Slideshow item handle */
18795    typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
18796    typedef void         (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
18797
18798    /**
18799     * @struct _Elm_Slideshow_Item_Class
18800     *
18801     * Slideshow item class definition. See @ref Slideshow_Items for
18802     * field details.
18803     */
18804    struct _Elm_Slideshow_Item_Class
18805      {
18806         struct _Elm_Slideshow_Item_Class_Func
18807           {
18808              SlideshowItemGetFunc get;
18809              SlideshowItemDelFunc del;
18810           } func;
18811      }; /**< #Elm_Slideshow_Item_Class member definitions */
18812
18813    /**
18814     * Add a new slideshow widget to the given parent Elementary
18815     * (container) object
18816     *
18817     * @param parent The parent object
18818     * @return A new slideshow widget handle or @c NULL, on errors
18819     *
18820     * This function inserts a new slideshow widget on the canvas.
18821     *
18822     * @ingroup Slideshow
18823     */
18824    EAPI Evas_Object        *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18825
18826    /**
18827     * Add (append) a new item in a given slideshow widget.
18828     *
18829     * @param obj The slideshow object
18830     * @param itc The item class for the item
18831     * @param data The item's data
18832     * @return A handle to the item added or @c NULL, on errors
18833     *
18834     * Add a new item to @p obj's internal list of items, appending it.
18835     * The item's class must contain the function really fetching the
18836     * image object to show for this item, which could be an Evas image
18837     * object or an Elementary photo, for example. The @p data
18838     * parameter is going to be passed to both class functions of the
18839     * item.
18840     *
18841     * @see #Elm_Slideshow_Item_Class
18842     * @see elm_slideshow_item_sorted_insert()
18843     *
18844     * @ingroup Slideshow
18845     */
18846    EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
18847
18848    /**
18849     * Insert a new item into the given slideshow widget, using the @p func
18850     * function to sort items (by item handles).
18851     *
18852     * @param obj The slideshow object
18853     * @param itc The item class for the item
18854     * @param data The item's data
18855     * @param func The comparing function to be used to sort slideshow
18856     * items <b>by #Elm_Slideshow_Item item handles</b>
18857     * @return Returns The slideshow item handle, on success, or
18858     * @c NULL, on errors
18859     *
18860     * Add a new item to @p obj's internal list of items, in a position
18861     * determined by the @p func comparing function. The item's class
18862     * must contain the function really fetching the image object to
18863     * show for this item, which could be an Evas image object or an
18864     * Elementary photo, for example. The @p data parameter is going to
18865     * be passed to both class functions of the item.
18866     *
18867     * @see #Elm_Slideshow_Item_Class
18868     * @see elm_slideshow_item_add()
18869     *
18870     * @ingroup Slideshow
18871     */
18872    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);
18873
18874    /**
18875     * Display a given slideshow widget's item, programmatically.
18876     *
18877     * @param obj The slideshow object
18878     * @param item The item to display on @p obj's viewport
18879     *
18880     * The change between the current item and @p item will use the
18881     * transition @p obj is set to use (@see
18882     * elm_slideshow_transition_set()).
18883     *
18884     * @ingroup Slideshow
18885     */
18886    EAPI void                elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18887
18888    /**
18889     * Slide to the @b next item, in a given slideshow widget
18890     *
18891     * @param obj The slideshow object
18892     *
18893     * The sliding animation @p obj is set to use will be the
18894     * transition effect used, after this call is issued.
18895     *
18896     * @note If the end of the slideshow's internal list of items is
18897     * reached, it'll wrap around to the list's beginning, again.
18898     *
18899     * @ingroup Slideshow
18900     */
18901    EAPI void                elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
18902
18903    /**
18904     * Slide to the @b previous item, in a given slideshow widget
18905     *
18906     * @param obj The slideshow object
18907     *
18908     * The sliding animation @p obj is set to use will be the
18909     * transition effect used, after this call is issued.
18910     *
18911     * @note If the beginning of the slideshow's internal list of items
18912     * is reached, it'll wrap around to the list's end, again.
18913     *
18914     * @ingroup Slideshow
18915     */
18916    EAPI void                elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
18917
18918    /**
18919     * Returns the list of sliding transition/effect names available, for a
18920     * given slideshow widget.
18921     *
18922     * @param obj The slideshow object
18923     * @return The list of transitions (list of @b stringshared strings
18924     * as data)
18925     *
18926     * The transitions, which come from @p obj's theme, must be an EDC
18927     * data item named @c "transitions" on the theme file, with (prefix)
18928     * names of EDC programs actually implementing them.
18929     *
18930     * The available transitions for slideshows on the default theme are:
18931     * - @c "fade" - the current item fades out, while the new one
18932     *   fades in to the slideshow's viewport.
18933     * - @c "black_fade" - the current item fades to black, and just
18934     *   then, the new item will fade in.
18935     * - @c "horizontal" - the current item slides horizontally, until
18936     *   it gets out of the slideshow's viewport, while the new item
18937     *   comes from the left to take its place.
18938     * - @c "vertical" - the current item slides vertically, until it
18939     *   gets out of the slideshow's viewport, while the new item comes
18940     *   from the bottom to take its place.
18941     * - @c "square" - the new item starts to appear from the middle of
18942     *   the current one, but with a tiny size, growing until its
18943     *   target (full) size and covering the old one.
18944     *
18945     * @warning The stringshared strings get no new references
18946     * exclusive to the user grabbing the list, here, so if you'd like
18947     * to use them out of this call's context, you'd better @c
18948     * eina_stringshare_ref() them.
18949     *
18950     * @see elm_slideshow_transition_set()
18951     *
18952     * @ingroup Slideshow
18953     */
18954    EAPI const Eina_List    *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18955
18956    /**
18957     * Set the current slide transition/effect in use for a given
18958     * slideshow widget
18959     *
18960     * @param obj The slideshow object
18961     * @param transition The new transition's name string
18962     *
18963     * If @p transition is implemented in @p obj's theme (i.e., is
18964     * contained in the list returned by
18965     * elm_slideshow_transitions_get()), this new sliding effect will
18966     * be used on the widget.
18967     *
18968     * @see elm_slideshow_transitions_get() for more details
18969     *
18970     * @ingroup Slideshow
18971     */
18972    EAPI void                elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
18973
18974    /**
18975     * Get the current slide transition/effect in use for a given
18976     * slideshow widget
18977     *
18978     * @param obj The slideshow object
18979     * @return The current transition's name
18980     *
18981     * @see elm_slideshow_transition_set() for more details
18982     *
18983     * @ingroup Slideshow
18984     */
18985    EAPI const char         *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18986
18987    /**
18988     * Set the interval between each image transition on a given
18989     * slideshow widget, <b>and start the slideshow, itself</b>
18990     *
18991     * @param obj The slideshow object
18992     * @param timeout The new displaying timeout for images
18993     *
18994     * After this call, the slideshow widget will start cycling its
18995     * view, sequentially and automatically, with the images of the
18996     * items it has. The time between each new image displayed is going
18997     * to be @p timeout, in @b seconds. If a different timeout was set
18998     * previously and an slideshow was in progress, it will continue
18999     * with the new time between transitions, after this call.
19000     *
19001     * @note A value less than or equal to 0 on @p timeout will disable
19002     * the widget's internal timer, thus halting any slideshow which
19003     * could be happening on @p obj.
19004     *
19005     * @see elm_slideshow_timeout_get()
19006     *
19007     * @ingroup Slideshow
19008     */
19009    EAPI void                elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
19010
19011    /**
19012     * Get the interval set for image transitions on a given slideshow
19013     * widget.
19014     *
19015     * @param obj The slideshow object
19016     * @return Returns the timeout set on it
19017     *
19018     * @see elm_slideshow_timeout_set() for more details
19019     *
19020     * @ingroup Slideshow
19021     */
19022    EAPI double              elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19023
19024    /**
19025     * Set if, after a slideshow is started, for a given slideshow
19026     * widget, its items should be displayed cyclically or not.
19027     *
19028     * @param obj The slideshow object
19029     * @param loop Use @c EINA_TRUE to make it cycle through items or
19030     * @c EINA_FALSE for it to stop at the end of @p obj's internal
19031     * list of items
19032     *
19033     * @note elm_slideshow_next() and elm_slideshow_previous() will @b
19034     * ignore what is set by this functions, i.e., they'll @b always
19035     * cycle through items. This affects only the "automatic"
19036     * slideshow, as set by elm_slideshow_timeout_set().
19037     *
19038     * @see elm_slideshow_loop_get()
19039     *
19040     * @ingroup Slideshow
19041     */
19042    EAPI void                elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
19043
19044    /**
19045     * Get if, after a slideshow is started, for a given slideshow
19046     * widget, its items are to be displayed cyclically or not.
19047     *
19048     * @param obj The slideshow object
19049     * @return @c EINA_TRUE, if the items in @p obj will be cycled
19050     * through or @c EINA_FALSE, otherwise
19051     *
19052     * @see elm_slideshow_loop_set() for more details
19053     *
19054     * @ingroup Slideshow
19055     */
19056    EAPI Eina_Bool           elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19057
19058    /**
19059     * Remove all items from a given slideshow widget
19060     *
19061     * @param obj The slideshow object
19062     *
19063     * This removes (and deletes) all items in @p obj, leaving it
19064     * empty.
19065     *
19066     * @see elm_slideshow_item_del(), to remove just one item.
19067     *
19068     * @ingroup Slideshow
19069     */
19070    EAPI void                elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
19071
19072    /**
19073     * Get the internal list of items in a given slideshow widget.
19074     *
19075     * @param obj The slideshow object
19076     * @return The list of items (#Elm_Slideshow_Item as data) or
19077     * @c NULL on errors.
19078     *
19079     * This list is @b not to be modified in any way and must not be
19080     * freed. Use the list members with functions like
19081     * elm_slideshow_item_del(), elm_slideshow_item_data_get().
19082     *
19083     * @warning This list is only valid until @p obj object's internal
19084     * items list is changed. It should be fetched again with another
19085     * call to this function when changes happen.
19086     *
19087     * @ingroup Slideshow
19088     */
19089    EAPI const Eina_List    *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19090
19091    /**
19092     * Delete a given item from a slideshow widget.
19093     *
19094     * @param item The slideshow item
19095     *
19096     * @ingroup Slideshow
19097     */
19098    EAPI void                elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
19099
19100    /**
19101     * Return the data associated with a given slideshow item
19102     *
19103     * @param item The slideshow item
19104     * @return Returns the data associated to this item
19105     *
19106     * @ingroup Slideshow
19107     */
19108    EAPI void               *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
19109
19110    /**
19111     * Returns the currently displayed item, in a given slideshow widget
19112     *
19113     * @param obj The slideshow object
19114     * @return A handle to the item being displayed in @p obj or
19115     * @c NULL, if none is (and on errors)
19116     *
19117     * @ingroup Slideshow
19118     */
19119    EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19120
19121    /**
19122     * Get the real Evas object created to implement the view of a
19123     * given slideshow item
19124     *
19125     * @param item The slideshow item.
19126     * @return the Evas object implementing this item's view.
19127     *
19128     * This returns the actual Evas object used to implement the
19129     * specified slideshow item's view. This may be @c NULL, as it may
19130     * not have been created or may have been deleted, at any time, by
19131     * the slideshow. <b>Do not modify this object</b> (move, resize,
19132     * show, hide, etc.), as the slideshow is controlling it. This
19133     * function is for querying, emitting custom signals or hooking
19134     * lower level callbacks for events on that object. Do not delete
19135     * this object under any circumstances.
19136     *
19137     * @see elm_slideshow_item_data_get()
19138     *
19139     * @ingroup Slideshow
19140     */
19141    EAPI Evas_Object*        elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
19142
19143    /**
19144     * Get the the item, in a given slideshow widget, placed at
19145     * position @p nth, in its internal items list
19146     *
19147     * @param obj The slideshow object
19148     * @param nth The number of the item to grab a handle to (0 being
19149     * the first)
19150     * @return The item stored in @p obj at position @p nth or @c NULL,
19151     * if there's no item with that index (and on errors)
19152     *
19153     * @ingroup Slideshow
19154     */
19155    EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
19156
19157    /**
19158     * Set the current slide layout in use for a given slideshow widget
19159     *
19160     * @param obj The slideshow object
19161     * @param layout The new layout's name string
19162     *
19163     * If @p layout is implemented in @p obj's theme (i.e., is contained
19164     * in the list returned by elm_slideshow_layouts_get()), this new
19165     * images layout will be used on the widget.
19166     *
19167     * @see elm_slideshow_layouts_get() for more details
19168     *
19169     * @ingroup Slideshow
19170     */
19171    EAPI void                elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
19172
19173    /**
19174     * Get the current slide layout in use for a given slideshow widget
19175     *
19176     * @param obj The slideshow object
19177     * @return The current layout's name
19178     *
19179     * @see elm_slideshow_layout_set() for more details
19180     *
19181     * @ingroup Slideshow
19182     */
19183    EAPI const char         *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19184
19185    /**
19186     * Returns the list of @b layout names available, for a given
19187     * slideshow widget.
19188     *
19189     * @param obj The slideshow object
19190     * @return The list of layouts (list of @b stringshared strings
19191     * as data)
19192     *
19193     * Slideshow layouts will change how the widget is to dispose each
19194     * image item in its viewport, with regard to cropping, scaling,
19195     * etc.
19196     *
19197     * The layouts, which come from @p obj's theme, must be an EDC
19198     * data item name @c "layouts" on the theme file, with (prefix)
19199     * names of EDC programs actually implementing them.
19200     *
19201     * The available layouts for slideshows on the default theme are:
19202     * - @c "fullscreen" - item images with original aspect, scaled to
19203     *   touch top and down slideshow borders or, if the image's heigh
19204     *   is not enough, left and right slideshow borders.
19205     * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
19206     *   one, but always leaving 10% of the slideshow's dimensions of
19207     *   distance between the item image's borders and the slideshow
19208     *   borders, for each axis.
19209     *
19210     * @warning The stringshared strings get no new references
19211     * exclusive to the user grabbing the list, here, so if you'd like
19212     * to use them out of this call's context, you'd better @c
19213     * eina_stringshare_ref() them.
19214     *
19215     * @see elm_slideshow_layout_set()
19216     *
19217     * @ingroup Slideshow
19218     */
19219    EAPI const Eina_List    *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19220
19221    /**
19222     * Set the number of items to cache, on a given slideshow widget,
19223     * <b>before the current item</b>
19224     *
19225     * @param obj The slideshow object
19226     * @param count Number of items to cache before the current one
19227     *
19228     * The default value for this property is @c 2. See
19229     * @ref Slideshow_Caching "slideshow caching" for more details.
19230     *
19231     * @see elm_slideshow_cache_before_get()
19232     *
19233     * @ingroup Slideshow
19234     */
19235    EAPI void                elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
19236
19237    /**
19238     * Retrieve the number of items to cache, on a given slideshow widget,
19239     * <b>before the current item</b>
19240     *
19241     * @param obj The slideshow object
19242     * @return The number of items set to be cached before the current one
19243     *
19244     * @see elm_slideshow_cache_before_set() for more details
19245     *
19246     * @ingroup Slideshow
19247     */
19248    EAPI int                 elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19249
19250    /**
19251     * Set the number of items to cache, on a given slideshow widget,
19252     * <b>after the current item</b>
19253     *
19254     * @param obj The slideshow object
19255     * @param count Number of items to cache after the current one
19256     *
19257     * The default value for this property is @c 2. See
19258     * @ref Slideshow_Caching "slideshow caching" for more details.
19259     *
19260     * @see elm_slideshow_cache_after_get()
19261     *
19262     * @ingroup Slideshow
19263     */
19264    EAPI void                elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
19265
19266    /**
19267     * Retrieve the number of items to cache, on a given slideshow widget,
19268     * <b>after the current item</b>
19269     *
19270     * @param obj The slideshow object
19271     * @return The number of items set to be cached after the current one
19272     *
19273     * @see elm_slideshow_cache_after_set() for more details
19274     *
19275     * @ingroup Slideshow
19276     */
19277    EAPI int                 elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19278
19279    /**
19280     * Get the number of items stored in a given slideshow widget
19281     *
19282     * @param obj The slideshow object
19283     * @return The number of items on @p obj, at the moment of this call
19284     *
19285     * @ingroup Slideshow
19286     */
19287    EAPI unsigned int        elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19288
19289    /**
19290     * @}
19291     */
19292
19293    /**
19294     * @defgroup Fileselector File Selector
19295     *
19296     * @image html img/widget/fileselector/preview-00.png
19297     * @image latex img/widget/fileselector/preview-00.eps
19298     *
19299     * A file selector is a widget that allows a user to navigate
19300     * through a file system, reporting file selections back via its
19301     * API.
19302     *
19303     * It contains shortcut buttons for home directory (@c ~) and to
19304     * jump one directory upwards (..), as well as cancel/ok buttons to
19305     * confirm/cancel a given selection. After either one of those two
19306     * former actions, the file selector will issue its @c "done" smart
19307     * callback.
19308     *
19309     * There's a text entry on it, too, showing the name of the current
19310     * selection. There's the possibility of making it editable, so it
19311     * is useful on file saving dialogs on applications, where one
19312     * gives a file name to save contents to, in a given directory in
19313     * the system. This custom file name will be reported on the @c
19314     * "done" smart callback (explained in sequence).
19315     *
19316     * Finally, it has a view to display file system items into in two
19317     * possible forms:
19318     * - list
19319     * - grid
19320     *
19321     * If Elementary is built with support of the Ethumb thumbnailing
19322     * library, the second form of view will display preview thumbnails
19323     * of files which it supports.
19324     *
19325     * Smart callbacks one can register to:
19326     *
19327     * - @c "selected" - the user has clicked on a file (when not in
19328     *      folders-only mode) or directory (when in folders-only mode)
19329     * - @c "directory,open" - the list has been populated with new
19330     *      content (@c event_info is a pointer to the directory's
19331     *      path, a @b stringshared string)
19332     * - @c "done" - the user has clicked on the "ok" or "cancel"
19333     *      buttons (@c event_info is a pointer to the selection's
19334     *      path, a @b stringshared string)
19335     *
19336     * Here is an example on its usage:
19337     * @li @ref fileselector_example
19338     */
19339
19340    /**
19341     * @addtogroup Fileselector
19342     * @{
19343     */
19344
19345    /**
19346     * Defines how a file selector widget is to layout its contents
19347     * (file system entries).
19348     */
19349    typedef enum _Elm_Fileselector_Mode
19350      {
19351         ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
19352         ELM_FILESELECTOR_GRID, /**< layout as a grid */
19353         ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
19354      } Elm_Fileselector_Mode;
19355
19356    /**
19357     * Add a new file selector widget to the given parent Elementary
19358     * (container) object
19359     *
19360     * @param parent The parent object
19361     * @return a new file selector widget handle or @c NULL, on errors
19362     *
19363     * This function inserts a new file selector widget on the canvas.
19364     *
19365     * @ingroup Fileselector
19366     */
19367    EAPI Evas_Object          *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19368
19369    /**
19370     * Enable/disable the file name entry box where the user can type
19371     * in a name for a file, in a given file selector widget
19372     *
19373     * @param obj The file selector object
19374     * @param is_save @c EINA_TRUE to make the file selector a "saving
19375     * dialog", @c EINA_FALSE otherwise
19376     *
19377     * Having the entry editable is useful on file saving dialogs on
19378     * applications, where one gives a file name to save contents to,
19379     * in a given directory in the system. This custom file name will
19380     * be reported on the @c "done" smart callback.
19381     *
19382     * @see elm_fileselector_is_save_get()
19383     *
19384     * @ingroup Fileselector
19385     */
19386    EAPI void                  elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
19387
19388    /**
19389     * Get whether the given file selector is in "saving dialog" mode
19390     *
19391     * @param obj The file selector object
19392     * @return @c EINA_TRUE, if the file selector is in "saving dialog"
19393     * mode, @c EINA_FALSE otherwise (and on errors)
19394     *
19395     * @see elm_fileselector_is_save_set() for more details
19396     *
19397     * @ingroup Fileselector
19398     */
19399    EAPI Eina_Bool             elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19400
19401    /**
19402     * Enable/disable folder-only view for a given file selector widget
19403     *
19404     * @param obj The file selector object
19405     * @param only @c EINA_TRUE to make @p obj only display
19406     * directories, @c EINA_FALSE to make files to be displayed in it
19407     * too
19408     *
19409     * If enabled, the widget's view will only display folder items,
19410     * naturally.
19411     *
19412     * @see elm_fileselector_folder_only_get()
19413     *
19414     * @ingroup Fileselector
19415     */
19416    EAPI void                  elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
19417
19418    /**
19419     * Get whether folder-only view is set for a given file selector
19420     * widget
19421     *
19422     * @param obj The file selector object
19423     * @return only @c EINA_TRUE if @p obj is only displaying
19424     * directories, @c EINA_FALSE if files are being displayed in it
19425     * too (and on errors)
19426     *
19427     * @see elm_fileselector_folder_only_get()
19428     *
19429     * @ingroup Fileselector
19430     */
19431    EAPI Eina_Bool             elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19432
19433    /**
19434     * Enable/disable the "ok" and "cancel" buttons on a given file
19435     * selector widget
19436     *
19437     * @param obj The file selector object
19438     * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
19439     *
19440     * @note A file selector without those buttons will never emit the
19441     * @c "done" smart event, and is only usable if one is just hooking
19442     * to the other two events.
19443     *
19444     * @see elm_fileselector_buttons_ok_cancel_get()
19445     *
19446     * @ingroup Fileselector
19447     */
19448    EAPI void                  elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
19449
19450    /**
19451     * Get whether the "ok" and "cancel" buttons on a given file
19452     * selector widget are being shown.
19453     *
19454     * @param obj The file selector object
19455     * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
19456     * otherwise (and on errors)
19457     *
19458     * @see elm_fileselector_buttons_ok_cancel_set() for more details
19459     *
19460     * @ingroup Fileselector
19461     */
19462    EAPI Eina_Bool             elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19463
19464    /**
19465     * Enable/disable a tree view in the given file selector widget,
19466     * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
19467     *
19468     * @param obj The file selector object
19469     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
19470     * disable
19471     *
19472     * In a tree view, arrows are created on the sides of directories,
19473     * allowing them to expand in place.
19474     *
19475     * @note If it's in other mode, the changes made by this function
19476     * will only be visible when one switches back to "list" mode.
19477     *
19478     * @see elm_fileselector_expandable_get()
19479     *
19480     * @ingroup Fileselector
19481     */
19482    EAPI void                  elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
19483
19484    /**
19485     * Get whether tree view is enabled for the given file selector
19486     * widget
19487     *
19488     * @param obj The file selector object
19489     * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
19490     * otherwise (and or errors)
19491     *
19492     * @see elm_fileselector_expandable_set() for more details
19493     *
19494     * @ingroup Fileselector
19495     */
19496    EAPI Eina_Bool             elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19497
19498    /**
19499     * Set, programmatically, the @b directory that a given file
19500     * selector widget will display contents from
19501     *
19502     * @param obj The file selector object
19503     * @param path The path to display in @p obj
19504     *
19505     * This will change the @b directory that @p obj is displaying. It
19506     * will also clear the text entry area on the @p obj object, which
19507     * displays select files' names.
19508     *
19509     * @see elm_fileselector_path_get()
19510     *
19511     * @ingroup Fileselector
19512     */
19513    EAPI void                  elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
19514
19515    /**
19516     * Get the parent directory's path that a given file selector
19517     * widget is displaying
19518     *
19519     * @param obj The file selector object
19520     * @return The (full) path of the directory the file selector is
19521     * displaying, a @b stringshared string
19522     *
19523     * @see elm_fileselector_path_set()
19524     *
19525     * @ingroup Fileselector
19526     */
19527    EAPI const char           *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19528
19529    /**
19530     * Set, programmatically, the currently selected file/directory in
19531     * the given file selector widget
19532     *
19533     * @param obj The file selector object
19534     * @param path The (full) path to a file or directory
19535     * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
19536     * latter case occurs if the directory or file pointed to do not
19537     * exist.
19538     *
19539     * @see elm_fileselector_selected_get()
19540     *
19541     * @ingroup Fileselector
19542     */
19543    EAPI Eina_Bool             elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
19544
19545    /**
19546     * Get the currently selected item's (full) path, in the given file
19547     * selector widget
19548     *
19549     * @param obj The file selector object
19550     * @return The absolute path of the selected item, a @b
19551     * stringshared string
19552     *
19553     * @note Custom editions on @p obj object's text entry, if made,
19554     * will appear on the return string of this function, naturally.
19555     *
19556     * @see elm_fileselector_selected_set() for more details
19557     *
19558     * @ingroup Fileselector
19559     */
19560    EAPI const char           *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19561
19562    /**
19563     * Set the mode in which a given file selector widget will display
19564     * (layout) file system entries in its view
19565     *
19566     * @param obj The file selector object
19567     * @param mode The mode of the fileselector, being it one of
19568     * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
19569     * first one, naturally, will display the files in a list. The
19570     * latter will make the widget to display its entries in a grid
19571     * form.
19572     *
19573     * @note By using elm_fileselector_expandable_set(), the user may
19574     * trigger a tree view for that list.
19575     *
19576     * @note If Elementary is built with support of the Ethumb
19577     * thumbnailing library, the second form of view will display
19578     * preview thumbnails of files which it supports. You must have
19579     * elm_need_ethumb() called in your Elementary for thumbnailing to
19580     * work, though.
19581     *
19582     * @see elm_fileselector_expandable_set().
19583     * @see elm_fileselector_mode_get().
19584     *
19585     * @ingroup Fileselector
19586     */
19587    EAPI void                  elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
19588
19589    /**
19590     * Get the mode in which a given file selector widget is displaying
19591     * (layouting) file system entries in its view
19592     *
19593     * @param obj The fileselector object
19594     * @return The mode in which the fileselector is at
19595     *
19596     * @see elm_fileselector_mode_set() for more details
19597     *
19598     * @ingroup Fileselector
19599     */
19600    EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19601
19602    /**
19603     * @}
19604     */
19605
19606    /**
19607     * @defgroup Progressbar Progress bar
19608     *
19609     * The progress bar is a widget for visually representing the
19610     * progress status of a given job/task.
19611     *
19612     * A progress bar may be horizontal or vertical. It may display an
19613     * icon besides it, as well as primary and @b units labels. The
19614     * former is meant to label the widget as a whole, while the
19615     * latter, which is formatted with floating point values (and thus
19616     * accepts a <c>printf</c>-style format string, like <c>"%1.2f
19617     * units"</c>), is meant to label the widget's <b>progress
19618     * value</b>. Label, icon and unit strings/objects are @b optional
19619     * for progress bars.
19620     *
19621     * A progress bar may be @b inverted, in which state it gets its
19622     * values inverted, with high values being on the left or top and
19623     * low values on the right or bottom, as opposed to normally have
19624     * the low values on the former and high values on the latter,
19625     * respectively, for horizontal and vertical modes.
19626     *
19627     * The @b span of the progress, as set by
19628     * elm_progressbar_span_size_set(), is its length (horizontally or
19629     * vertically), unless one puts size hints on the widget to expand
19630     * on desired directions, by any container. That length will be
19631     * scaled by the object or applications scaling factor. At any
19632     * point code can query the progress bar for its value with
19633     * elm_progressbar_value_get().
19634     *
19635     * Available widget styles for progress bars:
19636     * - @c "default"
19637     * - @c "wheel" (simple style, no text, no progression, only
19638     *      "pulse" effect is available)
19639     *
19640     * Here is an example on its usage:
19641     * @li @ref progressbar_example
19642     */
19643
19644    /**
19645     * Add a new progress bar widget to the given parent Elementary
19646     * (container) object
19647     *
19648     * @param parent The parent object
19649     * @return a new progress bar widget handle or @c NULL, on errors
19650     *
19651     * This function inserts a new progress bar widget on the canvas.
19652     *
19653     * @ingroup Progressbar
19654     */
19655    EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19656
19657    /**
19658     * Set whether a given progress bar widget is at "pulsing mode" or
19659     * not.
19660     *
19661     * @param obj The progress bar object
19662     * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
19663     * @c EINA_FALSE to put it back to its default one
19664     *
19665     * By default, progress bars will display values from the low to
19666     * high value boundaries. There are, though, contexts in which the
19667     * state of progression of a given task is @b unknown.  For those,
19668     * one can set a progress bar widget to a "pulsing state", to give
19669     * the user an idea that some computation is being held, but
19670     * without exact progress values. In the default theme it will
19671     * animate its bar with the contents filling in constantly and back
19672     * to non-filled, in a loop. To start and stop this pulsing
19673     * animation, one has to explicitly call elm_progressbar_pulse().
19674     *
19675     * @see elm_progressbar_pulse_get()
19676     * @see elm_progressbar_pulse()
19677     *
19678     * @ingroup Progressbar
19679     */
19680    EAPI void         elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
19681
19682    /**
19683     * Get whether a given progress bar widget is at "pulsing mode" or
19684     * not.
19685     *
19686     * @param obj The progress bar object
19687     * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
19688     * if it's in the default one (and on errors)
19689     *
19690     * @ingroup Progressbar
19691     */
19692    EAPI Eina_Bool    elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19693
19694    /**
19695     * Start/stop a given progress bar "pulsing" animation, if its
19696     * under that mode
19697     *
19698     * @param obj The progress bar object
19699     * @param state @c EINA_TRUE, to @b start the pulsing animation,
19700     * @c EINA_FALSE to @b stop it
19701     *
19702     * @note This call won't do anything if @p obj is not under "pulsing mode".
19703     *
19704     * @see elm_progressbar_pulse_set() for more details.
19705     *
19706     * @ingroup Progressbar
19707     */
19708    EAPI void         elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19709
19710    /**
19711     * Set the progress value (in percentage) on a given progress bar
19712     * widget
19713     *
19714     * @param obj The progress bar object
19715     * @param val The progress value (@b must be between @c 0.0 and @c
19716     * 1.0)
19717     *
19718     * Use this call to set progress bar levels.
19719     *
19720     * @note If you passes a value out of the specified range for @p
19721     * val, it will be interpreted as the @b closest of the @b boundary
19722     * values in the range.
19723     *
19724     * @ingroup Progressbar
19725     */
19726    EAPI void         elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
19727
19728    /**
19729     * Get the progress value (in percentage) on a given progress bar
19730     * widget
19731     *
19732     * @param obj The progress bar object
19733     * @return The value of the progressbar
19734     *
19735     * @see elm_progressbar_value_set() for more details
19736     *
19737     * @ingroup Progressbar
19738     */
19739    EAPI double       elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19740
19741    /**
19742     * Set the label of a given progress bar widget
19743     *
19744     * @param obj The progress bar object
19745     * @param label The text label string, in UTF-8
19746     *
19747     * @ingroup Progressbar
19748     * @deprecated use elm_object_text_set() instead.
19749     */
19750    EINA_DEPRECATED EAPI void         elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19751
19752    /**
19753     * Get the label of a given progress bar widget
19754     *
19755     * @param obj The progressbar object
19756     * @return The text label string, in UTF-8
19757     *
19758     * @ingroup Progressbar
19759     * @deprecated use elm_object_text_set() instead.
19760     */
19761    EINA_DEPRECATED EAPI const char  *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19762
19763    /**
19764     * Set the icon object of a given progress bar widget
19765     *
19766     * @param obj The progress bar object
19767     * @param icon The icon object
19768     *
19769     * Use this call to decorate @p obj with an icon next to it.
19770     *
19771     * @note Once the icon object is set, a previously set one will be
19772     * deleted. If you want to keep that old content object, use the
19773     * elm_progressbar_icon_unset() function.
19774     *
19775     * @see elm_progressbar_icon_get()
19776     *
19777     * @ingroup Progressbar
19778     */
19779    EAPI void         elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19780
19781    /**
19782     * Retrieve the icon object set for a given progress bar widget
19783     *
19784     * @param obj The progress bar object
19785     * @return The icon object's handle, if @p obj had one set, or @c NULL,
19786     * otherwise (and on errors)
19787     *
19788     * @see elm_progressbar_icon_set() for more details
19789     *
19790     * @ingroup Progressbar
19791     */
19792    EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19793
19794    /**
19795     * Unset an icon set on a given progress bar widget
19796     *
19797     * @param obj The progress bar object
19798     * @return The icon object that was being used, if any was set, or
19799     * @c NULL, otherwise (and on errors)
19800     *
19801     * This call will unparent and return the icon object which was set
19802     * for this widget, previously, on success.
19803     *
19804     * @see elm_progressbar_icon_set() for more details
19805     *
19806     * @ingroup Progressbar
19807     */
19808    EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19809
19810    /**
19811     * Set the (exact) length of the bar region of a given progress bar
19812     * widget
19813     *
19814     * @param obj The progress bar object
19815     * @param size The length of the progress bar's bar region
19816     *
19817     * This sets the minimum width (when in horizontal mode) or height
19818     * (when in vertical mode) of the actual bar area of the progress
19819     * bar @p obj. This in turn affects the object's minimum size. Use
19820     * this when you're not setting other size hints expanding on the
19821     * given direction (like weight and alignment hints) and you would
19822     * like it to have a specific size.
19823     *
19824     * @note Icon, label and unit text around @p obj will require their
19825     * own space, which will make @p obj to require more the @p size,
19826     * actually.
19827     *
19828     * @see elm_progressbar_span_size_get()
19829     *
19830     * @ingroup Progressbar
19831     */
19832    EAPI void         elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
19833
19834    /**
19835     * Get the length set for the bar region of a given progress bar
19836     * widget
19837     *
19838     * @param obj The progress bar object
19839     * @return The length of the progress bar's bar region
19840     *
19841     * If that size was not set previously, with
19842     * elm_progressbar_span_size_set(), this call will return @c 0.
19843     *
19844     * @ingroup Progressbar
19845     */
19846    EAPI Evas_Coord   elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19847
19848    /**
19849     * Set the format string for a given progress bar widget's units
19850     * label
19851     *
19852     * @param obj The progress bar object
19853     * @param format The format string for @p obj's units label
19854     *
19855     * If @c NULL is passed on @p format, it will make @p obj's units
19856     * area to be hidden completely. If not, it'll set the <b>format
19857     * string</b> for the units label's @b text. The units label is
19858     * provided a floating point value, so the units text is up display
19859     * at most one floating point falue. Note that the units label is
19860     * optional. Use a format string such as "%1.2f meters" for
19861     * example.
19862     *
19863     * @note The default format string for a progress bar is an integer
19864     * percentage, as in @c "%.0f %%".
19865     *
19866     * @see elm_progressbar_unit_format_get()
19867     *
19868     * @ingroup Progressbar
19869     */
19870    EAPI void         elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
19871
19872    /**
19873     * Retrieve the format string set for a given progress bar widget's
19874     * units label
19875     *
19876     * @param obj The progress bar object
19877     * @return The format set string for @p obj's units label or
19878     * @c NULL, if none was set (and on errors)
19879     *
19880     * @see elm_progressbar_unit_format_set() for more details
19881     *
19882     * @ingroup Progressbar
19883     */
19884    EAPI const char  *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19885
19886    /**
19887     * Set the orientation of a given progress bar widget
19888     *
19889     * @param obj The progress bar object
19890     * @param horizontal Use @c EINA_TRUE to make @p obj to be
19891     * @b horizontal, @c EINA_FALSE to make it @b vertical
19892     *
19893     * Use this function to change how your progress bar is to be
19894     * disposed: vertically or horizontally.
19895     *
19896     * @see elm_progressbar_horizontal_get()
19897     *
19898     * @ingroup Progressbar
19899     */
19900    EAPI void         elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
19901
19902    /**
19903     * Retrieve the orientation of a given progress bar widget
19904     *
19905     * @param obj The progress bar object
19906     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
19907     * @c EINA_FALSE if it's @b vertical (and on errors)
19908     *
19909     * @see elm_progressbar_horizontal_set() for more details
19910     *
19911     * @ingroup Progressbar
19912     */
19913    EAPI Eina_Bool    elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19914
19915    /**
19916     * Invert a given progress bar widget's displaying values order
19917     *
19918     * @param obj The progress bar object
19919     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
19920     * @c EINA_FALSE to bring it back to default, non-inverted values.
19921     *
19922     * A progress bar may be @b inverted, in which state it gets its
19923     * values inverted, with high values being on the left or top and
19924     * low values on the right or bottom, as opposed to normally have
19925     * the low values on the former and high values on the latter,
19926     * respectively, for horizontal and vertical modes.
19927     *
19928     * @see elm_progressbar_inverted_get()
19929     *
19930     * @ingroup Progressbar
19931     */
19932    EAPI void         elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
19933
19934    /**
19935     * Get whether a given progress bar widget's displaying values are
19936     * inverted or not
19937     *
19938     * @param obj The progress bar object
19939     * @return @c EINA_TRUE, if @p obj has inverted values,
19940     * @c EINA_FALSE otherwise (and on errors)
19941     *
19942     * @see elm_progressbar_inverted_set() for more details
19943     *
19944     * @ingroup Progressbar
19945     */
19946    EAPI Eina_Bool    elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19947
19948    /**
19949     * @defgroup Separator Separator
19950     *
19951     * @brief Separator is a very thin object used to separate other objects.
19952     *
19953     * A separator can be vertical or horizontal.
19954     *
19955     * @ref tutorial_separator is a good example of how to use a separator.
19956     * @{
19957     */
19958    /**
19959     * @brief Add a separator object to @p parent
19960     *
19961     * @param parent The parent object
19962     *
19963     * @return The separator object, or NULL upon failure
19964     */
19965    EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19966    /**
19967     * @brief Set the horizontal mode of a separator object
19968     *
19969     * @param obj The separator object
19970     * @param horizontal If true, the separator is horizontal
19971     */
19972    EAPI void         elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
19973    /**
19974     * @brief Get the horizontal mode of a separator object
19975     *
19976     * @param obj The separator object
19977     * @return If true, the separator is horizontal
19978     *
19979     * @see elm_separator_horizontal_set()
19980     */
19981    EAPI Eina_Bool    elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19982    /**
19983     * @}
19984     */
19985
19986    /**
19987     * @defgroup Spinner Spinner
19988     * @ingroup Elementary
19989     *
19990     * @image html img/widget/spinner/preview-00.png
19991     * @image latex img/widget/spinner/preview-00.eps
19992     *
19993     * A spinner is a widget which allows the user to increase or decrease
19994     * numeric values using arrow buttons, or edit values directly, clicking
19995     * over it and typing the new value.
19996     *
19997     * By default the spinner will not wrap and has a label
19998     * of "%.0f" (just showing the integer value of the double).
19999     *
20000     * A spinner has a label that is formatted with floating
20001     * point values and thus accepts a printf-style format string, like
20002     * “%1.2f units”.
20003     *
20004     * It also allows specific values to be replaced by pre-defined labels.
20005     *
20006     * Smart callbacks one can register to:
20007     *
20008     * - "changed" - Whenever the spinner value is changed.
20009     * - "delay,changed" - A short time after the value is changed by the user.
20010     *    This will be called only when the user stops dragging for a very short
20011     *    period or when they release their finger/mouse, so it avoids possibly
20012     *    expensive reactions to the value change.
20013     *
20014     * Available styles for it:
20015     * - @c "default";
20016     * - @c "vertical": up/down buttons at the right side and text left aligned.
20017     *
20018     * Here is an example on its usage:
20019     * @ref spinner_example
20020     */
20021
20022    /**
20023     * @addtogroup Spinner
20024     * @{
20025     */
20026
20027    /**
20028     * Add a new spinner widget to the given parent Elementary
20029     * (container) object.
20030     *
20031     * @param parent The parent object.
20032     * @return a new spinner widget handle or @c NULL, on errors.
20033     *
20034     * This function inserts a new spinner widget on the canvas.
20035     *
20036     * @ingroup Spinner
20037     *
20038     */
20039    EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20040
20041    /**
20042     * Set the format string of the displayed label.
20043     *
20044     * @param obj The spinner object.
20045     * @param fmt The format string for the label display.
20046     *
20047     * If @c NULL, this sets the format to "%.0f". If not it sets the format
20048     * string for the label text. The label text is provided a floating point
20049     * value, so the label text can display up to 1 floating point value.
20050     * Note that this is optional.
20051     *
20052     * Use a format string such as "%1.2f meters" for example, and it will
20053     * display values like: "3.14 meters" for a value equal to 3.14159.
20054     *
20055     * Default is "%0.f".
20056     *
20057     * @see elm_spinner_label_format_get()
20058     *
20059     * @ingroup Spinner
20060     */
20061    EAPI void         elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
20062
20063    /**
20064     * Get the label format of the spinner.
20065     *
20066     * @param obj The spinner object.
20067     * @return The text label format string in UTF-8.
20068     *
20069     * @see elm_spinner_label_format_set() for details.
20070     *
20071     * @ingroup Spinner
20072     */
20073    EAPI const char  *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20074
20075    /**
20076     * Set the minimum and maximum values for the spinner.
20077     *
20078     * @param obj The spinner object.
20079     * @param min The minimum value.
20080     * @param max The maximum value.
20081     *
20082     * Define the allowed range of values to be selected by the user.
20083     *
20084     * If actual value is less than @p min, it will be updated to @p min. If it
20085     * is bigger then @p max, will be updated to @p max. Actual value can be
20086     * get with elm_spinner_value_get().
20087     *
20088     * By default, min is equal to 0, and max is equal to 100.
20089     *
20090     * @warning Maximum must be greater than minimum.
20091     *
20092     * @see elm_spinner_min_max_get()
20093     *
20094     * @ingroup Spinner
20095     */
20096    EAPI void         elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
20097
20098    /**
20099     * Get the minimum and maximum values of the spinner.
20100     *
20101     * @param obj The spinner object.
20102     * @param min Pointer where to store the minimum value.
20103     * @param max Pointer where to store the maximum value.
20104     *
20105     * @note If only one value is needed, the other pointer can be passed
20106     * as @c NULL.
20107     *
20108     * @see elm_spinner_min_max_set() for details.
20109     *
20110     * @ingroup Spinner
20111     */
20112    EAPI void         elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
20113
20114    /**
20115     * Set the step used to increment or decrement the spinner value.
20116     *
20117     * @param obj The spinner object.
20118     * @param step The step value.
20119     *
20120     * This value will be incremented or decremented to the displayed value.
20121     * It will be incremented while the user keep right or top arrow pressed,
20122     * and will be decremented while the user keep left or bottom arrow pressed.
20123     *
20124     * The interval to increment / decrement can be set with
20125     * elm_spinner_interval_set().
20126     *
20127     * By default step value is equal to 1.
20128     *
20129     * @see elm_spinner_step_get()
20130     *
20131     * @ingroup Spinner
20132     */
20133    EAPI void         elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
20134
20135    /**
20136     * Get the step used to increment or decrement the spinner value.
20137     *
20138     * @param obj The spinner object.
20139     * @return The step value.
20140     *
20141     * @see elm_spinner_step_get() for more details.
20142     *
20143     * @ingroup Spinner
20144     */
20145    EAPI double       elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20146
20147    /**
20148     * Set the value the spinner displays.
20149     *
20150     * @param obj The spinner object.
20151     * @param val The value to be displayed.
20152     *
20153     * Value will be presented on the label following format specified with
20154     * elm_spinner_format_set().
20155     *
20156     * @warning The value must to be between min and max values. This values
20157     * are set by elm_spinner_min_max_set().
20158     *
20159     * @see elm_spinner_value_get().
20160     * @see elm_spinner_format_set().
20161     * @see elm_spinner_min_max_set().
20162     *
20163     * @ingroup Spinner
20164     */
20165    EAPI void         elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
20166
20167    /**
20168     * Get the value displayed by the spinner.
20169     *
20170     * @param obj The spinner object.
20171     * @return The value displayed.
20172     *
20173     * @see elm_spinner_value_set() for details.
20174     *
20175     * @ingroup Spinner
20176     */
20177    EAPI double       elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20178
20179    /**
20180     * Set whether the spinner should wrap when it reaches its
20181     * minimum or maximum value.
20182     *
20183     * @param obj The spinner object.
20184     * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
20185     * disable it.
20186     *
20187     * Disabled by default. If disabled, when the user tries to increment the
20188     * value,
20189     * but displayed value plus step value is bigger than maximum value,
20190     * the spinner
20191     * won't allow it. The same happens when the user tries to decrement it,
20192     * but the value less step is less than minimum value.
20193     *
20194     * When wrap is enabled, in such situations it will allow these changes,
20195     * but will get the value that would be less than minimum and subtracts
20196     * from maximum. Or add the value that would be more than maximum to
20197     * the minimum.
20198     *
20199     * E.g.:
20200     * @li min value = 10
20201     * @li max value = 50
20202     * @li step value = 20
20203     * @li displayed value = 20
20204     *
20205     * When the user decrement value (using left or bottom arrow), it will
20206     * displays @c 40, because max - (min - (displayed - step)) is
20207     * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
20208     *
20209     * @see elm_spinner_wrap_get().
20210     *
20211     * @ingroup Spinner
20212     */
20213    EAPI void         elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
20214
20215    /**
20216     * Get whether the spinner should wrap when it reaches its
20217     * minimum or maximum value.
20218     *
20219     * @param obj The spinner object
20220     * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
20221     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20222     *
20223     * @see elm_spinner_wrap_set() for details.
20224     *
20225     * @ingroup Spinner
20226     */
20227    EAPI Eina_Bool    elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20228
20229    /**
20230     * Set whether the spinner can be directly edited by the user or not.
20231     *
20232     * @param obj The spinner object.
20233     * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
20234     * don't allow users to edit it directly.
20235     *
20236     * Spinner objects can have edition @b disabled, in which state they will
20237     * be changed only by arrows.
20238     * Useful for contexts
20239     * where you don't want your users to interact with it writting the value.
20240     * Specially
20241     * when using special values, the user can see real value instead
20242     * of special label on edition.
20243     *
20244     * It's enabled by default.
20245     *
20246     * @see elm_spinner_editable_get()
20247     *
20248     * @ingroup Spinner
20249     */
20250    EAPI void         elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
20251
20252    /**
20253     * Get whether the spinner can be directly edited by the user or not.
20254     *
20255     * @param obj The spinner object.
20256     * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
20257     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20258     *
20259     * @see elm_spinner_editable_set() for details.
20260     *
20261     * @ingroup Spinner
20262     */
20263    EAPI Eina_Bool    elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20264
20265    /**
20266     * Set a special string to display in the place of the numerical value.
20267     *
20268     * @param obj The spinner object.
20269     * @param value The value to be replaced.
20270     * @param label The label to be used.
20271     *
20272     * It's useful for cases when a user should select an item that is
20273     * better indicated by a label than a value. For example, weekdays or months.
20274     *
20275     * E.g.:
20276     * @code
20277     * sp = elm_spinner_add(win);
20278     * elm_spinner_min_max_set(sp, 1, 3);
20279     * elm_spinner_special_value_add(sp, 1, "January");
20280     * elm_spinner_special_value_add(sp, 2, "February");
20281     * elm_spinner_special_value_add(sp, 3, "March");
20282     * evas_object_show(sp);
20283     * @endcode
20284     *
20285     * @ingroup Spinner
20286     */
20287    EAPI void         elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
20288
20289    /**
20290     * Set the interval on time updates for an user mouse button hold
20291     * on spinner widgets' arrows.
20292     *
20293     * @param obj The spinner object.
20294     * @param interval The (first) interval value in seconds.
20295     *
20296     * This interval value is @b decreased while the user holds the
20297     * mouse pointer either incrementing or decrementing spinner's value.
20298     *
20299     * This helps the user to get to a given value distant from the
20300     * current one easier/faster, as it will start to change quicker and
20301     * quicker on mouse button holds.
20302     *
20303     * The calculation for the next change interval value, starting from
20304     * the one set with this call, is the previous interval divided by
20305     * @c 1.05, so it decreases a little bit.
20306     *
20307     * The default starting interval value for automatic changes is
20308     * @c 0.85 seconds.
20309     *
20310     * @see elm_spinner_interval_get()
20311     *
20312     * @ingroup Spinner
20313     */
20314    EAPI void         elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
20315
20316    /**
20317     * Get the interval on time updates for an user mouse button hold
20318     * on spinner widgets' arrows.
20319     *
20320     * @param obj The spinner object.
20321     * @return The (first) interval value, in seconds, set on it.
20322     *
20323     * @see elm_spinner_interval_set() for more details.
20324     *
20325     * @ingroup Spinner
20326     */
20327    EAPI double       elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20328
20329    /**
20330     * @}
20331     */
20332
20333    /**
20334     * @defgroup Index Index
20335     *
20336     * @image html img/widget/index/preview-00.png
20337     * @image latex img/widget/index/preview-00.eps
20338     *
20339     * An index widget gives you an index for fast access to whichever
20340     * group of other UI items one might have. It's a list of text
20341     * items (usually letters, for alphabetically ordered access).
20342     *
20343     * Index widgets are by default hidden and just appear when the
20344     * user clicks over it's reserved area in the canvas. In its
20345     * default theme, it's an area one @ref Fingers "finger" wide on
20346     * the right side of the index widget's container.
20347     *
20348     * When items on the index are selected, smart callbacks get
20349     * called, so that its user can make other container objects to
20350     * show a given area or child object depending on the index item
20351     * selected. You'd probably be using an index together with @ref
20352     * List "lists", @ref Genlist "generic lists" or @ref Gengrid
20353     * "general grids".
20354     *
20355     * Smart events one  can add callbacks for are:
20356     * - @c "changed" - When the selected index item changes. @c
20357     *      event_info is the selected item's data pointer.
20358     * - @c "delay,changed" - When the selected index item changes, but
20359     *      after a small idling period. @c event_info is the selected
20360     *      item's data pointer.
20361     * - @c "selected" - When the user releases a mouse button and
20362     *      selects an item. @c event_info is the selected item's data
20363     *      pointer.
20364     * - @c "level,up" - when the user moves a finger from the first
20365     *      level to the second level
20366     * - @c "level,down" - when the user moves a finger from the second
20367     *      level to the first level
20368     *
20369     * The @c "delay,changed" event is so that it'll wait a small time
20370     * before actually reporting those events and, moreover, just the
20371     * last event happening on those time frames will actually be
20372     * reported.
20373     *
20374     * Here are some examples on its usage:
20375     * @li @ref index_example_01
20376     * @li @ref index_example_02
20377     */
20378
20379    /**
20380     * @addtogroup Index
20381     * @{
20382     */
20383
20384    typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
20385
20386    /**
20387     * Add a new index widget to the given parent Elementary
20388     * (container) object
20389     *
20390     * @param parent The parent object
20391     * @return a new index widget handle or @c NULL, on errors
20392     *
20393     * This function inserts a new index widget on the canvas.
20394     *
20395     * @ingroup Index
20396     */
20397    EAPI Evas_Object    *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20398
20399    /**
20400     * Set whether a given index widget is or not visible,
20401     * programatically.
20402     *
20403     * @param obj The index object
20404     * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
20405     *
20406     * Not to be confused with visible as in @c evas_object_show() --
20407     * visible with regard to the widget's auto hiding feature.
20408     *
20409     * @see elm_index_active_get()
20410     *
20411     * @ingroup Index
20412     */
20413    EAPI void            elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
20414
20415    /**
20416     * Get whether a given index widget is currently visible or not.
20417     *
20418     * @param obj The index object
20419     * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
20420     *
20421     * @see elm_index_active_set() for more details
20422     *
20423     * @ingroup Index
20424     */
20425    EAPI Eina_Bool       elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20426
20427    /**
20428     * Set the items level for a given index widget.
20429     *
20430     * @param obj The index object.
20431     * @param level @c 0 or @c 1, the currently implemented levels.
20432     *
20433     * @see elm_index_item_level_get()
20434     *
20435     * @ingroup Index
20436     */
20437    EAPI void            elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20438
20439    /**
20440     * Get the items level set for a given index widget.
20441     *
20442     * @param obj The index object.
20443     * @return @c 0 or @c 1, which are the levels @p obj might be at.
20444     *
20445     * @see elm_index_item_level_set() for more information
20446     *
20447     * @ingroup Index
20448     */
20449    EAPI int             elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20450
20451    /**
20452     * Returns the last selected item's data, for a given index widget.
20453     *
20454     * @param obj The index object.
20455     * @return The item @b data associated to the last selected item on
20456     * @p obj (or @c NULL, on errors).
20457     *
20458     * @warning The returned value is @b not an #Elm_Index_Item item
20459     * handle, but the data associated to it (see the @c item parameter
20460     * in elm_index_item_append(), as an example).
20461     *
20462     * @ingroup Index
20463     */
20464    EAPI void           *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20465
20466    /**
20467     * Append a new item on a given index widget.
20468     *
20469     * @param obj The index object.
20470     * @param letter Letter under which the item should be indexed
20471     * @param item The item data to set for the index's item
20472     *
20473     * Despite the most common usage of the @p letter argument is for
20474     * single char strings, one could use arbitrary strings as index
20475     * entries.
20476     *
20477     * @c item will be the pointer returned back on @c "changed", @c
20478     * "delay,changed" and @c "selected" smart events.
20479     *
20480     * @ingroup Index
20481     */
20482    EAPI void            elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
20483
20484    /**
20485     * Prepend a new item on a given index widget.
20486     *
20487     * @param obj The index object.
20488     * @param letter Letter under which the item should be indexed
20489     * @param item The item data to set for the index's item
20490     *
20491     * Despite the most common usage of the @p letter argument is for
20492     * single char strings, one could use arbitrary strings as index
20493     * entries.
20494     *
20495     * @c item will be the pointer returned back on @c "changed", @c
20496     * "delay,changed" and @c "selected" smart events.
20497     *
20498     * @ingroup Index
20499     */
20500    EAPI void            elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
20501
20502    /**
20503     * Append a new item, on a given index widget, <b>after the item
20504     * having @p relative as data</b>.
20505     *
20506     * @param obj The index object.
20507     * @param letter Letter under which the item should be indexed
20508     * @param item The item data to set for the index's item
20509     * @param relative The item data of the index item to be the
20510     * predecessor of this new one
20511     *
20512     * Despite the most common usage of the @p letter argument is for
20513     * single char strings, one could use arbitrary strings as index
20514     * entries.
20515     *
20516     * @c item will be the pointer returned back on @c "changed", @c
20517     * "delay,changed" and @c "selected" smart events.
20518     *
20519     * @note If @p relative is @c NULL or if it's not found to be data
20520     * set on any previous item on @p obj, this function will behave as
20521     * elm_index_item_append().
20522     *
20523     * @ingroup Index
20524     */
20525    EAPI void            elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
20526
20527    /**
20528     * Prepend a new item, on a given index widget, <b>after the item
20529     * having @p relative as data</b>.
20530     *
20531     * @param obj The index object.
20532     * @param letter Letter under which the item should be indexed
20533     * @param item The item data to set for the index's item
20534     * @param relative The item data of the index item to be the
20535     * successor of this new one
20536     *
20537     * Despite the most common usage of the @p letter argument is for
20538     * single char strings, one could use arbitrary strings as index
20539     * entries.
20540     *
20541     * @c item will be the pointer returned back on @c "changed", @c
20542     * "delay,changed" and @c "selected" smart events.
20543     *
20544     * @note If @p relative is @c NULL or if it's not found to be data
20545     * set on any previous item on @p obj, this function will behave as
20546     * elm_index_item_prepend().
20547     *
20548     * @ingroup Index
20549     */
20550    EAPI void            elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
20551
20552    /**
20553     * Insert a new item into the given index widget, using @p cmp_func
20554     * function to sort items (by item handles).
20555     *
20556     * @param obj The index object.
20557     * @param letter Letter under which the item should be indexed
20558     * @param item The item data to set for the index's item
20559     * @param cmp_func The comparing function to be used to sort index
20560     * items <b>by #Elm_Index_Item item handles</b>
20561     * @param cmp_data_func A @b fallback function to be called for the
20562     * sorting of index items <b>by item data</b>). It will be used
20563     * when @p cmp_func returns @c 0 (equality), which means an index
20564     * item with provided item data already exists. To decide which
20565     * data item should be pointed to by the index item in question, @p
20566     * cmp_data_func will be used. If @p cmp_data_func returns a
20567     * non-negative value, the previous index item data will be
20568     * replaced by the given @p item pointer. If the previous data need
20569     * to be freed, it should be done by the @p cmp_data_func function,
20570     * because all references to it will be lost. If this function is
20571     * not provided (@c NULL is given), index items will be @b
20572     * duplicated, if @p cmp_func returns @c 0.
20573     *
20574     * Despite the most common usage of the @p letter argument is for
20575     * single char strings, one could use arbitrary strings as index
20576     * entries.
20577     *
20578     * @c item will be the pointer returned back on @c "changed", @c
20579     * "delay,changed" and @c "selected" smart events.
20580     *
20581     * @ingroup Index
20582     */
20583    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);
20584
20585    /**
20586     * Remove an item from a given index widget, <b>to be referenced by
20587     * it's data value</b>.
20588     *
20589     * @param obj The index object
20590     * @param item The item's data pointer for the item to be removed
20591     * from @p obj
20592     *
20593     * If a deletion callback is set, via elm_index_item_del_cb_set(),
20594     * that callback function will be called by this one.
20595     *
20596     * @warning The item to be removed from @p obj will be found via
20597     * its item data pointer, and not by an #Elm_Index_Item handle.
20598     *
20599     * @ingroup Index
20600     */
20601    EAPI void            elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
20602
20603    /**
20604     * Find a given index widget's item, <b>using item data</b>.
20605     *
20606     * @param obj The index object
20607     * @param item The item data pointed to by the desired index item
20608     * @return The index item handle, if found, or @c NULL otherwise
20609     *
20610     * @ingroup Index
20611     */
20612    EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
20613
20614    /**
20615     * Removes @b all items from a given index widget.
20616     *
20617     * @param obj The index object.
20618     *
20619     * If deletion callbacks are set, via elm_index_item_del_cb_set(),
20620     * that callback function will be called for each item in @p obj.
20621     *
20622     * @ingroup Index
20623     */
20624    EAPI void            elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20625
20626    /**
20627     * Go to a given items level on a index widget
20628     *
20629     * @param obj The index object
20630     * @param level The index level (one of @c 0 or @c 1)
20631     *
20632     * @ingroup Index
20633     */
20634    EAPI void            elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20635
20636    /**
20637     * Return the data associated with a given index widget item
20638     *
20639     * @param it The index widget item handle
20640     * @return The data associated with @p it
20641     *
20642     * @see elm_index_item_data_set()
20643     *
20644     * @ingroup Index
20645     */
20646    EAPI void           *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
20647
20648    /**
20649     * Set the data associated with a given index widget item
20650     *
20651     * @param it The index widget item handle
20652     * @param data The new data pointer to set to @p it
20653     *
20654     * This sets new item data on @p it.
20655     *
20656     * @warning The old data pointer won't be touched by this function, so
20657     * the user had better to free that old data himself/herself.
20658     *
20659     * @ingroup Index
20660     */
20661    EAPI void            elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
20662
20663    /**
20664     * Set the function to be called when a given index widget item is freed.
20665     *
20666     * @param it The item to set the callback on
20667     * @param func The function to call on the item's deletion
20668     *
20669     * When called, @p func will have both @c data and @c event_info
20670     * arguments with the @p it item's data value and, naturally, the
20671     * @c obj argument with a handle to the parent index widget.
20672     *
20673     * @ingroup Index
20674     */
20675    EAPI void            elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
20676
20677    /**
20678     * Get the letter (string) set on a given index widget item.
20679     *
20680     * @param it The index item handle
20681     * @return The letter string set on @p it
20682     *
20683     * @ingroup Index
20684     */
20685    EAPI const char     *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
20686
20687    /**
20688     * @}
20689     */
20690
20691    /**
20692     * @defgroup Photocam Photocam
20693     *
20694     * @image html img/widget/photocam/preview-00.png
20695     * @image latex img/widget/photocam/preview-00.eps
20696     *
20697     * This is a widget specifically for displaying high-resolution digital
20698     * camera photos giving speedy feedback (fast load), low memory footprint
20699     * and zooming and panning as well as fitting logic. It is entirely focused
20700     * on jpeg images, and takes advantage of properties of the jpeg format (via
20701     * evas loader features in the jpeg loader).
20702     *
20703     * Signals that you can add callbacks for are:
20704     * @li "clicked" - This is called when a user has clicked the photo without
20705     *                 dragging around.
20706     * @li "press" - This is called when a user has pressed down on the photo.
20707     * @li "longpressed" - This is called when a user has pressed down on the
20708     *                     photo for a long time without dragging around.
20709     * @li "clicked,double" - This is called when a user has double-clicked the
20710     *                        photo.
20711     * @li "load" - Photo load begins.
20712     * @li "loaded" - This is called when the image file load is complete for the
20713     *                first view (low resolution blurry version).
20714     * @li "load,detail" - Photo detailed data load begins.
20715     * @li "loaded,detail" - This is called when the image file load is complete
20716     *                      for the detailed image data (full resolution needed).
20717     * @li "zoom,start" - Zoom animation started.
20718     * @li "zoom,stop" - Zoom animation stopped.
20719     * @li "zoom,change" - Zoom changed when using an auto zoom mode.
20720     * @li "scroll" - the content has been scrolled (moved)
20721     * @li "scroll,anim,start" - scrolling animation has started
20722     * @li "scroll,anim,stop" - scrolling animation has stopped
20723     * @li "scroll,drag,start" - dragging the contents around has started
20724     * @li "scroll,drag,stop" - dragging the contents around has stopped
20725     *
20726     * @ref tutorial_photocam shows the API in action.
20727     * @{
20728     */
20729    /**
20730     * @brief Types of zoom available.
20731     */
20732    typedef enum _Elm_Photocam_Zoom_Mode
20733      {
20734         ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
20735         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
20736         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
20737         ELM_PHOTOCAM_ZOOM_MODE_LAST
20738      } Elm_Photocam_Zoom_Mode;
20739    /**
20740     * @brief Add a new Photocam object
20741     *
20742     * @param parent The parent object
20743     * @return The new object or NULL if it cannot be created
20744     */
20745    EAPI Evas_Object           *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20746    /**
20747     * @brief Set the photo file to be shown
20748     *
20749     * @param obj The photocam object
20750     * @param file The photo file
20751     * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
20752     *
20753     * This sets (and shows) the specified file (with a relative or absolute
20754     * path) and will return a load error (same error that
20755     * evas_object_image_load_error_get() will return). The image will change and
20756     * adjust its size at this point and begin a background load process for this
20757     * photo that at some time in the future will be displayed at the full
20758     * quality needed.
20759     */
20760    EAPI Evas_Load_Error        elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
20761    /**
20762     * @brief Returns the path of the current image file
20763     *
20764     * @param obj The photocam object
20765     * @return Returns the path
20766     *
20767     * @see elm_photocam_file_set()
20768     */
20769    EAPI const char            *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20770    /**
20771     * @brief Set the zoom level of the photo
20772     *
20773     * @param obj The photocam object
20774     * @param zoom The zoom level to set
20775     *
20776     * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
20777     * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
20778     * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
20779     * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
20780     * 16, 32, etc.).
20781     */
20782    EAPI void                   elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
20783    /**
20784     * @brief Get the zoom level of the photo
20785     *
20786     * @param obj The photocam object
20787     * @return The current zoom level
20788     *
20789     * This returns the current zoom level of the photocam object. Note that if
20790     * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
20791     * (which is the default), the zoom level may be changed at any time by the
20792     * photocam object itself to account for photo size and photocam viewpoer
20793     * size.
20794     *
20795     * @see elm_photocam_zoom_set()
20796     * @see elm_photocam_zoom_mode_set()
20797     */
20798    EAPI double                 elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20799    /**
20800     * @brief Set the zoom mode
20801     *
20802     * @param obj The photocam object
20803     * @param mode The desired mode
20804     *
20805     * This sets the zoom mode to manual or one of several automatic levels.
20806     * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
20807     * elm_photocam_zoom_set() and will stay at that level until changed by code
20808     * or until zoom mode is changed. This is the default mode. The Automatic
20809     * modes will allow the photocam object to automatically adjust zoom mode
20810     * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
20811     * the photo fits EXACTLY inside the scroll frame with no pixels outside this
20812     * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
20813     * pixels within the frame are left unfilled.
20814     */
20815    EAPI void                   elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
20816    /**
20817     * @brief Get the zoom mode
20818     *
20819     * @param obj The photocam object
20820     * @return The current zoom mode
20821     *
20822     * This gets the current zoom mode of the photocam object.
20823     *
20824     * @see elm_photocam_zoom_mode_set()
20825     */
20826    EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20827    /**
20828     * @brief Get the current image pixel width and height
20829     *
20830     * @param obj The photocam object
20831     * @param w A pointer to the width return
20832     * @param h A pointer to the height return
20833     *
20834     * This gets the current photo pixel width and height (for the original).
20835     * The size will be returned in the integers @p w and @p h that are pointed
20836     * to.
20837     */
20838    EAPI void                   elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
20839    /**
20840     * @brief Get the area of the image that is currently shown
20841     *
20842     * @param obj
20843     * @param x A pointer to the X-coordinate of region
20844     * @param y A pointer to the Y-coordinate of region
20845     * @param w A pointer to the width
20846     * @param h A pointer to the height
20847     *
20848     * @see elm_photocam_image_region_show()
20849     * @see elm_photocam_image_region_bring_in()
20850     */
20851    EAPI void                   elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
20852    /**
20853     * @brief Set the viewed portion of the image
20854     *
20855     * @param obj The photocam object
20856     * @param x X-coordinate of region in image original pixels
20857     * @param y Y-coordinate of region in image original pixels
20858     * @param w Width of region in image original pixels
20859     * @param h Height of region in image original pixels
20860     *
20861     * This shows the region of the image without using animation.
20862     */
20863    EAPI void                   elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
20864    /**
20865     * @brief Bring in the viewed portion of the image
20866     *
20867     * @param obj The photocam object
20868     * @param x X-coordinate of region in image original pixels
20869     * @param y Y-coordinate of region in image original pixels
20870     * @param w Width of region in image original pixels
20871     * @param h Height of region in image original pixels
20872     *
20873     * This shows the region of the image using animation.
20874     */
20875    EAPI void                   elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
20876    /**
20877     * @brief Set the paused state for photocam
20878     *
20879     * @param obj The photocam object
20880     * @param paused The pause state to set
20881     *
20882     * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
20883     * photocam. The default is off. This will stop zooming using animation on
20884     * zoom levels changes and change instantly. This will stop any existing
20885     * animations that are running.
20886     */
20887    EAPI void                   elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
20888    /**
20889     * @brief Get the paused state for photocam
20890     *
20891     * @param obj The photocam object
20892     * @return The current paused state
20893     *
20894     * This gets the current paused state for the photocam object.
20895     *
20896     * @see elm_photocam_paused_set()
20897     */
20898    EAPI Eina_Bool              elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20899    /**
20900     * @brief Get the internal low-res image used for photocam
20901     *
20902     * @param obj The photocam object
20903     * @return The internal image object handle, or NULL if none exists
20904     *
20905     * This gets the internal image object inside photocam. Do not modify it. It
20906     * is for inspection only, and hooking callbacks to. Nothing else. It may be
20907     * deleted at any time as well.
20908     */
20909    EAPI Evas_Object           *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20910    /**
20911     * @brief Set the photocam scrolling bouncing.
20912     *
20913     * @param obj The photocam object
20914     * @param h_bounce bouncing for horizontal
20915     * @param v_bounce bouncing for vertical
20916     */
20917    EAPI void                   elm_photocam_bounce_set(Evas_Object *obj,  Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
20918    /**
20919     * @brief Get the photocam scrolling bouncing.
20920     *
20921     * @param obj The photocam object
20922     * @param h_bounce bouncing for horizontal
20923     * @param v_bounce bouncing for vertical
20924     *
20925     * @see elm_photocam_bounce_set()
20926     */
20927    EAPI void                   elm_photocam_bounce_get(const Evas_Object *obj,  Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
20928    /**
20929     * @}
20930     */
20931
20932    /**
20933     * @defgroup Map Map
20934     * @ingroup Elementary
20935     *
20936     * @image html img/widget/map/preview-00.png
20937     * @image latex img/widget/map/preview-00.eps
20938     *
20939     * This is a widget specifically for displaying a map. It uses basically
20940     * OpenStreetMap provider http://www.openstreetmap.org/,
20941     * but custom providers can be added.
20942     *
20943     * It supports some basic but yet nice features:
20944     * @li zoom and scroll
20945     * @li markers with content to be displayed when user clicks over it
20946     * @li group of markers
20947     * @li routes
20948     *
20949     * Smart callbacks one can listen to:
20950     *
20951     * - "clicked" - This is called when a user has clicked the map without
20952     *   dragging around.
20953     * - "press" - This is called when a user has pressed down on the map.
20954     * - "longpressed" - This is called when a user has pressed down on the map
20955     *   for a long time without dragging around.
20956     * - "clicked,double" - This is called when a user has double-clicked
20957     *   the map.
20958     * - "load,detail" - Map detailed data load begins.
20959     * - "loaded,detail" - This is called when all currently visible parts of
20960     *   the map are loaded.
20961     * - "zoom,start" - Zoom animation started.
20962     * - "zoom,stop" - Zoom animation stopped.
20963     * - "zoom,change" - Zoom changed when using an auto zoom mode.
20964     * - "scroll" - the content has been scrolled (moved).
20965     * - "scroll,anim,start" - scrolling animation has started.
20966     * - "scroll,anim,stop" - scrolling animation has stopped.
20967     * - "scroll,drag,start" - dragging the contents around has started.
20968     * - "scroll,drag,stop" - dragging the contents around has stopped.
20969     * - "downloaded" - This is called when all currently required map images
20970     *   are downloaded.
20971     * - "route,load" - This is called when route request begins.
20972     * - "route,loaded" - This is called when route request ends.
20973     * - "name,load" - This is called when name request begins.
20974     * - "name,loaded- This is called when name request ends.
20975     *
20976     * Available style for map widget:
20977     * - @c "default"
20978     *
20979     * Available style for markers:
20980     * - @c "radio"
20981     * - @c "radio2"
20982     * - @c "empty"
20983     *
20984     * Available style for marker bubble:
20985     * - @c "default"
20986     *
20987     * List of examples:
20988     * @li @ref map_example_01
20989     * @li @ref map_example_02
20990     * @li @ref map_example_03
20991     */
20992
20993    /**
20994     * @addtogroup Map
20995     * @{
20996     */
20997
20998    /**
20999     * @enum _Elm_Map_Zoom_Mode
21000     * @typedef Elm_Map_Zoom_Mode
21001     *
21002     * Set map's zoom behavior. It can be set to manual or automatic.
21003     *
21004     * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
21005     *
21006     * Values <b> don't </b> work as bitmask, only one can be choosen.
21007     *
21008     * @note Valid sizes are 2^zoom, consequently the map may be smaller
21009     * than the scroller view.
21010     *
21011     * @see elm_map_zoom_mode_set()
21012     * @see elm_map_zoom_mode_get()
21013     *
21014     * @ingroup Map
21015     */
21016    typedef enum _Elm_Map_Zoom_Mode
21017      {
21018         ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
21019         ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
21020         ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
21021         ELM_MAP_ZOOM_MODE_LAST
21022      } Elm_Map_Zoom_Mode;
21023
21024    /**
21025     * @enum _Elm_Map_Route_Sources
21026     * @typedef Elm_Map_Route_Sources
21027     *
21028     * Set route service to be used. By default used source is
21029     * #ELM_MAP_ROUTE_SOURCE_YOURS.
21030     *
21031     * @see elm_map_route_source_set()
21032     * @see elm_map_route_source_get()
21033     *
21034     * @ingroup Map
21035     */
21036    typedef enum _Elm_Map_Route_Sources
21037      {
21038         ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
21039         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. */
21040         ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
21041         ELM_MAP_ROUTE_SOURCE_LAST
21042      } Elm_Map_Route_Sources;
21043
21044    typedef enum _Elm_Map_Name_Sources
21045      {
21046         ELM_MAP_NAME_SOURCE_NOMINATIM,
21047         ELM_MAP_NAME_SOURCE_LAST
21048      } Elm_Map_Name_Sources;
21049
21050    /**
21051     * @enum _Elm_Map_Route_Type
21052     * @typedef Elm_Map_Route_Type
21053     *
21054     * Set type of transport used on route.
21055     *
21056     * @see elm_map_route_add()
21057     *
21058     * @ingroup Map
21059     */
21060    typedef enum _Elm_Map_Route_Type
21061      {
21062         ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
21063         ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
21064         ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
21065         ELM_MAP_ROUTE_TYPE_LAST
21066      } Elm_Map_Route_Type;
21067
21068    /**
21069     * @enum _Elm_Map_Route_Method
21070     * @typedef Elm_Map_Route_Method
21071     *
21072     * Set the routing method, what should be priorized, time or distance.
21073     *
21074     * @see elm_map_route_add()
21075     *
21076     * @ingroup Map
21077     */
21078    typedef enum _Elm_Map_Route_Method
21079      {
21080         ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
21081         ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
21082         ELM_MAP_ROUTE_METHOD_LAST
21083      } Elm_Map_Route_Method;
21084
21085    typedef enum _Elm_Map_Name_Method
21086      {
21087         ELM_MAP_NAME_METHOD_SEARCH,
21088         ELM_MAP_NAME_METHOD_REVERSE,
21089         ELM_MAP_NAME_METHOD_LAST
21090      } Elm_Map_Name_Method;
21091
21092    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(). */
21093    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(). */
21094    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(). */
21095    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(). */
21096    typedef struct _Elm_Map_Name            Elm_Map_Name; /**< A handle for specific coordinates. */
21097    typedef struct _Elm_Map_Track           Elm_Map_Track;
21098
21099    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. */
21100    typedef void         (*ElmMapMarkerDelFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
21101    typedef Evas_Object *(*ElmMapMarkerIconGetFunc)  (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
21102    typedef Evas_Object *(*ElmMapGroupIconGetFunc)   (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
21103
21104    typedef char        *(*ElmMapModuleSourceFunc) (void);
21105    typedef int          (*ElmMapModuleZoomMinFunc) (void);
21106    typedef int          (*ElmMapModuleZoomMaxFunc) (void);
21107    typedef char        *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
21108    typedef int          (*ElmMapModuleRouteSourceFunc) (void);
21109    typedef char        *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
21110    typedef char        *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
21111    typedef Eina_Bool    (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
21112    typedef Eina_Bool    (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
21113
21114    /**
21115     * Add a new map widget to the given parent Elementary (container) object.
21116     *
21117     * @param parent The parent object.
21118     * @return a new map widget handle or @c NULL, on errors.
21119     *
21120     * This function inserts a new map widget on the canvas.
21121     *
21122     * @ingroup Map
21123     */
21124    EAPI Evas_Object          *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21125
21126    /**
21127     * Set the zoom level of the map.
21128     *
21129     * @param obj The map object.
21130     * @param zoom The zoom level to set.
21131     *
21132     * This sets the zoom level.
21133     *
21134     * It will respect limits defined by elm_map_source_zoom_min_set() and
21135     * elm_map_source_zoom_max_set().
21136     *
21137     * By default these values are 0 (world map) and 18 (maximum zoom).
21138     *
21139     * This function should be used when zoom mode is set to
21140     * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
21141     * with elm_map_zoom_mode_set().
21142     *
21143     * @see elm_map_zoom_mode_set().
21144     * @see elm_map_zoom_get().
21145     *
21146     * @ingroup Map
21147     */
21148    EAPI void                  elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
21149
21150    /**
21151     * Get the zoom level of the map.
21152     *
21153     * @param obj The map object.
21154     * @return The current zoom level.
21155     *
21156     * This returns the current zoom level of the map object.
21157     *
21158     * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
21159     * (which is the default), the zoom level may be changed at any time by the
21160     * map object itself to account for map size and map viewport size.
21161     *
21162     * @see elm_map_zoom_set() for details.
21163     *
21164     * @ingroup Map
21165     */
21166    EAPI int                   elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21167
21168    /**
21169     * Set the zoom mode used by the map object.
21170     *
21171     * @param obj The map object.
21172     * @param mode The zoom mode of the map, being it one of
21173     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
21174     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
21175     *
21176     * This sets the zoom mode to manual or one of the automatic levels.
21177     * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
21178     * elm_map_zoom_set() and will stay at that level until changed by code
21179     * or until zoom mode is changed. This is the default mode.
21180     *
21181     * The Automatic modes will allow the map object to automatically
21182     * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
21183     * adjust zoom so the map fits inside the scroll frame with no pixels
21184     * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
21185     * ensure no pixels within the frame are left unfilled. Do not forget that
21186     * the valid sizes are 2^zoom, consequently the map may be smaller than
21187     * the scroller view.
21188     *
21189     * @see elm_map_zoom_set()
21190     *
21191     * @ingroup Map
21192     */
21193    EAPI void                  elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
21194
21195    /**
21196     * Get the zoom mode used by the map object.
21197     *
21198     * @param obj The map object.
21199     * @return The zoom mode of the map, being it one of
21200     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
21201     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
21202     *
21203     * This function returns the current zoom mode used by the map object.
21204     *
21205     * @see elm_map_zoom_mode_set() for more details.
21206     *
21207     * @ingroup Map
21208     */
21209    EAPI Elm_Map_Zoom_Mode     elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21210
21211    /**
21212     * Get the current coordinates of the map.
21213     *
21214     * @param obj The map object.
21215     * @param lon Pointer where to store longitude.
21216     * @param lat Pointer where to store latitude.
21217     *
21218     * This gets the current center coordinates of the map object. It can be
21219     * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
21220     *
21221     * @see elm_map_geo_region_bring_in()
21222     * @see elm_map_geo_region_show()
21223     *
21224     * @ingroup Map
21225     */
21226    EAPI void                  elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
21227
21228    /**
21229     * Animatedly bring in given coordinates to the center of the map.
21230     *
21231     * @param obj The map object.
21232     * @param lon Longitude to center at.
21233     * @param lat Latitude to center at.
21234     *
21235     * This causes map to jump to the given @p lat and @p lon coordinates
21236     * and show it (by scrolling) in the center of the viewport, if it is not
21237     * already centered. This will use animation to do so and take a period
21238     * of time to complete.
21239     *
21240     * @see elm_map_geo_region_show() for a function to avoid animation.
21241     * @see elm_map_geo_region_get()
21242     *
21243     * @ingroup Map
21244     */
21245    EAPI void                  elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
21246
21247    /**
21248     * Show the given coordinates at the center of the map, @b immediately.
21249     *
21250     * @param obj The map object.
21251     * @param lon Longitude to center at.
21252     * @param lat Latitude to center at.
21253     *
21254     * This causes map to @b redraw its viewport's contents to the
21255     * region contining the given @p lat and @p lon, that will be moved to the
21256     * center of the map.
21257     *
21258     * @see elm_map_geo_region_bring_in() for a function to move with animation.
21259     * @see elm_map_geo_region_get()
21260     *
21261     * @ingroup Map
21262     */
21263    EAPI void                  elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
21264
21265    /**
21266     * Pause or unpause the map.
21267     *
21268     * @param obj The map object.
21269     * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
21270     * to unpause it.
21271     *
21272     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21273     * for map.
21274     *
21275     * The default is off.
21276     *
21277     * This will stop zooming using animation, changing zoom levels will
21278     * change instantly. This will stop any existing animations that are running.
21279     *
21280     * @see elm_map_paused_get()
21281     *
21282     * @ingroup Map
21283     */
21284    EAPI void                  elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
21285
21286    /**
21287     * Get a value whether map is paused or not.
21288     *
21289     * @param obj The map object.
21290     * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
21291     * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
21292     *
21293     * This gets the current paused state for the map object.
21294     *
21295     * @see elm_map_paused_set() for details.
21296     *
21297     * @ingroup Map
21298     */
21299    EAPI Eina_Bool             elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21300
21301    /**
21302     * Set to show markers during zoom level changes or not.
21303     *
21304     * @param obj The map object.
21305     * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
21306     * to show them.
21307     *
21308     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21309     * for map.
21310     *
21311     * The default is off.
21312     *
21313     * This will stop zooming using animation, changing zoom levels will
21314     * change instantly. This will stop any existing animations that are running.
21315     *
21316     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21317     * for the markers.
21318     *
21319     * The default  is off.
21320     *
21321     * Enabling it will force the map to stop displaying the markers during
21322     * zoom level changes. Set to on if you have a large number of markers.
21323     *
21324     * @see elm_map_paused_markers_get()
21325     *
21326     * @ingroup Map
21327     */
21328    EAPI void                  elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
21329
21330    /**
21331     * Get a value whether markers will be displayed on zoom level changes or not
21332     *
21333     * @param obj The map object.
21334     * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
21335     * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
21336     *
21337     * This gets the current markers paused state for the map object.
21338     *
21339     * @see elm_map_paused_markers_set() for details.
21340     *
21341     * @ingroup Map
21342     */
21343    EAPI Eina_Bool             elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21344
21345    /**
21346     * Get the information of downloading status.
21347     *
21348     * @param obj The map object.
21349     * @param try_num Pointer where to store number of tiles being downloaded.
21350     * @param finish_num Pointer where to store number of tiles successfully
21351     * downloaded.
21352     *
21353     * This gets the current downloading status for the map object, the number
21354     * of tiles being downloaded and the number of tiles already downloaded.
21355     *
21356     * @ingroup Map
21357     */
21358    EAPI void                  elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
21359
21360    /**
21361     * Convert a pixel coordinate (x,y) into a geographic coordinate
21362     * (longitude, latitude).
21363     *
21364     * @param obj The map object.
21365     * @param x the coordinate.
21366     * @param y the coordinate.
21367     * @param size the size in pixels of the map.
21368     * The map is a square and generally his size is : pow(2.0, zoom)*256.
21369     * @param lon Pointer where to store the longitude that correspond to x.
21370     * @param lat Pointer where to store the latitude that correspond to y.
21371     *
21372     * @note Origin pixel point is the top left corner of the viewport.
21373     * Map zoom and size are taken on account.
21374     *
21375     * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
21376     *
21377     * @ingroup Map
21378     */
21379    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);
21380
21381    /**
21382     * Convert a geographic coordinate (longitude, latitude) into a pixel
21383     * coordinate (x, y).
21384     *
21385     * @param obj The map object.
21386     * @param lon the longitude.
21387     * @param lat the latitude.
21388     * @param size the size in pixels of the map. The map is a square
21389     * and generally his size is : pow(2.0, zoom)*256.
21390     * @param x Pointer where to store the horizontal pixel coordinate that
21391     * correspond to the longitude.
21392     * @param y Pointer where to store the vertical pixel coordinate that
21393     * correspond to the latitude.
21394     *
21395     * @note Origin pixel point is the top left corner of the viewport.
21396     * Map zoom and size are taken on account.
21397     *
21398     * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
21399     *
21400     * @ingroup Map
21401     */
21402    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);
21403
21404    /**
21405     * Convert a geographic coordinate (longitude, latitude) into a name
21406     * (address).
21407     *
21408     * @param obj The map object.
21409     * @param lon the longitude.
21410     * @param lat the latitude.
21411     * @return name A #Elm_Map_Name handle for this coordinate.
21412     *
21413     * To get the string for this address, elm_map_name_address_get()
21414     * should be used.
21415     *
21416     * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
21417     *
21418     * @ingroup Map
21419     */
21420    EAPI Elm_Map_Name         *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
21421
21422    /**
21423     * Convert a name (address) into a geographic coordinate
21424     * (longitude, latitude).
21425     *
21426     * @param obj The map object.
21427     * @param name The address.
21428     * @return name A #Elm_Map_Name handle for this address.
21429     *
21430     * To get the longitude and latitude, elm_map_name_region_get()
21431     * should be used.
21432     *
21433     * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
21434     *
21435     * @ingroup Map
21436     */
21437    EAPI Elm_Map_Name         *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
21438
21439    /**
21440     * Convert a pixel coordinate into a rotated pixel coordinate.
21441     *
21442     * @param obj The map object.
21443     * @param x horizontal coordinate of the point to rotate.
21444     * @param y vertical coordinate of the point to rotate.
21445     * @param cx rotation's center horizontal position.
21446     * @param cy rotation's center vertical position.
21447     * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
21448     * @param xx Pointer where to store rotated x.
21449     * @param yy Pointer where to store rotated y.
21450     *
21451     * @ingroup Map
21452     */
21453    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);
21454
21455    /**
21456     * Add a new marker to the map object.
21457     *
21458     * @param obj The map object.
21459     * @param lon The longitude of the marker.
21460     * @param lat The latitude of the marker.
21461     * @param clas The class, to use when marker @b isn't grouped to others.
21462     * @param clas_group The class group, to use when marker is grouped to others
21463     * @param data The data passed to the callbacks.
21464     *
21465     * @return The created marker or @c NULL upon failure.
21466     *
21467     * A marker will be created and shown in a specific point of the map, defined
21468     * by @p lon and @p lat.
21469     *
21470     * It will be displayed using style defined by @p class when this marker
21471     * is displayed alone (not grouped). A new class can be created with
21472     * elm_map_marker_class_new().
21473     *
21474     * If the marker is grouped to other markers, it will be displayed with
21475     * style defined by @p class_group. Markers with the same group are grouped
21476     * if they are close. A new group class can be created with
21477     * elm_map_marker_group_class_new().
21478     *
21479     * Markers created with this method can be deleted with
21480     * elm_map_marker_remove().
21481     *
21482     * A marker can have associated content to be displayed by a bubble,
21483     * when a user click over it, as well as an icon. These objects will
21484     * be fetch using class' callback functions.
21485     *
21486     * @see elm_map_marker_class_new()
21487     * @see elm_map_marker_group_class_new()
21488     * @see elm_map_marker_remove()
21489     *
21490     * @ingroup Map
21491     */
21492    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);
21493
21494    /**
21495     * Set the maximum numbers of markers' content to be displayed in a group.
21496     *
21497     * @param obj The map object.
21498     * @param max The maximum numbers of items displayed in a bubble.
21499     *
21500     * A bubble will be displayed when the user clicks over the group,
21501     * and will place the content of markers that belong to this group
21502     * inside it.
21503     *
21504     * A group can have a long list of markers, consequently the creation
21505     * of the content of the bubble can be very slow.
21506     *
21507     * In order to avoid this, a maximum number of items is displayed
21508     * in a bubble.
21509     *
21510     * By default this number is 30.
21511     *
21512     * Marker with the same group class are grouped if they are close.
21513     *
21514     * @see elm_map_marker_add()
21515     *
21516     * @ingroup Map
21517     */
21518    EAPI void                  elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
21519
21520    /**
21521     * Remove a marker from the map.
21522     *
21523     * @param marker The marker to remove.
21524     *
21525     * @see elm_map_marker_add()
21526     *
21527     * @ingroup Map
21528     */
21529    EAPI void                  elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21530
21531    /**
21532     * Get the current coordinates of the marker.
21533     *
21534     * @param marker marker.
21535     * @param lat Pointer where to store the marker's latitude.
21536     * @param lon Pointer where to store the marker's longitude.
21537     *
21538     * These values are set when adding markers, with function
21539     * elm_map_marker_add().
21540     *
21541     * @see elm_map_marker_add()
21542     *
21543     * @ingroup Map
21544     */
21545    EAPI void                  elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
21546
21547    /**
21548     * Animatedly bring in given marker to the center of the map.
21549     *
21550     * @param marker The marker to center at.
21551     *
21552     * This causes map to jump to the given @p marker's coordinates
21553     * and show it (by scrolling) in the center of the viewport, if it is not
21554     * already centered. This will use animation to do so and take a period
21555     * of time to complete.
21556     *
21557     * @see elm_map_marker_show() for a function to avoid animation.
21558     * @see elm_map_marker_region_get()
21559     *
21560     * @ingroup Map
21561     */
21562    EAPI void                  elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21563
21564    /**
21565     * Show the given marker at the center of the map, @b immediately.
21566     *
21567     * @param marker The marker to center at.
21568     *
21569     * This causes map to @b redraw its viewport's contents to the
21570     * region contining the given @p marker's coordinates, that will be
21571     * moved to the center of the map.
21572     *
21573     * @see elm_map_marker_bring_in() for a function to move with animation.
21574     * @see elm_map_markers_list_show() if more than one marker need to be
21575     * displayed.
21576     * @see elm_map_marker_region_get()
21577     *
21578     * @ingroup Map
21579     */
21580    EAPI void                  elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21581
21582    /**
21583     * Move and zoom the map to display a list of markers.
21584     *
21585     * @param markers A list of #Elm_Map_Marker handles.
21586     *
21587     * The map will be centered on the center point of the markers in the list.
21588     * Then the map will be zoomed in order to fit the markers using the maximum
21589     * zoom which allows display of all the markers.
21590     *
21591     * @warning All the markers should belong to the same map object.
21592     *
21593     * @see elm_map_marker_show() to show a single marker.
21594     * @see elm_map_marker_bring_in()
21595     *
21596     * @ingroup Map
21597     */
21598    EAPI void                  elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
21599
21600    /**
21601     * Get the Evas object returned by the ElmMapMarkerGetFunc callback
21602     *
21603     * @param marker The marker wich content should be returned.
21604     * @return Return the evas object if it exists, else @c NULL.
21605     *
21606     * To set callback function #ElmMapMarkerGetFunc for the marker class,
21607     * elm_map_marker_class_get_cb_set() should be used.
21608     *
21609     * This content is what will be inside the bubble that will be displayed
21610     * when an user clicks over the marker.
21611     *
21612     * This returns the actual Evas object used to be placed inside
21613     * the bubble. This may be @c NULL, as it may
21614     * not have been created or may have been deleted, at any time, by
21615     * the map. <b>Do not modify this object</b> (move, resize,
21616     * show, hide, etc.), as the map is controlling it. This
21617     * function is for querying, emitting custom signals or hooking
21618     * lower level callbacks for events on that object. Do not delete
21619     * this object under any circumstances.
21620     *
21621     * @ingroup Map
21622     */
21623    EAPI Evas_Object          *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21624
21625    /**
21626     * Update the marker
21627     *
21628     * @param marker The marker to be updated.
21629     *
21630     * If a content is set to this marker, it will call function to delete it,
21631     * #ElmMapMarkerDelFunc, and then will fetch the content again with
21632     * #ElmMapMarkerGetFunc.
21633     *
21634     * These functions are set for the marker class with
21635     * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
21636     *
21637     * @ingroup Map
21638     */
21639    EAPI void                  elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21640
21641    /**
21642     * Close all the bubbles opened by the user.
21643     *
21644     * @param obj The map object.
21645     *
21646     * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
21647     * when the user clicks on a marker.
21648     *
21649     * This functions is set for the marker class with
21650     * elm_map_marker_class_get_cb_set().
21651     *
21652     * @ingroup Map
21653     */
21654    EAPI void                  elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
21655
21656    /**
21657     * Create a new group class.
21658     *
21659     * @param obj The map object.
21660     * @return Returns the new group class.
21661     *
21662     * Each marker must be associated to a group class. Markers in the same
21663     * group are grouped if they are close.
21664     *
21665     * The group class defines the style of the marker when a marker is grouped
21666     * to others markers. When it is alone, another class will be used.
21667     *
21668     * A group class will need to be provided when creating a marker with
21669     * elm_map_marker_add().
21670     *
21671     * Some properties and functions can be set by class, as:
21672     * - style, with elm_map_group_class_style_set()
21673     * - data - to be associated to the group class. It can be set using
21674     *   elm_map_group_class_data_set().
21675     * - min zoom to display markers, set with
21676     *   elm_map_group_class_zoom_displayed_set().
21677     * - max zoom to group markers, set using
21678     *   elm_map_group_class_zoom_grouped_set().
21679     * - visibility - set if markers will be visible or not, set with
21680     *   elm_map_group_class_hide_set().
21681     * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
21682     *   It can be set using elm_map_group_class_icon_cb_set().
21683     *
21684     * @see elm_map_marker_add()
21685     * @see elm_map_group_class_style_set()
21686     * @see elm_map_group_class_data_set()
21687     * @see elm_map_group_class_zoom_displayed_set()
21688     * @see elm_map_group_class_zoom_grouped_set()
21689     * @see elm_map_group_class_hide_set()
21690     * @see elm_map_group_class_icon_cb_set()
21691     *
21692     * @ingroup Map
21693     */
21694    EAPI Elm_Map_Group_Class  *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
21695
21696    /**
21697     * Set the marker's style of a group class.
21698     *
21699     * @param clas The group class.
21700     * @param style The style to be used by markers.
21701     *
21702     * Each marker must be associated to a group class, and will use the style
21703     * defined by such class when grouped to other markers.
21704     *
21705     * The following styles are provided by default theme:
21706     * @li @c radio - blue circle
21707     * @li @c radio2 - green circle
21708     * @li @c empty
21709     *
21710     * @see elm_map_group_class_new() for more details.
21711     * @see elm_map_marker_add()
21712     *
21713     * @ingroup Map
21714     */
21715    EAPI void                  elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
21716
21717    /**
21718     * Set the icon callback function of a group class.
21719     *
21720     * @param clas The group class.
21721     * @param icon_get The callback function that will return the icon.
21722     *
21723     * Each marker must be associated to a group class, and it can display a
21724     * custom icon. The function @p icon_get must return this icon.
21725     *
21726     * @see elm_map_group_class_new() for more details.
21727     * @see elm_map_marker_add()
21728     *
21729     * @ingroup Map
21730     */
21731    EAPI void                  elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
21732
21733    /**
21734     * Set the data associated to the group class.
21735     *
21736     * @param clas The group class.
21737     * @param data The new user data.
21738     *
21739     * This data will be passed for callback functions, like icon get callback,
21740     * that can be set with elm_map_group_class_icon_cb_set().
21741     *
21742     * If a data was previously set, the object will lose the pointer for it,
21743     * so if needs to be freed, you must do it yourself.
21744     *
21745     * @see elm_map_group_class_new() for more details.
21746     * @see elm_map_group_class_icon_cb_set()
21747     * @see elm_map_marker_add()
21748     *
21749     * @ingroup Map
21750     */
21751    EAPI void                  elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
21752
21753    /**
21754     * Set the minimum zoom from where the markers are displayed.
21755     *
21756     * @param clas The group class.
21757     * @param zoom The minimum zoom.
21758     *
21759     * Markers only will be displayed when the map is displayed at @p zoom
21760     * or bigger.
21761     *
21762     * @see elm_map_group_class_new() for more details.
21763     * @see elm_map_marker_add()
21764     *
21765     * @ingroup Map
21766     */
21767    EAPI void                  elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
21768
21769    /**
21770     * Set the zoom from where the markers are no more grouped.
21771     *
21772     * @param clas The group class.
21773     * @param zoom The maximum zoom.
21774     *
21775     * Markers only will be grouped when the map is displayed at
21776     * less than @p zoom.
21777     *
21778     * @see elm_map_group_class_new() for more details.
21779     * @see elm_map_marker_add()
21780     *
21781     * @ingroup Map
21782     */
21783    EAPI void                  elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
21784
21785    /**
21786     * Set if the markers associated to the group class @clas are hidden or not.
21787     *
21788     * @param clas The group class.
21789     * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
21790     * to show them.
21791     *
21792     * If @p hide is @c EINA_TRUE the markers will be hidden, but default
21793     * is to show them.
21794     *
21795     * @ingroup Map
21796     */
21797    EAPI void                  elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
21798
21799    /**
21800     * Create a new marker class.
21801     *
21802     * @param obj The map object.
21803     * @return Returns the new group class.
21804     *
21805     * Each marker must be associated to a class.
21806     *
21807     * The marker class defines the style of the marker when a marker is
21808     * displayed alone, i.e., not grouped to to others markers. When grouped
21809     * it will use group class style.
21810     *
21811     * A marker class will need to be provided when creating a marker with
21812     * elm_map_marker_add().
21813     *
21814     * Some properties and functions can be set by class, as:
21815     * - style, with elm_map_marker_class_style_set()
21816     * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
21817     *   It can be set using elm_map_marker_class_icon_cb_set().
21818     * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
21819     *   Set using elm_map_marker_class_get_cb_set().
21820     * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
21821     *   Set using elm_map_marker_class_del_cb_set().
21822     *
21823     * @see elm_map_marker_add()
21824     * @see elm_map_marker_class_style_set()
21825     * @see elm_map_marker_class_icon_cb_set()
21826     * @see elm_map_marker_class_get_cb_set()
21827     * @see elm_map_marker_class_del_cb_set()
21828     *
21829     * @ingroup Map
21830     */
21831    EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
21832
21833    /**
21834     * Set the marker's style of a marker class.
21835     *
21836     * @param clas The marker class.
21837     * @param style The style to be used by markers.
21838     *
21839     * Each marker must be associated to a marker class, and will use the style
21840     * defined by such class when alone, i.e., @b not grouped to other markers.
21841     *
21842     * The following styles are provided by default theme:
21843     * @li @c radio
21844     * @li @c radio2
21845     * @li @c empty
21846     *
21847     * @see elm_map_marker_class_new() for more details.
21848     * @see elm_map_marker_add()
21849     *
21850     * @ingroup Map
21851     */
21852    EAPI void                  elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
21853
21854    /**
21855     * Set the icon callback function of a marker class.
21856     *
21857     * @param clas The marker class.
21858     * @param icon_get The callback function that will return the icon.
21859     *
21860     * Each marker must be associated to a marker class, and it can display a
21861     * custom icon. The function @p icon_get must return this icon.
21862     *
21863     * @see elm_map_marker_class_new() for more details.
21864     * @see elm_map_marker_add()
21865     *
21866     * @ingroup Map
21867     */
21868    EAPI void                  elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
21869
21870    /**
21871     * Set the bubble content callback function of a marker class.
21872     *
21873     * @param clas The marker class.
21874     * @param get The callback function that will return the content.
21875     *
21876     * Each marker must be associated to a marker class, and it can display a
21877     * a content on a bubble that opens when the user click over the marker.
21878     * The function @p get must return this content object.
21879     *
21880     * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
21881     * can be used.
21882     *
21883     * @see elm_map_marker_class_new() for more details.
21884     * @see elm_map_marker_class_del_cb_set()
21885     * @see elm_map_marker_add()
21886     *
21887     * @ingroup Map
21888     */
21889    EAPI void                  elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
21890
21891    /**
21892     * Set the callback function used to delete bubble content of a marker class.
21893     *
21894     * @param clas The marker class.
21895     * @param del The callback function that will delete the content.
21896     *
21897     * Each marker must be associated to a marker class, and it can display a
21898     * a content on a bubble that opens when the user click over the marker.
21899     * The function to return such content can be set with
21900     * elm_map_marker_class_get_cb_set().
21901     *
21902     * If this content must be freed, a callback function need to be
21903     * set for that task with this function.
21904     *
21905     * If this callback is defined it will have to delete (or not) the
21906     * object inside, but if the callback is not defined the object will be
21907     * destroyed with evas_object_del().
21908     *
21909     * @see elm_map_marker_class_new() for more details.
21910     * @see elm_map_marker_class_get_cb_set()
21911     * @see elm_map_marker_add()
21912     *
21913     * @ingroup Map
21914     */
21915    EAPI void                  elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
21916
21917    /**
21918     * Get the list of available sources.
21919     *
21920     * @param obj The map object.
21921     * @return The source names list.
21922     *
21923     * It will provide a list with all available sources, that can be set as
21924     * current source with elm_map_source_name_set(), or get with
21925     * elm_map_source_name_get().
21926     *
21927     * Available sources:
21928     * @li "Mapnik"
21929     * @li "Osmarender"
21930     * @li "CycleMap"
21931     * @li "Maplint"
21932     *
21933     * @see elm_map_source_name_set() for more details.
21934     * @see elm_map_source_name_get()
21935     *
21936     * @ingroup Map
21937     */
21938    EAPI const char          **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21939
21940    /**
21941     * Set the source of the map.
21942     *
21943     * @param obj The map object.
21944     * @param source The source to be used.
21945     *
21946     * Map widget retrieves images that composes the map from a web service.
21947     * This web service can be set with this method.
21948     *
21949     * A different service can return a different maps with different
21950     * information and it can use different zoom values.
21951     *
21952     * The @p source_name need to match one of the names provided by
21953     * elm_map_source_names_get().
21954     *
21955     * The current source can be get using elm_map_source_name_get().
21956     *
21957     * @see elm_map_source_names_get()
21958     * @see elm_map_source_name_get()
21959     *
21960     *
21961     * @ingroup Map
21962     */
21963    EAPI void                  elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
21964
21965    /**
21966     * Get the name of currently used source.
21967     *
21968     * @param obj The map object.
21969     * @return Returns the name of the source in use.
21970     *
21971     * @see elm_map_source_name_set() for more details.
21972     *
21973     * @ingroup Map
21974     */
21975    EAPI const char           *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21976
21977    /**
21978     * Set the source of the route service to be used by the map.
21979     *
21980     * @param obj The map object.
21981     * @param source The route service to be used, being it one of
21982     * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
21983     * and #ELM_MAP_ROUTE_SOURCE_ORS.
21984     *
21985     * Each one has its own algorithm, so the route retrieved may
21986     * differ depending on the source route. Now, only the default is working.
21987     *
21988     * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
21989     * http://www.yournavigation.org/.
21990     *
21991     * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
21992     * assumptions. Its routing core is based on Contraction Hierarchies.
21993     *
21994     * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
21995     *
21996     * @see elm_map_route_source_get().
21997     *
21998     * @ingroup Map
21999     */
22000    EAPI void                  elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
22001
22002    /**
22003     * Get the current route source.
22004     *
22005     * @param obj The map object.
22006     * @return The source of the route service used by the map.
22007     *
22008     * @see elm_map_route_source_set() for details.
22009     *
22010     * @ingroup Map
22011     */
22012    EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22013
22014    /**
22015     * Set the minimum zoom of the source.
22016     *
22017     * @param obj The map object.
22018     * @param zoom New minimum zoom value to be used.
22019     *
22020     * By default, it's 0.
22021     *
22022     * @ingroup Map
22023     */
22024    EAPI void                  elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22025
22026    /**
22027     * Get the minimum zoom of the source.
22028     *
22029     * @param obj The map object.
22030     * @return Returns the minimum zoom of the source.
22031     *
22032     * @see elm_map_source_zoom_min_set() for details.
22033     *
22034     * @ingroup Map
22035     */
22036    EAPI int                   elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22037
22038    /**
22039     * Set the maximum zoom of the source.
22040     *
22041     * @param obj The map object.
22042     * @param zoom New maximum zoom value to be used.
22043     *
22044     * By default, it's 18.
22045     *
22046     * @ingroup Map
22047     */
22048    EAPI void                  elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22049
22050    /**
22051     * Get the maximum zoom of the source.
22052     *
22053     * @param obj The map object.
22054     * @return Returns the maximum zoom of the source.
22055     *
22056     * @see elm_map_source_zoom_min_set() for details.
22057     *
22058     * @ingroup Map
22059     */
22060    EAPI int                   elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22061
22062    /**
22063     * Set the user agent used by the map object to access routing services.
22064     *
22065     * @param obj The map object.
22066     * @param user_agent The user agent to be used by the map.
22067     *
22068     * User agent is a client application implementing a network protocol used
22069     * in communications within a client–server distributed computing system
22070     *
22071     * The @p user_agent identification string will transmitted in a header
22072     * field @c User-Agent.
22073     *
22074     * @see elm_map_user_agent_get()
22075     *
22076     * @ingroup Map
22077     */
22078    EAPI void                  elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
22079
22080    /**
22081     * Get the user agent used by the map object.
22082     *
22083     * @param obj The map object.
22084     * @return The user agent identification string used by the map.
22085     *
22086     * @see elm_map_user_agent_set() for details.
22087     *
22088     * @ingroup Map
22089     */
22090    EAPI const char           *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22091
22092    /**
22093     * Add a new route to the map object.
22094     *
22095     * @param obj The map object.
22096     * @param type The type of transport to be considered when tracing a route.
22097     * @param method The routing method, what should be priorized.
22098     * @param flon The start longitude.
22099     * @param flat The start latitude.
22100     * @param tlon The destination longitude.
22101     * @param tlat The destination latitude.
22102     *
22103     * @return The created route or @c NULL upon failure.
22104     *
22105     * A route will be traced by point on coordinates (@p flat, @p flon)
22106     * to point on coordinates (@p tlat, @p tlon), using the route service
22107     * set with elm_map_route_source_set().
22108     *
22109     * It will take @p type on consideration to define the route,
22110     * depending if the user will be walking or driving, the route may vary.
22111     * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
22112     * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
22113     *
22114     * Another parameter is what the route should priorize, the minor distance
22115     * or the less time to be spend on the route. So @p method should be one
22116     * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
22117     *
22118     * Routes created with this method can be deleted with
22119     * elm_map_route_remove(), colored with elm_map_route_color_set(),
22120     * and distance can be get with elm_map_route_distance_get().
22121     *
22122     * @see elm_map_route_remove()
22123     * @see elm_map_route_color_set()
22124     * @see elm_map_route_distance_get()
22125     * @see elm_map_route_source_set()
22126     *
22127     * @ingroup Map
22128     */
22129    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);
22130
22131    /**
22132     * Remove a route from the map.
22133     *
22134     * @param route The route to remove.
22135     *
22136     * @see elm_map_route_add()
22137     *
22138     * @ingroup Map
22139     */
22140    EAPI void                  elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
22141
22142    /**
22143     * Set the route color.
22144     *
22145     * @param route The route object.
22146     * @param r Red channel value, from 0 to 255.
22147     * @param g Green channel value, from 0 to 255.
22148     * @param b Blue channel value, from 0 to 255.
22149     * @param a Alpha channel value, from 0 to 255.
22150     *
22151     * It uses an additive color model, so each color channel represents
22152     * how much of each primary colors must to be used. 0 represents
22153     * ausence of this color, so if all of the three are set to 0,
22154     * the color will be black.
22155     *
22156     * These component values should be integers in the range 0 to 255,
22157     * (single 8-bit byte).
22158     *
22159     * This sets the color used for the route. By default, it is set to
22160     * solid red (r = 255, g = 0, b = 0, a = 255).
22161     *
22162     * For alpha channel, 0 represents completely transparent, and 255, opaque.
22163     *
22164     * @see elm_map_route_color_get()
22165     *
22166     * @ingroup Map
22167     */
22168    EAPI void                  elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
22169
22170    /**
22171     * Get the route color.
22172     *
22173     * @param route The route object.
22174     * @param r Pointer where to store the red channel value.
22175     * @param g Pointer where to store the green channel value.
22176     * @param b Pointer where to store the blue channel value.
22177     * @param a Pointer where to store the alpha channel value.
22178     *
22179     * @see elm_map_route_color_set() for details.
22180     *
22181     * @ingroup Map
22182     */
22183    EAPI void                  elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
22184
22185    /**
22186     * Get the route distance in kilometers.
22187     *
22188     * @param route The route object.
22189     * @return The distance of route (unit : km).
22190     *
22191     * @ingroup Map
22192     */
22193    EAPI double                elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
22194
22195    /**
22196     * Get the information of route nodes.
22197     *
22198     * @param route The route object.
22199     * @return Returns a string with the nodes of route.
22200     *
22201     * @ingroup Map
22202     */
22203    EAPI const char           *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
22204
22205    /**
22206     * Get the information of route waypoint.
22207     *
22208     * @param route the route object.
22209     * @return Returns a string with information about waypoint of route.
22210     *
22211     * @ingroup Map
22212     */
22213    EAPI const char           *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
22214
22215    /**
22216     * Get the address of the name.
22217     *
22218     * @param name The name handle.
22219     * @return Returns the address string of @p name.
22220     *
22221     * This gets the coordinates of the @p name, created with one of the
22222     * conversion functions.
22223     *
22224     * @see elm_map_utils_convert_name_into_coord()
22225     * @see elm_map_utils_convert_coord_into_name()
22226     *
22227     * @ingroup Map
22228     */
22229    EAPI const char           *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
22230
22231    /**
22232     * Get the current coordinates of the name.
22233     *
22234     * @param name The name handle.
22235     * @param lat Pointer where to store the latitude.
22236     * @param lon Pointer where to store The longitude.
22237     *
22238     * This gets the coordinates of the @p name, created with one of the
22239     * conversion functions.
22240     *
22241     * @see elm_map_utils_convert_name_into_coord()
22242     * @see elm_map_utils_convert_coord_into_name()
22243     *
22244     * @ingroup Map
22245     */
22246    EAPI void                  elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
22247
22248    /**
22249     * Remove a name from the map.
22250     *
22251     * @param name The name to remove.
22252     *
22253     * Basically the struct handled by @p name will be freed, so convertions
22254     * between address and coordinates will be lost.
22255     *
22256     * @see elm_map_utils_convert_name_into_coord()
22257     * @see elm_map_utils_convert_coord_into_name()
22258     *
22259     * @ingroup Map
22260     */
22261    EAPI void                  elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
22262
22263    /**
22264     * Rotate the map.
22265     *
22266     * @param obj The map object.
22267     * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
22268     * @param cx Rotation's center horizontal position.
22269     * @param cy Rotation's center vertical position.
22270     *
22271     * @see elm_map_rotate_get()
22272     *
22273     * @ingroup Map
22274     */
22275    EAPI void                  elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
22276
22277    /**
22278     * Get the rotate degree of the map
22279     *
22280     * @param obj The map object
22281     * @param degree Pointer where to store degrees from 0.0 to 360.0
22282     * to rotate arount Z axis.
22283     * @param cx Pointer where to store rotation's center horizontal position.
22284     * @param cy Pointer where to store rotation's center vertical position.
22285     *
22286     * @see elm_map_rotate_set() to set map rotation.
22287     *
22288     * @ingroup Map
22289     */
22290    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);
22291
22292    /**
22293     * Enable or disable mouse wheel to be used to zoom in / out the map.
22294     *
22295     * @param obj The map object.
22296     * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
22297     * to enable it.
22298     *
22299     * Mouse wheel can be used for the user to zoom in or zoom out the map.
22300     *
22301     * It's disabled by default.
22302     *
22303     * @see elm_map_wheel_disabled_get()
22304     *
22305     * @ingroup Map
22306     */
22307    EAPI void                  elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22308
22309    /**
22310     * Get a value whether mouse wheel is enabled or not.
22311     *
22312     * @param obj The map object.
22313     * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
22314     * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22315     *
22316     * Mouse wheel can be used for the user to zoom in or zoom out the map.
22317     *
22318     * @see elm_map_wheel_disabled_set() for details.
22319     *
22320     * @ingroup Map
22321     */
22322    EAPI Eina_Bool             elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22323
22324 #ifdef ELM_EMAP
22325    /**
22326     * Add a track on the map
22327     *
22328     * @param obj The map object.
22329     * @param emap The emap route object.
22330     * @return The route object. This is an elm object of type Route.
22331     *
22332     * @see elm_route_add() for details.
22333     *
22334     * @ingroup Map
22335     */
22336    EAPI Evas_Object          *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
22337 #endif
22338
22339    /**
22340     * Remove a track from the map
22341     *
22342     * @param obj The map object.
22343     * @param route The track to remove.
22344     *
22345     * @ingroup Map
22346     */
22347    EAPI void                  elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
22348
22349    /**
22350     * @}
22351     */
22352
22353    /* Route */
22354    EAPI Evas_Object *elm_route_add(Evas_Object *parent);
22355 #ifdef ELM_EMAP
22356    EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
22357 #endif
22358    EAPI double elm_route_lon_min_get(Evas_Object *obj);
22359    EAPI double elm_route_lat_min_get(Evas_Object *obj);
22360    EAPI double elm_route_lon_max_get(Evas_Object *obj);
22361    EAPI double elm_route_lat_max_get(Evas_Object *obj);
22362
22363
22364    /**
22365     * @defgroup Panel Panel
22366     *
22367     * @image html img/widget/panel/preview-00.png
22368     * @image latex img/widget/panel/preview-00.eps
22369     *
22370     * @brief A panel is a type of animated container that contains subobjects.
22371     * It can be expanded or contracted by clicking the button on it's edge.
22372     *
22373     * Orientations are as follows:
22374     * @li ELM_PANEL_ORIENT_TOP
22375     * @li ELM_PANEL_ORIENT_LEFT
22376     * @li ELM_PANEL_ORIENT_RIGHT
22377     *
22378     * @ref tutorial_panel shows one way to use this widget.
22379     * @{
22380     */
22381    typedef enum _Elm_Panel_Orient
22382      {
22383         ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
22384         ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
22385         ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
22386         ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
22387      } Elm_Panel_Orient;
22388    /**
22389     * @brief Adds a panel object
22390     *
22391     * @param parent The parent object
22392     *
22393     * @return The panel object, or NULL on failure
22394     */
22395    EAPI Evas_Object          *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22396    /**
22397     * @brief Sets the orientation of the panel
22398     *
22399     * @param parent The parent object
22400     * @param orient The panel orientation. Can be one of the following:
22401     * @li ELM_PANEL_ORIENT_TOP
22402     * @li ELM_PANEL_ORIENT_LEFT
22403     * @li ELM_PANEL_ORIENT_RIGHT
22404     *
22405     * Sets from where the panel will (dis)appear.
22406     */
22407    EAPI void                  elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
22408    /**
22409     * @brief Get the orientation of the panel.
22410     *
22411     * @param obj The panel object
22412     * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
22413     */
22414    EAPI Elm_Panel_Orient      elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22415    /**
22416     * @brief Set the content of the panel.
22417     *
22418     * @param obj The panel object
22419     * @param content The panel content
22420     *
22421     * Once the content object is set, a previously set one will be deleted.
22422     * If you want to keep that old content object, use the
22423     * elm_panel_content_unset() function.
22424     */
22425    EAPI void                  elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22426    /**
22427     * @brief Get the content of the panel.
22428     *
22429     * @param obj The panel object
22430     * @return The content that is being used
22431     *
22432     * Return the content object which is set for this widget.
22433     *
22434     * @see elm_panel_content_set()
22435     */
22436    EAPI Evas_Object          *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22437    /**
22438     * @brief Unset the content of the panel.
22439     *
22440     * @param obj The panel object
22441     * @return The content that was being used
22442     *
22443     * Unparent and return the content object which was set for this widget.
22444     *
22445     * @see elm_panel_content_set()
22446     */
22447    EAPI Evas_Object          *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22448    /**
22449     * @brief Set the state of the panel.
22450     *
22451     * @param obj The panel object
22452     * @param hidden If true, the panel will run the animation to contract
22453     */
22454    EAPI void                  elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
22455    /**
22456     * @brief Get the state of the panel.
22457     *
22458     * @param obj The panel object
22459     * @param hidden If true, the panel is in the "hide" state
22460     */
22461    EAPI Eina_Bool             elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22462    /**
22463     * @brief Toggle the hidden state of the panel from code
22464     *
22465     * @param obj The panel object
22466     */
22467    EAPI void                  elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
22468    /**
22469     * @}
22470     */
22471
22472    /**
22473     * @defgroup Panes Panes
22474     * @ingroup Elementary
22475     *
22476     * @image html img/widget/panes/preview-00.png
22477     * @image latex img/widget/panes/preview-00.eps width=\textwidth
22478     *
22479     * @image html img/panes.png
22480     * @image latex img/panes.eps width=\textwidth
22481     *
22482     * The panes adds a dragable bar between two contents. When dragged
22483     * this bar will resize contents size.
22484     *
22485     * Panes can be displayed vertically or horizontally, and contents
22486     * size proportion can be customized (homogeneous by default).
22487     *
22488     * Smart callbacks one can listen to:
22489     * - "press" - The panes has been pressed (button wasn't released yet).
22490     * - "unpressed" - The panes was released after being pressed.
22491     * - "clicked" - The panes has been clicked>
22492     * - "clicked,double" - The panes has been double clicked
22493     *
22494     * Available styles for it:
22495     * - @c "default"
22496     *
22497     * Here is an example on its usage:
22498     * @li @ref panes_example
22499     */
22500
22501    /**
22502     * @addtogroup Panes
22503     * @{
22504     */
22505
22506    /**
22507     * Add a new panes widget to the given parent Elementary
22508     * (container) object.
22509     *
22510     * @param parent The parent object.
22511     * @return a new panes widget handle or @c NULL, on errors.
22512     *
22513     * This function inserts a new panes widget on the canvas.
22514     *
22515     * @ingroup Panes
22516     */
22517    EAPI Evas_Object          *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22518
22519    /**
22520     * Set the left content of the panes widget.
22521     *
22522     * @param obj The panes object.
22523     * @param content The new left content object.
22524     *
22525     * Once the content object is set, a previously set one will be deleted.
22526     * If you want to keep that old content object, use the
22527     * elm_panes_content_left_unset() function.
22528     *
22529     * If panes is displayed vertically, left content will be displayed at
22530     * top.
22531     *
22532     * @see elm_panes_content_left_get()
22533     * @see elm_panes_content_right_set() to set content on the other side.
22534     *
22535     * @ingroup Panes
22536     */
22537    EAPI void                  elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22538
22539    /**
22540     * Set the right content of the panes widget.
22541     *
22542     * @param obj The panes object.
22543     * @param content The new right content object.
22544     *
22545     * Once the content object is set, a previously set one will be deleted.
22546     * If you want to keep that old content object, use the
22547     * elm_panes_content_right_unset() function.
22548     *
22549     * If panes is displayed vertically, left content will be displayed at
22550     * bottom.
22551     *
22552     * @see elm_panes_content_right_get()
22553     * @see elm_panes_content_left_set() to set content on the other side.
22554     *
22555     * @ingroup Panes
22556     */
22557    EAPI void                  elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22558
22559    /**
22560     * Get the left content of the panes.
22561     *
22562     * @param obj The panes object.
22563     * @return The left content object that is being used.
22564     *
22565     * Return the left content object which is set for this widget.
22566     *
22567     * @see elm_panes_content_left_set() for details.
22568     *
22569     * @ingroup Panes
22570     */
22571    EAPI Evas_Object          *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22572
22573    /**
22574     * Get the right content of the panes.
22575     *
22576     * @param obj The panes object
22577     * @return The right content object that is being used
22578     *
22579     * Return the right content object which is set for this widget.
22580     *
22581     * @see elm_panes_content_right_set() for details.
22582     *
22583     * @ingroup Panes
22584     */
22585    EAPI Evas_Object          *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22586
22587    /**
22588     * Unset the left content used for the panes.
22589     *
22590     * @param obj The panes object.
22591     * @return The left content object that was being used.
22592     *
22593     * Unparent and return the left content object which was set for this widget.
22594     *
22595     * @see elm_panes_content_left_set() for details.
22596     * @see elm_panes_content_left_get().
22597     *
22598     * @ingroup Panes
22599     */
22600    EAPI Evas_Object          *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22601
22602    /**
22603     * Unset the right content used for the panes.
22604     *
22605     * @param obj The panes object.
22606     * @return The right content object that was being used.
22607     *
22608     * Unparent and return the right content object which was set for this
22609     * widget.
22610     *
22611     * @see elm_panes_content_right_set() for details.
22612     * @see elm_panes_content_right_get().
22613     *
22614     * @ingroup Panes
22615     */
22616    EAPI Evas_Object          *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22617
22618    /**
22619     * Get the size proportion of panes widget's left side.
22620     *
22621     * @param obj The panes object.
22622     * @return float value between 0.0 and 1.0 representing size proportion
22623     * of left side.
22624     *
22625     * @see elm_panes_content_left_size_set() for more details.
22626     *
22627     * @ingroup Panes
22628     */
22629    EAPI double                elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22630
22631    /**
22632     * Set the size proportion of panes widget's left side.
22633     *
22634     * @param obj The panes object.
22635     * @param size Value between 0.0 and 1.0 representing size proportion
22636     * of left side.
22637     *
22638     * By default it's homogeneous, i.e., both sides have the same size.
22639     *
22640     * If something different is required, it can be set with this function.
22641     * For example, if the left content should be displayed over
22642     * 75% of the panes size, @p size should be passed as @c 0.75.
22643     * This way, right content will be resized to 25% of panes size.
22644     *
22645     * If displayed vertically, left content is displayed at top, and
22646     * right content at bottom.
22647     *
22648     * @note This proportion will change when user drags the panes bar.
22649     *
22650     * @see elm_panes_content_left_size_get()
22651     *
22652     * @ingroup Panes
22653     */
22654    EAPI void                  elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
22655
22656   /**
22657    * Set the orientation of a given panes widget.
22658    *
22659    * @param obj The panes object.
22660    * @param horizontal Use @c EINA_TRUE to make @p obj to be
22661    * @b horizontal, @c EINA_FALSE to make it @b vertical.
22662    *
22663    * Use this function to change how your panes is to be
22664    * disposed: vertically or horizontally.
22665    *
22666    * By default it's displayed horizontally.
22667    *
22668    * @see elm_panes_horizontal_get()
22669    *
22670    * @ingroup Panes
22671    */
22672    EAPI void                  elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22673
22674    /**
22675     * Retrieve the orientation of a given panes widget.
22676     *
22677     * @param obj The panes object.
22678     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
22679     * @c EINA_FALSE if it's @b vertical (and on errors).
22680     *
22681     * @see elm_panes_horizontal_set() for more details.
22682     *
22683     * @ingroup Panes
22684     */
22685    EAPI Eina_Bool             elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22686
22687    /**
22688     * @}
22689     */
22690
22691    /**
22692     * @defgroup Flip Flip
22693     *
22694     * @image html img/widget/flip/preview-00.png
22695     * @image latex img/widget/flip/preview-00.eps
22696     *
22697     * This widget holds 2 content objects(Evas_Object): one on the front and one
22698     * on the back. It allows you to flip from front to back and vice-versa using
22699     * various animations.
22700     *
22701     * If either the front or back contents are not set the flip will treat that
22702     * as transparent. So if you wore to set the front content but not the back,
22703     * and then call elm_flip_go() you would see whatever is below the flip.
22704     *
22705     * For a list of supported animations see elm_flip_go().
22706     *
22707     * Signals that you can add callbacks for are:
22708     * "animate,begin" - when a flip animation was started
22709     * "animate,done" - when a flip animation is finished
22710     *
22711     * @ref tutorial_flip show how to use most of the API.
22712     *
22713     * @{
22714     */
22715    typedef enum _Elm_Flip_Mode
22716      {
22717         ELM_FLIP_ROTATE_Y_CENTER_AXIS,
22718         ELM_FLIP_ROTATE_X_CENTER_AXIS,
22719         ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
22720         ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
22721         ELM_FLIP_CUBE_LEFT,
22722         ELM_FLIP_CUBE_RIGHT,
22723         ELM_FLIP_CUBE_UP,
22724         ELM_FLIP_CUBE_DOWN,
22725         ELM_FLIP_PAGE_LEFT,
22726         ELM_FLIP_PAGE_RIGHT,
22727         ELM_FLIP_PAGE_UP,
22728         ELM_FLIP_PAGE_DOWN
22729      } Elm_Flip_Mode;
22730    typedef enum _Elm_Flip_Interaction
22731      {
22732         ELM_FLIP_INTERACTION_NONE,
22733         ELM_FLIP_INTERACTION_ROTATE,
22734         ELM_FLIP_INTERACTION_CUBE,
22735         ELM_FLIP_INTERACTION_PAGE
22736      } Elm_Flip_Interaction;
22737    typedef enum _Elm_Flip_Direction
22738      {
22739         ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
22740         ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
22741         ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
22742         ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
22743      } Elm_Flip_Direction;
22744    /**
22745     * @brief Add a new flip to the parent
22746     *
22747     * @param parent The parent object
22748     * @return The new object or NULL if it cannot be created
22749     */
22750    EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22751    /**
22752     * @brief Set the front content of the flip widget.
22753     *
22754     * @param obj The flip object
22755     * @param content The new front content object
22756     *
22757     * Once the content object is set, a previously set one will be deleted.
22758     * If you want to keep that old content object, use the
22759     * elm_flip_content_front_unset() function.
22760     */
22761    EAPI void         elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22762    /**
22763     * @brief Set the back content of the flip widget.
22764     *
22765     * @param obj The flip object
22766     * @param content The new back content object
22767     *
22768     * Once the content object is set, a previously set one will be deleted.
22769     * If you want to keep that old content object, use the
22770     * elm_flip_content_back_unset() function.
22771     */
22772    EAPI void         elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22773    /**
22774     * @brief Get the front content used for the flip
22775     *
22776     * @param obj The flip object
22777     * @return The front content object that is being used
22778     *
22779     * Return the front content object which is set for this widget.
22780     */
22781    EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22782    /**
22783     * @brief Get the back content used for the flip
22784     *
22785     * @param obj The flip object
22786     * @return The back content object that is being used
22787     *
22788     * Return the back content object which is set for this widget.
22789     */
22790    EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22791    /**
22792     * @brief Unset the front content used for the flip
22793     *
22794     * @param obj The flip object
22795     * @return The front content object that was being used
22796     *
22797     * Unparent and return the front content object which was set for this widget.
22798     */
22799    EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22800    /**
22801     * @brief Unset the back content used for the flip
22802     *
22803     * @param obj The flip object
22804     * @return The back content object that was being used
22805     *
22806     * Unparent and return the back content object which was set for this widget.
22807     */
22808    EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22809    /**
22810     * @brief Get flip front visibility state
22811     *
22812     * @param obj The flip objct
22813     * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
22814     * showing.
22815     */
22816    EAPI Eina_Bool    elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22817    /**
22818     * @brief Set flip perspective
22819     *
22820     * @param obj The flip object
22821     * @param foc The coordinate to set the focus on
22822     * @param x The X coordinate
22823     * @param y The Y coordinate
22824     *
22825     * @warning This function currently does nothing.
22826     */
22827    EAPI void         elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
22828    /**
22829     * @brief Runs the flip animation
22830     *
22831     * @param obj The flip object
22832     * @param mode The mode type
22833     *
22834     * Flips the front and back contents using the @p mode animation. This
22835     * efectively hides the currently visible content and shows the hidden one.
22836     *
22837     * There a number of possible animations to use for the flipping:
22838     * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
22839     * around a horizontal axis in the middle of its height, the other content
22840     * is shown as the other side of the flip.
22841     * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
22842     * around a vertical axis in the middle of its width, the other content is
22843     * shown as the other side of the flip.
22844     * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
22845     * around a diagonal axis in the middle of its width, the other content is
22846     * shown as the other side of the flip.
22847     * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
22848     * around a diagonal axis in the middle of its height, the other content is
22849     * shown as the other side of the flip.
22850     * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
22851     * as if the flip was a cube, the other content is show as the right face of
22852     * the cube.
22853     * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
22854     * right as if the flip was a cube, the other content is show as the left
22855     * face of the cube.
22856     * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
22857     * flip was a cube, the other content is show as the bottom face of the cube.
22858     * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
22859     * the flip was a cube, the other content is show as the upper face of the
22860     * cube.
22861     * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
22862     * if the flip was a book, the other content is shown as the page below that.
22863     * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
22864     * as if the flip was a book, the other content is shown as the page below
22865     * that.
22866     * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
22867     * flip was a book, the other content is shown as the page below that.
22868     * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
22869     * flip was a book, the other content is shown as the page below that.
22870     *
22871     * @image html elm_flip.png
22872     * @image latex elm_flip.eps width=\textwidth
22873     */
22874    EAPI void         elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
22875    /**
22876     * @brief Set the interactive flip mode
22877     *
22878     * @param obj The flip object
22879     * @param mode The interactive flip mode to use
22880     *
22881     * This sets if the flip should be interactive (allow user to click and
22882     * drag a side of the flip to reveal the back page and cause it to flip).
22883     * By default a flip is not interactive. You may also need to set which
22884     * sides of the flip are "active" for flipping and how much space they use
22885     * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
22886     * and elm_flip_interacton_direction_hitsize_set()
22887     *
22888     * The four avilable mode of interaction are:
22889     * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
22890     * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
22891     * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
22892     * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
22893     *
22894     * @note ELM_FLIP_INTERACTION_ROTATE won't cause
22895     * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
22896     * happen, those can only be acheived with elm_flip_go();
22897     */
22898    EAPI void         elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
22899    /**
22900     * @brief Get the interactive flip mode
22901     *
22902     * @param obj The flip object
22903     * @return The interactive flip mode
22904     *
22905     * Returns the interactive flip mode set by elm_flip_interaction_set()
22906     */
22907    EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
22908    /**
22909     * @brief Set which directions of the flip respond to interactive flip
22910     *
22911     * @param obj The flip object
22912     * @param dir The direction to change
22913     * @param enabled If that direction is enabled or not
22914     *
22915     * By default all directions are disabled, so you may want to enable the
22916     * desired directions for flipping if you need interactive flipping. You must
22917     * call this function once for each direction that should be enabled.
22918     *
22919     * @see elm_flip_interaction_set()
22920     */
22921    EAPI void         elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
22922    /**
22923     * @brief Get the enabled state of that flip direction
22924     *
22925     * @param obj The flip object
22926     * @param dir The direction to check
22927     * @return If that direction is enabled or not
22928     *
22929     * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
22930     *
22931     * @see elm_flip_interaction_set()
22932     */
22933    EAPI Eina_Bool    elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
22934    /**
22935     * @brief Set the amount of the flip that is sensitive to interactive flip
22936     *
22937     * @param obj The flip object
22938     * @param dir The direction to modify
22939     * @param hitsize The amount of that dimension (0.0 to 1.0) to use
22940     *
22941     * Set the amount of the flip that is sensitive to interactive flip, with 0
22942     * representing no area in the flip and 1 representing the entire flip. There
22943     * is however a consideration to be made in that the area will never be
22944     * smaller than the finger size set(as set in your Elementary configuration).
22945     *
22946     * @see elm_flip_interaction_set()
22947     */
22948    EAPI void         elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
22949    /**
22950     * @brief Get the amount of the flip that is sensitive to interactive flip
22951     *
22952     * @param obj The flip object
22953     * @param dir The direction to check
22954     * @return The size set for that direction
22955     *
22956     * Returns the amount os sensitive area set by
22957     * elm_flip_interacton_direction_hitsize_set().
22958     */
22959    EAPI double       elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
22960    /**
22961     * @}
22962     */
22963
22964    /* scrolledentry */
22965    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22966    EINA_DEPRECATED EAPI void         elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
22967    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22968    EINA_DEPRECATED EAPI void         elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
22969    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22970    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22971    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22972    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22973    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22974    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22975    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22976    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
22977    EINA_DEPRECATED EAPI void         elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
22978    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22979    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
22980    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
22981    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
22982    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
22983    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
22984    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
22985    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22986    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22987    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22988    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22989    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
22990    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
22991    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22992    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22993    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22994    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
22995    EINA_DEPRECATED EAPI int          elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22996    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
22997    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
22998    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
22999    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
23000    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);
23001    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23002    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23003    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);
23004    EINA_DEPRECATED EAPI void         elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
23005    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);
23006    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
23007    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23008    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23009    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
23010    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
23011    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23012    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23013    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
23014    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);
23015    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);
23016    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);
23017    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);
23018    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);
23019    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);
23020    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
23021    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
23022    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
23023    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
23024    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23025    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
23026    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
23027
23028    /**
23029     * @defgroup Conformant Conformant
23030     * @ingroup Elementary
23031     *
23032     * @image html img/widget/conformant/preview-00.png
23033     * @image latex img/widget/conformant/preview-00.eps width=\textwidth
23034     *
23035     * @image html img/conformant.png
23036     * @image latex img/conformant.eps width=\textwidth
23037     *
23038     * The aim is to provide a widget that can be used in elementary apps to
23039     * account for space taken up by the indicator, virtual keypad & softkey
23040     * windows when running the illume2 module of E17.
23041     *
23042     * So conformant content will be sized and positioned considering the
23043     * space required for such stuff, and when they popup, as a keyboard
23044     * shows when an entry is selected, conformant content won't change.
23045     *
23046     * Available styles for it:
23047     * - @c "default"
23048     *
23049     * See how to use this widget in this example:
23050     * @ref conformant_example
23051     */
23052
23053    /**
23054     * @addtogroup Conformant
23055     * @{
23056     */
23057
23058    /**
23059     * Add a new conformant widget to the given parent Elementary
23060     * (container) object.
23061     *
23062     * @param parent The parent object.
23063     * @return A new conformant widget handle or @c NULL, on errors.
23064     *
23065     * This function inserts a new conformant widget on the canvas.
23066     *
23067     * @ingroup Conformant
23068     */
23069    EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23070
23071    /**
23072     * Set the content of the conformant widget.
23073     *
23074     * @param obj The conformant object.
23075     * @param content The content to be displayed by the conformant.
23076     *
23077     * Content will be sized and positioned considering the space required
23078     * to display a virtual keyboard. So it won't fill all the conformant
23079     * size. This way is possible to be sure that content won't resize
23080     * or be re-positioned after the keyboard is displayed.
23081     *
23082     * Once the content object is set, a previously set one will be deleted.
23083     * If you want to keep that old content object, use the
23084     * elm_conformat_content_unset() function.
23085     *
23086     * @see elm_conformant_content_unset()
23087     * @see elm_conformant_content_get()
23088     *
23089     * @ingroup Conformant
23090     */
23091    EAPI void         elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23092
23093    /**
23094     * Get the content of the conformant widget.
23095     *
23096     * @param obj The conformant object.
23097     * @return The content that is being used.
23098     *
23099     * Return the content object which is set for this widget.
23100     * It won't be unparent from conformant. For that, use
23101     * elm_conformant_content_unset().
23102     *
23103     * @see elm_conformant_content_set() for more details.
23104     * @see elm_conformant_content_unset()
23105     *
23106     * @ingroup Conformant
23107     */
23108    EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23109
23110    /**
23111     * Unset the content of the conformant widget.
23112     *
23113     * @param obj The conformant object.
23114     * @return The content that was being used.
23115     *
23116     * Unparent and return the content object which was set for this widget.
23117     *
23118     * @see elm_conformant_content_set() for more details.
23119     *
23120     * @ingroup Conformant
23121     */
23122    EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23123
23124    /**
23125     * Returns the Evas_Object that represents the content area.
23126     *
23127     * @param obj The conformant object.
23128     * @return The content area of the widget.
23129     *
23130     * @ingroup Conformant
23131     */
23132    EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23133
23134    /**
23135     * @}
23136     */
23137
23138    /**
23139     * @defgroup Mapbuf Mapbuf
23140     * @ingroup Elementary
23141     *
23142     * @image html img/widget/mapbuf/preview-00.png
23143     * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
23144     *
23145     * This holds one content object and uses an Evas Map of transformation
23146     * points to be later used with this content. So the content will be
23147     * moved, resized, etc as a single image. So it will improve performance
23148     * when you have a complex interafce, with a lot of elements, and will
23149     * need to resize or move it frequently (the content object and its
23150     * children).
23151     *
23152     * See how to use this widget in this example:
23153     * @ref mapbuf_example
23154     */
23155
23156    /**
23157     * @addtogroup Mapbuf
23158     * @{
23159     */
23160
23161    /**
23162     * Add a new mapbuf widget to the given parent Elementary
23163     * (container) object.
23164     *
23165     * @param parent The parent object.
23166     * @return A new mapbuf widget handle or @c NULL, on errors.
23167     *
23168     * This function inserts a new mapbuf widget on the canvas.
23169     *
23170     * @ingroup Mapbuf
23171     */
23172    EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23173
23174    /**
23175     * Set the content of the mapbuf.
23176     *
23177     * @param obj The mapbuf object.
23178     * @param content The content that will be filled in this mapbuf object.
23179     *
23180     * Once the content object is set, a previously set one will be deleted.
23181     * If you want to keep that old content object, use the
23182     * elm_mapbuf_content_unset() function.
23183     *
23184     * To enable map, elm_mapbuf_enabled_set() should be used.
23185     *
23186     * @ingroup Mapbuf
23187     */
23188    EAPI void         elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23189
23190    /**
23191     * Get the content of the mapbuf.
23192     *
23193     * @param obj The mapbuf object.
23194     * @return The content that is being used.
23195     *
23196     * Return the content object which is set for this widget.
23197     *
23198     * @see elm_mapbuf_content_set() for details.
23199     *
23200     * @ingroup Mapbuf
23201     */
23202    EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23203
23204    /**
23205     * Unset the content of the mapbuf.
23206     *
23207     * @param obj The mapbuf object.
23208     * @return The content that was being used.
23209     *
23210     * Unparent and return the content object which was set for this widget.
23211     *
23212     * @see elm_mapbuf_content_set() for details.
23213     *
23214     * @ingroup Mapbuf
23215     */
23216    EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23217
23218    /**
23219     * Enable or disable the map.
23220     *
23221     * @param obj The mapbuf object.
23222     * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
23223     *
23224     * This enables the map that is set or disables it. On enable, the object
23225     * geometry will be saved, and the new geometry will change (position and
23226     * size) to reflect the map geometry set.
23227     *
23228     * Also, when enabled, alpha and smooth states will be used, so if the
23229     * content isn't solid, alpha should be enabled, for example, otherwise
23230     * a black retangle will fill the content.
23231     *
23232     * When disabled, the stored map will be freed and geometry prior to
23233     * enabling the map will be restored.
23234     *
23235     * It's disabled by default.
23236     *
23237     * @see elm_mapbuf_alpha_set()
23238     * @see elm_mapbuf_smooth_set()
23239     *
23240     * @ingroup Mapbuf
23241     */
23242    EAPI void         elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23243
23244    /**
23245     * Get a value whether map is enabled or not.
23246     *
23247     * @param obj The mapbuf object.
23248     * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
23249     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23250     *
23251     * @see elm_mapbuf_enabled_set() for details.
23252     *
23253     * @ingroup Mapbuf
23254     */
23255    EAPI Eina_Bool    elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23256
23257    /**
23258     * Enable or disable smooth map rendering.
23259     *
23260     * @param obj The mapbuf object.
23261     * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
23262     * to disable it.
23263     *
23264     * This sets smoothing for map rendering. If the object is a type that has
23265     * its own smoothing settings, then both the smooth settings for this object
23266     * and the map must be turned off.
23267     *
23268     * By default smooth maps are enabled.
23269     *
23270     * @ingroup Mapbuf
23271     */
23272    EAPI void         elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
23273
23274    /**
23275     * Get a value whether smooth map rendering is enabled or not.
23276     *
23277     * @param obj The mapbuf object.
23278     * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
23279     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23280     *
23281     * @see elm_mapbuf_smooth_set() for details.
23282     *
23283     * @ingroup Mapbuf
23284     */
23285    EAPI Eina_Bool    elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23286
23287    /**
23288     * Set or unset alpha flag for map rendering.
23289     *
23290     * @param obj The mapbuf object.
23291     * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
23292     * to disable it.
23293     *
23294     * This sets alpha flag for map rendering. If the object is a type that has
23295     * its own alpha settings, then this will take precedence. Only image objects
23296     * have this currently. It stops alpha blending of the map area, and is
23297     * useful if you know the object and/or all sub-objects is 100% solid.
23298     *
23299     * Alpha is enabled by default.
23300     *
23301     * @ingroup Mapbuf
23302     */
23303    EAPI void         elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
23304
23305    /**
23306     * Get a value whether alpha blending is enabled or not.
23307     *
23308     * @param obj The mapbuf object.
23309     * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
23310     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23311     *
23312     * @see elm_mapbuf_alpha_set() for details.
23313     *
23314     * @ingroup Mapbuf
23315     */
23316    EAPI Eina_Bool    elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23317
23318    /**
23319     * @}
23320     */
23321
23322    /**
23323     * @defgroup Flipselector Flip Selector
23324     *
23325     * @image html img/widget/flipselector/preview-00.png
23326     * @image latex img/widget/flipselector/preview-00.eps
23327     *
23328     * A flip selector is a widget to show a set of @b text items, one
23329     * at a time, with the same sheet switching style as the @ref Clock
23330     * "clock" widget, when one changes the current displaying sheet
23331     * (thus, the "flip" in the name).
23332     *
23333     * User clicks to flip sheets which are @b held for some time will
23334     * make the flip selector to flip continuosly and automatically for
23335     * the user. The interval between flips will keep growing in time,
23336     * so that it helps the user to reach an item which is distant from
23337     * the current selection.
23338     *
23339     * Smart callbacks one can register to:
23340     * - @c "selected" - when the widget's selected text item is changed
23341     * - @c "overflowed" - when the widget's current selection is changed
23342     *   from the first item in its list to the last
23343     * - @c "underflowed" - when the widget's current selection is changed
23344     *   from the last item in its list to the first
23345     *
23346     * Available styles for it:
23347     * - @c "default"
23348     *
23349     * Here is an example on its usage:
23350     * @li @ref flipselector_example
23351     */
23352
23353    /**
23354     * @addtogroup Flipselector
23355     * @{
23356     */
23357
23358    typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
23359
23360    /**
23361     * Add a new flip selector widget to the given parent Elementary
23362     * (container) widget
23363     *
23364     * @param parent The parent object
23365     * @return a new flip selector widget handle or @c NULL, on errors
23366     *
23367     * This function inserts a new flip selector widget on the canvas.
23368     *
23369     * @ingroup Flipselector
23370     */
23371    EAPI Evas_Object               *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23372
23373    /**
23374     * Programmatically select the next item of a flip selector widget
23375     *
23376     * @param obj The flipselector object
23377     *
23378     * @note The selection will be animated. Also, if it reaches the
23379     * end of its list of member items, it will continue with the first
23380     * one onwards.
23381     *
23382     * @ingroup Flipselector
23383     */
23384    EAPI void                       elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
23385
23386    /**
23387     * Programmatically select the previous item of a flip selector
23388     * widget
23389     *
23390     * @param obj The flipselector object
23391     *
23392     * @note The selection will be animated.  Also, if it reaches the
23393     * beginning of its list of member items, it will continue with the
23394     * last one backwards.
23395     *
23396     * @ingroup Flipselector
23397     */
23398    EAPI void                       elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
23399
23400    /**
23401     * Append a (text) item to a flip selector widget
23402     *
23403     * @param obj The flipselector object
23404     * @param label The (text) label of the new item
23405     * @param func Convenience callback function to take place when
23406     * item is selected
23407     * @param data Data passed to @p func, above
23408     * @return A handle to the item added or @c NULL, on errors
23409     *
23410     * The widget's list of labels to show will be appended with the
23411     * given value. If the user wishes so, a callback function pointer
23412     * can be passed, which will get called when this same item is
23413     * selected.
23414     *
23415     * @note The current selection @b won't be modified by appending an
23416     * element to the list.
23417     *
23418     * @note The maximum length of the text label is going to be
23419     * determined <b>by the widget's theme</b>. Strings larger than
23420     * that value are going to be @b truncated.
23421     *
23422     * @ingroup Flipselector
23423     */
23424    EAPI Elm_Flipselector_Item     *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
23425
23426    /**
23427     * Prepend a (text) item to a flip selector widget
23428     *
23429     * @param obj The flipselector object
23430     * @param label The (text) label of the new item
23431     * @param func Convenience callback function to take place when
23432     * item is selected
23433     * @param data Data passed to @p func, above
23434     * @return A handle to the item added or @c NULL, on errors
23435     *
23436     * The widget's list of labels to show will be prepended with the
23437     * given value. If the user wishes so, a callback function pointer
23438     * can be passed, which will get called when this same item is
23439     * selected.
23440     *
23441     * @note The current selection @b won't be modified by prepending
23442     * an element to the list.
23443     *
23444     * @note The maximum length of the text label is going to be
23445     * determined <b>by the widget's theme</b>. Strings larger than
23446     * that value are going to be @b truncated.
23447     *
23448     * @ingroup Flipselector
23449     */
23450    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
23451
23452    /**
23453     * Get the internal list of items in a given flip selector widget.
23454     *
23455     * @param obj The flipselector object
23456     * @return The list of items (#Elm_Flipselector_Item as data) or
23457     * @c NULL on errors.
23458     *
23459     * This list is @b not to be modified in any way and must not be
23460     * freed. Use the list members with functions like
23461     * elm_flipselector_item_label_set(),
23462     * elm_flipselector_item_label_get(),
23463     * elm_flipselector_item_del(),
23464     * elm_flipselector_item_selected_get(),
23465     * elm_flipselector_item_selected_set().
23466     *
23467     * @warning This list is only valid until @p obj object's internal
23468     * items list is changed. It should be fetched again with another
23469     * call to this function when changes happen.
23470     *
23471     * @ingroup Flipselector
23472     */
23473    EAPI const Eina_List           *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23474
23475    /**
23476     * Get the first item in the given flip selector widget's list of
23477     * items.
23478     *
23479     * @param obj The flipselector object
23480     * @return The first item or @c NULL, if it has no items (and on
23481     * errors)
23482     *
23483     * @see elm_flipselector_item_append()
23484     * @see elm_flipselector_last_item_get()
23485     *
23486     * @ingroup Flipselector
23487     */
23488    EAPI Elm_Flipselector_Item     *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23489
23490    /**
23491     * Get the last item in the given flip selector widget's list of
23492     * items.
23493     *
23494     * @param obj The flipselector object
23495     * @return The last item or @c NULL, if it has no items (and on
23496     * errors)
23497     *
23498     * @see elm_flipselector_item_prepend()
23499     * @see elm_flipselector_first_item_get()
23500     *
23501     * @ingroup Flipselector
23502     */
23503    EAPI Elm_Flipselector_Item     *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23504
23505    /**
23506     * Get the currently selected item in a flip selector widget.
23507     *
23508     * @param obj The flipselector object
23509     * @return The selected item or @c NULL, if the widget has no items
23510     * (and on erros)
23511     *
23512     * @ingroup Flipselector
23513     */
23514    EAPI Elm_Flipselector_Item     *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23515
23516    /**
23517     * Set whether a given flip selector widget's item should be the
23518     * currently selected one.
23519     *
23520     * @param item The flip selector item
23521     * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
23522     *
23523     * This sets whether @p item is or not the selected (thus, under
23524     * display) one. If @p item is different than one under display,
23525     * the latter will be unselected. If the @p item is set to be
23526     * unselected, on the other hand, the @b first item in the widget's
23527     * internal members list will be the new selected one.
23528     *
23529     * @see elm_flipselector_item_selected_get()
23530     *
23531     * @ingroup Flipselector
23532     */
23533    EAPI void                       elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
23534
23535    /**
23536     * Get whether a given flip selector widget's item is the currently
23537     * selected one.
23538     *
23539     * @param item The flip selector item
23540     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
23541     * (or on errors).
23542     *
23543     * @see elm_flipselector_item_selected_set()
23544     *
23545     * @ingroup Flipselector
23546     */
23547    EAPI Eina_Bool                  elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23548
23549    /**
23550     * Delete a given item from a flip selector widget.
23551     *
23552     * @param item The item to delete
23553     *
23554     * @ingroup Flipselector
23555     */
23556    EAPI void                       elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23557
23558    /**
23559     * Get the label of a given flip selector widget's item.
23560     *
23561     * @param item The item to get label from
23562     * @return The text label of @p item or @c NULL, on errors
23563     *
23564     * @see elm_flipselector_item_label_set()
23565     *
23566     * @ingroup Flipselector
23567     */
23568    EAPI const char                *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23569
23570    /**
23571     * Set the label of a given flip selector widget's item.
23572     *
23573     * @param item The item to set label on
23574     * @param label The text label string, in UTF-8 encoding
23575     *
23576     * @see elm_flipselector_item_label_get()
23577     *
23578     * @ingroup Flipselector
23579     */
23580    EAPI void                       elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
23581
23582    /**
23583     * Gets the item before @p item in a flip selector widget's
23584     * internal list of items.
23585     *
23586     * @param item The item to fetch previous from
23587     * @return The item before the @p item, in its parent's list. If
23588     *         there is no previous item for @p item or there's an
23589     *         error, @c NULL is returned.
23590     *
23591     * @see elm_flipselector_item_next_get()
23592     *
23593     * @ingroup Flipselector
23594     */
23595    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23596
23597    /**
23598     * Gets the item after @p item in a flip selector widget's
23599     * internal list of items.
23600     *
23601     * @param item The item to fetch next from
23602     * @return The item after the @p item, in its parent's list. If
23603     *         there is no next item for @p item or there's an
23604     *         error, @c NULL is returned.
23605     *
23606     * @see elm_flipselector_item_next_get()
23607     *
23608     * @ingroup Flipselector
23609     */
23610    EAPI Elm_Flipselector_Item     *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23611
23612    /**
23613     * Set the interval on time updates for an user mouse button hold
23614     * on a flip selector widget.
23615     *
23616     * @param obj The flip selector object
23617     * @param interval The (first) interval value in seconds
23618     *
23619     * This interval value is @b decreased while the user holds the
23620     * mouse pointer either flipping up or flipping doww a given flip
23621     * selector.
23622     *
23623     * This helps the user to get to a given item distant from the
23624     * current one easier/faster, as it will start to flip quicker and
23625     * quicker on mouse button holds.
23626     *
23627     * The calculation for the next flip interval value, starting from
23628     * the one set with this call, is the previous interval divided by
23629     * 1.05, so it decreases a little bit.
23630     *
23631     * The default starting interval value for automatic flips is
23632     * @b 0.85 seconds.
23633     *
23634     * @see elm_flipselector_interval_get()
23635     *
23636     * @ingroup Flipselector
23637     */
23638    EAPI void                       elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
23639
23640    /**
23641     * Get the interval on time updates for an user mouse button hold
23642     * on a flip selector widget.
23643     *
23644     * @param obj The flip selector object
23645     * @return The (first) interval value, in seconds, set on it
23646     *
23647     * @see elm_flipselector_interval_set() for more details
23648     *
23649     * @ingroup Flipselector
23650     */
23651    EAPI double                     elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23652    /**
23653     * @}
23654     */
23655
23656    /**
23657     * @addtogroup Calendar
23658     * @{
23659     */
23660
23661    /**
23662     * @enum _Elm_Calendar_Mark_Repeat
23663     * @typedef Elm_Calendar_Mark_Repeat
23664     *
23665     * Event periodicity, used to define if a mark should be repeated
23666     * @b beyond event's day. It's set when a mark is added.
23667     *
23668     * So, for a mark added to 13th May with periodicity set to WEEKLY,
23669     * there will be marks every week after this date. Marks will be displayed
23670     * at 13th, 20th, 27th, 3rd June ...
23671     *
23672     * Values don't work as bitmask, only one can be choosen.
23673     *
23674     * @see elm_calendar_mark_add()
23675     *
23676     * @ingroup Calendar
23677     */
23678    typedef enum _Elm_Calendar_Mark_Repeat
23679      {
23680         ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
23681         ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
23682         ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
23683         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*/
23684         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. */
23685      } Elm_Calendar_Mark_Repeat;
23686
23687    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(). */
23688
23689    /**
23690     * Add a new calendar widget to the given parent Elementary
23691     * (container) object.
23692     *
23693     * @param parent The parent object.
23694     * @return a new calendar widget handle or @c NULL, on errors.
23695     *
23696     * This function inserts a new calendar widget on the canvas.
23697     *
23698     * @ref calendar_example_01
23699     *
23700     * @ingroup Calendar
23701     */
23702    EAPI Evas_Object       *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23703
23704    /**
23705     * Get weekdays names displayed by the calendar.
23706     *
23707     * @param obj The calendar object.
23708     * @return Array of seven strings to be used as weekday names.
23709     *
23710     * By default, weekdays abbreviations get from system are displayed:
23711     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
23712     * The first string is related to Sunday, the second to Monday...
23713     *
23714     * @see elm_calendar_weekdays_name_set()
23715     *
23716     * @ref calendar_example_05
23717     *
23718     * @ingroup Calendar
23719     */
23720    EAPI const char       **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23721
23722    /**
23723     * Set weekdays names to be displayed by the calendar.
23724     *
23725     * @param obj The calendar object.
23726     * @param weekdays Array of seven strings to be used as weekday names.
23727     * @warning It must have 7 elements, or it will access invalid memory.
23728     * @warning The strings must be NULL terminated ('@\0').
23729     *
23730     * By default, weekdays abbreviations get from system are displayed:
23731     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
23732     *
23733     * The first string should be related to Sunday, the second to Monday...
23734     *
23735     * The usage should be like this:
23736     * @code
23737     *   const char *weekdays[] =
23738     *   {
23739     *      "Sunday", "Monday", "Tuesday", "Wednesday",
23740     *      "Thursday", "Friday", "Saturday"
23741     *   };
23742     *   elm_calendar_weekdays_names_set(calendar, weekdays);
23743     * @endcode
23744     *
23745     * @see elm_calendar_weekdays_name_get()
23746     *
23747     * @ref calendar_example_02
23748     *
23749     * @ingroup Calendar
23750     */
23751    EAPI void               elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
23752
23753    /**
23754     * Set the minimum and maximum values for the year
23755     *
23756     * @param obj The calendar object
23757     * @param min The minimum year, greater than 1901;
23758     * @param max The maximum year;
23759     *
23760     * Maximum must be greater than minimum, except if you don't wan't to set
23761     * maximum year.
23762     * Default values are 1902 and -1.
23763     *
23764     * If the maximum year is a negative value, it will be limited depending
23765     * on the platform architecture (year 2037 for 32 bits);
23766     *
23767     * @see elm_calendar_min_max_year_get()
23768     *
23769     * @ref calendar_example_03
23770     *
23771     * @ingroup Calendar
23772     */
23773    EAPI void               elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
23774
23775    /**
23776     * Get the minimum and maximum values for the year
23777     *
23778     * @param obj The calendar object.
23779     * @param min The minimum year.
23780     * @param max The maximum year.
23781     *
23782     * Default values are 1902 and -1.
23783     *
23784     * @see elm_calendar_min_max_year_get() for more details.
23785     *
23786     * @ref calendar_example_05
23787     *
23788     * @ingroup Calendar
23789     */
23790    EAPI void               elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
23791
23792    /**
23793     * Enable or disable day selection
23794     *
23795     * @param obj The calendar object.
23796     * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
23797     * disable it.
23798     *
23799     * Enabled by default. If disabled, the user still can select months,
23800     * but not days. Selected days are highlighted on calendar.
23801     * It should be used if you won't need such selection for the widget usage.
23802     *
23803     * When a day is selected, or month is changed, smart callbacks for
23804     * signal "changed" will be called.
23805     *
23806     * @see elm_calendar_day_selection_enable_get()
23807     *
23808     * @ref calendar_example_04
23809     *
23810     * @ingroup Calendar
23811     */
23812    EAPI void               elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23813
23814    /**
23815     * Get a value whether day selection is enabled or not.
23816     *
23817     * @see elm_calendar_day_selection_enable_set() for details.
23818     *
23819     * @param obj The calendar object.
23820     * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
23821     * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
23822     *
23823     * @ref calendar_example_05
23824     *
23825     * @ingroup Calendar
23826     */
23827    EAPI Eina_Bool          elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23828
23829
23830    /**
23831     * Set selected date to be highlighted on calendar.
23832     *
23833     * @param obj The calendar object.
23834     * @param selected_time A @b tm struct to represent the selected date.
23835     *
23836     * Set the selected date, changing the displayed month if needed.
23837     * Selected date changes when the user goes to next/previous month or
23838     * select a day pressing over it on calendar.
23839     *
23840     * @see elm_calendar_selected_time_get()
23841     *
23842     * @ref calendar_example_04
23843     *
23844     * @ingroup Calendar
23845     */
23846    EAPI void               elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
23847
23848    /**
23849     * Get selected date.
23850     *
23851     * @param obj The calendar object
23852     * @param selected_time A @b tm struct to point to selected date
23853     * @return EINA_FALSE means an error ocurred and returned time shouldn't
23854     * be considered.
23855     *
23856     * Get date selected by the user or set by function
23857     * elm_calendar_selected_time_set().
23858     * Selected date changes when the user goes to next/previous month or
23859     * select a day pressing over it on calendar.
23860     *
23861     * @see elm_calendar_selected_time_get()
23862     *
23863     * @ref calendar_example_05
23864     *
23865     * @ingroup Calendar
23866     */
23867    EAPI Eina_Bool          elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
23868
23869    /**
23870     * Set a function to format the string that will be used to display
23871     * month and year;
23872     *
23873     * @param obj The calendar object
23874     * @param format_function Function to set the month-year string given
23875     * the selected date
23876     *
23877     * By default it uses strftime with "%B %Y" format string.
23878     * It should allocate the memory that will be used by the string,
23879     * that will be freed by the widget after usage.
23880     * A pointer to the string and a pointer to the time struct will be provided.
23881     *
23882     * Example:
23883     * @code
23884     * static char *
23885     * _format_month_year(struct tm *selected_time)
23886     * {
23887     *    char buf[32];
23888     *    if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
23889     *    return strdup(buf);
23890     * }
23891     *
23892     * elm_calendar_format_function_set(calendar, _format_month_year);
23893     * @endcode
23894     *
23895     * @ref calendar_example_02
23896     *
23897     * @ingroup Calendar
23898     */
23899    EAPI void               elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
23900
23901    /**
23902     * Add a new mark to the calendar
23903     *
23904     * @param obj The calendar object
23905     * @param mark_type A string used to define the type of mark. It will be
23906     * emitted to the theme, that should display a related modification on these
23907     * days representation.
23908     * @param mark_time A time struct to represent the date of inclusion of the
23909     * mark. For marks that repeats it will just be displayed after the inclusion
23910     * date in the calendar.
23911     * @param repeat Repeat the event following this periodicity. Can be a unique
23912     * mark (that don't repeat), daily, weekly, monthly or annually.
23913     * @return The created mark or @p NULL upon failure.
23914     *
23915     * Add a mark that will be drawn in the calendar respecting the insertion
23916     * time and periodicity. It will emit the type as signal to the widget theme.
23917     * Default theme supports "holiday" and "checked", but it can be extended.
23918     *
23919     * It won't immediately update the calendar, drawing the marks.
23920     * For this, call elm_calendar_marks_draw(). However, when user selects
23921     * next or previous month calendar forces marks drawn.
23922     *
23923     * Marks created with this method can be deleted with
23924     * elm_calendar_mark_del().
23925     *
23926     * Example
23927     * @code
23928     * struct tm selected_time;
23929     * time_t current_time;
23930     *
23931     * current_time = time(NULL) + 5 * 84600;
23932     * localtime_r(&current_time, &selected_time);
23933     * elm_calendar_mark_add(cal, "holiday", selected_time,
23934     *     ELM_CALENDAR_ANNUALLY);
23935     *
23936     * current_time = time(NULL) + 1 * 84600;
23937     * localtime_r(&current_time, &selected_time);
23938     * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
23939     *
23940     * elm_calendar_marks_draw(cal);
23941     * @endcode
23942     *
23943     * @see elm_calendar_marks_draw()
23944     * @see elm_calendar_mark_del()
23945     *
23946     * @ref calendar_example_06
23947     *
23948     * @ingroup Calendar
23949     */
23950    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);
23951
23952    /**
23953     * Delete mark from the calendar.
23954     *
23955     * @param mark The mark to be deleted.
23956     *
23957     * If deleting all calendar marks is required, elm_calendar_marks_clear()
23958     * should be used instead of getting marks list and deleting each one.
23959     *
23960     * @see elm_calendar_mark_add()
23961     *
23962     * @ref calendar_example_06
23963     *
23964     * @ingroup Calendar
23965     */
23966    EAPI void               elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
23967
23968    /**
23969     * Remove all calendar's marks
23970     *
23971     * @param obj The calendar object.
23972     *
23973     * @see elm_calendar_mark_add()
23974     * @see elm_calendar_mark_del()
23975     *
23976     * @ingroup Calendar
23977     */
23978    EAPI void               elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
23979
23980
23981    /**
23982     * Get a list of all the calendar marks.
23983     *
23984     * @param obj The calendar object.
23985     * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
23986     *
23987     * @see elm_calendar_mark_add()
23988     * @see elm_calendar_mark_del()
23989     * @see elm_calendar_marks_clear()
23990     *
23991     * @ingroup Calendar
23992     */
23993    EAPI const Eina_List   *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23994
23995    /**
23996     * Draw calendar marks.
23997     *
23998     * @param obj The calendar object.
23999     *
24000     * Should be used after adding, removing or clearing marks.
24001     * It will go through the entire marks list updating the calendar.
24002     * If lots of marks will be added, add all the marks and then call
24003     * this function.
24004     *
24005     * When the month is changed, i.e. user selects next or previous month,
24006     * marks will be drawed.
24007     *
24008     * @see elm_calendar_mark_add()
24009     * @see elm_calendar_mark_del()
24010     * @see elm_calendar_marks_clear()
24011     *
24012     * @ref calendar_example_06
24013     *
24014     * @ingroup Calendar
24015     */
24016    EAPI void               elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
24017
24018    /**
24019     * Set a day text color to the same that represents Saturdays.
24020     *
24021     * @param obj The calendar object.
24022     * @param pos The text position. Position is the cell counter, from left
24023     * to right, up to down. It starts on 0 and ends on 41.
24024     *
24025     * @deprecated use elm_calendar_mark_add() instead like:
24026     *
24027     * @code
24028     * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
24029     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
24030     * @endcode
24031     *
24032     * @see elm_calendar_mark_add()
24033     *
24034     * @ingroup Calendar
24035     */
24036    EINA_DEPRECATED EAPI void               elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24037
24038    /**
24039     * Set a day text color to the same that represents Sundays.
24040     *
24041     * @param obj The calendar object.
24042     * @param pos The text position. Position is the cell counter, from left
24043     * to right, up to down. It starts on 0 and ends on 41.
24044
24045     * @deprecated use elm_calendar_mark_add() instead like:
24046     *
24047     * @code
24048     * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
24049     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
24050     * @endcode
24051     *
24052     * @see elm_calendar_mark_add()
24053     *
24054     * @ingroup Calendar
24055     */
24056    EINA_DEPRECATED EAPI void               elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24057
24058    /**
24059     * Set a day text color to the same that represents Weekdays.
24060     *
24061     * @param obj The calendar object
24062     * @param pos The text position. Position is the cell counter, from left
24063     * to right, up to down. It starts on 0 and ends on 41.
24064     *
24065     * @deprecated use elm_calendar_mark_add() instead like:
24066     *
24067     * @code
24068     * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
24069     *
24070     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
24071     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
24072     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
24073     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
24074     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
24075     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
24076     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
24077     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
24078     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
24079     * @endcode
24080     *
24081     * @see elm_calendar_mark_add()
24082     *
24083     * @ingroup Calendar
24084     */
24085    EINA_DEPRECATED EAPI void               elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24086
24087    /**
24088     * Set the interval on time updates for an user mouse button hold
24089     * on calendar widgets' month selection.
24090     *
24091     * @param obj The calendar object
24092     * @param interval The (first) interval value in seconds
24093     *
24094     * This interval value is @b decreased while the user holds the
24095     * mouse pointer either selecting next or previous month.
24096     *
24097     * This helps the user to get to a given month distant from the
24098     * current one easier/faster, as it will start to change quicker and
24099     * quicker on mouse button holds.
24100     *
24101     * The calculation for the next change interval value, starting from
24102     * the one set with this call, is the previous interval divided by
24103     * 1.05, so it decreases a little bit.
24104     *
24105     * The default starting interval value for automatic changes is
24106     * @b 0.85 seconds.
24107     *
24108     * @see elm_calendar_interval_get()
24109     *
24110     * @ingroup Calendar
24111     */
24112    EAPI void               elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
24113
24114    /**
24115     * Get the interval on time updates for an user mouse button hold
24116     * on calendar widgets' month selection.
24117     *
24118     * @param obj The calendar object
24119     * @return The (first) interval value, in seconds, set on it
24120     *
24121     * @see elm_calendar_interval_set() for more details
24122     *
24123     * @ingroup Calendar
24124     */
24125    EAPI double             elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24126
24127    /**
24128     * @}
24129     */
24130
24131    /**
24132     * @defgroup Diskselector Diskselector
24133     * @ingroup Elementary
24134     *
24135     * @image html img/widget/diskselector/preview-00.png
24136     * @image latex img/widget/diskselector/preview-00.eps
24137     *
24138     * A diskselector is a kind of list widget. It scrolls horizontally,
24139     * and can contain label and icon objects. Three items are displayed
24140     * with the selected one in the middle.
24141     *
24142     * It can act like a circular list with round mode and labels can be
24143     * reduced for a defined length for side items.
24144     *
24145     * Smart callbacks one can listen to:
24146     * - "selected" - when item is selected, i.e. scroller stops.
24147     *
24148     * Available styles for it:
24149     * - @c "default"
24150     *
24151     * List of examples:
24152     * @li @ref diskselector_example_01
24153     * @li @ref diskselector_example_02
24154     */
24155
24156    /**
24157     * @addtogroup Diskselector
24158     * @{
24159     */
24160
24161    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(). */
24162
24163    /**
24164     * Add a new diskselector widget to the given parent Elementary
24165     * (container) object.
24166     *
24167     * @param parent The parent object.
24168     * @return a new diskselector widget handle or @c NULL, on errors.
24169     *
24170     * This function inserts a new diskselector widget on the canvas.
24171     *
24172     * @ingroup Diskselector
24173     */
24174    EAPI Evas_Object           *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24175
24176    /**
24177     * Enable or disable round mode.
24178     *
24179     * @param obj The diskselector object.
24180     * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
24181     * disable it.
24182     *
24183     * Disabled by default. If round mode is enabled the items list will
24184     * work like a circle list, so when the user reaches the last item,
24185     * the first one will popup.
24186     *
24187     * @see elm_diskselector_round_get()
24188     *
24189     * @ingroup Diskselector
24190     */
24191    EAPI void                   elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
24192
24193    /**
24194     * Get a value whether round mode is enabled or not.
24195     *
24196     * @see elm_diskselector_round_set() for details.
24197     *
24198     * @param obj The diskselector object.
24199     * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
24200     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24201     *
24202     * @ingroup Diskselector
24203     */
24204    EAPI Eina_Bool              elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24205
24206    /**
24207     * Get the side labels max length.
24208     *
24209     * @deprecated use elm_diskselector_side_label_length_get() instead:
24210     *
24211     * @param obj The diskselector object.
24212     * @return The max length defined for side labels, or 0 if not a valid
24213     * diskselector.
24214     *
24215     * @ingroup Diskselector
24216     */
24217    EINA_DEPRECATED EAPI int    elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24218
24219    /**
24220     * Set the side labels max length.
24221     *
24222     * @deprecated use elm_diskselector_side_label_length_set() instead:
24223     *
24224     * @param obj The diskselector object.
24225     * @param len The max length defined for side labels.
24226     *
24227     * @ingroup Diskselector
24228     */
24229    EINA_DEPRECATED EAPI void   elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
24230
24231    /**
24232     * Get the side labels max length.
24233     *
24234     * @see elm_diskselector_side_label_length_set() for details.
24235     *
24236     * @param obj The diskselector object.
24237     * @return The max length defined for side labels, or 0 if not a valid
24238     * diskselector.
24239     *
24240     * @ingroup Diskselector
24241     */
24242    EAPI int                    elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24243
24244    /**
24245     * Set the side labels max length.
24246     *
24247     * @param obj The diskselector object.
24248     * @param len The max length defined for side labels.
24249     *
24250     * Length is the number of characters of items' label that will be
24251     * visible when it's set on side positions. It will just crop
24252     * the string after defined size. E.g.:
24253     *
24254     * An item with label "January" would be displayed on side position as
24255     * "Jan" if max length is set to 3, or "Janu", if this property
24256     * is set to 4.
24257     *
24258     * When it's selected, the entire label will be displayed, except for
24259     * width restrictions. In this case label will be cropped and "..."
24260     * will be concatenated.
24261     *
24262     * Default side label max length is 3.
24263     *
24264     * This property will be applyed over all items, included before or
24265     * later this function call.
24266     *
24267     * @ingroup Diskselector
24268     */
24269    EAPI void                   elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
24270
24271    /**
24272     * Set the number of items to be displayed.
24273     *
24274     * @param obj The diskselector object.
24275     * @param num The number of items the diskselector will display.
24276     *
24277     * Default value is 3, and also it's the minimun. If @p num is less
24278     * than 3, it will be set to 3.
24279     *
24280     * Also, it can be set on theme, using data item @c display_item_num
24281     * on group "elm/diskselector/item/X", where X is style set.
24282     * E.g.:
24283     *
24284     * group { name: "elm/diskselector/item/X";
24285     * data {
24286     *     item: "display_item_num" "5";
24287     *     }
24288     *
24289     * @ingroup Diskselector
24290     */
24291    EAPI void                   elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
24292
24293    /**
24294     * Get the number of items in the diskselector object.
24295     *
24296     * @param obj The diskselector object.
24297     *
24298     * @ingroup Diskselector
24299     */
24300    EAPI int                   elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24301
24302    /**
24303     * Set bouncing behaviour when the scrolled content reaches an edge.
24304     *
24305     * Tell the internal scroller object whether it should bounce or not
24306     * when it reaches the respective edges for each axis.
24307     *
24308     * @param obj The diskselector object.
24309     * @param h_bounce Whether to bounce or not in the horizontal axis.
24310     * @param v_bounce Whether to bounce or not in the vertical axis.
24311     *
24312     * @see elm_scroller_bounce_set()
24313     *
24314     * @ingroup Diskselector
24315     */
24316    EAPI void                   elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24317
24318    /**
24319     * Get the bouncing behaviour of the internal scroller.
24320     *
24321     * Get whether the internal scroller should bounce when the edge of each
24322     * axis is reached scrolling.
24323     *
24324     * @param obj The diskselector object.
24325     * @param h_bounce Pointer where to store the bounce state of the horizontal
24326     * axis.
24327     * @param v_bounce Pointer where to store the bounce state of the vertical
24328     * axis.
24329     *
24330     * @see elm_scroller_bounce_get()
24331     * @see elm_diskselector_bounce_set()
24332     *
24333     * @ingroup Diskselector
24334     */
24335    EAPI void                   elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
24336
24337    /**
24338     * Get the scrollbar policy.
24339     *
24340     * @see elm_diskselector_scroller_policy_get() for details.
24341     *
24342     * @param obj The diskselector object.
24343     * @param policy_h Pointer where to store horizontal scrollbar policy.
24344     * @param policy_v Pointer where to store vertical scrollbar policy.
24345     *
24346     * @ingroup Diskselector
24347     */
24348    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);
24349
24350    /**
24351     * Set the scrollbar policy.
24352     *
24353     * @param obj The diskselector object.
24354     * @param policy_h Horizontal scrollbar policy.
24355     * @param policy_v Vertical scrollbar policy.
24356     *
24357     * This sets the scrollbar visibility policy for the given scroller.
24358     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
24359     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
24360     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
24361     * This applies respectively for the horizontal and vertical scrollbars.
24362     *
24363     * The both are disabled by default, i.e., are set to
24364     * #ELM_SCROLLER_POLICY_OFF.
24365     *
24366     * @ingroup Diskselector
24367     */
24368    EAPI void                   elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
24369
24370    /**
24371     * Remove all diskselector's items.
24372     *
24373     * @param obj The diskselector object.
24374     *
24375     * @see elm_diskselector_item_del()
24376     * @see elm_diskselector_item_append()
24377     *
24378     * @ingroup Diskselector
24379     */
24380    EAPI void                   elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24381
24382    /**
24383     * Get a list of all the diskselector items.
24384     *
24385     * @param obj The diskselector object.
24386     * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
24387     * or @c NULL on failure.
24388     *
24389     * @see elm_diskselector_item_append()
24390     * @see elm_diskselector_item_del()
24391     * @see elm_diskselector_clear()
24392     *
24393     * @ingroup Diskselector
24394     */
24395    EAPI const Eina_List       *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24396
24397    /**
24398     * Appends a new item to the diskselector object.
24399     *
24400     * @param obj The diskselector object.
24401     * @param label The label of the diskselector item.
24402     * @param icon The icon object to use at left side of the item. An
24403     * icon can be any Evas object, but usually it is an icon created
24404     * with elm_icon_add().
24405     * @param func The function to call when the item is selected.
24406     * @param data The data to associate with the item for related callbacks.
24407     *
24408     * @return The created item or @c NULL upon failure.
24409     *
24410     * A new item will be created and appended to the diskselector, i.e., will
24411     * be set as last item. Also, if there is no selected item, it will
24412     * be selected. This will always happens for the first appended item.
24413     *
24414     * If no icon is set, label will be centered on item position, otherwise
24415     * the icon will be placed at left of the label, that will be shifted
24416     * to the right.
24417     *
24418     * Items created with this method can be deleted with
24419     * elm_diskselector_item_del().
24420     *
24421     * Associated @p data can be properly freed when item is deleted if a
24422     * callback function is set with elm_diskselector_item_del_cb_set().
24423     *
24424     * If a function is passed as argument, it will be called everytime this item
24425     * is selected, i.e., the user stops the diskselector with this
24426     * item on center position. If such function isn't needed, just passing
24427     * @c NULL as @p func is enough. The same should be done for @p data.
24428     *
24429     * Simple example (with no function callback or data associated):
24430     * @code
24431     * disk = elm_diskselector_add(win);
24432     * ic = elm_icon_add(win);
24433     * elm_icon_file_set(ic, "path/to/image", NULL);
24434     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
24435     * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
24436     * @endcode
24437     *
24438     * @see elm_diskselector_item_del()
24439     * @see elm_diskselector_item_del_cb_set()
24440     * @see elm_diskselector_clear()
24441     * @see elm_icon_add()
24442     *
24443     * @ingroup Diskselector
24444     */
24445    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);
24446
24447
24448    /**
24449     * Delete them item from the diskselector.
24450     *
24451     * @param it The item of diskselector to be deleted.
24452     *
24453     * If deleting all diskselector items is required, elm_diskselector_clear()
24454     * should be used instead of getting items list and deleting each one.
24455     *
24456     * @see elm_diskselector_clear()
24457     * @see elm_diskselector_item_append()
24458     * @see elm_diskselector_item_del_cb_set()
24459     *
24460     * @ingroup Diskselector
24461     */
24462    EAPI void                   elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24463
24464    /**
24465     * Set the function called when a diskselector item is freed.
24466     *
24467     * @param it The item to set the callback on
24468     * @param func The function called
24469     *
24470     * If there is a @p func, then it will be called prior item's memory release.
24471     * That will be called with the following arguments:
24472     * @li item's data;
24473     * @li item's Evas object;
24474     * @li item itself;
24475     *
24476     * This way, a data associated to a diskselector item could be properly
24477     * freed.
24478     *
24479     * @ingroup Diskselector
24480     */
24481    EAPI void                   elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
24482
24483    /**
24484     * Get the data associated to the item.
24485     *
24486     * @param it The diskselector item
24487     * @return The data associated to @p it
24488     *
24489     * The return value is a pointer to data associated to @p item when it was
24490     * created, with function elm_diskselector_item_append(). If no data
24491     * was passed as argument, it will return @c NULL.
24492     *
24493     * @see elm_diskselector_item_append()
24494     *
24495     * @ingroup Diskselector
24496     */
24497    EAPI void                  *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24498
24499    /**
24500     * Set the icon associated to the item.
24501     *
24502     * @param it The diskselector item
24503     * @param icon The icon object to associate with @p it
24504     *
24505     * The icon object to use at left side of the item. An
24506     * icon can be any Evas object, but usually it is an icon created
24507     * with elm_icon_add().
24508     *
24509     * Once the icon object is set, a previously set one will be deleted.
24510     * @warning Setting the same icon for two items will cause the icon to
24511     * dissapear from the first item.
24512     *
24513     * If an icon was passed as argument on item creation, with function
24514     * elm_diskselector_item_append(), it will be already
24515     * associated to the item.
24516     *
24517     * @see elm_diskselector_item_append()
24518     * @see elm_diskselector_item_icon_get()
24519     *
24520     * @ingroup Diskselector
24521     */
24522    EAPI void                   elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
24523
24524    /**
24525     * Get the icon associated to the item.
24526     *
24527     * @param it The diskselector item
24528     * @return The icon associated to @p it
24529     *
24530     * The return value is a pointer to the icon associated to @p item when it was
24531     * created, with function elm_diskselector_item_append(), or later
24532     * with function elm_diskselector_item_icon_set. If no icon
24533     * was passed as argument, it will return @c NULL.
24534     *
24535     * @see elm_diskselector_item_append()
24536     * @see elm_diskselector_item_icon_set()
24537     *
24538     * @ingroup Diskselector
24539     */
24540    EAPI Evas_Object           *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24541
24542    /**
24543     * Set the label of item.
24544     *
24545     * @param it The item of diskselector.
24546     * @param label The label of item.
24547     *
24548     * The label to be displayed by the item.
24549     *
24550     * If no icon is set, label will be centered on item position, otherwise
24551     * the icon will be placed at left of the label, that will be shifted
24552     * to the right.
24553     *
24554     * An item with label "January" would be displayed on side position as
24555     * "Jan" if max length is set to 3 with function
24556     * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
24557     * is set to 4.
24558     *
24559     * When this @p item is selected, the entire label will be displayed,
24560     * except for width restrictions.
24561     * In this case label will be cropped and "..." will be concatenated,
24562     * but only for display purposes. It will keep the entire string, so
24563     * if diskselector is resized the remaining characters will be displayed.
24564     *
24565     * If a label was passed as argument on item creation, with function
24566     * elm_diskselector_item_append(), it will be already
24567     * displayed by the item.
24568     *
24569     * @see elm_diskselector_side_label_lenght_set()
24570     * @see elm_diskselector_item_label_get()
24571     * @see elm_diskselector_item_append()
24572     *
24573     * @ingroup Diskselector
24574     */
24575    EAPI void                   elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
24576
24577    /**
24578     * Get the label of item.
24579     *
24580     * @param it The item of diskselector.
24581     * @return The label of item.
24582     *
24583     * The return value is a pointer to the label associated to @p item when it was
24584     * created, with function elm_diskselector_item_append(), or later
24585     * with function elm_diskselector_item_label_set. If no label
24586     * was passed as argument, it will return @c NULL.
24587     *
24588     * @see elm_diskselector_item_label_set() for more details.
24589     * @see elm_diskselector_item_append()
24590     *
24591     * @ingroup Diskselector
24592     */
24593    EAPI const char            *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24594
24595    /**
24596     * Get the selected item.
24597     *
24598     * @param obj The diskselector object.
24599     * @return The selected diskselector item.
24600     *
24601     * The selected item can be unselected with function
24602     * elm_diskselector_item_selected_set(), and the first item of
24603     * diskselector will be selected.
24604     *
24605     * The selected item always will be centered on diskselector, with
24606     * full label displayed, i.e., max lenght set to side labels won't
24607     * apply on the selected item. More details on
24608     * elm_diskselector_side_label_length_set().
24609     *
24610     * @ingroup Diskselector
24611     */
24612    EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24613
24614    /**
24615     * Set the selected state of an item.
24616     *
24617     * @param it The diskselector item
24618     * @param selected The selected state
24619     *
24620     * This sets the selected state of the given item @p it.
24621     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
24622     *
24623     * If a new item is selected the previosly selected will be unselected.
24624     * Previoulsy selected item can be get with function
24625     * elm_diskselector_selected_item_get().
24626     *
24627     * If the item @p it is unselected, the first item of diskselector will
24628     * be selected.
24629     *
24630     * Selected items will be visible on center position of diskselector.
24631     * So if it was on another position before selected, or was invisible,
24632     * diskselector will animate items until the selected item reaches center
24633     * position.
24634     *
24635     * @see elm_diskselector_item_selected_get()
24636     * @see elm_diskselector_selected_item_get()
24637     *
24638     * @ingroup Diskselector
24639     */
24640    EAPI void                   elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
24641
24642    /*
24643     * Get whether the @p item is selected or not.
24644     *
24645     * @param it The diskselector item.
24646     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
24647     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
24648     *
24649     * @see elm_diskselector_selected_item_set() for details.
24650     * @see elm_diskselector_item_selected_get()
24651     *
24652     * @ingroup Diskselector
24653     */
24654    EAPI Eina_Bool              elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24655
24656    /**
24657     * Get the first item of the diskselector.
24658     *
24659     * @param obj The diskselector object.
24660     * @return The first item, or @c NULL if none.
24661     *
24662     * The list of items follows append order. So it will return the first
24663     * item appended to the widget that wasn't deleted.
24664     *
24665     * @see elm_diskselector_item_append()
24666     * @see elm_diskselector_items_get()
24667     *
24668     * @ingroup Diskselector
24669     */
24670    EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24671
24672    /**
24673     * Get the last item of the diskselector.
24674     *
24675     * @param obj The diskselector object.
24676     * @return The last item, or @c NULL if none.
24677     *
24678     * The list of items follows append order. So it will return last first
24679     * item appended to the widget that wasn't deleted.
24680     *
24681     * @see elm_diskselector_item_append()
24682     * @see elm_diskselector_items_get()
24683     *
24684     * @ingroup Diskselector
24685     */
24686    EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24687
24688    /**
24689     * Get the item before @p item in diskselector.
24690     *
24691     * @param it The diskselector item.
24692     * @return The item before @p item, or @c NULL if none or on failure.
24693     *
24694     * The list of items follows append order. So it will return item appended
24695     * just before @p item and that wasn't deleted.
24696     *
24697     * If it is the first item, @c NULL will be returned.
24698     * First item can be get by elm_diskselector_first_item_get().
24699     *
24700     * @see elm_diskselector_item_append()
24701     * @see elm_diskselector_items_get()
24702     *
24703     * @ingroup Diskselector
24704     */
24705    EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24706
24707    /**
24708     * Get the item after @p item in diskselector.
24709     *
24710     * @param it The diskselector item.
24711     * @return The item after @p item, or @c NULL if none or on failure.
24712     *
24713     * The list of items follows append order. So it will return item appended
24714     * just after @p item and that wasn't deleted.
24715     *
24716     * If it is the last item, @c NULL will be returned.
24717     * Last item can be get by elm_diskselector_last_item_get().
24718     *
24719     * @see elm_diskselector_item_append()
24720     * @see elm_diskselector_items_get()
24721     *
24722     * @ingroup Diskselector
24723     */
24724    EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24725
24726    /**
24727     * Set the text to be shown in the diskselector item.
24728     *
24729     * @param item Target item
24730     * @param text The text to set in the content
24731     *
24732     * Setup the text as tooltip to object. The item can have only one tooltip,
24733     * so any previous tooltip data is removed.
24734     *
24735     * @see elm_object_tooltip_text_set() for more details.
24736     *
24737     * @ingroup Diskselector
24738     */
24739    EAPI void                   elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
24740
24741    /**
24742     * Set the content to be shown in the tooltip item.
24743     *
24744     * Setup the tooltip to item. The item can have only one tooltip,
24745     * so any previous tooltip data is removed. @p func(with @p data) will
24746     * be called every time that need show the tooltip and it should
24747     * return a valid Evas_Object. This object is then managed fully by
24748     * tooltip system and is deleted when the tooltip is gone.
24749     *
24750     * @param item the diskselector item being attached a tooltip.
24751     * @param func the function used to create the tooltip contents.
24752     * @param data what to provide to @a func as callback data/context.
24753     * @param del_cb called when data is not needed anymore, either when
24754     *        another callback replaces @p func, the tooltip is unset with
24755     *        elm_diskselector_item_tooltip_unset() or the owner @a item
24756     *        dies. This callback receives as the first parameter the
24757     *        given @a data, and @c event_info is the item.
24758     *
24759     * @see elm_object_tooltip_content_cb_set() for more details.
24760     *
24761     * @ingroup Diskselector
24762     */
24763    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);
24764
24765    /**
24766     * Unset tooltip from item.
24767     *
24768     * @param item diskselector item to remove previously set tooltip.
24769     *
24770     * Remove tooltip from item. The callback provided as del_cb to
24771     * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
24772     * it is not used anymore.
24773     *
24774     * @see elm_object_tooltip_unset() for more details.
24775     * @see elm_diskselector_item_tooltip_content_cb_set()
24776     *
24777     * @ingroup Diskselector
24778     */
24779    EAPI void                   elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24780
24781
24782    /**
24783     * Sets a different style for this item tooltip.
24784     *
24785     * @note before you set a style you should define a tooltip with
24786     *       elm_diskselector_item_tooltip_content_cb_set() or
24787     *       elm_diskselector_item_tooltip_text_set()
24788     *
24789     * @param item diskselector item with tooltip already set.
24790     * @param style the theme style to use (default, transparent, ...)
24791     *
24792     * @see elm_object_tooltip_style_set() for more details.
24793     *
24794     * @ingroup Diskselector
24795     */
24796    EAPI void                   elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
24797
24798    /**
24799     * Get the style for this item tooltip.
24800     *
24801     * @param item diskselector item with tooltip already set.
24802     * @return style the theme style in use, defaults to "default". If the
24803     *         object does not have a tooltip set, then NULL is returned.
24804     *
24805     * @see elm_object_tooltip_style_get() for more details.
24806     * @see elm_diskselector_item_tooltip_style_set()
24807     *
24808     * @ingroup Diskselector
24809     */
24810    EAPI const char            *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24811
24812    /**
24813     * Set the cursor to be shown when mouse is over the diskselector item
24814     *
24815     * @param item Target item
24816     * @param cursor the cursor name to be used.
24817     *
24818     * @see elm_object_cursor_set() for more details.
24819     *
24820     * @ingroup Diskselector
24821     */
24822    EAPI void                   elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
24823
24824    /**
24825     * Get the cursor to be shown when mouse is over the diskselector item
24826     *
24827     * @param item diskselector item with cursor already set.
24828     * @return the cursor name.
24829     *
24830     * @see elm_object_cursor_get() for more details.
24831     * @see elm_diskselector_cursor_set()
24832     *
24833     * @ingroup Diskselector
24834     */
24835    EAPI const char            *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24836
24837
24838    /**
24839     * Unset the cursor to be shown when mouse is over the diskselector item
24840     *
24841     * @param item Target item
24842     *
24843     * @see elm_object_cursor_unset() for more details.
24844     * @see elm_diskselector_cursor_set()
24845     *
24846     * @ingroup Diskselector
24847     */
24848    EAPI void                   elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24849
24850    /**
24851     * Sets a different style for this item cursor.
24852     *
24853     * @note before you set a style you should define a cursor with
24854     *       elm_diskselector_item_cursor_set()
24855     *
24856     * @param item diskselector item with cursor already set.
24857     * @param style the theme style to use (default, transparent, ...)
24858     *
24859     * @see elm_object_cursor_style_set() for more details.
24860     *
24861     * @ingroup Diskselector
24862     */
24863    EAPI void                   elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
24864
24865
24866    /**
24867     * Get the style for this item cursor.
24868     *
24869     * @param item diskselector item with cursor already set.
24870     * @return style the theme style in use, defaults to "default". If the
24871     *         object does not have a cursor set, then @c NULL is returned.
24872     *
24873     * @see elm_object_cursor_style_get() for more details.
24874     * @see elm_diskselector_item_cursor_style_set()
24875     *
24876     * @ingroup Diskselector
24877     */
24878    EAPI const char            *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24879
24880
24881    /**
24882     * Set if the cursor set should be searched on the theme or should use
24883     * the provided by the engine, only.
24884     *
24885     * @note before you set if should look on theme you should define a cursor
24886     * with elm_diskselector_item_cursor_set().
24887     * By default it will only look for cursors provided by the engine.
24888     *
24889     * @param item widget item with cursor already set.
24890     * @param engine_only boolean to define if cursors set with
24891     * elm_diskselector_item_cursor_set() should be searched only
24892     * between cursors provided by the engine or searched on widget's
24893     * theme as well.
24894     *
24895     * @see elm_object_cursor_engine_only_set() for more details.
24896     *
24897     * @ingroup Diskselector
24898     */
24899    EAPI void                   elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
24900
24901    /**
24902     * Get the cursor engine only usage for this item cursor.
24903     *
24904     * @param item widget item with cursor already set.
24905     * @return engine_only boolean to define it cursors should be looked only
24906     * between the provided by the engine or searched on widget's theme as well.
24907     * If the item does not have a cursor set, then @c EINA_FALSE is returned.
24908     *
24909     * @see elm_object_cursor_engine_only_get() for more details.
24910     * @see elm_diskselector_item_cursor_engine_only_set()
24911     *
24912     * @ingroup Diskselector
24913     */
24914    EAPI Eina_Bool              elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24915
24916    /**
24917     * @}
24918     */
24919
24920    /**
24921     * @defgroup Colorselector Colorselector
24922     *
24923     * @{
24924     *
24925     * @image html img/widget/colorselector/preview-00.png
24926     * @image latex img/widget/colorselector/preview-00.eps
24927     *
24928     * @brief Widget for user to select a color.
24929     *
24930     * Signals that you can add callbacks for are:
24931     * "changed" - When the color value changes(event_info is NULL).
24932     *
24933     * See @ref tutorial_colorselector.
24934     */
24935    /**
24936     * @brief Add a new colorselector to the parent
24937     *
24938     * @param parent The parent object
24939     * @return The new object or NULL if it cannot be created
24940     *
24941     * @ingroup Colorselector
24942     */
24943    EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24944    /**
24945     * Set a color for the colorselector
24946     *
24947     * @param obj   Colorselector object
24948     * @param r     r-value of color
24949     * @param g     g-value of color
24950     * @param b     b-value of color
24951     * @param a     a-value of color
24952     *
24953     * @ingroup Colorselector
24954     */
24955    EAPI void         elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
24956    /**
24957     * Get a color from the colorselector
24958     *
24959     * @param obj   Colorselector object
24960     * @param r     integer pointer for r-value of color
24961     * @param g     integer pointer for g-value of color
24962     * @param b     integer pointer for b-value of color
24963     * @param a     integer pointer for a-value of color
24964     *
24965     * @ingroup Colorselector
24966     */
24967    EAPI void         elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
24968    /**
24969     * @}
24970     */
24971
24972    /**
24973     * @defgroup Ctxpopup Ctxpopup
24974     *
24975     * @image html img/widget/ctxpopup/preview-00.png
24976     * @image latex img/widget/ctxpopup/preview-00.eps
24977     *
24978     * @brief Context popup widet.
24979     *
24980     * A ctxpopup is a widget that, when shown, pops up a list of items.
24981     * It automatically chooses an area inside its parent object's view
24982     * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
24983     * optimally fit into it. In the default theme, it will also point an
24984     * arrow to it's top left position at the time one shows it. Ctxpopup
24985     * items have a label and/or an icon. It is intended for a small
24986     * number of items (hence the use of list, not genlist).
24987     *
24988     * @note Ctxpopup is a especialization of @ref Hover.
24989     *
24990     * Signals that you can add callbacks for are:
24991     * "dismissed" - the ctxpopup was dismissed
24992     *
24993     * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
24994     * @{
24995     */
24996    typedef enum _Elm_Ctxpopup_Direction
24997      {
24998         ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
24999                                           area */
25000         ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
25001                                            the clicked area */
25002         ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
25003                                           the clicked area */
25004         ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
25005                                         area */
25006         ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
25007      } Elm_Ctxpopup_Direction;
25008
25009    /**
25010     * @brief Add a new Ctxpopup object to the parent.
25011     *
25012     * @param parent Parent object
25013     * @return New object or @c NULL, if it cannot be created
25014     */
25015    EAPI Evas_Object  *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25016    /**
25017     * @brief Set the Ctxpopup's parent
25018     *
25019     * @param obj The ctxpopup object
25020     * @param area The parent to use
25021     *
25022     * Set the parent object.
25023     *
25024     * @note elm_ctxpopup_add() will automatically call this function
25025     * with its @c parent argument.
25026     *
25027     * @see elm_ctxpopup_add()
25028     * @see elm_hover_parent_set()
25029     */
25030    EAPI void          elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
25031    /**
25032     * @brief Get the Ctxpopup's parent
25033     *
25034     * @param obj The ctxpopup object
25035     *
25036     * @see elm_ctxpopup_hover_parent_set() for more information
25037     */
25038    EAPI Evas_Object  *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25039    /**
25040     * @brief Clear all items in the given ctxpopup object.
25041     *
25042     * @param obj Ctxpopup object
25043     */
25044    EAPI void          elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25045    /**
25046     * @brief Change the ctxpopup's orientation to horizontal or vertical.
25047     *
25048     * @param obj Ctxpopup object
25049     * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
25050     */
25051    EAPI void          elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
25052    /**
25053     * @brief Get the value of current ctxpopup object's orientation.
25054     *
25055     * @param obj Ctxpopup object
25056     * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
25057     *
25058     * @see elm_ctxpopup_horizontal_set()
25059     */
25060    EAPI Eina_Bool     elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25061    /**
25062     * @brief Add a new item to a ctxpopup object.
25063     *
25064     * @param obj Ctxpopup object
25065     * @param icon Icon to be set on new item
25066     * @param label The Label of the new item
25067     * @param func Convenience function called when item selected
25068     * @param data Data passed to @p func
25069     * @return A handle to the item added or @c NULL, on errors
25070     *
25071     * @warning Ctxpopup can't hold both an item list and a content at the same
25072     * time. When an item is added, any previous content will be removed.
25073     *
25074     * @see elm_ctxpopup_content_set()
25075     */
25076    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);
25077    /**
25078     * @brief Delete the given item in a ctxpopup object.
25079     *
25080     * @param it Ctxpopup item to be deleted
25081     *
25082     * @see elm_ctxpopup_item_append()
25083     */
25084    EAPI void          elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25085    /**
25086     * @brief Set the ctxpopup item's state as disabled or enabled.
25087     *
25088     * @param it Ctxpopup item to be enabled/disabled
25089     * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
25090     *
25091     * When disabled the item is greyed out to indicate it's state.
25092     */
25093    EAPI void          elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
25094    /**
25095     * @brief Get the ctxpopup item's disabled/enabled state.
25096     *
25097     * @param it Ctxpopup item to be enabled/disabled
25098     * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
25099     *
25100     * @see elm_ctxpopup_item_disabled_set()
25101     */
25102    EAPI Eina_Bool     elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25103    /**
25104     * @brief Get the icon object for the given ctxpopup item.
25105     *
25106     * @param it Ctxpopup item
25107     * @return icon object or @c NULL, if the item does not have icon or an error
25108     * occurred
25109     *
25110     * @see elm_ctxpopup_item_append()
25111     * @see elm_ctxpopup_item_icon_set()
25112     */
25113    EAPI Evas_Object  *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25114    /**
25115     * @brief Sets the side icon associated with the ctxpopup item
25116     *
25117     * @param it Ctxpopup item
25118     * @param icon Icon object to be set
25119     *
25120     * Once the icon object is set, a previously set one will be deleted.
25121     * @warning Setting the same icon for two items will cause the icon to
25122     * dissapear from the first item.
25123     *
25124     * @see elm_ctxpopup_item_append()
25125     */
25126    EAPI void          elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
25127    /**
25128     * @brief Get the label for the given ctxpopup item.
25129     *
25130     * @param it Ctxpopup item
25131     * @return label string or @c NULL, if the item does not have label or an
25132     * error occured
25133     *
25134     * @see elm_ctxpopup_item_append()
25135     * @see elm_ctxpopup_item_label_set()
25136     */
25137    EAPI const char   *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25138    /**
25139     * @brief (Re)set the label on the given ctxpopup item.
25140     *
25141     * @param it Ctxpopup item
25142     * @param label String to set as label
25143     */
25144    EAPI void          elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
25145    /**
25146     * @brief Set an elm widget as the content of the ctxpopup.
25147     *
25148     * @param obj Ctxpopup object
25149     * @param content Content to be swallowed
25150     *
25151     * If the content object is already set, a previous one will bedeleted. If
25152     * you want to keep that old content object, use the
25153     * elm_ctxpopup_content_unset() function.
25154     *
25155     * @deprecated use elm_object_content_set()
25156     *
25157     * @warning Ctxpopup can't hold both a item list and a content at the same
25158     * time. When a content is set, any previous items will be removed.
25159     */
25160    EINA_DEPRECATED EAPI void          elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
25161    /**
25162     * @brief Unset the ctxpopup content
25163     *
25164     * @param obj Ctxpopup object
25165     * @return The content that was being used
25166     *
25167     * Unparent and return the content object which was set for this widget.
25168     *
25169     * @deprecated use elm_object_content_unset()
25170     *
25171     * @see elm_ctxpopup_content_set()
25172     */
25173    EINA_DEPRECATED EAPI Evas_Object  *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25174    /**
25175     * @brief Set the direction priority of a ctxpopup.
25176     *
25177     * @param obj Ctxpopup object
25178     * @param first 1st priority of direction
25179     * @param second 2nd priority of direction
25180     * @param third 3th priority of direction
25181     * @param fourth 4th priority of direction
25182     *
25183     * This functions gives a chance to user to set the priority of ctxpopup
25184     * showing direction. This doesn't guarantee the ctxpopup will appear in the
25185     * requested direction.
25186     *
25187     * @see Elm_Ctxpopup_Direction
25188     */
25189    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);
25190    /**
25191     * @brief Get the direction priority of a ctxpopup.
25192     *
25193     * @param obj Ctxpopup object
25194     * @param first 1st priority of direction to be returned
25195     * @param second 2nd priority of direction to be returned
25196     * @param third 3th priority of direction to be returned
25197     * @param fourth 4th priority of direction to be returned
25198     *
25199     * @see elm_ctxpopup_direction_priority_set() for more information.
25200     */
25201    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);
25202
25203    /**
25204     * @brief Get the current direction of a ctxpopup.
25205     *
25206     * @param obj Ctxpopup object
25207     * @return current direction of a ctxpopup
25208     *
25209     * @warning Once the ctxpopup showed up, the direction would be determined
25210     */
25211    EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25212
25213    /**
25214     * @}
25215     */
25216
25217    /* transit */
25218    /**
25219     *
25220     * @defgroup Transit Transit
25221     * @ingroup Elementary
25222     *
25223     * Transit is designed to apply various animated transition effects to @c
25224     * Evas_Object, such like translation, rotation, etc. For using these
25225     * effects, create an @ref Elm_Transit and add the desired transition effects.
25226     *
25227     * Once the effects are added into transit, they will be automatically
25228     * managed (their callback will be called until the duration is ended, and
25229     * they will be deleted on completion).
25230     *
25231     * Example:
25232     * @code
25233     * Elm_Transit *trans = elm_transit_add();
25234     * elm_transit_object_add(trans, obj);
25235     * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
25236     * elm_transit_duration_set(transit, 1);
25237     * elm_transit_auto_reverse_set(transit, EINA_TRUE);
25238     * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
25239     * elm_transit_repeat_times_set(transit, 3);
25240     * @endcode
25241     *
25242     * Some transition effects are used to change the properties of objects. They
25243     * are:
25244     * @li @ref elm_transit_effect_translation_add
25245     * @li @ref elm_transit_effect_color_add
25246     * @li @ref elm_transit_effect_rotation_add
25247     * @li @ref elm_transit_effect_wipe_add
25248     * @li @ref elm_transit_effect_zoom_add
25249     * @li @ref elm_transit_effect_resizing_add
25250     *
25251     * Other transition effects are used to make one object disappear and another
25252     * object appear on its old place. These effects are:
25253     *
25254     * @li @ref elm_transit_effect_flip_add
25255     * @li @ref elm_transit_effect_resizable_flip_add
25256     * @li @ref elm_transit_effect_fade_add
25257     * @li @ref elm_transit_effect_blend_add
25258     *
25259     * It's also possible to make a transition chain with @ref
25260     * elm_transit_chain_transit_add.
25261     *
25262     * @warning We strongly recommend to use elm_transit just when edje can not do
25263     * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
25264     * animations can be manipulated inside the theme.
25265     *
25266     * List of examples:
25267     * @li @ref transit_example_01_explained
25268     * @li @ref transit_example_02_explained
25269     * @li @ref transit_example_03_c
25270     * @li @ref transit_example_04_c
25271     *
25272     * @{
25273     */
25274
25275    /**
25276     * @enum Elm_Transit_Tween_Mode
25277     *
25278     * The type of acceleration used in the transition.
25279     */
25280    typedef enum
25281      {
25282         ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
25283         ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
25284                                              over time, then decrease again
25285                                              and stop slowly */
25286         ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
25287                                              speed over time */
25288         ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
25289                                             over time */
25290      } Elm_Transit_Tween_Mode;
25291
25292    /**
25293     * @enum Elm_Transit_Effect_Flip_Axis
25294     *
25295     * The axis where flip effect should be applied.
25296     */
25297    typedef enum
25298      {
25299         ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
25300         ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
25301      } Elm_Transit_Effect_Flip_Axis;
25302    /**
25303     * @enum Elm_Transit_Effect_Wipe_Dir
25304     *
25305     * The direction where the wipe effect should occur.
25306     */
25307    typedef enum
25308      {
25309         ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
25310         ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
25311         ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
25312         ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
25313      } Elm_Transit_Effect_Wipe_Dir;
25314    /** @enum Elm_Transit_Effect_Wipe_Type
25315     *
25316     * Whether the wipe effect should show or hide the object.
25317     */
25318    typedef enum
25319      {
25320         ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
25321                                              animation */
25322         ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
25323                                             animation */
25324      } Elm_Transit_Effect_Wipe_Type;
25325
25326    /**
25327     * @typedef Elm_Transit
25328     *
25329     * The Transit created with elm_transit_add(). This type has the information
25330     * about the objects which the transition will be applied, and the
25331     * transition effects that will be used. It also contains info about
25332     * duration, number of repetitions, auto-reverse, etc.
25333     */
25334    typedef struct _Elm_Transit Elm_Transit;
25335    typedef void Elm_Transit_Effect;
25336    /**
25337     * @typedef Elm_Transit_Effect_Transition_Cb
25338     *
25339     * Transition callback called for this effect on each transition iteration.
25340     */
25341    typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
25342    /**
25343     * Elm_Transit_Effect_End_Cb
25344     *
25345     * Transition callback called for this effect when the transition is over.
25346     */
25347    typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
25348
25349    /**
25350     * Elm_Transit_Del_Cb
25351     *
25352     * A callback called when the transit is deleted.
25353     */
25354    typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
25355
25356    /**
25357     * Add new transit.
25358     *
25359     * @note Is not necessary to delete the transit object, it will be deleted at
25360     * the end of its operation.
25361     * @note The transit will start playing when the program enter in the main loop, is not
25362     * necessary to give a start to the transit.
25363     *
25364     * @return The transit object.
25365     *
25366     * @ingroup Transit
25367     */
25368    EAPI Elm_Transit                *elm_transit_add(void);
25369
25370    /**
25371     * Stops the animation and delete the @p transit object.
25372     *
25373     * Call this function if you wants to stop the animation before the duration
25374     * time. Make sure the @p transit object is still alive with
25375     * elm_transit_del_cb_set() function.
25376     * All added effects will be deleted, calling its repective data_free_cb
25377     * functions. The function setted by elm_transit_del_cb_set() will be called.
25378     *
25379     * @see elm_transit_del_cb_set()
25380     *
25381     * @param transit The transit object to be deleted.
25382     *
25383     * @ingroup Transit
25384     * @warning Just call this function if you are sure the transit is alive.
25385     */
25386    EAPI void                        elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
25387
25388    /**
25389     * Add a new effect to the transit.
25390     *
25391     * @note The cb function and the data are the key to the effect. If you try to
25392     * add an already added effect, nothing is done.
25393     * @note After the first addition of an effect in @p transit, if its
25394     * effect list become empty again, the @p transit will be killed by
25395     * elm_transit_del(transit) function.
25396     *
25397     * Exemple:
25398     * @code
25399     * Elm_Transit *transit = elm_transit_add();
25400     * elm_transit_effect_add(transit,
25401     *                        elm_transit_effect_blend_op,
25402     *                        elm_transit_effect_blend_context_new(),
25403     *                        elm_transit_effect_blend_context_free);
25404     * @endcode
25405     *
25406     * @param transit The transit object.
25407     * @param transition_cb The operation function. It is called when the
25408     * animation begins, it is the function that actually performs the animation.
25409     * It is called with the @p data, @p transit and the time progression of the
25410     * animation (a double value between 0.0 and 1.0).
25411     * @param effect The context data of the effect.
25412     * @param end_cb The function to free the context data, it will be called
25413     * at the end of the effect, it must finalize the animation and free the
25414     * @p data.
25415     *
25416     * @ingroup Transit
25417     * @warning The transit free the context data at the and of the transition with
25418     * the data_free_cb function, do not use the context data in another transit.
25419     */
25420    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);
25421
25422    /**
25423     * Delete an added effect.
25424     *
25425     * This function will remove the effect from the @p transit, calling the
25426     * data_free_cb to free the @p data.
25427     *
25428     * @see elm_transit_effect_add()
25429     *
25430     * @note If the effect is not found, nothing is done.
25431     * @note If the effect list become empty, this function will call
25432     * elm_transit_del(transit), that is, it will kill the @p transit.
25433     *
25434     * @param transit The transit object.
25435     * @param transition_cb The operation function.
25436     * @param effect The context data of the effect.
25437     *
25438     * @ingroup Transit
25439     */
25440    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);
25441
25442    /**
25443     * Add new object to apply the effects.
25444     *
25445     * @note After the first addition of an object in @p transit, if its
25446     * object list become empty again, the @p transit will be killed by
25447     * elm_transit_del(transit) function.
25448     * @note If the @p obj belongs to another transit, the @p obj will be
25449     * removed from it and it will only belong to the @p transit. If the old
25450     * transit stays without objects, it will die.
25451     * @note When you add an object into the @p transit, its state from
25452     * evas_object_pass_events_get(obj) is saved, and it is applied when the
25453     * transit ends, if you change this state whith evas_object_pass_events_set()
25454     * after add the object, this state will change again when @p transit stops to
25455     * run.
25456     *
25457     * @param transit The transit object.
25458     * @param obj Object to be animated.
25459     *
25460     * @ingroup Transit
25461     * @warning It is not allowed to add a new object after transit begins to go.
25462     */
25463    EAPI void                        elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
25464
25465    /**
25466     * Removes an added object from the transit.
25467     *
25468     * @note If the @p obj is not in the @p transit, nothing is done.
25469     * @note If the list become empty, this function will call
25470     * elm_transit_del(transit), that is, it will kill the @p transit.
25471     *
25472     * @param transit The transit object.
25473     * @param obj Object to be removed from @p transit.
25474     *
25475     * @ingroup Transit
25476     * @warning It is not allowed to remove objects after transit begins to go.
25477     */
25478    EAPI void                        elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
25479
25480    /**
25481     * Get the objects of the transit.
25482     *
25483     * @param transit The transit object.
25484     * @return a Eina_List with the objects from the transit.
25485     *
25486     * @ingroup Transit
25487     */
25488    EAPI const Eina_List            *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25489
25490    /**
25491     * Enable/disable keeping up the objects states.
25492     * If it is not kept, the objects states will be reset when transition ends.
25493     *
25494     * @note @p transit can not be NULL.
25495     * @note One state includes geometry, color, map data.
25496     *
25497     * @param transit The transit object.
25498     * @param state_keep Keeping or Non Keeping.
25499     *
25500     * @ingroup Transit
25501     */
25502    EAPI void                        elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
25503
25504    /**
25505     * Get a value whether the objects states will be reset or not.
25506     *
25507     * @note @p transit can not be NULL
25508     *
25509     * @see elm_transit_objects_final_state_keep_set()
25510     *
25511     * @param transit The transit object.
25512     * @return EINA_TRUE means the states of the objects will be reset.
25513     * If @p transit is NULL, EINA_FALSE is returned
25514     *
25515     * @ingroup Transit
25516     */
25517    EAPI Eina_Bool                   elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25518
25519    /**
25520     * Set the event enabled when transit is operating.
25521     *
25522     * If @p enabled is EINA_TRUE, the objects of the transit will receives
25523     * events from mouse and keyboard during the animation.
25524     * @note When you add an object with elm_transit_object_add(), its state from
25525     * evas_object_pass_events_get(obj) is saved, and it is applied when the
25526     * transit ends, if you change this state with evas_object_pass_events_set()
25527     * after adding the object, this state will change again when @p transit stops
25528     * to run.
25529     *
25530     * @param transit The transit object.
25531     * @param enabled Events are received when enabled is @c EINA_TRUE, and
25532     * ignored otherwise.
25533     *
25534     * @ingroup Transit
25535     */
25536    EAPI void                        elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25537
25538    /**
25539     * Get the value of event enabled status.
25540     *
25541     * @see elm_transit_event_enabled_set()
25542     *
25543     * @param transit The Transit object
25544     * @return EINA_TRUE, when event is enabled. If @p transit is NULL
25545     * EINA_FALSE is returned
25546     *
25547     * @ingroup Transit
25548     */
25549    EAPI Eina_Bool                   elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25550
25551    /**
25552     * Set the user-callback function when the transit is deleted.
25553     *
25554     * @note Using this function twice will overwrite the first function setted.
25555     * @note the @p transit object will be deleted after call @p cb function.
25556     *
25557     * @param transit The transit object.
25558     * @param cb Callback function pointer. This function will be called before
25559     * the deletion of the transit.
25560     * @param data Callback funtion user data. It is the @p op parameter.
25561     *
25562     * @ingroup Transit
25563     */
25564    EAPI void                        elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
25565
25566    /**
25567     * Set reverse effect automatically.
25568     *
25569     * If auto reverse is setted, after running the effects with the progress
25570     * parameter from 0 to 1, it will call the effecs again with the progress
25571     * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
25572     * where the duration was setted with the function elm_transit_add and
25573     * the repeat with the function elm_transit_repeat_times_set().
25574     *
25575     * @param transit The transit object.
25576     * @param reverse EINA_TRUE means the auto_reverse is on.
25577     *
25578     * @ingroup Transit
25579     */
25580    EAPI void                        elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
25581
25582    /**
25583     * Get if the auto reverse is on.
25584     *
25585     * @see elm_transit_auto_reverse_set()
25586     *
25587     * @param transit The transit object.
25588     * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
25589     * EINA_FALSE is returned
25590     *
25591     * @ingroup Transit
25592     */
25593    EAPI Eina_Bool                   elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25594
25595    /**
25596     * Set the transit repeat count. Effect will be repeated by repeat count.
25597     *
25598     * This function sets the number of repetition the transit will run after
25599     * the first one, that is, if @p repeat is 1, the transit will run 2 times.
25600     * If the @p repeat is a negative number, it will repeat infinite times.
25601     *
25602     * @note If this function is called during the transit execution, the transit
25603     * will run @p repeat times, ignoring the times it already performed.
25604     *
25605     * @param transit The transit object
25606     * @param repeat Repeat count
25607     *
25608     * @ingroup Transit
25609     */
25610    EAPI void                        elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
25611
25612    /**
25613     * Get the transit repeat count.
25614     *
25615     * @see elm_transit_repeat_times_set()
25616     *
25617     * @param transit The Transit object.
25618     * @return The repeat count. If @p transit is NULL
25619     * 0 is returned
25620     *
25621     * @ingroup Transit
25622     */
25623    EAPI int                         elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25624
25625    /**
25626     * Set the transit animation acceleration type.
25627     *
25628     * This function sets the tween mode of the transit that can be:
25629     * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
25630     * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
25631     * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
25632     * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
25633     *
25634     * @param transit The transit object.
25635     * @param tween_mode The tween type.
25636     *
25637     * @ingroup Transit
25638     */
25639    EAPI void                        elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
25640
25641    /**
25642     * Get the transit animation acceleration type.
25643     *
25644     * @note @p transit can not be NULL
25645     *
25646     * @param transit The transit object.
25647     * @return The tween type. If @p transit is NULL
25648     * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
25649     *
25650     * @ingroup Transit
25651     */
25652    EAPI Elm_Transit_Tween_Mode      elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25653
25654    /**
25655     * Set the transit animation time
25656     *
25657     * @note @p transit can not be NULL
25658     *
25659     * @param transit The transit object.
25660     * @param duration The animation time.
25661     *
25662     * @ingroup Transit
25663     */
25664    EAPI void                        elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
25665
25666    /**
25667     * Get the transit animation time
25668     *
25669     * @note @p transit can not be NULL
25670     *
25671     * @param transit The transit object.
25672     *
25673     * @return The transit animation time.
25674     *
25675     * @ingroup Transit
25676     */
25677    EAPI double                      elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25678
25679    /**
25680     * Starts the transition.
25681     * Once this API is called, the transit begins to measure the time.
25682     *
25683     * @note @p transit can not be NULL
25684     *
25685     * @param transit The transit object.
25686     *
25687     * @ingroup Transit
25688     */
25689    EAPI void                        elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
25690
25691    /**
25692     * Pause/Resume the transition.
25693     *
25694     * If you call elm_transit_go again, the transit will be started from the
25695     * beginning, and will be unpaused.
25696     *
25697     * @note @p transit can not be NULL
25698     *
25699     * @param transit The transit object.
25700     * @param paused Whether the transition should be paused or not.
25701     *
25702     * @ingroup Transit
25703     */
25704    EAPI void                        elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
25705
25706    /**
25707     * Get the value of paused status.
25708     *
25709     * @see elm_transit_paused_set()
25710     *
25711     * @note @p transit can not be NULL
25712     *
25713     * @param transit The transit object.
25714     * @return EINA_TRUE means transition is paused. If @p transit is NULL
25715     * EINA_FALSE is returned
25716     *
25717     * @ingroup Transit
25718     */
25719    EAPI Eina_Bool                   elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25720
25721    /**
25722     * Get the time progression of the animation (a double value between 0.0 and 1.0).
25723     *
25724     * The value returned is a fraction (current time / total time). It
25725     * represents the progression position relative to the total.
25726     *
25727     * @note @p transit can not be NULL
25728     *
25729     * @param transit The transit object.
25730     *
25731     * @return The time progression value. If @p transit is NULL
25732     * 0 is returned
25733     *
25734     * @ingroup Transit
25735     */
25736    EAPI double                      elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25737
25738    /**
25739     * Makes the chain relationship between two transits.
25740     *
25741     * @note @p transit can not be NULL. Transit would have multiple chain transits.
25742     * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
25743     *
25744     * @param transit The transit object.
25745     * @param chain_transit The chain transit object. This transit will be operated
25746     *        after transit is done.
25747     *
25748     * This function adds @p chain_transit transition to a chain after the @p
25749     * transit, and will be started as soon as @p transit ends. See @ref
25750     * transit_example_02_explained for a full example.
25751     *
25752     * @ingroup Transit
25753     */
25754    EAPI void                        elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
25755
25756    /**
25757     * Cut off the chain relationship between two transits.
25758     *
25759     * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
25760     * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
25761     *
25762     * @param transit The transit object.
25763     * @param chain_transit The chain transit object.
25764     *
25765     * This function remove the @p chain_transit transition from the @p transit.
25766     *
25767     * @ingroup Transit
25768     */
25769    EAPI void                        elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
25770
25771    /**
25772     * Get the current chain transit list.
25773     *
25774     * @note @p transit can not be NULL.
25775     *
25776     * @param transit The transit object.
25777     * @return chain transit list.
25778     *
25779     * @ingroup Transit
25780     */
25781    EAPI Eina_List                  *elm_transit_chain_transits_get(const Elm_Transit *transit);
25782
25783    /**
25784     * Add the Resizing Effect to Elm_Transit.
25785     *
25786     * @note This API is one of the facades. It creates resizing effect context
25787     * and add it's required APIs to elm_transit_effect_add.
25788     *
25789     * @see elm_transit_effect_add()
25790     *
25791     * @param transit Transit object.
25792     * @param from_w Object width size when effect begins.
25793     * @param from_h Object height size when effect begins.
25794     * @param to_w Object width size when effect ends.
25795     * @param to_h Object height size when effect ends.
25796     * @return Resizing effect context data.
25797     *
25798     * @ingroup Transit
25799     */
25800    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);
25801
25802    /**
25803     * Add the Translation Effect to Elm_Transit.
25804     *
25805     * @note This API is one of the facades. It creates translation effect context
25806     * and add it's required APIs to elm_transit_effect_add.
25807     *
25808     * @see elm_transit_effect_add()
25809     *
25810     * @param transit Transit object.
25811     * @param from_dx X Position variation when effect begins.
25812     * @param from_dy Y Position variation when effect begins.
25813     * @param to_dx X Position variation when effect ends.
25814     * @param to_dy Y Position variation when effect ends.
25815     * @return Translation effect context data.
25816     *
25817     * @ingroup Transit
25818     * @warning It is highly recommended just create a transit with this effect when
25819     * the window that the objects of the transit belongs has already been created.
25820     * This is because this effect needs the geometry information about the objects,
25821     * and if the window was not created yet, it can get a wrong information.
25822     */
25823    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);
25824
25825    /**
25826     * Add the Zoom Effect to Elm_Transit.
25827     *
25828     * @note This API is one of the facades. It creates zoom effect context
25829     * and add it's required APIs to elm_transit_effect_add.
25830     *
25831     * @see elm_transit_effect_add()
25832     *
25833     * @param transit Transit object.
25834     * @param from_rate Scale rate when effect begins (1 is current rate).
25835     * @param to_rate Scale rate when effect ends.
25836     * @return Zoom effect context data.
25837     *
25838     * @ingroup Transit
25839     * @warning It is highly recommended just create a transit with this effect when
25840     * the window that the objects of the transit belongs has already been created.
25841     * This is because this effect needs the geometry information about the objects,
25842     * and if the window was not created yet, it can get a wrong information.
25843     */
25844    EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
25845
25846    /**
25847     * Add the Flip Effect to Elm_Transit.
25848     *
25849     * @note This API is one of the facades. It creates flip effect context
25850     * and add it's required APIs to elm_transit_effect_add.
25851     * @note This effect is applied to each pair of objects in the order they are listed
25852     * in the transit list of objects. The first object in the pair will be the
25853     * "front" object and the second will be the "back" object.
25854     *
25855     * @see elm_transit_effect_add()
25856     *
25857     * @param transit Transit object.
25858     * @param axis Flipping Axis(X or Y).
25859     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
25860     * @return Flip effect context data.
25861     *
25862     * @ingroup Transit
25863     * @warning It is highly recommended just create a transit with this effect when
25864     * the window that the objects of the transit belongs has already been created.
25865     * This is because this effect needs the geometry information about the objects,
25866     * and if the window was not created yet, it can get a wrong information.
25867     */
25868    EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
25869
25870    /**
25871     * Add the Resizable Flip Effect to Elm_Transit.
25872     *
25873     * @note This API is one of the facades. It creates resizable flip effect context
25874     * and add it's required APIs to elm_transit_effect_add.
25875     * @note This effect is applied to each pair of objects in the order they are listed
25876     * in the transit list of objects. The first object in the pair will be the
25877     * "front" object and the second will be the "back" object.
25878     *
25879     * @see elm_transit_effect_add()
25880     *
25881     * @param transit Transit object.
25882     * @param axis Flipping Axis(X or Y).
25883     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
25884     * @return Resizable flip effect context data.
25885     *
25886     * @ingroup Transit
25887     * @warning It is highly recommended just create a transit with this effect when
25888     * the window that the objects of the transit belongs has already been created.
25889     * This is because this effect needs the geometry information about the objects,
25890     * and if the window was not created yet, it can get a wrong information.
25891     */
25892    EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
25893
25894    /**
25895     * Add the Wipe Effect to Elm_Transit.
25896     *
25897     * @note This API is one of the facades. It creates wipe effect context
25898     * and add it's required APIs to elm_transit_effect_add.
25899     *
25900     * @see elm_transit_effect_add()
25901     *
25902     * @param transit Transit object.
25903     * @param type Wipe type. Hide or show.
25904     * @param dir Wipe Direction.
25905     * @return Wipe effect context data.
25906     *
25907     * @ingroup Transit
25908     * @warning It is highly recommended just create a transit with this effect when
25909     * the window that the objects of the transit belongs has already been created.
25910     * This is because this effect needs the geometry information about the objects,
25911     * and if the window was not created yet, it can get a wrong information.
25912     */
25913    EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
25914
25915    /**
25916     * Add the Color Effect to Elm_Transit.
25917     *
25918     * @note This API is one of the facades. It creates color effect context
25919     * and add it's required APIs to elm_transit_effect_add.
25920     *
25921     * @see elm_transit_effect_add()
25922     *
25923     * @param transit        Transit object.
25924     * @param  from_r        RGB R when effect begins.
25925     * @param  from_g        RGB G when effect begins.
25926     * @param  from_b        RGB B when effect begins.
25927     * @param  from_a        RGB A when effect begins.
25928     * @param  to_r          RGB R when effect ends.
25929     * @param  to_g          RGB G when effect ends.
25930     * @param  to_b          RGB B when effect ends.
25931     * @param  to_a          RGB A when effect ends.
25932     * @return               Color effect context data.
25933     *
25934     * @ingroup Transit
25935     */
25936    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);
25937
25938    /**
25939     * Add the Fade Effect to Elm_Transit.
25940     *
25941     * @note This API is one of the facades. It creates fade effect context
25942     * and add it's required APIs to elm_transit_effect_add.
25943     * @note This effect is applied to each pair of objects in the order they are listed
25944     * in the transit list of objects. The first object in the pair will be the
25945     * "before" object and the second will be the "after" object.
25946     *
25947     * @see elm_transit_effect_add()
25948     *
25949     * @param transit Transit object.
25950     * @return Fade effect context data.
25951     *
25952     * @ingroup Transit
25953     * @warning It is highly recommended just create a transit with this effect when
25954     * the window that the objects of the transit belongs has already been created.
25955     * This is because this effect needs the color information about the objects,
25956     * and if the window was not created yet, it can get a wrong information.
25957     */
25958    EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
25959
25960    /**
25961     * Add the Blend Effect to Elm_Transit.
25962     *
25963     * @note This API is one of the facades. It creates blend effect context
25964     * and add it's required APIs to elm_transit_effect_add.
25965     * @note This effect is applied to each pair of objects in the order they are listed
25966     * in the transit list of objects. The first object in the pair will be the
25967     * "before" object and the second will be the "after" object.
25968     *
25969     * @see elm_transit_effect_add()
25970     *
25971     * @param transit Transit object.
25972     * @return Blend effect context data.
25973     *
25974     * @ingroup Transit
25975     * @warning It is highly recommended just create a transit with this effect when
25976     * the window that the objects of the transit belongs has already been created.
25977     * This is because this effect needs the color information about the objects,
25978     * and if the window was not created yet, it can get a wrong information.
25979     */
25980    EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
25981
25982    /**
25983     * Add the Rotation Effect to Elm_Transit.
25984     *
25985     * @note This API is one of the facades. It creates rotation effect context
25986     * and add it's required APIs to elm_transit_effect_add.
25987     *
25988     * @see elm_transit_effect_add()
25989     *
25990     * @param transit Transit object.
25991     * @param from_degree Degree when effect begins.
25992     * @param to_degree Degree when effect is ends.
25993     * @return Rotation effect context data.
25994     *
25995     * @ingroup Transit
25996     * @warning It is highly recommended just create a transit with this effect when
25997     * the window that the objects of the transit belongs has already been created.
25998     * This is because this effect needs the geometry information about the objects,
25999     * and if the window was not created yet, it can get a wrong information.
26000     */
26001    EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
26002
26003    /**
26004     * Add the ImageAnimation Effect to Elm_Transit.
26005     *
26006     * @note This API is one of the facades. It creates image animation effect context
26007     * and add it's required APIs to elm_transit_effect_add.
26008     * The @p images parameter is a list images paths. This list and
26009     * its contents will be deleted at the end of the effect by
26010     * elm_transit_effect_image_animation_context_free() function.
26011     *
26012     * Example:
26013     * @code
26014     * char buf[PATH_MAX];
26015     * Eina_List *images = NULL;
26016     * Elm_Transit *transi = elm_transit_add();
26017     *
26018     * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
26019     * images = eina_list_append(images, eina_stringshare_add(buf));
26020     *
26021     * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
26022     * images = eina_list_append(images, eina_stringshare_add(buf));
26023     * elm_transit_effect_image_animation_add(transi, images);
26024     *
26025     * @endcode
26026     *
26027     * @see elm_transit_effect_add()
26028     *
26029     * @param transit Transit object.
26030     * @param images Eina_List of images file paths. This list and
26031     * its contents will be deleted at the end of the effect by
26032     * elm_transit_effect_image_animation_context_free() function.
26033     * @return Image Animation effect context data.
26034     *
26035     * @ingroup Transit
26036     */
26037    EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
26038    /**
26039     * @}
26040     */
26041
26042   typedef struct _Elm_Store                      Elm_Store;
26043   typedef struct _Elm_Store_Filesystem           Elm_Store_Filesystem;
26044   typedef struct _Elm_Store_Item                 Elm_Store_Item;
26045   typedef struct _Elm_Store_Item_Filesystem      Elm_Store_Item_Filesystem;
26046   typedef struct _Elm_Store_Item_Info            Elm_Store_Item_Info;
26047   typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
26048   typedef struct _Elm_Store_Item_Mapping         Elm_Store_Item_Mapping;
26049   typedef struct _Elm_Store_Item_Mapping_Empty   Elm_Store_Item_Mapping_Empty;
26050   typedef struct _Elm_Store_Item_Mapping_Icon    Elm_Store_Item_Mapping_Icon;
26051   typedef struct _Elm_Store_Item_Mapping_Photo   Elm_Store_Item_Mapping_Photo;
26052   typedef struct _Elm_Store_Item_Mapping_Custom  Elm_Store_Item_Mapping_Custom;
26053
26054   typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
26055   typedef void      (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
26056   typedef void      (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
26057   typedef void     *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
26058
26059   typedef enum
26060     {
26061        ELM_STORE_ITEM_MAPPING_NONE = 0,
26062        ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
26063        ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
26064        ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
26065        ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
26066        ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
26067        // can add more here as needed by common apps
26068        ELM_STORE_ITEM_MAPPING_LAST
26069     } Elm_Store_Item_Mapping_Type;
26070
26071   struct _Elm_Store_Item_Mapping_Icon
26072     {
26073        // FIXME: allow edje file icons
26074        int                   w, h;
26075        Elm_Icon_Lookup_Order lookup_order;
26076        Eina_Bool             standard_name : 1;
26077        Eina_Bool             no_scale : 1;
26078        Eina_Bool             smooth : 1;
26079        Eina_Bool             scale_up : 1;
26080        Eina_Bool             scale_down : 1;
26081     };
26082
26083   struct _Elm_Store_Item_Mapping_Empty
26084     {
26085        Eina_Bool             dummy;
26086     };
26087
26088   struct _Elm_Store_Item_Mapping_Photo
26089     {
26090        int                   size;
26091     };
26092
26093   struct _Elm_Store_Item_Mapping_Custom
26094     {
26095        Elm_Store_Item_Mapping_Cb func;
26096     };
26097
26098   struct _Elm_Store_Item_Mapping
26099     {
26100        Elm_Store_Item_Mapping_Type     type;
26101        const char                     *part;
26102        int                             offset;
26103        union
26104          {
26105             Elm_Store_Item_Mapping_Empty  empty;
26106             Elm_Store_Item_Mapping_Icon   icon;
26107             Elm_Store_Item_Mapping_Photo  photo;
26108             Elm_Store_Item_Mapping_Custom custom;
26109             // add more types here
26110          } details;
26111     };
26112
26113   struct _Elm_Store_Item_Info
26114     {
26115       Elm_Genlist_Item_Class       *item_class;
26116       const Elm_Store_Item_Mapping *mapping;
26117       void                         *data;
26118       char                         *sort_id;
26119     };
26120
26121   struct _Elm_Store_Item_Info_Filesystem
26122     {
26123       Elm_Store_Item_Info  base;
26124       char                *path;
26125     };
26126
26127 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
26128 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
26129
26130   EAPI void                    elm_store_free(Elm_Store *st);
26131
26132   EAPI Elm_Store              *elm_store_filesystem_new(void);
26133   EAPI void                    elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
26134   EAPI const char             *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
26135   EAPI const char             *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
26136
26137   EAPI void                    elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
26138
26139   EAPI void                    elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
26140   EAPI int                     elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
26141   EAPI void                    elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
26142   EAPI void                    elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
26143   EAPI void                    elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
26144   EAPI Eina_Bool               elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
26145
26146   EAPI void                    elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
26147   EAPI void                    elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
26148   EAPI Eina_Bool               elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
26149   EAPI void                    elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
26150   EAPI void                   *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
26151   EAPI const Elm_Store        *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
26152   EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
26153
26154    /**
26155     * @defgroup SegmentControl SegmentControl
26156     * @ingroup Elementary
26157     *
26158     * @image html img/widget/segment_control/preview-00.png
26159     * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
26160     *
26161     * @image html img/segment_control.png
26162     * @image latex img/segment_control.eps width=\textwidth
26163     *
26164     * Segment control widget is a horizontal control made of multiple segment
26165     * items, each segment item functioning similar to discrete two state button.
26166     * A segment control groups the items together and provides compact
26167     * single button with multiple equal size segments.
26168     *
26169     * Segment item size is determined by base widget
26170     * size and the number of items added.
26171     * Only one segment item can be at selected state. A segment item can display
26172     * combination of Text and any Evas_Object like Images or other widget.
26173     *
26174     * Smart callbacks one can listen to:
26175     * - "changed" - When the user clicks on a segment item which is not
26176     *   previously selected and get selected. The event_info parameter is the
26177     *   segment item index.
26178     *
26179     * Available styles for it:
26180     * - @c "default"
26181     *
26182     * Here is an example on its usage:
26183     * @li @ref segment_control_example
26184     */
26185
26186    /**
26187     * @addtogroup SegmentControl
26188     * @{
26189     */
26190
26191    typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
26192
26193    /**
26194     * Add a new segment control widget to the given parent Elementary
26195     * (container) object.
26196     *
26197     * @param parent The parent object.
26198     * @return a new segment control widget handle or @c NULL, on errors.
26199     *
26200     * This function inserts a new segment control widget on the canvas.
26201     *
26202     * @ingroup SegmentControl
26203     */
26204    EAPI Evas_Object      *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26205
26206    /**
26207     * Append a new item to the segment control object.
26208     *
26209     * @param obj The segment control object.
26210     * @param icon The icon object to use for the left side of the item. An
26211     * icon can be any Evas object, but usually it is an icon created
26212     * with elm_icon_add().
26213     * @param label The label of the item.
26214     *        Note that, NULL is different from empty string "".
26215     * @return The created item or @c NULL upon failure.
26216     *
26217     * A new item will be created and appended to the segment control, i.e., will
26218     * be set as @b last item.
26219     *
26220     * If it should be inserted at another position,
26221     * elm_segment_control_item_insert_at() should be used instead.
26222     *
26223     * Items created with this function can be deleted with function
26224     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
26225     *
26226     * @note @p label set to @c NULL is different from empty string "".
26227     * If an item
26228     * only has icon, it will be displayed bigger and centered. If it has
26229     * icon and label, even that an empty string, icon will be smaller and
26230     * positioned at left.
26231     *
26232     * Simple example:
26233     * @code
26234     * sc = elm_segment_control_add(win);
26235     * ic = elm_icon_add(win);
26236     * elm_icon_file_set(ic, "path/to/image", NULL);
26237     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
26238     * elm_segment_control_item_add(sc, ic, "label");
26239     * evas_object_show(sc);
26240     * @endcode
26241     *
26242     * @see elm_segment_control_item_insert_at()
26243     * @see elm_segment_control_item_del()
26244     *
26245     * @ingroup SegmentControl
26246     */
26247    EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
26248
26249    /**
26250     * Insert a new item to the segment control object at specified position.
26251     *
26252     * @param obj The segment control object.
26253     * @param icon The icon object to use for the left side of the item. An
26254     * icon can be any Evas object, but usually it is an icon created
26255     * with elm_icon_add().
26256     * @param label The label of the item.
26257     * @param index Item position. Value should be between 0 and items count.
26258     * @return The created item or @c NULL upon failure.
26259
26260     * Index values must be between @c 0, when item will be prepended to
26261     * segment control, and items count, that can be get with
26262     * elm_segment_control_item_count_get(), case when item will be appended
26263     * to segment control, just like elm_segment_control_item_add().
26264     *
26265     * Items created with this function can be deleted with function
26266     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
26267     *
26268     * @note @p label set to @c NULL is different from empty string "".
26269     * If an item
26270     * only has icon, it will be displayed bigger and centered. If it has
26271     * icon and label, even that an empty string, icon will be smaller and
26272     * positioned at left.
26273     *
26274     * @see elm_segment_control_item_add()
26275     * @see elm_segment_control_item_count_get()
26276     * @see elm_segment_control_item_del()
26277     *
26278     * @ingroup SegmentControl
26279     */
26280    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);
26281
26282    /**
26283     * Remove a segment control item from its parent, deleting it.
26284     *
26285     * @param it The item to be removed.
26286     *
26287     * Items can be added with elm_segment_control_item_add() or
26288     * elm_segment_control_item_insert_at().
26289     *
26290     * @ingroup SegmentControl
26291     */
26292    EAPI void              elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26293
26294    /**
26295     * Remove a segment control item at given index from its parent,
26296     * deleting it.
26297     *
26298     * @param obj The segment control object.
26299     * @param index The position of the segment control item to be deleted.
26300     *
26301     * Items can be added with elm_segment_control_item_add() or
26302     * elm_segment_control_item_insert_at().
26303     *
26304     * @ingroup SegmentControl
26305     */
26306    EAPI void              elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26307
26308    /**
26309     * Get the Segment items count from segment control.
26310     *
26311     * @param obj The segment control object.
26312     * @return Segment items count.
26313     *
26314     * It will just return the number of items added to segment control @p obj.
26315     *
26316     * @ingroup SegmentControl
26317     */
26318    EAPI int               elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26319
26320    /**
26321     * Get the item placed at specified index.
26322     *
26323     * @param obj The segment control object.
26324     * @param index The index of the segment item.
26325     * @return The segment control item or @c NULL on failure.
26326     *
26327     * Index is the position of an item in segment control widget. Its
26328     * range is from @c 0 to <tt> count - 1 </tt>.
26329     * Count is the number of items, that can be get with
26330     * elm_segment_control_item_count_get().
26331     *
26332     * @ingroup SegmentControl
26333     */
26334    EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26335
26336    /**
26337     * Get the label of item.
26338     *
26339     * @param obj The segment control object.
26340     * @param index The index of the segment item.
26341     * @return The label of the item at @p index.
26342     *
26343     * The return value is a pointer to the label associated to the item when
26344     * it was created, with function elm_segment_control_item_add(), or later
26345     * with function elm_segment_control_item_label_set. If no label
26346     * was passed as argument, it will return @c NULL.
26347     *
26348     * @see elm_segment_control_item_label_set() for more details.
26349     * @see elm_segment_control_item_add()
26350     *
26351     * @ingroup SegmentControl
26352     */
26353    EAPI const char       *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26354
26355    /**
26356     * Set the label of item.
26357     *
26358     * @param it The item of segment control.
26359     * @param text The label of item.
26360     *
26361     * The label to be displayed by the item.
26362     * Label will be at right of the icon (if set).
26363     *
26364     * If a label was passed as argument on item creation, with function
26365     * elm_control_segment_item_add(), it will be already
26366     * displayed by the item.
26367     *
26368     * @see elm_segment_control_item_label_get()
26369     * @see elm_segment_control_item_add()
26370     *
26371     * @ingroup SegmentControl
26372     */
26373    EAPI void              elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
26374
26375    /**
26376     * Get the icon associated to the item.
26377     *
26378     * @param obj The segment control object.
26379     * @param index The index of the segment item.
26380     * @return The left side icon associated to the item at @p index.
26381     *
26382     * The return value is a pointer to the icon associated to the item when
26383     * it was created, with function elm_segment_control_item_add(), or later
26384     * with function elm_segment_control_item_icon_set(). If no icon
26385     * was passed as argument, it will return @c NULL.
26386     *
26387     * @see elm_segment_control_item_add()
26388     * @see elm_segment_control_item_icon_set()
26389     *
26390     * @ingroup SegmentControl
26391     */
26392    EAPI Evas_Object      *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26393
26394    /**
26395     * Set the icon associated to the item.
26396     *
26397     * @param it The segment control item.
26398     * @param icon The icon object to associate with @p it.
26399     *
26400     * The icon object to use at left side of the item. An
26401     * icon can be any Evas object, but usually it is an icon created
26402     * with elm_icon_add().
26403     *
26404     * Once the icon object is set, a previously set one will be deleted.
26405     * @warning Setting the same icon for two items will cause the icon to
26406     * dissapear from the first item.
26407     *
26408     * If an icon was passed as argument on item creation, with function
26409     * elm_segment_control_item_add(), it will be already
26410     * associated to the item.
26411     *
26412     * @see elm_segment_control_item_add()
26413     * @see elm_segment_control_item_icon_get()
26414     *
26415     * @ingroup SegmentControl
26416     */
26417    EAPI void              elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26418
26419    /**
26420     * Get the index of an item.
26421     *
26422     * @param it The segment control item.
26423     * @return The position of item in segment control widget.
26424     *
26425     * Index is the position of an item in segment control widget. Its
26426     * range is from @c 0 to <tt> count - 1 </tt>.
26427     * Count is the number of items, that can be get with
26428     * elm_segment_control_item_count_get().
26429     *
26430     * @ingroup SegmentControl
26431     */
26432    EAPI int               elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26433
26434    /**
26435     * Get the base object of the item.
26436     *
26437     * @param it The segment control item.
26438     * @return The base object associated with @p it.
26439     *
26440     * Base object is the @c Evas_Object that represents that item.
26441     *
26442     * @ingroup SegmentControl
26443     */
26444    EAPI Evas_Object      *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26445
26446    /**
26447     * Get the selected item.
26448     *
26449     * @param obj The segment control object.
26450     * @return The selected item or @c NULL if none of segment items is
26451     * selected.
26452     *
26453     * The selected item can be unselected with function
26454     * elm_segment_control_item_selected_set().
26455     *
26456     * The selected item always will be highlighted on segment control.
26457     *
26458     * @ingroup SegmentControl
26459     */
26460    EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26461
26462    /**
26463     * Set the selected state of an item.
26464     *
26465     * @param it The segment control item
26466     * @param select The selected state
26467     *
26468     * This sets the selected state of the given item @p it.
26469     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26470     *
26471     * If a new item is selected the previosly selected will be unselected.
26472     * Previoulsy selected item can be get with function
26473     * elm_segment_control_item_selected_get().
26474     *
26475     * The selected item always will be highlighted on segment control.
26476     *
26477     * @see elm_segment_control_item_selected_get()
26478     *
26479     * @ingroup SegmentControl
26480     */
26481    EAPI void              elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
26482
26483    /**
26484     * @}
26485     */
26486
26487    /**
26488     * @defgroup Grid Grid
26489     *
26490     * The grid is a grid layout widget that lays out a series of children as a
26491     * fixed "grid" of widgets using a given percentage of the grid width and
26492     * height each using the child object.
26493     *
26494     * The Grid uses a "Virtual resolution" that is stretched to fill the grid
26495     * widgets size itself. The default is 100 x 100, so that means the
26496     * position and sizes of children will effectively be percentages (0 to 100)
26497     * of the width or height of the grid widget
26498     *
26499     * @{
26500     */
26501
26502    /**
26503     * Add a new grid to the parent
26504     *
26505     * @param parent The parent object
26506     * @return The new object or NULL if it cannot be created
26507     *
26508     * @ingroup Grid
26509     */
26510    EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
26511
26512    /**
26513     * Set the virtual size of the grid
26514     *
26515     * @param obj The grid object
26516     * @param w The virtual width of the grid
26517     * @param h The virtual height of the grid
26518     *
26519     * @ingroup Grid
26520     */
26521    EAPI void         elm_grid_size_set(Evas_Object *obj, int w, int h);
26522
26523    /**
26524     * Get the virtual size of the grid
26525     *
26526     * @param obj The grid object
26527     * @param w Pointer to integer to store the virtual width of the grid
26528     * @param h Pointer to integer to store the virtual height of the grid
26529     *
26530     * @ingroup Grid
26531     */
26532    EAPI void         elm_grid_size_get(Evas_Object *obj, int *w, int *h);
26533
26534    /**
26535     * Pack child at given position and size
26536     *
26537     * @param obj The grid object
26538     * @param subobj The child to pack
26539     * @param x The virtual x coord at which to pack it
26540     * @param y The virtual y coord at which to pack it
26541     * @param w The virtual width at which to pack it
26542     * @param h The virtual height at which to pack it
26543     *
26544     * @ingroup Grid
26545     */
26546    EAPI void         elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
26547
26548    /**
26549     * Unpack a child from a grid object
26550     *
26551     * @param obj The grid object
26552     * @param subobj The child to unpack
26553     *
26554     * @ingroup Grid
26555     */
26556    EAPI void         elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
26557
26558    /**
26559     * Faster way to remove all child objects from a grid object.
26560     *
26561     * @param obj The grid object
26562     * @param clear If true, it will delete just removed children
26563     *
26564     * @ingroup Grid
26565     */
26566    EAPI void         elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
26567
26568    /**
26569     * Set packing of an existing child at to position and size
26570     *
26571     * @param subobj The child to set packing of
26572     * @param x The virtual x coord at which to pack it
26573     * @param y The virtual y coord at which to pack it
26574     * @param w The virtual width at which to pack it
26575     * @param h The virtual height at which to pack it
26576     *
26577     * @ingroup Grid
26578     */
26579    EAPI void         elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
26580
26581    /**
26582     * get packing of a child
26583     *
26584     * @param subobj The child to query
26585     * @param x Pointer to integer to store the virtual x coord
26586     * @param y Pointer to integer to store the virtual y coord
26587     * @param w Pointer to integer to store the virtual width
26588     * @param h Pointer to integer to store the virtual height
26589     *
26590     * @ingroup Grid
26591     */
26592    EAPI void         elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
26593
26594    /**
26595     * @}
26596     */
26597
26598    EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
26599    EAPI void         elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
26600    EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
26601    EAPI void         elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
26602    EAPI Eina_Bool    elm_factory_maxmin_mode_get(const Evas_Object *obj);
26603    EAPI void         elm_factory_maxmin_reset_set(Evas_Object *obj);
26604
26605    /**
26606     * @defgroup Video Video
26607     *
26608     * This object display an player that let you control an Elm_Video
26609     * object. It take care of updating it's content according to what is
26610     * going on inside the Emotion object. It does activate the remember
26611     * function on the linked Elm_Video object.
26612     *
26613     * Signals that you cann add callback for are :
26614     *
26615     * "forward,clicked" - the user clicked the forward button.
26616     * "info,clicked" - the user clicked the info button.
26617     * "next,clicked" - the user clicked the next button.
26618     * "pause,clicked" - the user clicked the pause button.
26619     * "play,clicked" - the user clicked the play button.
26620     * "prev,clicked" - the user clicked the prev button.
26621     * "rewind,clicked" - the user clicked the rewind button.
26622     * "stop,clicked" - the user clicked the stop button.
26623     */
26624    EAPI Evas_Object *elm_video_add(Evas_Object *parent);
26625    EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
26626    EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
26627    EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
26628    EAPI void elm_video_play(Evas_Object *video);
26629    EAPI void elm_video_pause(Evas_Object *video);
26630    EAPI void elm_video_stop(Evas_Object *video);
26631    EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
26632    EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
26633    EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
26634    EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
26635    EAPI double elm_video_audio_level_get(Evas_Object *video);
26636    EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
26637    EAPI double elm_video_play_position_get(Evas_Object *video);
26638    EAPI void elm_video_play_position_set(Evas_Object *video, double position);
26639    EAPI double elm_video_play_length_get(Evas_Object *video);
26640    EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
26641    EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
26642    EAPI const char *elm_video_title_get(Evas_Object *video);
26643
26644    EAPI Evas_Object *elm_player_add(Evas_Object *parent);
26645    EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
26646
26647   /* naviframe */
26648    EAPI Evas_Object        *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26649    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);
26650    EAPI Evas_Object        *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
26651    EAPI void                elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
26652    EAPI Eina_Bool           elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26653    EAPI Elm_Object_Item    *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26654    EAPI Elm_Object_Item    *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26655    EAPI void                elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
26656    EAPI const char         *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26657    EAPI void                elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
26658    EAPI Eina_Bool           elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26659
26660 #ifdef __cplusplus
26661 }
26662 #endif
26663
26664 #endif