891ffd016813f44b3238fe2506ab4b40d9985dec
[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 which hold the widgets.
33
34 @section license License
35
36 LGPL v2 (see COPYING in the base of Elementary's source). This applies to
37 all files in the source tree.
38
39 @section ack Acknowledgements
40 There is a lot that goes into making a widget set, and they don't happen out of
41 nothing. It's like trying to make everyone everywhere happy, regardless of age,
42 gender, race or nationality - and that is really tough. So thanks to people and
43 organisations behind this, as listed in the @ref authors page.
44 */
45
46
47 /**
48  * @defgroup Start Getting Started
49  *
50  * To write an Elementary app, you can get started with the following:
51  *
52 @code
53 #include <Elementary.h>
54 EAPI_MAIN int
55 elm_main(int argc, char **argv)
56 {
57    // create window(s) here and do any application init
58    elm_run(); // run main loop
59    elm_shutdown(); // after mainloop finishes running, shutdown
60    return 0; // exit 0 for exit code
61 }
62 ELM_MAIN()
63 @endcode
64  *
65  * To use autotools (which helps in many ways in the long run, like being able
66  * to immediately create releases of your software directly from your tree
67  * and ensure everything needed to build it is there) you will need a
68  * configure.ac, Makefile.am and autogen.sh file.
69  *
70  * configure.ac:
71  *
72 @verbatim
73 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
74 AC_PREREQ(2.52)
75 AC_CONFIG_SRCDIR(configure.ac)
76 AM_CONFIG_HEADER(config.h)
77 AC_PROG_CC
78 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
79 PKG_CHECK_MODULES([ELEMENTARY], elementary)
80 AC_OUTPUT(Makefile)
81 @endverbatim
82  *
83  * Makefile.am:
84  *
85 @verbatim
86 AUTOMAKE_OPTIONS = 1.4 foreign
87 MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.h.in configure depcomp install-sh missing
88
89 INCLUDES = -I$(top_srcdir)
90
91 bin_PROGRAMS = myapp
92
93 myapp_SOURCES = main.c
94 myapp_LDADD = @ELEMENTARY_LIBS@
95 myapp_CFLAGS = @ELEMENTARY_CFLAGS@
96 @endverbatim
97  *
98  * autogen.sh:
99  *
100 @verbatim
101 #!/bin/sh
102 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS || exit 1
103 echo "Running autoheader..." ; autoheader || exit 1
104 echo "Running autoconf..." ; autoconf || exit 1
105 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
106 ./configure "$@"
107 @endverbatim
108  *
109  * To generate all the things needed to bootstrap just run:
110  *
111 @verbatim
112 ./autogen.sh
113 @endverbatim
114  *
115  * This will generate Makefile.in's, the confgure script and everything else.
116  * After this it works like all normal autotools projects:
117 @verbatim
118 ./configure
119 make
120 sudo make install
121 @endverbatim
122  *
123  * Note sudo was assumed to get root permissions, as this would install in
124  * /usr/local which is system-owned. Use any way you like to gain root, or
125  * specify a different prefix with configure:
126  *
127 @verbatim
128 ./confiugre --prefix=$HOME/mysoftware
129 @endverbatim
130  *
131  * Also remember that autotools buys you some useful commands like:
132 @verbatim
133 make uninstall
134 @endverbatim
135  *
136  * This uninstalls the software after it was installed with "make install".
137  * It is very useful to clear up what you built if you wish to clean the
138  * system.
139  *
140 @verbatim
141 make distcheck
142 @endverbatim
143  *
144  * This firstly checks if your build tree is "clean" and ready for
145  * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
146  * ready to upload and distribute to the world, that contains the generated
147  * Makefile.in's and configure script. The users do not need to run
148  * autogen.sh - just configure and on. They don't need autotools installed.
149  * This tarball also builds cleanly, has all the sources it needs to build
150  * included (that is sources for your application, not libraries it depends
151  * on like Elementary). It builds cleanly in a buildroot and does not
152  * contain any files that are temporarily generated like binaries and other
153  * build-generated files, so the tarball is clean, and no need to worry
154  * about cleaning up your tree before packaging.
155  *
156 @verbatim
157 make clean
158 @endverbatim
159  *
160  * This cleans up all build files (binaries, objects etc.) from the tree.
161  *
162 @verbatim
163 make distclean
164 @endverbatim
165  *
166  * This cleans out all files from the build and from configure's output too.
167  *
168 @verbatim
169 make maintainer-clean
170 @endverbatim
171  *
172  * This deletes all the files autogen.sh will produce so the tree is clean
173  * to be put into a revision-control system (like CVS, SVN or GIT for example).
174  *
175  * There is a more advanced way of making use of the quicklaunch infrastructure
176  * in Elementary (which will not be covered here due to its more advanced
177  * nature).
178  *
179  * Now let's actually create an interactive "Hello World" gui that you can
180  * click the ok button to exit. It's more code because this now does something
181  * much more significant, but it's still very simple:
182  *
183 @code
184 #include <Elementary.h>
185
186 static void
187 on_done(void *data, Evas_Object *obj, void *event_info)
188 {
189    // quit the mainloop (elm_run function will return)
190    elm_exit();
191 }
192
193 EAPI_MAIN int
194 elm_main(int argc, char **argv)
195 {
196    Evas_Object *win, *bg, *box, *lab, *btn;
197
198    // new window - do the usual and give it a name, title and delete handler
199    win = elm_win_add(NULL, "hello", ELM_WIN_BASIC);
200    elm_win_title_set(win, "Hello");
201    // when the user clicks "close" on a window there is a request to delete
202    evas_object_smart_callback_add(win, "delete,request", on_done, NULL);
203
204    // add a standard bg
205    bg = elm_bg_add(win);
206    // add object as a resize object for the window (controls window minimum
207    // size as well as gets resized if window is resized)
208    elm_win_resize_object_add(win, bg);
209    evas_object_show(bg);
210
211    // add a box object - default is vertical. a box holds children in a row,
212    // either horizontally or vertically. nothing more.
213    box = elm_box_add(win);
214    // make the box hotizontal
215    elm_box_horizontal_set(box, EINA_TRUE);
216    // add object as a resize object for the window (controls window minimum
217    // size as well as gets resized if window is resized)
218    elm_win_resize_object_add(win, box);
219    evas_object_show(box);
220
221    // add a label widget, set the text and put it in the pad frame
222    lab = elm_label_add(win);
223    // set default text of the label
224    elm_object_text_set(lab, "Hello out there world!");
225    // pack the label at the end of the box
226    elm_box_pack_end(box, lab);
227    evas_object_show(lab);
228
229    // add an ok button
230    btn = elm_button_add(win);
231    // set default text of button to "OK"
232    elm_object_text_set(btn, "OK");
233    // pack the button at the end of the box
234    elm_box_pack_end(box, btn);
235    evas_object_show(btn);
236    // call on_done when button is clicked
237    evas_object_smart_callback_add(btn, "clicked", on_done, NULL);
238
239    // now we are done, show the window
240    evas_object_show(win);
241
242    // run the mainloop and process events and callbacks
243    elm_run();
244    return 0;
245 }
246 ELM_MAIN()
247 @endcode
248    *
249    */
250
251 /**
252 @page authors Authors
253 @author Carsten Haitzler <raster@@rasterman.com>
254 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
255 @author Cedric Bail <cedric.bail@@free.fr>
256 @author Vincent Torri <vtorri@@univ-evry.fr>
257 @author Daniel Kolesa <quaker66@@gmail.com>
258 @author Jaime Thomas <avi.thomas@@gmail.com>
259 @author Swisscom - http://www.swisscom.ch/
260 @author Christopher Michael <devilhorns@@comcast.net>
261 @author Marco Trevisan (Treviño) <mail@@3v1n0.net>
262 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
263 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
264 @author Brian Wang <brian.wang.0721@@gmail.com>
265 @author Mike Blumenkrantz (zmike) <mike@@zentific.com>
266 @author Samsung Electronics <tbd>
267 @author Samsung SAIT <tbd>
268 @author Brett Nash <nash@@nash.id.au>
269 @author Bruno Dilly <bdilly@@profusion.mobi>
270 @author Rafael Fonseca <rfonseca@@profusion.mobi>
271 @author Chuneon Park <hermet@@hermet.pe.kr>
272 @author Woohyun Jung <wh0705.jung@@samsung.com>
273 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
274 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
275 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
276 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
277 @author Gustavo Lima Chaves <glima@@profusion.mobi>
278 @author Fabiano Fidêncio <fidencio@@profusion.mobi>
279 @author Tiago Falcão <tiago@@profusion.mobi>
280 @author Otavio Pontes <otavio@@profusion.mobi>
281 @author Viktor Kojouharov <vkojouharov@@gmail.com>
282 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
283 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
284 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
285 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
286 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
287 @author Jihoon Kim <jihoon48.kim@@samsung.com>
288 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
289 @author Tom Hacohen <tom@@stosb.com>
290 @author Aharon Hillel <a.hillel@@partner.samsung.com>
291 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
292 @author Shinwoo Kim <kimcinoo@@gmail.com>
293 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
294 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
295 @author Sung W. Park <sungwoo@gmail.com>
296 @author Thierry el Borgi <thierry@substantiel.fr>
297 @author Shilpa Singh <shilpa.singh@samsung.com> <shilpasingh.o@gmail.com>
298 @author Chanwook Jung <joey.jung@samsung.com>
299 @author Hyoyoung Chang <hyoyoung.chang@samsung.com>
300 @author Guillaume "Kuri" Friloux <guillaume.friloux@asp64.com>
301 @author Kim Yunhan <spbear@gmail.com>
302
303 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
304 contact with the developers and maintainers.
305  */
306
307 #ifndef ELEMENTARY_H
308 #define ELEMENTARY_H
309
310 /**
311  * @file Elementary.h
312  * @brief Elementary's API
313  *
314  * Elementary API.
315  */
316
317 @ELM_UNIX_DEF@ ELM_UNIX
318 @ELM_WIN32_DEF@ ELM_WIN32
319 @ELM_WINCE_DEF@ ELM_WINCE
320 @ELM_EDBUS_DEF@ ELM_EDBUS
321 @ELM_EFREET_DEF@ ELM_EFREET
322 @ELM_ETHUMB_DEF@ ELM_ETHUMB
323 @ELM_WEB_DEF@ ELM_WEB
324 @ELM_EMAP_DEF@ ELM_EMAP
325 @ELM_DEBUG_DEF@ ELM_DEBUG
326 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
327 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
328
329 /* Standard headers for standard system calls etc. */
330 #include <stdio.h>
331 #include <stdlib.h>
332 #include <unistd.h>
333 #include <string.h>
334 #include <sys/types.h>
335 #include <sys/stat.h>
336 #include <sys/time.h>
337 #include <sys/param.h>
338 #include <dlfcn.h>
339 #include <math.h>
340 #include <fnmatch.h>
341 #include <limits.h>
342 #include <ctype.h>
343 #include <time.h>
344 #include <dirent.h>
345 #include <pwd.h>
346 #include <errno.h>
347
348 #ifdef ELM_UNIX
349 # include <locale.h>
350 # ifdef ELM_LIBINTL_H
351 #  include <libintl.h>
352 # endif
353 # include <signal.h>
354 # include <grp.h>
355 # include <glob.h>
356 #endif
357
358 #ifdef ELM_ALLOCA_H
359 # include <alloca.h>
360 #endif
361
362 #if defined (ELM_WIN32) || defined (ELM_WINCE)
363 # include <malloc.h>
364 # ifndef alloca
365 #  define alloca _alloca
366 # endif
367 #endif
368
369
370 /* EFL headers */
371 #include <Eina.h>
372 #include <Eet.h>
373 #include <Evas.h>
374 #include <Evas_GL.h>
375 #include <Ecore.h>
376 #include <Ecore_Evas.h>
377 #include <Ecore_File.h>
378 #include <Ecore_IMF.h>
379 #include <Ecore_Con.h>
380 #include <Edje.h>
381
382 #ifdef ELM_EDBUS
383 # include <E_DBus.h>
384 #endif
385
386 #ifdef ELM_EFREET
387 # include <Efreet.h>
388 # include <Efreet_Mime.h>
389 # include <Efreet_Trash.h>
390 #endif
391
392 #ifdef ELM_ETHUMB
393 # include <Ethumb_Client.h>
394 #endif
395
396 #ifdef ELM_EMAP
397 # include <EMap.h>
398 #endif
399
400 #ifdef EAPI
401 # undef EAPI
402 #endif
403
404 #ifdef _WIN32
405 # ifdef ELEMENTARY_BUILD
406 #  ifdef DLL_EXPORT
407 #   define EAPI __declspec(dllexport)
408 #  else
409 #   define EAPI
410 #  endif /* ! DLL_EXPORT */
411 # else
412 #  define EAPI __declspec(dllimport)
413 # endif /* ! EFL_EVAS_BUILD */
414 #else
415 # ifdef __GNUC__
416 #  if __GNUC__ >= 4
417 #   define EAPI __attribute__ ((visibility("default")))
418 #  else
419 #   define EAPI
420 #  endif
421 # else
422 #  define EAPI
423 # endif
424 #endif /* ! _WIN32 */
425
426 #ifdef _WIN32
427 # define EAPI_MAIN
428 #else
429 # define EAPI_MAIN EAPI
430 #endif
431
432 /* allow usage from c++ */
433 #ifdef __cplusplus
434 extern "C" {
435 #endif
436
437 #define ELM_VERSION_MAJOR @VMAJ@
438 #define ELM_VERSION_MINOR @VMIN@
439
440    typedef struct _Elm_Version
441      {
442         int major;
443         int minor;
444         int micro;
445         int revision;
446      } Elm_Version;
447
448    EAPI extern Elm_Version *elm_version;
449
450 /* handy macros */
451 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
452 #define ELM_PI 3.14159265358979323846
453
454    /**
455     * @defgroup General General
456     *
457     * @brief General Elementary API. Functions that don't relate to
458     * Elementary objects specifically.
459     *
460     * Here are documented functions which init/shutdown the library,
461     * that apply to generic Elementary objects, that deal with
462     * configuration, et cetera.
463     *
464     * @ref general_functions_example_page "This" example contemplates
465     * some of these functions.
466     */
467
468    /**
469     * @addtogroup General
470     * @{
471     */
472
473   /**
474    * Defines couple of standard Evas_Object layers to be used
475    * with evas_object_layer_set().
476    *
477    * @note whenever extending with new values, try to keep some padding
478    *       to siblings so there is room for further extensions.
479    */
480   typedef enum _Elm_Object_Layer
481     {
482        ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
483        ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
484        ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
485        ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
486        ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
487        ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
488     } Elm_Object_Layer;
489
490 /**************************************************************************/
491    EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
492
493    /**
494     * Emitted when the application has reconfigured elementary settings due
495     * to an external configuration tool asking it to.
496     */
497    EAPI extern int ELM_EVENT_CONFIG_ALL_CHANGED;
498
499    /**
500     * Emitted when any Elementary's policy value is changed.
501     */
502    EAPI extern int ELM_EVENT_POLICY_CHANGED;
503
504    /**
505     * @typedef Elm_Event_Policy_Changed
506     *
507     * Data on the event when an Elementary policy has changed
508     */
509     typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
510
511    /**
512     * @struct _Elm_Event_Policy_Changed
513     *
514     * Data on the event when an Elementary policy has changed
515     */
516     struct _Elm_Event_Policy_Changed
517      {
518         unsigned int policy; /**< the policy identifier */
519         int          new_value; /**< value the policy had before the change */
520         int          old_value; /**< new value the policy got */
521     };
522
523    /**
524     * Policy identifiers.
525     */
526     typedef enum _Elm_Policy
527     {
528         ELM_POLICY_QUIT, /**< under which circumstances the application
529                           * should quit automatically. @see
530                           * Elm_Policy_Quit.
531                           */
532         ELM_POLICY_LAST
533     } Elm_Policy; /**< Elementary policy identifiers/groups enumeration.  @see elm_policy_set()
534  */
535
536    typedef enum _Elm_Policy_Quit
537      {
538         ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
539                                    * automatically */
540         ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
541                                             * application's last
542                                             * window is closed */
543      } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
544
545    typedef enum _Elm_Focus_Direction
546      {
547         ELM_FOCUS_PREVIOUS,
548         ELM_FOCUS_NEXT
549      } Elm_Focus_Direction;
550
551    typedef enum _Elm_Text_Format
552      {
553         ELM_TEXT_FORMAT_PLAIN_UTF8,
554         ELM_TEXT_FORMAT_MARKUP_UTF8
555      } Elm_Text_Format;
556
557    /**
558     * Line wrapping types.
559     */
560    typedef enum _Elm_Wrap_Type
561      {
562         ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
563         ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
564         ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
565         ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
566         ELM_WRAP_LAST
567      } Elm_Wrap_Type;
568
569    typedef enum
570      {
571         ELM_INPUT_PANEL_LAYOUT_NORMAL,          /**< Default layout */
572         ELM_INPUT_PANEL_LAYOUT_NUMBER,          /**< Number layout */
573         ELM_INPUT_PANEL_LAYOUT_EMAIL,           /**< Email layout */
574         ELM_INPUT_PANEL_LAYOUT_URL,             /**< URL layout */
575         ELM_INPUT_PANEL_LAYOUT_PHONENUMBER,     /**< Phone Number layout */
576         ELM_INPUT_PANEL_LAYOUT_IP,              /**< IP layout */
577         ELM_INPUT_PANEL_LAYOUT_MONTH,           /**< Month layout */
578         ELM_INPUT_PANEL_LAYOUT_NUMBERONLY,      /**< Number Only layout */
579         ELM_INPUT_PANEL_LAYOUT_INVALID
580      } Elm_Input_Panel_Layout;
581
582    /**
583     * @typedef Elm_Object_Item
584     * An Elementary Object item handle.
585     * @ingroup General
586     */
587    typedef struct _Elm_Object_Item Elm_Object_Item;
588
589
590    /**
591     * Called back when a widget's tooltip is activated and needs content.
592     * @param data user-data given to elm_object_tooltip_content_cb_set()
593     * @param obj owner widget.
594     * @param tooltip The tooltip object (affix content to this!)
595     */
596    typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
597
598    /**
599     * Called back when a widget's item tooltip is activated and needs content.
600     * @param data user-data given to elm_object_tooltip_content_cb_set()
601     * @param obj owner widget.
602     * @param tooltip The tooltip object (affix content to this!)
603     * @param item context dependent item. As an example, if tooltip was
604     *        set on Elm_List_Item, then it is of this type.
605     */
606    typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
607
608    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. */
609
610 #ifndef ELM_LIB_QUICKLAUNCH
611 #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 */
612 #else
613 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
614 #endif
615
616 /**************************************************************************/
617    /* General calls */
618
619    /**
620     * Initialize Elementary
621     *
622     * @param[in] argc System's argument count value
623     * @param[in] argv System's pointer to array of argument strings
624     * @return The init counter value.
625     *
626     * This function initializes Elementary and increments a counter of
627     * the number of calls to it. It returns the new counter's value.
628     *
629     * @warning This call is exported only for use by the @c ELM_MAIN()
630     * macro. There is no need to use this if you use this macro (which
631     * is highly advisable). An elm_main() should contain the entry
632     * point code for your application, having the same prototype as
633     * elm_init(), and @b not being static (putting the @c EAPI symbol
634     * in front of its type declaration is advisable). The @c
635     * ELM_MAIN() call should be placed just after it.
636     *
637     * Example:
638     * @dontinclude bg_example_01.c
639     * @skip static void
640     * @until ELM_MAIN
641     *
642     * See the full @ref bg_example_01_c "example".
643     *
644     * @see elm_shutdown().
645     * @ingroup General
646     */
647    EAPI int          elm_init(int argc, char **argv);
648
649    /**
650     * Shut down Elementary
651     *
652     * @return The init counter value.
653     *
654     * This should be called at the end of your application, just
655     * before it ceases to do any more processing. This will clean up
656     * any permanent resources your application may have allocated via
657     * Elementary that would otherwise persist.
658     *
659     * @see elm_init() for an example
660     *
661     * @ingroup General
662     */
663    EAPI int          elm_shutdown(void);
664
665    /**
666     * Run Elementary's main loop
667     *
668     * This call should be issued just after all initialization is
669     * completed. This function will not return until elm_exit() is
670     * called. It will keep looping, running the main
671     * (event/processing) loop for Elementary.
672     *
673     * @see elm_init() for an example
674     *
675     * @ingroup General
676     */
677    EAPI void         elm_run(void);
678
679    /**
680     * Exit Elementary's main loop
681     *
682     * If this call is issued, it will flag the main loop to cease
683     * processing and return back to its parent function (usually your
684     * elm_main() function).
685     *
686     * @see elm_init() for an example. There, just after a request to
687     * close the window comes, the main loop will be left.
688     *
689     * @note By using the #ELM_POLICY_QUIT on your Elementary
690     * applications, you'll this function called automatically for you.
691     *
692     * @ingroup General
693     */
694    EAPI void         elm_exit(void);
695
696    /**
697     * Provide information in order to make Elementary determine the @b
698     * run time location of the software in question, so other data files
699     * such as images, sound files, executable utilities, libraries,
700     * modules and locale files can be found.
701     *
702     * @param mainfunc This is your application's main function name,
703     *        whose binary's location is to be found. Providing @c NULL
704     *        will make Elementary not to use it
705     * @param dom This will be used as the application's "domain", in the
706     *        form of a prefix to any environment variables that may
707     *        override prefix detection and the directory name, inside the
708     *        standard share or data directories, where the software's
709     *        data files will be looked for.
710     * @param checkfile This is an (optional) magic file's path to check
711     *        for existence (and it must be located in the data directory,
712     *        under the share directory provided above). Its presence will
713     *        help determine the prefix found was correct. Pass @c NULL if
714     *        the check is not to be done.
715     *
716     * This function allows one to re-locate the application somewhere
717     * else after compilation, if the developer wishes for easier
718     * distribution of pre-compiled binaries.
719     *
720     * The prefix system is designed to locate where the given software is
721     * installed (under a common path prefix) at run time and then report
722     * specific locations of this prefix and common directories inside
723     * this prefix like the binary, library, data and locale directories,
724     * through the @c elm_app_*_get() family of functions.
725     *
726     * Call elm_app_info_set() early on before you change working
727     * directory or anything about @c argv[0], so it gets accurate
728     * information.
729     *
730     * It will then try and trace back which file @p mainfunc comes from,
731     * if provided, to determine the application's prefix directory.
732     *
733     * The @p dom parameter provides a string prefix to prepend before
734     * environment variables, allowing a fallback to @b specific
735     * environment variables to locate the software. You would most
736     * probably provide a lowercase string there, because it will also
737     * serve as directory domain, explained next. For environment
738     * variables purposes, this string is made uppercase. For example if
739     * @c "myapp" is provided as the prefix, then the program would expect
740     * @c "MYAPP_PREFIX" as a master environment variable to specify the
741     * exact install prefix for the software, or more specific environment
742     * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
743     * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
744     * the user or scripts before launching. If not provided (@c NULL),
745     * environment variables will not be used to override compiled-in
746     * defaults or auto detections.
747     *
748     * The @p dom string also provides a subdirectory inside the system
749     * shared data directory for data files. For example, if the system
750     * directory is @c /usr/local/share, then this directory name is
751     * appended, creating @c /usr/local/share/myapp, if it @p was @c
752     * "myapp". It is expected the application installs data files in
753     * this directory.
754     *
755     * The @p checkfile is a file name or path of something inside the
756     * share or data directory to be used to test that the prefix
757     * detection worked. For example, your app will install a wallpaper
758     * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
759     * check that this worked, provide @c "images/wallpaper.jpg" as the @p
760     * checkfile string.
761     *
762     * @see elm_app_compile_bin_dir_set()
763     * @see elm_app_compile_lib_dir_set()
764     * @see elm_app_compile_data_dir_set()
765     * @see elm_app_compile_locale_set()
766     * @see elm_app_prefix_dir_get()
767     * @see elm_app_bin_dir_get()
768     * @see elm_app_lib_dir_get()
769     * @see elm_app_data_dir_get()
770     * @see elm_app_locale_dir_get()
771     */
772    EAPI void         elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
773
774    /**
775     * Provide information on the @b fallback application's binaries
776     * directory, on scenarios where they get overriden by
777     * elm_app_info_set().
778     *
779     * @param dir The path to the default binaries directory (compile time
780     * one)
781     *
782     * @note Elementary will as well use this path to determine actual
783     * names of binaries' directory paths, maybe changing it to be @c
784     * something/local/bin instead of @c something/bin, only, for
785     * example.
786     *
787     * @warning You should call this function @b before
788     * elm_app_info_set().
789     */
790    EAPI void         elm_app_compile_bin_dir_set(const char *dir);
791
792    /**
793     * Provide information on the @b fallback application's libraries
794     * directory, on scenarios where they get overriden by
795     * elm_app_info_set().
796     *
797     * @param dir The path to the default libraries directory (compile
798     * time one)
799     *
800     * @note Elementary will as well use this path to determine actual
801     * names of libraries' directory paths, maybe changing it to be @c
802     * something/lib32 or @c something/lib64 instead of @c something/lib,
803     * only, for example.
804     *
805     * @warning You should call this function @b before
806     * elm_app_info_set().
807     */
808    EAPI void         elm_app_compile_lib_dir_set(const char *dir);
809
810    /**
811     * Provide information on the @b fallback application's data
812     * directory, on scenarios where they get overriden by
813     * elm_app_info_set().
814     *
815     * @param dir The path to the default data directory (compile time
816     * one)
817     *
818     * @note Elementary will as well use this path to determine actual
819     * names of data directory paths, maybe changing it to be @c
820     * something/local/share instead of @c something/share, only, for
821     * example.
822     *
823     * @warning You should call this function @b before
824     * elm_app_info_set().
825     */
826    EAPI void         elm_app_compile_data_dir_set(const char *dir);
827
828    /**
829     * Provide information on the @b fallback application's locale
830     * directory, on scenarios where they get overriden by
831     * elm_app_info_set().
832     *
833     * @param dir The path to the default locale directory (compile time
834     * one)
835     *
836     * @warning You should call this function @b before
837     * elm_app_info_set().
838     */
839    EAPI void         elm_app_compile_locale_set(const char *dir);
840
841    /**
842     * Retrieve the application's run time prefix directory, as set by
843     * elm_app_info_set() and the way (environment) the application was
844     * run from.
845     *
846     * @return The directory prefix the application is actually using
847     */
848    EAPI const char  *elm_app_prefix_dir_get(void);
849
850    /**
851     * Retrieve the application's run time binaries prefix directory, as
852     * set by elm_app_info_set() and the way (environment) the application
853     * was run from.
854     *
855     * @return The binaries directory prefix the application is actually
856     * using
857     */
858    EAPI const char  *elm_app_bin_dir_get(void);
859
860    /**
861     * Retrieve the application's run time libraries prefix directory, as
862     * set by elm_app_info_set() and the way (environment) the application
863     * was run from.
864     *
865     * @return The libraries directory prefix the application is actually
866     * using
867     */
868    EAPI const char  *elm_app_lib_dir_get(void);
869
870    /**
871     * Retrieve the application's run time data prefix directory, as
872     * set by elm_app_info_set() and the way (environment) the application
873     * was run from.
874     *
875     * @return The data directory prefix the application is actually
876     * using
877     */
878    EAPI const char  *elm_app_data_dir_get(void);
879
880    /**
881     * Retrieve the application's run time locale prefix directory, as
882     * set by elm_app_info_set() and the way (environment) the application
883     * was run from.
884     *
885     * @return The locale directory prefix the application is actually
886     * using
887     */
888    EAPI const char  *elm_app_locale_dir_get(void);
889
890    EAPI void         elm_quicklaunch_mode_set(Eina_Bool ql_on);
891    EAPI Eina_Bool    elm_quicklaunch_mode_get(void);
892    EAPI int          elm_quicklaunch_init(int argc, char **argv);
893    EAPI int          elm_quicklaunch_sub_init(int argc, char **argv);
894    EAPI int          elm_quicklaunch_sub_shutdown(void);
895    EAPI int          elm_quicklaunch_shutdown(void);
896    EAPI void         elm_quicklaunch_seed(void);
897    EAPI Eina_Bool    elm_quicklaunch_prepare(int argc, char **argv);
898    EAPI Eina_Bool    elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
899    EAPI void         elm_quicklaunch_cleanup(void);
900    EAPI int          elm_quicklaunch_fallback(int argc, char **argv);
901    EAPI char        *elm_quicklaunch_exe_path_get(const char *exe);
902
903    EAPI Eina_Bool    elm_need_efreet(void);
904    EAPI Eina_Bool    elm_need_e_dbus(void);
905
906    /**
907     * This must be called before any other function that handle with
908     * elm_thumb objects or ethumb_client instances.
909     *
910     * @ingroup Thumb
911     */
912    EAPI Eina_Bool    elm_need_ethumb(void);
913
914    /**
915     * This must be called before any other function that handle with
916     * elm_web objects or ewk_view instances.
917     *
918     * @ingroup Web
919     */
920    EAPI Eina_Bool    elm_need_web(void);
921
922    /**
923     * Set a new policy's value (for a given policy group/identifier).
924     *
925     * @param policy policy identifier, as in @ref Elm_Policy.
926     * @param value policy value, which depends on the identifier
927     *
928     * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
929     *
930     * Elementary policies define applications' behavior,
931     * somehow. These behaviors are divided in policy groups (see
932     * #Elm_Policy enumeration). This call will emit the Ecore event
933     * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
934     * handlers. An #Elm_Event_Policy_Changed struct will be passed,
935     * then.
936     *
937     * @note Currently, we have only one policy identifier/group
938     * (#ELM_POLICY_QUIT), which has two possible values.
939     *
940     * @ingroup General
941     */
942    EAPI Eina_Bool    elm_policy_set(unsigned int policy, int value);
943
944    /**
945     * Gets the policy value set for given policy identifier.
946     *
947     * @param policy policy identifier, as in #Elm_Policy.
948     * @return The currently set policy value, for that
949     * identifier. Will be @c 0 if @p policy passed is invalid.
950     *
951     * @ingroup General
952     */
953    EAPI int          elm_policy_get(unsigned int policy);
954
955    /**
956     * Change the language of the current application
957     *
958     * The @p lang passed must be the full name of the locale to use, for
959     * example "en_US.utf8" or "es_ES@euro".
960     *
961     * Changing language with this function will make Elementary run through
962     * all its widgets, translating strings set with
963     * elm_object_domain_translatable_text_part_set(). This way, an entire
964     * UI can have its language changed without having to restart the program.
965     *
966     * For more complex cases, like having formatted strings that need
967     * translation, widgets will also emit a "language,changed" signal that
968     * the user can listen to to manually translate the text.
969     *
970     * @param lang Language to set, must be the full name of the locale
971     *
972     * @ingroup General
973     */
974    EAPI void         elm_language_set(const char *lang);
975
976    /**
977     * Set a label of an object
978     *
979     * @param obj The Elementary object
980     * @param part The text part name to set (NULL for the default label)
981     * @param label The new text of the label
982     *
983     * @note Elementary objects may have many labels (e.g. Action Slider)
984     *
985     * @ingroup General
986     */
987    EAPI void         elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
988
989 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
990
991    /**
992     * Get a label of an object
993     *
994     * @param obj The Elementary object
995     * @param part The text part name to get (NULL for the default label)
996     * @return text of the label or NULL for any error
997     *
998     * @note Elementary objects may have many labels (e.g. Action Slider)
999     *
1000     * @ingroup General
1001     */
1002    EAPI const char  *elm_object_text_part_get(const Evas_Object *obj, const char *part);
1003
1004 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
1005
1006    /**
1007     * Set the text for an objects part, marking it as translatable
1008     *
1009     * The string to set as @p text must be the original one. Do not pass the
1010     * return of @c gettext() here. Elementary will translate the string
1011     * internally and set it on the object using elm_object_text_part_set(),
1012     * also storing the original string so that it can be automatically
1013     * translated when the language is changed with elm_language_set().
1014     *
1015     * The @p domain will be stored along to find the translation in the
1016     * correct catalog. It can be NULL, in which case it will use whatever
1017     * domain was set by the application with @c textdomain(). This is useful
1018     * in case you are building a library on top of Elementary that will have
1019     * its own translatable strings, that should not be mixed with those of
1020     * programs using the library.
1021     *
1022     * @param obj The object
1023     * @param part The name of the part to set
1024     * @param domain The translation domain to use
1025     * @param text The original, non-translated text to set
1026     *
1027     * @ingroup General
1028     */
1029    EAPI void         elm_object_domain_translatable_text_part_set(Evas_Object *obj, const char *part, const char *domain, const char *text);
1030
1031 #define elm_object_domain_translatable_text_set(obj, domain, text) elm_object_domain_translatable_text_part_set((obj), NULL, (domain), (text))
1032
1033 #define elm_object_translatable_text_set(obj, text) elm_object_domain_translatable_text_part_set((obj), NULL, NULL, (text))
1034
1035    /**
1036     * Gets the original string set as translatable for an object
1037     *
1038     * When setting translated strings, the function elm_object_text_part_get()
1039     * will return the translation returned by @c gettext(). To get the
1040     * original string use this function.
1041     *
1042     * @param obj The object
1043     * @param part The name of the part that was set
1044     *
1045     * @return The original, untranslated string
1046     *
1047     * @ingroup General
1048     */
1049    EAPI const char  *elm_object_translatable_text_part_get(const Evas_Object *obj, const char *part);
1050
1051 #define elm_object_translatable_text_get(obj) elm_object_translatable_text_part_get((obj), NULL)
1052
1053    /**
1054     * Set a content of an object
1055     *
1056     * @param obj The Elementary object
1057     * @param part The content part name to set (NULL for the default content)
1058     * @param content The new content of the object
1059     *
1060     * @note Elementary objects may have many contents
1061     *
1062     * @ingroup General
1063     */
1064    EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
1065
1066 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
1067
1068    /**
1069     * Get a content of an object
1070     *
1071     * @param obj The Elementary object
1072     * @param item The content part name to get (NULL for the default content)
1073     * @return content of the object or NULL for any error
1074     *
1075     * @note Elementary objects may have many contents
1076     *
1077     * @ingroup General
1078     */
1079    EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
1080
1081 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
1082
1083    /**
1084     * Unset a content of an object
1085     *
1086     * @param obj The Elementary object
1087     * @param item The content part name to unset (NULL for the default content)
1088     *
1089     * @note Elementary objects may have many contents
1090     *
1091     * @ingroup General
1092     */
1093    EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1094
1095 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
1096
1097    /**
1098     * Get the wiget object's handle which contains a given item
1099     *
1100     * @param item The Elementary object item 
1101     * @return The widget object
1102     *
1103     * @note This returns the widget object itself that an item belongs to.
1104     *
1105     * @ingroup General
1106     */
1107    EAPI Evas_Object *elm_object_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1108
1109    /**
1110     * Set a content of an object item
1111     *
1112     * @param it The Elementary object item
1113     * @param part The content part name to set (NULL for the default content)
1114     * @param content The new content of the object item
1115     *
1116     * @note Elementary object items may have many contents
1117     *
1118     * @ingroup General
1119     */
1120    EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1121
1122 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
1123
1124    /**
1125     * Get a content of an object item
1126     *
1127     * @param it The Elementary object item
1128     * @param part The content part name to unset (NULL for the default content)
1129     * @return content of the object item or NULL for any error
1130     *
1131     * @note Elementary object items may have many contents
1132     *
1133     * @ingroup General
1134     */
1135    EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
1136
1137 #define elm_object_item_content_get(it) elm_object_item_content_part_get((it), NULL)
1138
1139    /**
1140     * Unset a content of an object item
1141     *
1142     * @param it The Elementary object item
1143     * @param part The content part name to unset (NULL for the default content)
1144     *
1145     * @note Elementary object items may have many contents
1146     *
1147     * @ingroup General
1148     */
1149    EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1150
1151 #define elm_object_item_content_unset(it) elm_object_item_content_part_unset((it), NULL)
1152
1153    /**
1154     * Set a label of an object item
1155     *
1156     * @param it The Elementary object item
1157     * @param part The text part name to set (NULL for the default label)
1158     * @param label The new text of the label
1159     *
1160     * @note Elementary object items may have many labels
1161     *
1162     * @ingroup General
1163     */
1164    EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1165
1166 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1167
1168    /**
1169     * Get a label of an object
1170     *
1171     * @param it The Elementary object item
1172     * @param part The text part name to get (NULL for the default label)
1173     * @return text of the label or NULL for any error
1174     *
1175     * @note Elementary object items may have many labels
1176     *
1177     * @ingroup General
1178     */
1179    EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1180
1181 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
1182
1183    /**
1184     * Set the text to read out when in accessibility mode
1185     *
1186     * @param obj The object which is to be described
1187     * @param txt The text that describes the widget to people with poor or no vision
1188     *
1189     * @ingroup General
1190     */
1191    EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1192
1193    /**
1194     * Set the text to read out when in accessibility mode
1195     *
1196     * @param it The object item which is to be described
1197     * @param txt The text that describes the widget to people with poor or no vision
1198     *
1199     * @ingroup General
1200     */
1201    EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1202
1203    /**
1204     * Get the data associated with an object item
1205     * @param it The object item
1206     * @return The data associated with @p it
1207     *
1208     * @ingroup General
1209     */
1210    EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1211
1212    /**
1213     * Set the data associated with an object item
1214     * @param it The object item
1215     * @param data The data to be associated with @p it
1216     *
1217     * @ingroup General
1218     */
1219    EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1220
1221    /**
1222     * Send a signal to the edje object of the widget item.
1223     *
1224     * This function sends a signal to the edje object of the obj item. An
1225     * edje program can respond to a signal by specifying matching
1226     * 'signal' and 'source' fields.
1227     *
1228     * @param it The Elementary object item
1229     * @param emission The signal's name.
1230     * @param source The signal's source.
1231     * @ingroup General
1232     */
1233    EAPI void             elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1234
1235    /**
1236     * @}
1237     */
1238
1239    /**
1240     * @defgroup Caches Caches
1241     *
1242     * These are functions which let one fine-tune some cache values for
1243     * Elementary applications, thus allowing for performance adjustments.
1244     *
1245     * @{
1246     */
1247
1248    /**
1249     * @brief Flush all caches.
1250     *
1251     * Frees all data that was in cache and is not currently being used to reduce
1252     * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1253     * to calling all of the following functions:
1254     * @li edje_file_cache_flush()
1255     * @li edje_collection_cache_flush()
1256     * @li eet_clearcache()
1257     * @li evas_image_cache_flush()
1258     * @li evas_font_cache_flush()
1259     * @li evas_render_dump()
1260     * @note Evas caches are flushed for every canvas associated with a window.
1261     *
1262     * @ingroup Caches
1263     */
1264    EAPI void         elm_all_flush(void);
1265
1266    /**
1267     * Get the configured cache flush interval time
1268     *
1269     * This gets the globally configured cache flush interval time, in
1270     * ticks
1271     *
1272     * @return The cache flush interval time
1273     * @ingroup Caches
1274     *
1275     * @see elm_all_flush()
1276     */
1277    EAPI int          elm_cache_flush_interval_get(void);
1278
1279    /**
1280     * Set the configured cache flush interval time
1281     *
1282     * This sets the globally configured cache flush interval time, in ticks
1283     *
1284     * @param size The cache flush interval time
1285     * @ingroup Caches
1286     *
1287     * @see elm_all_flush()
1288     */
1289    EAPI void         elm_cache_flush_interval_set(int size);
1290
1291    /**
1292     * Set the configured cache flush interval time for all applications on the
1293     * display
1294     *
1295     * This sets the globally configured cache flush interval time -- in ticks
1296     * -- for all applications on the display.
1297     *
1298     * @param size The cache flush interval time
1299     * @ingroup Caches
1300     */
1301    EAPI void         elm_cache_flush_interval_all_set(int size);
1302
1303    /**
1304     * Get the configured cache flush enabled state
1305     *
1306     * This gets the globally configured cache flush state - if it is enabled
1307     * or not. When cache flushing is enabled, elementary will regularly
1308     * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1309     * memory and allow usage to re-seed caches and data in memory where it
1310     * can do so. An idle application will thus minimise its memory usage as
1311     * data will be freed from memory and not be re-loaded as it is idle and
1312     * not rendering or doing anything graphically right now.
1313     *
1314     * @return The cache flush state
1315     * @ingroup Caches
1316     *
1317     * @see elm_all_flush()
1318     */
1319    EAPI Eina_Bool    elm_cache_flush_enabled_get(void);
1320
1321    /**
1322     * Set the configured cache flush enabled state
1323     *
1324     * This sets the globally configured cache flush enabled state
1325     *
1326     * @param size The cache flush enabled state
1327     * @ingroup Caches
1328     *
1329     * @see elm_all_flush()
1330     */
1331    EAPI void         elm_cache_flush_enabled_set(Eina_Bool enabled);
1332
1333    /**
1334     * Set the configured cache flush enabled state for all applications on the
1335     * display
1336     *
1337     * This sets the globally configured cache flush enabled state for all
1338     * applications on the display.
1339     *
1340     * @param size The cache flush enabled state
1341     * @ingroup Caches
1342     */
1343    EAPI void         elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1344
1345    /**
1346     * Get the configured font cache size
1347     *
1348     * This gets the globally configured font cache size, in bytes
1349     *
1350     * @return The font cache size
1351     * @ingroup Caches
1352     */
1353    EAPI int          elm_font_cache_get(void);
1354
1355    /**
1356     * Set the configured font cache size
1357     *
1358     * This sets the globally configured font cache size, in bytes
1359     *
1360     * @param size The font cache size
1361     * @ingroup Caches
1362     */
1363    EAPI void         elm_font_cache_set(int size);
1364
1365    /**
1366     * Set the configured font cache size for all applications on the
1367     * display
1368     *
1369     * This sets the globally configured font cache size -- in bytes
1370     * -- for all applications on the display.
1371     *
1372     * @param size The font cache size
1373     * @ingroup Caches
1374     */
1375    EAPI void         elm_font_cache_all_set(int size);
1376
1377    /**
1378     * Get the configured image cache size
1379     *
1380     * This gets the globally configured image cache size, in bytes
1381     *
1382     * @return The image cache size
1383     * @ingroup Caches
1384     */
1385    EAPI int          elm_image_cache_get(void);
1386
1387    /**
1388     * Set the configured image cache size
1389     *
1390     * This sets the globally configured image cache size, in bytes
1391     *
1392     * @param size The image cache size
1393     * @ingroup Caches
1394     */
1395    EAPI void         elm_image_cache_set(int size);
1396
1397    /**
1398     * Set the configured image cache size for all applications on the
1399     * display
1400     *
1401     * This sets the globally configured image cache size -- in bytes
1402     * -- for all applications on the display.
1403     *
1404     * @param size The image cache size
1405     * @ingroup Caches
1406     */
1407    EAPI void         elm_image_cache_all_set(int size);
1408
1409    /**
1410     * Get the configured edje file cache size.
1411     *
1412     * This gets the globally configured edje file cache size, in number
1413     * of files.
1414     *
1415     * @return The edje file cache size
1416     * @ingroup Caches
1417     */
1418    EAPI int          elm_edje_file_cache_get(void);
1419
1420    /**
1421     * Set the configured edje file cache size
1422     *
1423     * This sets the globally configured edje file cache size, in number
1424     * of files.
1425     *
1426     * @param size The edje file cache size
1427     * @ingroup Caches
1428     */
1429    EAPI void         elm_edje_file_cache_set(int size);
1430
1431    /**
1432     * Set the configured edje file cache size for all applications on the
1433     * display
1434     *
1435     * This sets the globally configured edje file cache size -- in number
1436     * of files -- for all applications on the display.
1437     *
1438     * @param size The edje file cache size
1439     * @ingroup Caches
1440     */
1441    EAPI void         elm_edje_file_cache_all_set(int size);
1442
1443    /**
1444     * Get the configured edje collections (groups) cache size.
1445     *
1446     * This gets the globally configured edje collections cache size, in
1447     * number of collections.
1448     *
1449     * @return The edje collections cache size
1450     * @ingroup Caches
1451     */
1452    EAPI int          elm_edje_collection_cache_get(void);
1453
1454    /**
1455     * Set the configured edje collections (groups) cache size
1456     *
1457     * This sets the globally configured edje collections cache size, in
1458     * number of collections.
1459     *
1460     * @param size The edje collections cache size
1461     * @ingroup Caches
1462     */
1463    EAPI void         elm_edje_collection_cache_set(int size);
1464
1465    /**
1466     * Set the configured edje collections (groups) cache size for all
1467     * applications on the display
1468     *
1469     * This sets the globally configured edje collections cache size -- in
1470     * number of collections -- for all applications on the display.
1471     *
1472     * @param size The edje collections cache size
1473     * @ingroup Caches
1474     */
1475    EAPI void         elm_edje_collection_cache_all_set(int size);
1476
1477    /**
1478     * @}
1479     */
1480
1481    /**
1482     * @defgroup Scaling Widget Scaling
1483     *
1484     * Different widgets can be scaled independently. These functions
1485     * allow you to manipulate this scaling on a per-widget basis. The
1486     * object and all its children get their scaling factors multiplied
1487     * by the scale factor set. This is multiplicative, in that if a
1488     * child also has a scale size set it is in turn multiplied by its
1489     * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
1490     * double size, @c 0.5 is half, etc.
1491     *
1492     * @ref general_functions_example_page "This" example contemplates
1493     * some of these functions.
1494     */
1495
1496    /**
1497     * Get the global scaling factor
1498     *
1499     * This gets the globally configured scaling factor that is applied to all
1500     * objects.
1501     *
1502     * @return The scaling factor
1503     * @ingroup Scaling
1504     */
1505    EAPI double       elm_scale_get(void);
1506
1507    /**
1508     * Set the global scaling factor
1509     *
1510     * This sets the globally configured scaling factor that is applied to all
1511     * objects.
1512     *
1513     * @param scale The scaling factor to set
1514     * @ingroup Scaling
1515     */
1516    EAPI void         elm_scale_set(double scale);
1517
1518    /**
1519     * Set the global scaling factor for all applications on the display
1520     *
1521     * This sets the globally configured scaling factor that is applied to all
1522     * objects for all applications.
1523     * @param scale The scaling factor to set
1524     * @ingroup Scaling
1525     */
1526    EAPI void         elm_scale_all_set(double scale);
1527
1528    /**
1529     * Set the scaling factor for a given Elementary object
1530     *
1531     * @param obj The Elementary to operate on
1532     * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1533     * no scaling)
1534     *
1535     * @ingroup Scaling
1536     */
1537    EAPI void         elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1538
1539    /**
1540     * Get the scaling factor for a given Elementary object
1541     *
1542     * @param obj The object
1543     * @return The scaling factor set by elm_object_scale_set()
1544     *
1545     * @ingroup Scaling
1546     */
1547    EAPI double       elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1548
1549    /**
1550     * @defgroup Password_last_show Password last input show
1551     *
1552     * Last show feature of password mode enables user to view
1553     * the last input entered for few seconds before masking it.
1554     * These functions allow to set this feature in password mode
1555     * of entry widget and also allow to manipulate the duration
1556     * for which the input has to be visible.
1557     *
1558     * @{
1559     */
1560
1561    /**
1562     * Get show last setting of password mode.
1563     *
1564     * This gets the show last input setting of password mode which might be
1565     * enabled or disabled.
1566     *
1567     * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1568     *            if it's disabled.
1569     * @ingroup Password_last_show
1570     */
1571    EAPI Eina_Bool elm_password_show_last_get(void);
1572
1573    /**
1574     * Set show last setting in password mode.
1575     *
1576     * This enables or disables show last setting of password mode.
1577     *
1578     * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1579     * @see elm_password_show_last_timeout_set()
1580     * @ingroup Password_last_show
1581     */
1582    EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1583
1584    /**
1585     * Get's the timeout value in last show password mode.
1586     *
1587     * This gets the time out value for which the last input entered in password
1588     * mode will be visible.
1589     *
1590     * @return The timeout value of last show password mode.
1591     * @ingroup Password_last_show
1592     */
1593    EAPI double elm_password_show_last_timeout_get(void);
1594
1595    /**
1596     * Set's the timeout value in last show password mode.
1597     *
1598     * This sets the time out value for which the last input entered in password
1599     * mode will be visible.
1600     *
1601     * @param password_show_last_timeout The timeout value.
1602     * @see elm_password_show_last_set()
1603     * @ingroup Password_last_show
1604     */
1605    EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1606
1607    /**
1608     * @}
1609     */
1610
1611    /**
1612     * @defgroup UI-Mirroring Selective Widget mirroring
1613     *
1614     * These functions allow you to set ui-mirroring on specific
1615     * widgets or the whole interface. Widgets can be in one of two
1616     * modes, automatic and manual.  Automatic means they'll be changed
1617     * according to the system mirroring mode and manual means only
1618     * explicit changes will matter. You are not supposed to change
1619     * mirroring state of a widget set to automatic, will mostly work,
1620     * but the behavior is not really defined.
1621     *
1622     * @{
1623     */
1624
1625    EAPI Eina_Bool    elm_mirrored_get(void);
1626    EAPI void         elm_mirrored_set(Eina_Bool mirrored);
1627
1628    /**
1629     * Get the system mirrored mode. This determines the default mirrored mode
1630     * of widgets.
1631     *
1632     * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1633     */
1634    EAPI Eina_Bool    elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1635
1636    /**
1637     * Set the system mirrored mode. This determines the default mirrored mode
1638     * of widgets.
1639     *
1640     * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1641     */
1642    EAPI void         elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1643
1644    /**
1645     * Returns the widget's mirrored mode setting.
1646     *
1647     * @param obj The widget.
1648     * @return mirrored mode setting of the object.
1649     *
1650     **/
1651    EAPI Eina_Bool    elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1652
1653    /**
1654     * Sets the widget's mirrored mode setting.
1655     * When widget in automatic mode, it follows the system mirrored mode set by
1656     * elm_mirrored_set().
1657     * @param obj The widget.
1658     * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1659     */
1660    EAPI void         elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1661
1662    /**
1663     * @}
1664     */
1665
1666    /**
1667     * Set the style to use by a widget
1668     *
1669     * Sets the style name that will define the appearance of a widget. Styles
1670     * vary from widget to widget and may also be defined by other themes
1671     * by means of extensions and overlays.
1672     *
1673     * @param obj The Elementary widget to style
1674     * @param style The style name to use
1675     *
1676     * @see elm_theme_extension_add()
1677     * @see elm_theme_extension_del()
1678     * @see elm_theme_overlay_add()
1679     * @see elm_theme_overlay_del()
1680     *
1681     * @ingroup Styles
1682     */
1683    EAPI void         elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1684    /**
1685     * Get the style used by the widget
1686     *
1687     * This gets the style being used for that widget. Note that the string
1688     * pointer is only valid as longas the object is valid and the style doesn't
1689     * change.
1690     *
1691     * @param obj The Elementary widget to query for its style
1692     * @return The style name used
1693     *
1694     * @see elm_object_style_set()
1695     *
1696     * @ingroup Styles
1697     */
1698    EAPI const char  *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1699
1700    /**
1701     * @defgroup Styles Styles
1702     *
1703     * Widgets can have different styles of look. These generic API's
1704     * set styles of widgets, if they support them (and if the theme(s)
1705     * do).
1706     *
1707     * @ref general_functions_example_page "This" example contemplates
1708     * some of these functions.
1709     */
1710
1711    /**
1712     * Set the disabled state of an Elementary object.
1713     *
1714     * @param obj The Elementary object to operate on
1715     * @param disabled The state to put in in: @c EINA_TRUE for
1716     *        disabled, @c EINA_FALSE for enabled
1717     *
1718     * Elementary objects can be @b disabled, in which state they won't
1719     * receive input and, in general, will be themed differently from
1720     * their normal state, usually greyed out. Useful for contexts
1721     * where you don't want your users to interact with some of the
1722     * parts of you interface.
1723     *
1724     * This sets the state for the widget, either disabling it or
1725     * enabling it back.
1726     *
1727     * @ingroup Styles
1728     */
1729    EAPI void         elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1730
1731    /**
1732     * Get the disabled state of an Elementary object.
1733     *
1734     * @param obj The Elementary object to operate on
1735     * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1736     *            if it's enabled (or on errors)
1737     *
1738     * This gets the state of the widget, which might be enabled or disabled.
1739     *
1740     * @ingroup Styles
1741     */
1742    EAPI Eina_Bool    elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1743
1744    /**
1745     * @defgroup WidgetNavigation Widget Tree Navigation.
1746     *
1747     * How to check if an Evas Object is an Elementary widget? How to
1748     * get the first elementary widget that is parent of the given
1749     * object?  These are all covered in widget tree navigation.
1750     *
1751     * @ref general_functions_example_page "This" example contemplates
1752     * some of these functions.
1753     */
1754
1755    /**
1756     * Check if the given Evas Object is an Elementary widget.
1757     *
1758     * @param obj the object to query.
1759     * @return @c EINA_TRUE if it is an elementary widget variant,
1760     *         @c EINA_FALSE otherwise
1761     * @ingroup WidgetNavigation
1762     */
1763    EAPI Eina_Bool    elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1764
1765    /**
1766     * Get the first parent of the given object that is an Elementary
1767     * widget.
1768     *
1769     * @param obj the Elementary object to query parent from.
1770     * @return the parent object that is an Elementary widget, or @c
1771     *         NULL, if it was not found.
1772     *
1773     * Use this to query for an object's parent widget.
1774     *
1775     * @note Most of Elementary users wouldn't be mixing non-Elementary
1776     * smart objects in the objects tree of an application, as this is
1777     * an advanced usage of Elementary with Evas. So, except for the
1778     * application's window, which is the root of that tree, all other
1779     * objects would have valid Elementary widget parents.
1780     *
1781     * @ingroup WidgetNavigation
1782     */
1783    EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1784
1785    /**
1786     * Get the top level parent of an Elementary widget.
1787     *
1788     * @param obj The object to query.
1789     * @return The top level Elementary widget, or @c NULL if parent cannot be
1790     * found.
1791     * @ingroup WidgetNavigation
1792     */
1793    EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1794
1795    /**
1796     * Get the string that represents this Elementary widget.
1797     *
1798     * @note Elementary is weird and exposes itself as a single
1799     *       Evas_Object_Smart_Class of type "elm_widget", so
1800     *       evas_object_type_get() always return that, making debug and
1801     *       language bindings hard. This function tries to mitigate this
1802     *       problem, but the solution is to change Elementary to use
1803     *       proper inheritance.
1804     *
1805     * @param obj the object to query.
1806     * @return Elementary widget name, or @c NULL if not a valid widget.
1807     * @ingroup WidgetNavigation
1808     */
1809    EAPI const char  *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1810
1811    /**
1812     * @defgroup Config Elementary Config
1813     *
1814     * Elementary configuration is formed by a set options bounded to a
1815     * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1816     * "finger size", etc. These are functions with which one syncronizes
1817     * changes made to those values to the configuration storing files, de
1818     * facto. You most probably don't want to use the functions in this
1819     * group unlees you're writing an elementary configuration manager.
1820     *
1821     * @{
1822     */
1823
1824    /**
1825     * Save back Elementary's configuration, so that it will persist on
1826     * future sessions.
1827     *
1828     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1829     * @ingroup Config
1830     *
1831     * This function will take effect -- thus, do I/O -- immediately. Use
1832     * it when you want to apply all configuration changes at once. The
1833     * current configuration set will get saved onto the current profile
1834     * configuration file.
1835     *
1836     */
1837    EAPI Eina_Bool    elm_config_save(void);
1838
1839    /**
1840     * Reload Elementary's configuration, bounded to current selected
1841     * profile.
1842     *
1843     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1844     * @ingroup Config
1845     *
1846     * Useful when you want to force reloading of configuration values for
1847     * a profile. If one removes user custom configuration directories,
1848     * for example, it will force a reload with system values insted.
1849     *
1850     */
1851    EAPI void         elm_config_reload(void);
1852
1853    /**
1854     * @}
1855     */
1856
1857    /**
1858     * @defgroup Profile Elementary Profile
1859     *
1860     * Profiles are pre-set options that affect the whole look-and-feel of
1861     * Elementary-based applications. There are, for example, profiles
1862     * aimed at desktop computer applications and others aimed at mobile,
1863     * touchscreen-based ones. You most probably don't want to use the
1864     * functions in this group unlees you're writing an elementary
1865     * configuration manager.
1866     *
1867     * @{
1868     */
1869
1870    /**
1871     * Get Elementary's profile in use.
1872     *
1873     * This gets the global profile that is applied to all Elementary
1874     * applications.
1875     *
1876     * @return The profile's name
1877     * @ingroup Profile
1878     */
1879    EAPI const char  *elm_profile_current_get(void);
1880
1881    /**
1882     * Get an Elementary's profile directory path in the filesystem. One
1883     * may want to fetch a system profile's dir or an user one (fetched
1884     * inside $HOME).
1885     *
1886     * @param profile The profile's name
1887     * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1888     *                or a system one (@c EINA_FALSE)
1889     * @return The profile's directory path.
1890     * @ingroup Profile
1891     *
1892     * @note You must free it with elm_profile_dir_free().
1893     */
1894    EAPI const char  *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1895
1896    /**
1897     * Free an Elementary's profile directory path, as returned by
1898     * elm_profile_dir_get().
1899     *
1900     * @param p_dir The profile's path
1901     * @ingroup Profile
1902     *
1903     */
1904    EAPI void         elm_profile_dir_free(const char *p_dir);
1905
1906    /**
1907     * Get Elementary's list of available profiles.
1908     *
1909     * @return The profiles list. List node data are the profile name
1910     *         strings.
1911     * @ingroup Profile
1912     *
1913     * @note One must free this list, after usage, with the function
1914     *       elm_profile_list_free().
1915     */
1916    EAPI Eina_List   *elm_profile_list_get(void);
1917
1918    /**
1919     * Free Elementary's list of available profiles.
1920     *
1921     * @param l The profiles list, as returned by elm_profile_list_get().
1922     * @ingroup Profile
1923     *
1924     */
1925    EAPI void         elm_profile_list_free(Eina_List *l);
1926
1927    /**
1928     * Set Elementary's profile.
1929     *
1930     * This sets the global profile that is applied to Elementary
1931     * applications. Just the process the call comes from will be
1932     * affected.
1933     *
1934     * @param profile The profile's name
1935     * @ingroup Profile
1936     *
1937     */
1938    EAPI void         elm_profile_set(const char *profile);
1939
1940    /**
1941     * Set Elementary's profile.
1942     *
1943     * This sets the global profile that is applied to all Elementary
1944     * applications. All running Elementary windows will be affected.
1945     *
1946     * @param profile The profile's name
1947     * @ingroup Profile
1948     *
1949     */
1950    EAPI void         elm_profile_all_set(const char *profile);
1951
1952    /**
1953     * @}
1954     */
1955
1956    /**
1957     * @defgroup Engine Elementary Engine
1958     *
1959     * These are functions setting and querying which rendering engine
1960     * Elementary will use for drawing its windows' pixels.
1961     *
1962     * The following are the available engines:
1963     * @li "software_x11"
1964     * @li "fb"
1965     * @li "directfb"
1966     * @li "software_16_x11"
1967     * @li "software_8_x11"
1968     * @li "xrender_x11"
1969     * @li "opengl_x11"
1970     * @li "software_gdi"
1971     * @li "software_16_wince_gdi"
1972     * @li "sdl"
1973     * @li "software_16_sdl"
1974     * @li "opengl_sdl"
1975     * @li "buffer"
1976     * @li "ews"
1977     *
1978     * @{
1979     */
1980
1981    /**
1982     * @brief Get Elementary's rendering engine in use.
1983     *
1984     * @return The rendering engine's name
1985     * @note there's no need to free the returned string, here.
1986     *
1987     * This gets the global rendering engine that is applied to all Elementary
1988     * applications.
1989     *
1990     * @see elm_engine_set()
1991     */
1992    EAPI const char  *elm_engine_current_get(void);
1993
1994    /**
1995     * @brief Set Elementary's rendering engine for use.
1996     *
1997     * @param engine The rendering engine's name
1998     *
1999     * This sets global rendering engine that is applied to all Elementary
2000     * applications. Note that it will take effect only to Elementary windows
2001     * created after this is called.
2002     *
2003     * @see elm_win_add()
2004     */
2005    EAPI void         elm_engine_set(const char *engine);
2006
2007    /**
2008     * @}
2009     */
2010
2011    /**
2012     * @defgroup Fonts Elementary Fonts
2013     *
2014     * These are functions dealing with font rendering, selection and the
2015     * like for Elementary applications. One might fetch which system
2016     * fonts are there to use and set custom fonts for individual classes
2017     * of UI items containing text (text classes).
2018     *
2019     * @{
2020     */
2021
2022   typedef struct _Elm_Text_Class
2023     {
2024        const char *name;
2025        const char *desc;
2026     } Elm_Text_Class;
2027
2028   typedef struct _Elm_Font_Overlay
2029     {
2030        const char     *text_class;
2031        const char     *font;
2032        Evas_Font_Size  size;
2033     } Elm_Font_Overlay;
2034
2035   typedef struct _Elm_Font_Properties
2036     {
2037        const char *name;
2038        Eina_List  *styles;
2039     } Elm_Font_Properties;
2040
2041    /**
2042     * Get Elementary's list of supported text classes.
2043     *
2044     * @return The text classes list, with @c Elm_Text_Class blobs as data.
2045     * @ingroup Fonts
2046     *
2047     * Release the list with elm_text_classes_list_free().
2048     */
2049    EAPI const Eina_List     *elm_text_classes_list_get(void);
2050
2051    /**
2052     * Free Elementary's list of supported text classes.
2053     *
2054     * @ingroup Fonts
2055     *
2056     * @see elm_text_classes_list_get().
2057     */
2058    EAPI void                 elm_text_classes_list_free(const Eina_List *list);
2059
2060    /**
2061     * Get Elementary's list of font overlays, set with
2062     * elm_font_overlay_set().
2063     *
2064     * @return The font overlays list, with @c Elm_Font_Overlay blobs as
2065     * data.
2066     *
2067     * @ingroup Fonts
2068     *
2069     * For each text class, one can set a <b>font overlay</b> for it,
2070     * overriding the default font properties for that class coming from
2071     * the theme in use. There is no need to free this list.
2072     *
2073     * @see elm_font_overlay_set() and elm_font_overlay_unset().
2074     */
2075    EAPI const Eina_List     *elm_font_overlay_list_get(void);
2076
2077    /**
2078     * Set a font overlay for a given Elementary text class.
2079     *
2080     * @param text_class Text class name
2081     * @param font Font name and style string
2082     * @param size Font size
2083     *
2084     * @ingroup Fonts
2085     *
2086     * @p font has to be in the format returned by
2087     * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
2088     * and elm_font_overlay_unset().
2089     */
2090    EAPI void                 elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
2091
2092    /**
2093     * Unset a font overlay for a given Elementary text class.
2094     *
2095     * @param text_class Text class name
2096     *
2097     * @ingroup Fonts
2098     *
2099     * This will bring back text elements belonging to text class
2100     * @p text_class back to their default font settings.
2101     */
2102    EAPI void                 elm_font_overlay_unset(const char *text_class);
2103
2104    /**
2105     * Apply the changes made with elm_font_overlay_set() and
2106     * elm_font_overlay_unset() on the current Elementary window.
2107     *
2108     * @ingroup Fonts
2109     *
2110     * This applies all font overlays set to all objects in the UI.
2111     */
2112    EAPI void                 elm_font_overlay_apply(void);
2113
2114    /**
2115     * Apply the changes made with elm_font_overlay_set() and
2116     * elm_font_overlay_unset() on all Elementary application windows.
2117     *
2118     * @ingroup Fonts
2119     *
2120     * This applies all font overlays set to all objects in the UI.
2121     */
2122    EAPI void                 elm_font_overlay_all_apply(void);
2123
2124    /**
2125     * Translate a font (family) name string in fontconfig's font names
2126     * syntax into an @c Elm_Font_Properties struct.
2127     *
2128     * @param font The font name and styles string
2129     * @return the font properties struct
2130     *
2131     * @ingroup Fonts
2132     *
2133     * @note The reverse translation can be achived with
2134     * elm_font_fontconfig_name_get(), for one style only (single font
2135     * instance, not family).
2136     */
2137    EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2138
2139    /**
2140     * Free font properties return by elm_font_properties_get().
2141     *
2142     * @param efp the font properties struct
2143     *
2144     * @ingroup Fonts
2145     */
2146    EAPI void                 elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2147
2148    /**
2149     * Translate a font name, bound to a style, into fontconfig's font names
2150     * syntax.
2151     *
2152     * @param name The font (family) name
2153     * @param style The given style (may be @c NULL)
2154     *
2155     * @return the font name and style string
2156     *
2157     * @ingroup Fonts
2158     *
2159     * @note The reverse translation can be achived with
2160     * elm_font_properties_get(), for one style only (single font
2161     * instance, not family).
2162     */
2163    EAPI const char          *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2164
2165    /**
2166     * Free the font string return by elm_font_fontconfig_name_get().
2167     *
2168     * @param efp the font properties struct
2169     *
2170     * @ingroup Fonts
2171     */
2172    EAPI void                 elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2173
2174    /**
2175     * Create a font hash table of available system fonts.
2176     *
2177     * One must call it with @p list being the return value of
2178     * evas_font_available_list(). The hash will be indexed by font
2179     * (family) names, being its values @c Elm_Font_Properties blobs.
2180     *
2181     * @param list The list of available system fonts, as returned by
2182     * evas_font_available_list().
2183     * @return the font hash.
2184     *
2185     * @ingroup Fonts
2186     *
2187     * @note The user is supposed to get it populated at least with 3
2188     * default font families (Sans, Serif, Monospace), which should be
2189     * present on most systems.
2190     */
2191    EAPI Eina_Hash           *elm_font_available_hash_add(Eina_List *list);
2192
2193    /**
2194     * Free the hash return by elm_font_available_hash_add().
2195     *
2196     * @param hash the hash to be freed.
2197     *
2198     * @ingroup Fonts
2199     */
2200    EAPI void                 elm_font_available_hash_del(Eina_Hash *hash);
2201
2202    /**
2203     * @}
2204     */
2205
2206    /**
2207     * @defgroup Fingers Fingers
2208     *
2209     * Elementary is designed to be finger-friendly for touchscreens,
2210     * and so in addition to scaling for display resolution, it can
2211     * also scale based on finger "resolution" (or size). You can then
2212     * customize the granularity of the areas meant to receive clicks
2213     * on touchscreens.
2214     *
2215     * Different profiles may have pre-set values for finger sizes.
2216     *
2217     * @ref general_functions_example_page "This" example contemplates
2218     * some of these functions.
2219     *
2220     * @{
2221     */
2222
2223    /**
2224     * Get the configured "finger size"
2225     *
2226     * @return The finger size
2227     *
2228     * This gets the globally configured finger size, <b>in pixels</b>
2229     *
2230     * @ingroup Fingers
2231     */
2232    EAPI Evas_Coord       elm_finger_size_get(void);
2233
2234    /**
2235     * Set the configured finger size
2236     *
2237     * This sets the globally configured finger size in pixels
2238     *
2239     * @param size The finger size
2240     * @ingroup Fingers
2241     */
2242    EAPI void             elm_finger_size_set(Evas_Coord size);
2243
2244    /**
2245     * Set the configured finger size for all applications on the display
2246     *
2247     * This sets the globally configured finger size in pixels for all
2248     * applications on the display
2249     *
2250     * @param size The finger size
2251     * @ingroup Fingers
2252     */
2253    EAPI void             elm_finger_size_all_set(Evas_Coord size);
2254
2255    /**
2256     * @}
2257     */
2258
2259    /**
2260     * @defgroup Focus Focus
2261     *
2262     * An Elementary application has, at all times, one (and only one)
2263     * @b focused object. This is what determines where the input
2264     * events go to within the application's window. Also, focused
2265     * objects can be decorated differently, in order to signal to the
2266     * user where the input is, at a given moment.
2267     *
2268     * Elementary applications also have the concept of <b>focus
2269     * chain</b>: one can cycle through all the windows' focusable
2270     * objects by input (tab key) or programmatically. The default
2271     * focus chain for an application is the one define by the order in
2272     * which the widgets where added in code. One will cycle through
2273     * top level widgets, and, for each one containg sub-objects, cycle
2274     * through them all, before returning to the level
2275     * above. Elementary also allows one to set @b custom focus chains
2276     * for their applications.
2277     *
2278     * Besides the focused decoration a widget may exhibit, when it
2279     * gets focus, Elementary has a @b global focus highlight object
2280     * that can be enabled for a window. If one chooses to do so, this
2281     * extra highlight effect will surround the current focused object,
2282     * too.
2283     *
2284     * @note Some Elementary widgets are @b unfocusable, after
2285     * creation, by their very nature: they are not meant to be
2286     * interacted with input events, but are there just for visual
2287     * purposes.
2288     *
2289     * @ref general_functions_example_page "This" example contemplates
2290     * some of these functions.
2291     */
2292
2293    /**
2294     * Get the enable status of the focus highlight
2295     *
2296     * This gets whether the highlight on focused objects is enabled or not
2297     * @ingroup Focus
2298     */
2299    EAPI Eina_Bool        elm_focus_highlight_enabled_get(void);
2300
2301    /**
2302     * Set the enable status of the focus highlight
2303     *
2304     * Set whether to show or not the highlight on focused objects
2305     * @param enable Enable highlight if EINA_TRUE, disable otherwise
2306     * @ingroup Focus
2307     */
2308    EAPI void             elm_focus_highlight_enabled_set(Eina_Bool enable);
2309
2310    /**
2311     * Get the enable status of the highlight animation
2312     *
2313     * Get whether the focus highlight, if enabled, will animate its switch from
2314     * one object to the next
2315     * @ingroup Focus
2316     */
2317    EAPI Eina_Bool        elm_focus_highlight_animate_get(void);
2318
2319    /**
2320     * Set the enable status of the highlight animation
2321     *
2322     * Set whether the focus highlight, if enabled, will animate its switch from
2323     * one object to the next
2324     * @param animate Enable animation if EINA_TRUE, disable otherwise
2325     * @ingroup Focus
2326     */
2327    EAPI void             elm_focus_highlight_animate_set(Eina_Bool animate);
2328
2329    /**
2330     * Get the whether an Elementary object has the focus or not.
2331     *
2332     * @param obj The Elementary object to get the information from
2333     * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2334     *            not (and on errors).
2335     *
2336     * @see elm_object_focus_set()
2337     *
2338     * @ingroup Focus
2339     */
2340    EAPI Eina_Bool        elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2341
2342    /**
2343     * Set/unset focus to a given Elementary object.
2344     *
2345     * @param obj The Elementary object to operate on.
2346     * @param enable @c EINA_TRUE Set focus to a given object,
2347     *               @c EINA_FALSE Unset focus to a given object.
2348     *
2349     * @note When you set focus to this object, if it can handle focus, will
2350     * take the focus away from the one who had it previously and will, for
2351     * now on, be the one receiving input events. Unsetting focus will remove
2352     * the focus from @p obj, passing it back to the previous element in the
2353     * focus chain list.
2354     *
2355     * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2356     *
2357     * @ingroup Focus
2358     */
2359    EAPI void             elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2360
2361    /**
2362     * Make a given Elementary object the focused one.
2363     *
2364     * @param obj The Elementary object to make focused.
2365     *
2366     * @note This object, if it can handle focus, will take the focus
2367     * away from the one who had it previously and will, for now on, be
2368     * the one receiving input events.
2369     *
2370     * @see elm_object_focus_get()
2371     * @deprecated use elm_object_focus_set() instead.
2372     *
2373     * @ingroup Focus
2374     */
2375    EINA_DEPRECATED EAPI void             elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2376
2377    /**
2378     * Remove the focus from an Elementary object
2379     *
2380     * @param obj The Elementary to take focus from
2381     *
2382     * This removes the focus from @p obj, passing it back to the
2383     * previous element in the focus chain list.
2384     *
2385     * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2386     * @deprecated use elm_object_focus_set() instead.
2387     *
2388     * @ingroup Focus
2389     */
2390    EINA_DEPRECATED EAPI void             elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2391
2392    /**
2393     * Set the ability for an Element object to be focused
2394     *
2395     * @param obj The Elementary object to operate on
2396     * @param enable @c EINA_TRUE if the object can be focused, @c
2397     *        EINA_FALSE if not (and on errors)
2398     *
2399     * This sets whether the object @p obj is able to take focus or
2400     * not. Unfocusable objects do nothing when programmatically
2401     * focused, being the nearest focusable parent object the one
2402     * really getting focus. Also, when they receive mouse input, they
2403     * will get the event, but not take away the focus from where it
2404     * was previously.
2405     *
2406     * @ingroup Focus
2407     */
2408    EAPI void             elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2409
2410    /**
2411     * Get whether an Elementary object is focusable or not
2412     *
2413     * @param obj The Elementary object to operate on
2414     * @return @c EINA_TRUE if the object is allowed to be focused, @c
2415     *             EINA_FALSE if not (and on errors)
2416     *
2417     * @note Objects which are meant to be interacted with by input
2418     * events are created able to be focused, by default. All the
2419     * others are not.
2420     *
2421     * @ingroup Focus
2422     */
2423    EAPI Eina_Bool        elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2424
2425    /**
2426     * Set custom focus chain.
2427     *
2428     * This function overwrites any previous custom focus chain within
2429     * the list of objects. The previous list will be deleted and this list
2430     * will be managed by elementary. After it is set, don't modify it.
2431     *
2432     * @note On focus cycle, only will be evaluated children of this container.
2433     *
2434     * @param obj The container object
2435     * @param objs Chain of objects to pass focus
2436     * @ingroup Focus
2437     */
2438    EAPI void             elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2439
2440    /**
2441     * Unset a custom focus chain on a given Elementary widget
2442     *
2443     * @param obj The container object to remove focus chain from
2444     *
2445     * Any focus chain previously set on @p obj (for its child objects)
2446     * is removed entirely after this call.
2447     *
2448     * @ingroup Focus
2449     */
2450    EAPI void             elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2451
2452    /**
2453     * Get custom focus chain
2454     *
2455     * @param obj The container object
2456     * @ingroup Focus
2457     */
2458    EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2459
2460    /**
2461     * Append object to custom focus chain.
2462     *
2463     * @note If relative_child equal to NULL or not in custom chain, the object
2464     * will be added in end.
2465     *
2466     * @note On focus cycle, only will be evaluated children of this container.
2467     *
2468     * @param obj The container object
2469     * @param child The child to be added in custom chain
2470     * @param relative_child The relative object to position the child
2471     * @ingroup Focus
2472     */
2473    EAPI void             elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2474
2475    /**
2476     * Prepend object to custom focus chain.
2477     *
2478     * @note If relative_child equal to NULL or not in custom chain, the object
2479     * will be added in begin.
2480     *
2481     * @note On focus cycle, only will be evaluated children of this container.
2482     *
2483     * @param obj The container object
2484     * @param child The child to be added in custom chain
2485     * @param relative_child The relative object to position the child
2486     * @ingroup Focus
2487     */
2488    EAPI void             elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2489
2490    /**
2491     * Give focus to next object in object tree.
2492     *
2493     * Give focus to next object in focus chain of one object sub-tree.
2494     * If the last object of chain already have focus, the focus will go to the
2495     * first object of chain.
2496     *
2497     * @param obj The object root of sub-tree
2498     * @param dir Direction to cycle the focus
2499     *
2500     * @ingroup Focus
2501     */
2502    EAPI void             elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2503
2504    /**
2505     * Give focus to near object in one direction.
2506     *
2507     * Give focus to near object in direction of one object.
2508     * If none focusable object in given direction, the focus will not change.
2509     *
2510     * @param obj The reference object
2511     * @param x Horizontal component of direction to focus
2512     * @param y Vertical component of direction to focus
2513     *
2514     * @ingroup Focus
2515     */
2516    EAPI void             elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2517
2518    /**
2519     * Make the elementary object and its children to be unfocusable
2520     * (or focusable).
2521     *
2522     * @param obj The Elementary object to operate on
2523     * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2524     *        @c EINA_FALSE for focusable.
2525     *
2526     * This sets whether the object @p obj and its children objects
2527     * are able to take focus or not. If the tree is set as unfocusable,
2528     * newest focused object which is not in this tree will get focus.
2529     * This API can be helpful for an object to be deleted.
2530     * When an object will be deleted soon, it and its children may not
2531     * want to get focus (by focus reverting or by other focus controls).
2532     * Then, just use this API before deleting.
2533     *
2534     * @see elm_object_tree_unfocusable_get()
2535     *
2536     * @ingroup Focus
2537     */
2538    EAPI void             elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2539
2540    /**
2541     * Get whether an Elementary object and its children are unfocusable or not.
2542     *
2543     * @param obj The Elementary object to get the information from
2544     * @return @c EINA_TRUE, if the tree is unfocussable,
2545     *         @c EINA_FALSE if not (and on errors).
2546     *
2547     * @see elm_object_tree_unfocusable_set()
2548     *
2549     * @ingroup Focus
2550     */
2551    EAPI Eina_Bool        elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2552
2553    /**
2554     * @defgroup Scrolling Scrolling
2555     *
2556     * These are functions setting how scrollable views in Elementary
2557     * widgets should behave on user interaction.
2558     *
2559     * @{
2560     */
2561
2562    /**
2563     * Get whether scrollers should bounce when they reach their
2564     * viewport's edge during a scroll.
2565     *
2566     * @return the thumb scroll bouncing state
2567     *
2568     * This is the default behavior for touch screens, in general.
2569     * @ingroup Scrolling
2570     */
2571    EAPI Eina_Bool        elm_scroll_bounce_enabled_get(void);
2572
2573    /**
2574     * Set whether scrollers should bounce when they reach their
2575     * viewport's edge during a scroll.
2576     *
2577     * @param enabled the thumb scroll bouncing state
2578     *
2579     * @see elm_thumbscroll_bounce_enabled_get()
2580     * @ingroup Scrolling
2581     */
2582    EAPI void             elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2583
2584    /**
2585     * Set whether scrollers should bounce when they reach their
2586     * viewport's edge during a scroll, for all Elementary application
2587     * windows.
2588     *
2589     * @param enabled the thumb scroll bouncing state
2590     *
2591     * @see elm_thumbscroll_bounce_enabled_get()
2592     * @ingroup Scrolling
2593     */
2594    EAPI void             elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2595
2596    /**
2597     * Get the amount of inertia a scroller will impose at bounce
2598     * animations.
2599     *
2600     * @return the thumb scroll bounce friction
2601     *
2602     * @ingroup Scrolling
2603     */
2604    EAPI double           elm_scroll_bounce_friction_get(void);
2605
2606    /**
2607     * Set the amount of inertia a scroller will impose at bounce
2608     * animations.
2609     *
2610     * @param friction the thumb scroll bounce friction
2611     *
2612     * @see elm_thumbscroll_bounce_friction_get()
2613     * @ingroup Scrolling
2614     */
2615    EAPI void             elm_scroll_bounce_friction_set(double friction);
2616
2617    /**
2618     * Set the amount of inertia a scroller will impose at bounce
2619     * animations, for all Elementary application windows.
2620     *
2621     * @param friction the thumb scroll bounce friction
2622     *
2623     * @see elm_thumbscroll_bounce_friction_get()
2624     * @ingroup Scrolling
2625     */
2626    EAPI void             elm_scroll_bounce_friction_all_set(double friction);
2627
2628    /**
2629     * Get the amount of inertia a <b>paged</b> scroller will impose at
2630     * page fitting animations.
2631     *
2632     * @return the page scroll friction
2633     *
2634     * @ingroup Scrolling
2635     */
2636    EAPI double           elm_scroll_page_scroll_friction_get(void);
2637
2638    /**
2639     * Set the amount of inertia a <b>paged</b> scroller will impose at
2640     * page fitting animations.
2641     *
2642     * @param friction the page scroll friction
2643     *
2644     * @see elm_thumbscroll_page_scroll_friction_get()
2645     * @ingroup Scrolling
2646     */
2647    EAPI void             elm_scroll_page_scroll_friction_set(double friction);
2648
2649    /**
2650     * Set the amount of inertia a <b>paged</b> scroller will impose at
2651     * page fitting animations, for all Elementary application windows.
2652     *
2653     * @param friction the page scroll friction
2654     *
2655     * @see elm_thumbscroll_page_scroll_friction_get()
2656     * @ingroup Scrolling
2657     */
2658    EAPI void             elm_scroll_page_scroll_friction_all_set(double friction);
2659
2660    /**
2661     * Get the amount of inertia a scroller will impose at region bring
2662     * animations.
2663     *
2664     * @return the bring in scroll friction
2665     *
2666     * @ingroup Scrolling
2667     */
2668    EAPI double           elm_scroll_bring_in_scroll_friction_get(void);
2669
2670    /**
2671     * Set the amount of inertia a scroller will impose at region bring
2672     * animations.
2673     *
2674     * @param friction the bring in scroll friction
2675     *
2676     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2677     * @ingroup Scrolling
2678     */
2679    EAPI void             elm_scroll_bring_in_scroll_friction_set(double friction);
2680
2681    /**
2682     * Set the amount of inertia a scroller will impose at region bring
2683     * animations, for all Elementary application windows.
2684     *
2685     * @param friction the bring in scroll friction
2686     *
2687     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2688     * @ingroup Scrolling
2689     */
2690    EAPI void             elm_scroll_bring_in_scroll_friction_all_set(double friction);
2691
2692    /**
2693     * Get the amount of inertia scrollers will impose at animations
2694     * triggered by Elementary widgets' zooming API.
2695     *
2696     * @return the zoom friction
2697     *
2698     * @ingroup Scrolling
2699     */
2700    EAPI double           elm_scroll_zoom_friction_get(void);
2701
2702    /**
2703     * Set the amount of inertia scrollers will impose at animations
2704     * triggered by Elementary widgets' zooming API.
2705     *
2706     * @param friction the zoom friction
2707     *
2708     * @see elm_thumbscroll_zoom_friction_get()
2709     * @ingroup Scrolling
2710     */
2711    EAPI void             elm_scroll_zoom_friction_set(double friction);
2712
2713    /**
2714     * Set the amount of inertia scrollers will impose at animations
2715     * triggered by Elementary widgets' zooming API, for all Elementary
2716     * application windows.
2717     *
2718     * @param friction the zoom friction
2719     *
2720     * @see elm_thumbscroll_zoom_friction_get()
2721     * @ingroup Scrolling
2722     */
2723    EAPI void             elm_scroll_zoom_friction_all_set(double friction);
2724
2725    /**
2726     * Get whether scrollers should be draggable from any point in their
2727     * views.
2728     *
2729     * @return the thumb scroll state
2730     *
2731     * @note This is the default behavior for touch screens, in general.
2732     * @note All other functions namespaced with "thumbscroll" will only
2733     *       have effect if this mode is enabled.
2734     *
2735     * @ingroup Scrolling
2736     */
2737    EAPI Eina_Bool        elm_scroll_thumbscroll_enabled_get(void);
2738
2739    /**
2740     * Set whether scrollers should be draggable from any point in their
2741     * views.
2742     *
2743     * @param enabled the thumb scroll state
2744     *
2745     * @see elm_thumbscroll_enabled_get()
2746     * @ingroup Scrolling
2747     */
2748    EAPI void             elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2749
2750    /**
2751     * Set whether scrollers should be draggable from any point in their
2752     * views, for all Elementary application windows.
2753     *
2754     * @param enabled the thumb scroll state
2755     *
2756     * @see elm_thumbscroll_enabled_get()
2757     * @ingroup Scrolling
2758     */
2759    EAPI void             elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2760
2761    /**
2762     * Get the number of pixels one should travel while dragging a
2763     * scroller's view to actually trigger scrolling.
2764     *
2765     * @return the thumb scroll threshould
2766     *
2767     * One would use higher values for touch screens, in general, because
2768     * of their inherent imprecision.
2769     * @ingroup Scrolling
2770     */
2771    EAPI unsigned int     elm_scroll_thumbscroll_threshold_get(void);
2772
2773    /**
2774     * Set the number of pixels one should travel while dragging a
2775     * scroller's view to actually trigger scrolling.
2776     *
2777     * @param threshold the thumb scroll threshould
2778     *
2779     * @see elm_thumbscroll_threshould_get()
2780     * @ingroup Scrolling
2781     */
2782    EAPI void             elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2783
2784    /**
2785     * Set the number of pixels one should travel while dragging a
2786     * scroller's view to actually trigger scrolling, for all Elementary
2787     * application windows.
2788     *
2789     * @param threshold the thumb scroll threshould
2790     *
2791     * @see elm_thumbscroll_threshould_get()
2792     * @ingroup Scrolling
2793     */
2794    EAPI void             elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2795
2796    /**
2797     * Get the minimum speed of mouse cursor movement which will trigger
2798     * list self scrolling animation after a mouse up event
2799     * (pixels/second).
2800     *
2801     * @return the thumb scroll momentum threshould
2802     *
2803     * @ingroup Scrolling
2804     */
2805    EAPI double           elm_scroll_thumbscroll_momentum_threshold_get(void);
2806
2807    /**
2808     * Set the minimum speed of mouse cursor movement which will trigger
2809     * list self scrolling animation after a mouse up event
2810     * (pixels/second).
2811     *
2812     * @param threshold the thumb scroll momentum threshould
2813     *
2814     * @see elm_thumbscroll_momentum_threshould_get()
2815     * @ingroup Scrolling
2816     */
2817    EAPI void             elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2818
2819    /**
2820     * Set the minimum speed of mouse cursor movement which will trigger
2821     * list self scrolling animation after a mouse up event
2822     * (pixels/second), for all Elementary application windows.
2823     *
2824     * @param threshold the thumb scroll momentum threshould
2825     *
2826     * @see elm_thumbscroll_momentum_threshould_get()
2827     * @ingroup Scrolling
2828     */
2829    EAPI void             elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2830
2831    /**
2832     * Get the amount of inertia a scroller will impose at self scrolling
2833     * animations.
2834     *
2835     * @return the thumb scroll friction
2836     *
2837     * @ingroup Scrolling
2838     */
2839    EAPI double           elm_scroll_thumbscroll_friction_get(void);
2840
2841    /**
2842     * Set the amount of inertia a scroller will impose at self scrolling
2843     * animations.
2844     *
2845     * @param friction the thumb scroll friction
2846     *
2847     * @see elm_thumbscroll_friction_get()
2848     * @ingroup Scrolling
2849     */
2850    EAPI void             elm_scroll_thumbscroll_friction_set(double friction);
2851
2852    /**
2853     * Set the amount of inertia a scroller will impose at self scrolling
2854     * animations, for all Elementary application windows.
2855     *
2856     * @param friction the thumb scroll friction
2857     *
2858     * @see elm_thumbscroll_friction_get()
2859     * @ingroup Scrolling
2860     */
2861    EAPI void             elm_scroll_thumbscroll_friction_all_set(double friction);
2862
2863    /**
2864     * Get the amount of lag between your actual mouse cursor dragging
2865     * movement and a scroller's view movement itself, while pushing it
2866     * into bounce state manually.
2867     *
2868     * @return the thumb scroll border friction
2869     *
2870     * @ingroup Scrolling
2871     */
2872    EAPI double           elm_scroll_thumbscroll_border_friction_get(void);
2873
2874    /**
2875     * Set the amount of lag between your actual mouse cursor dragging
2876     * movement and a scroller's view movement itself, while pushing it
2877     * into bounce state manually.
2878     *
2879     * @param friction the thumb scroll border friction. @c 0.0 for
2880     *        perfect synchrony between two movements, @c 1.0 for maximum
2881     *        lag.
2882     *
2883     * @see elm_thumbscroll_border_friction_get()
2884     * @note parameter value will get bound to 0.0 - 1.0 interval, always
2885     *
2886     * @ingroup Scrolling
2887     */
2888    EAPI void             elm_scroll_thumbscroll_border_friction_set(double friction);
2889
2890    /**
2891     * Set the amount of lag between your actual mouse cursor dragging
2892     * movement and a scroller's view movement itself, while pushing it
2893     * into bounce state manually, for all Elementary application windows.
2894     *
2895     * @param friction the thumb scroll border friction. @c 0.0 for
2896     *        perfect synchrony between two movements, @c 1.0 for maximum
2897     *        lag.
2898     *
2899     * @see elm_thumbscroll_border_friction_get()
2900     * @note parameter value will get bound to 0.0 - 1.0 interval, always
2901     *
2902     * @ingroup Scrolling
2903     */
2904    EAPI void             elm_scroll_thumbscroll_border_friction_all_set(double friction);
2905
2906    /**
2907     * Get the sensitivity amount which is be multiplied by the length of
2908     * mouse dragging.
2909     *
2910     * @return the thumb scroll sensitivity friction
2911     *
2912     * @ingroup Scrolling
2913     */
2914    EAPI double           elm_scroll_thumbscroll_sensitivity_friction_get(void);
2915
2916    /**
2917     * Set the sensitivity amount which is be multiplied by the length of
2918     * mouse dragging.
2919     *
2920     * @param friction the thumb scroll sensitivity friction. @c 0.1 for
2921     *        minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
2922     *        is proper.
2923     *
2924     * @see elm_thumbscroll_sensitivity_friction_get()
2925     * @note parameter value will get bound to 0.1 - 1.0 interval, always
2926     *
2927     * @ingroup Scrolling
2928     */
2929    EAPI void             elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
2930
2931    /**
2932     * Set the sensitivity amount which is be multiplied by the length of
2933     * mouse dragging, for all Elementary application windows.
2934     *
2935     * @param friction the thumb scroll sensitivity friction. @c 0.1 for
2936     *        minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
2937     *        is proper.
2938     *
2939     * @see elm_thumbscroll_sensitivity_friction_get()
2940     * @note parameter value will get bound to 0.1 - 1.0 interval, always
2941     *
2942     * @ingroup Scrolling
2943     */
2944    EAPI void             elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
2945
2946    /**
2947     * @}
2948     */
2949
2950    /**
2951     * @defgroup Scrollhints Scrollhints
2952     *
2953     * Objects when inside a scroller can scroll, but this may not always be
2954     * desirable in certain situations. This allows an object to hint to itself
2955     * and parents to "not scroll" in one of 2 ways. If any child object of a
2956     * scroller has pushed a scroll freeze or hold then it affects all parent
2957     * scrollers until all children have released them.
2958     *
2959     * 1. To hold on scrolling. This means just flicking and dragging may no
2960     * longer scroll, but pressing/dragging near an edge of the scroller will
2961     * still scroll. This is automatically used by the entry object when
2962     * selecting text.
2963     *
2964     * 2. To totally freeze scrolling. This means it stops. until
2965     * popped/released.
2966     *
2967     * @{
2968     */
2969
2970    /**
2971     * Push the scroll hold by 1
2972     *
2973     * This increments the scroll hold count by one. If it is more than 0 it will
2974     * take effect on the parents of the indicated object.
2975     *
2976     * @param obj The object
2977     * @ingroup Scrollhints
2978     */
2979    EAPI void             elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2980
2981    /**
2982     * Pop the scroll hold by 1
2983     *
2984     * This decrements the scroll hold count by one. If it is more than 0 it will
2985     * take effect on the parents of the indicated object.
2986     *
2987     * @param obj The object
2988     * @ingroup Scrollhints
2989     */
2990    EAPI void             elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2991
2992    /**
2993     * Push the scroll freeze by 1
2994     *
2995     * This increments the scroll freeze count by one. If it is more
2996     * than 0 it will take effect on the parents of the indicated
2997     * object.
2998     *
2999     * @param obj The object
3000     * @ingroup Scrollhints
3001     */
3002    EAPI void             elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3003
3004    /**
3005     * Pop the scroll freeze by 1
3006     *
3007     * This decrements the scroll freeze count by one. If it is more
3008     * than 0 it will take effect on the parents of the indicated
3009     * object.
3010     *
3011     * @param obj The object
3012     * @ingroup Scrollhints
3013     */
3014    EAPI void             elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3015
3016    /**
3017     * Lock the scrolling of the given widget (and thus all parents)
3018     *
3019     * This locks the given object from scrolling in the X axis (and implicitly
3020     * also locks all parent scrollers too from doing the same).
3021     *
3022     * @param obj The object
3023     * @param lock The lock state (1 == locked, 0 == unlocked)
3024     * @ingroup Scrollhints
3025     */
3026    EAPI void             elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3027
3028    /**
3029     * Lock the scrolling of the given widget (and thus all parents)
3030     *
3031     * This locks the given object from scrolling in the Y axis (and implicitly
3032     * also locks all parent scrollers too from doing the same).
3033     *
3034     * @param obj The object
3035     * @param lock The lock state (1 == locked, 0 == unlocked)
3036     * @ingroup Scrollhints
3037     */
3038    EAPI void             elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3039
3040    /**
3041     * Get the scrolling lock of the given widget
3042     *
3043     * This gets the lock for X axis scrolling.
3044     *
3045     * @param obj The object
3046     * @ingroup Scrollhints
3047     */
3048    EAPI Eina_Bool        elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3049
3050    /**
3051     * Get the scrolling lock of the given widget
3052     *
3053     * This gets the lock for X axis scrolling.
3054     *
3055     * @param obj The object
3056     * @ingroup Scrollhints
3057     */
3058    EAPI Eina_Bool        elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3059
3060    /**
3061     * @}
3062     */
3063
3064    /**
3065     * Send a signal to the widget edje object.
3066     *
3067     * This function sends a signal to the edje object of the obj. An
3068     * edje program can respond to a signal by specifying matching
3069     * 'signal' and 'source' fields.
3070     *
3071     * @param obj The object
3072     * @param emission The signal's name.
3073     * @param source The signal's source.
3074     * @ingroup General
3075     */
3076    EAPI void             elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
3077
3078    /**
3079     * Add a callback for a signal emitted by widget edje object.
3080     *
3081     * This function connects a callback function to a signal emitted by the
3082     * edje object of the obj.
3083     * Globs can occur in either the emission or source name.
3084     *
3085     * @param obj The object
3086     * @param emission The signal's name.
3087     * @param source The signal's source.
3088     * @param func The callback function to be executed when the signal is
3089     * emitted.
3090     * @param data A pointer to data to pass in to the callback function.
3091     * @ingroup General
3092     */
3093    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);
3094
3095    /**
3096     * Remove a signal-triggered callback from a widget edje object.
3097     *
3098     * This function removes a callback, previoulsy attached to a
3099     * signal emitted by the edje object of the obj.  The parameters
3100     * emission, source and func must match exactly those passed to a
3101     * previous call to elm_object_signal_callback_add(). The data
3102     * pointer that was passed to this call will be returned.
3103     *
3104     * @param obj The object
3105     * @param emission The signal's name.
3106     * @param source The signal's source.
3107     * @param func The callback function to be executed when the signal is
3108     * emitted.
3109     * @return The data pointer
3110     * @ingroup General
3111     */
3112    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);
3113
3114    /**
3115     * Add a callback for input events (key up, key down, mouse wheel)
3116     * on a given Elementary widget
3117     *
3118     * @param obj The widget to add an event callback on
3119     * @param func The callback function to be executed when the event
3120     * happens
3121     * @param data Data to pass in to @p func
3122     *
3123     * Every widget in an Elementary interface set to receive focus,
3124     * with elm_object_focus_allow_set(), will propagate @b all of its
3125     * key up, key down and mouse wheel input events up to its parent
3126     * object, and so on. All of the focusable ones in this chain which
3127     * had an event callback set, with this call, will be able to treat
3128     * those events. There are two ways of making the propagation of
3129     * these event upwards in the tree of widgets to @b cease:
3130     * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
3131     *   the event was @b not processed, so the propagation will go on.
3132     * - The @c event_info pointer passed to @p func will contain the
3133     *   event's structure and, if you OR its @c event_flags inner
3134     *   value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
3135     *   one has already handled it, thus killing the event's
3136     *   propagation, too.
3137     *
3138     * @note Your event callback will be issued on those events taking
3139     * place only if no other child widget of @obj has consumed the
3140     * event already.
3141     *
3142     * @note Not to be confused with @c
3143     * evas_object_event_callback_add(), which will add event callbacks
3144     * per type on general Evas objects (no event propagation
3145     * infrastructure taken in account).
3146     *
3147     * @note Not to be confused with @c
3148     * elm_object_signal_callback_add(), which will add callbacks to @b
3149     * signals coming from a widget's theme, not input events.
3150     *
3151     * @note Not to be confused with @c
3152     * edje_object_signal_callback_add(), which does the same as
3153     * elm_object_signal_callback_add(), but directly on an Edje
3154     * object.
3155     *
3156     * @note Not to be confused with @c
3157     * evas_object_smart_callback_add(), which adds callbacks to smart
3158     * objects' <b>smart events</b>, and not input events.
3159     *
3160     * @see elm_object_event_callback_del()
3161     *
3162     * @ingroup General
3163     */
3164    EAPI void             elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3165
3166    /**
3167     * Remove an event callback from a widget.
3168     *
3169     * This function removes a callback, previoulsy attached to event emission
3170     * by the @p obj.
3171     * The parameters func and data must match exactly those passed to
3172     * a previous call to elm_object_event_callback_add(). The data pointer that
3173     * was passed to this call will be returned.
3174     *
3175     * @param obj The object
3176     * @param func The callback function to be executed when the event is
3177     * emitted.
3178     * @param data Data to pass in to the callback function.
3179     * @return The data pointer
3180     * @ingroup General
3181     */
3182    EAPI void            *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3183
3184    /**
3185     * Adjust size of an element for finger usage.
3186     *
3187     * @param times_w How many fingers should fit horizontally
3188     * @param w Pointer to the width size to adjust
3189     * @param times_h How many fingers should fit vertically
3190     * @param h Pointer to the height size to adjust
3191     *
3192     * This takes width and height sizes (in pixels) as input and a
3193     * size multiple (which is how many fingers you want to place
3194     * within the area, being "finger" the size set by
3195     * elm_finger_size_set()), and adjusts the size to be large enough
3196     * to accommodate the resulting size -- if it doesn't already
3197     * accommodate it. On return the @p w and @p h sizes pointed to by
3198     * these parameters will be modified, on those conditions.
3199     *
3200     * @note This is kind of a low level Elementary call, most useful
3201     * on size evaluation times for widgets. An external user wouldn't
3202     * be calling, most of the time.
3203     *
3204     * @ingroup Fingers
3205     */
3206    EAPI void             elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3207
3208    /**
3209     * Get the duration for occuring long press event.
3210     *
3211     * @return Timeout for long press event
3212     * @ingroup Longpress
3213     */
3214    EAPI double           elm_longpress_timeout_get(void);
3215
3216    /**
3217     * Set the duration for occuring long press event.
3218     *
3219     * @param lonpress_timeout Timeout for long press event
3220     * @ingroup Longpress
3221     */
3222    EAPI void             elm_longpress_timeout_set(double longpress_timeout);
3223
3224    /**
3225     * @defgroup Debug Debug
3226     * don't use it unless you are sure
3227     *
3228     * @{
3229     */
3230
3231    /**
3232     * Print Tree object hierarchy in stdout
3233     *
3234     * @param obj The root object
3235     * @ingroup Debug
3236     */
3237    EAPI void             elm_object_tree_dump(const Evas_Object *top);
3238
3239    /**
3240     * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3241     *
3242     * @param obj The root object
3243     * @param file The path of output file
3244     * @ingroup Debug
3245     */
3246    EAPI void             elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3247
3248    /**
3249     * @}
3250     */
3251
3252    /**
3253     * @defgroup Theme Theme
3254     *
3255     * Elementary uses Edje to theme its widgets, naturally. But for the most
3256     * part this is hidden behind a simpler interface that lets the user set
3257     * extensions and choose the style of widgets in a much easier way.
3258     *
3259     * Instead of thinking in terms of paths to Edje files and their groups
3260     * each time you want to change the appearance of a widget, Elementary
3261     * works so you can add any theme file with extensions or replace the
3262     * main theme at one point in the application, and then just set the style
3263     * of widgets with elm_object_style_set() and related functions. Elementary
3264     * will then look in its list of themes for a matching group and apply it,
3265     * and when the theme changes midway through the application, all widgets
3266     * will be updated accordingly.
3267     *
3268     * There are three concepts you need to know to understand how Elementary
3269     * theming works: default theme, extensions and overlays.
3270     *
3271     * Default theme, obviously enough, is the one that provides the default
3272     * look of all widgets. End users can change the theme used by Elementary
3273     * by setting the @c ELM_THEME environment variable before running an
3274     * application, or globally for all programs using the @c elementary_config
3275     * utility. Applications can change the default theme using elm_theme_set(),
3276     * but this can go against the user wishes, so it's not an adviced practice.
3277     *
3278     * Ideally, applications should find everything they need in the already
3279     * provided theme, but there may be occasions when that's not enough and
3280     * custom styles are required to correctly express the idea. For this
3281     * cases, Elementary has extensions.
3282     *
3283     * Extensions allow the application developer to write styles of its own
3284     * to apply to some widgets. This requires knowledge of how each widget
3285     * is themed, as extensions will always replace the entire group used by
3286     * the widget, so important signals and parts need to be there for the
3287     * object to behave properly (see documentation of Edje for details).
3288     * Once the theme for the extension is done, the application needs to add
3289     * it to the list of themes Elementary will look into, using
3290     * elm_theme_extension_add(), and set the style of the desired widgets as
3291     * he would normally with elm_object_style_set().
3292     *
3293     * Overlays, on the other hand, can replace the look of all widgets by
3294     * overriding the default style. Like extensions, it's up to the application
3295     * developer to write the theme for the widgets it wants, the difference
3296     * being that when looking for the theme, Elementary will check first the
3297     * list of overlays, then the set theme and lastly the list of extensions,
3298     * so with overlays it's possible to replace the default view and every
3299     * widget will be affected. This is very much alike to setting the whole
3300     * theme for the application and will probably clash with the end user
3301     * options, not to mention the risk of ending up with not matching styles
3302     * across the program. Unless there's a very special reason to use them,
3303     * overlays should be avoided for the resons exposed before.
3304     *
3305     * All these theme lists are handled by ::Elm_Theme instances. Elementary
3306     * keeps one default internally and every function that receives one of
3307     * these can be called with NULL to refer to this default (except for
3308     * elm_theme_free()). It's possible to create a new instance of a
3309     * ::Elm_Theme to set other theme for a specific widget (and all of its
3310     * children), but this is as discouraged, if not even more so, than using
3311     * overlays. Don't use this unless you really know what you are doing.
3312     *
3313     * But to be less negative about things, you can look at the following
3314     * examples:
3315     * @li @ref theme_example_01 "Using extensions"
3316     * @li @ref theme_example_02 "Using overlays"
3317     *
3318     * @{
3319     */
3320    /**
3321     * @typedef Elm_Theme
3322     *
3323     * Opaque handler for the list of themes Elementary looks for when
3324     * rendering widgets.
3325     *
3326     * Stay out of this unless you really know what you are doing. For most
3327     * cases, sticking to the default is all a developer needs.
3328     */
3329    typedef struct _Elm_Theme Elm_Theme;
3330
3331    /**
3332     * Create a new specific theme
3333     *
3334     * This creates an empty specific theme that only uses the default theme. A
3335     * specific theme has its own private set of extensions and overlays too
3336     * (which are empty by default). Specific themes do not fall back to themes
3337     * of parent objects. They are not intended for this use. Use styles, overlays
3338     * and extensions when needed, but avoid specific themes unless there is no
3339     * other way (example: you want to have a preview of a new theme you are
3340     * selecting in a "theme selector" window. The preview is inside a scroller
3341     * and should display what the theme you selected will look like, but not
3342     * actually apply it yet. The child of the scroller will have a specific
3343     * theme set to show this preview before the user decides to apply it to all
3344     * applications).
3345     */
3346    EAPI Elm_Theme       *elm_theme_new(void);
3347    /**
3348     * Free a specific theme
3349     *
3350     * @param th The theme to free
3351     *
3352     * This frees a theme created with elm_theme_new().
3353     */
3354    EAPI void             elm_theme_free(Elm_Theme *th);
3355    /**
3356     * Copy the theme fom the source to the destination theme
3357     *
3358     * @param th The source theme to copy from
3359     * @param thdst The destination theme to copy data to
3360     *
3361     * This makes a one-time static copy of all the theme config, extensions
3362     * and overlays from @p th to @p thdst. If @p th references a theme, then
3363     * @p thdst is also set to reference it, with all the theme settings,
3364     * overlays and extensions that @p th had.
3365     */
3366    EAPI void             elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3367    /**
3368     * Tell the source theme to reference the ref theme
3369     *
3370     * @param th The theme that will do the referencing
3371     * @param thref The theme that is the reference source
3372     *
3373     * This clears @p th to be empty and then sets it to refer to @p thref
3374     * so @p th acts as an override to @p thref, but where its overrides
3375     * don't apply, it will fall through to @p thref for configuration.
3376     */
3377    EAPI void             elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3378    /**
3379     * Return the theme referred to
3380     *
3381     * @param th The theme to get the reference from
3382     * @return The referenced theme handle
3383     *
3384     * This gets the theme set as the reference theme by elm_theme_ref_set().
3385     * If no theme is set as a reference, NULL is returned.
3386     */
3387    EAPI Elm_Theme       *elm_theme_ref_get(Elm_Theme *th);
3388    /**
3389     * Return the default theme
3390     *
3391     * @return The default theme handle
3392     *
3393     * This returns the internal default theme setup handle that all widgets
3394     * use implicitly unless a specific theme is set. This is also often use
3395     * as a shorthand of NULL.
3396     */
3397    EAPI Elm_Theme       *elm_theme_default_get(void);
3398    /**
3399     * Prepends a theme overlay to the list of overlays
3400     *
3401     * @param th The theme to add to, or if NULL, the default theme
3402     * @param item The Edje file path to be used
3403     *
3404     * Use this if your application needs to provide some custom overlay theme
3405     * (An Edje file that replaces some default styles of widgets) where adding
3406     * new styles, or changing system theme configuration is not possible. Do
3407     * NOT use this instead of a proper system theme configuration. Use proper
3408     * configuration files, profiles, environment variables etc. to set a theme
3409     * so that the theme can be altered by simple confiugration by a user. Using
3410     * this call to achieve that effect is abusing the API and will create lots
3411     * of trouble.
3412     *
3413     * @see elm_theme_extension_add()
3414     */
3415    EAPI void             elm_theme_overlay_add(Elm_Theme *th, const char *item);
3416    /**
3417     * Delete a theme overlay from the list of overlays
3418     *
3419     * @param th The theme to delete from, or if NULL, the default theme
3420     * @param item The name of the theme overlay
3421     *
3422     * @see elm_theme_overlay_add()
3423     */
3424    EAPI void             elm_theme_overlay_del(Elm_Theme *th, const char *item);
3425    /**
3426     * Appends a theme extension to the list of extensions.
3427     *
3428     * @param th The theme to add to, or if NULL, the default theme
3429     * @param item The Edje file path to be used
3430     *
3431     * This is intended when an application needs more styles of widgets or new
3432     * widget themes that the default does not provide (or may not provide). The
3433     * application has "extended" usage by coming up with new custom style names
3434     * for widgets for specific uses, but as these are not "standard", they are
3435     * not guaranteed to be provided by a default theme. This means the
3436     * application is required to provide these extra elements itself in specific
3437     * Edje files. This call adds one of those Edje files to the theme search
3438     * path to be search after the default theme. The use of this call is
3439     * encouraged when default styles do not meet the needs of the application.
3440     * Use this call instead of elm_theme_overlay_add() for almost all cases.
3441     *
3442     * @see elm_object_style_set()
3443     */
3444    EAPI void             elm_theme_extension_add(Elm_Theme *th, const char *item);
3445    /**
3446     * Deletes a theme extension from the list of extensions.
3447     *
3448     * @param th The theme to delete from, or if NULL, the default theme
3449     * @param item The name of the theme extension
3450     *
3451     * @see elm_theme_extension_add()
3452     */
3453    EAPI void             elm_theme_extension_del(Elm_Theme *th, const char *item);
3454    /**
3455     * Set the theme search order for the given theme
3456     *
3457     * @param th The theme to set the search order, or if NULL, the default theme
3458     * @param theme Theme search string
3459     *
3460     * This sets the search string for the theme in path-notation from first
3461     * theme to search, to last, delimited by the : character. Example:
3462     *
3463     * "shiny:/path/to/file.edj:default"
3464     *
3465     * See the ELM_THEME environment variable for more information.
3466     *
3467     * @see elm_theme_get()
3468     * @see elm_theme_list_get()
3469     */
3470    EAPI void             elm_theme_set(Elm_Theme *th, const char *theme);
3471    /**
3472     * Return the theme search order
3473     *
3474     * @param th The theme to get the search order, or if NULL, the default theme
3475     * @return The internal search order path
3476     *
3477     * This function returns a colon separated string of theme elements as
3478     * returned by elm_theme_list_get().
3479     *
3480     * @see elm_theme_set()
3481     * @see elm_theme_list_get()
3482     */
3483    EAPI const char      *elm_theme_get(Elm_Theme *th);
3484    /**
3485     * Return a list of theme elements to be used in a theme.
3486     *
3487     * @param th Theme to get the list of theme elements from.
3488     * @return The internal list of theme elements
3489     *
3490     * This returns the internal list of theme elements (will only be valid as
3491     * long as the theme is not modified by elm_theme_set() or theme is not
3492     * freed by elm_theme_free(). This is a list of strings which must not be
3493     * altered as they are also internal. If @p th is NULL, then the default
3494     * theme element list is returned.
3495     *
3496     * A theme element can consist of a full or relative path to a .edj file,
3497     * or a name, without extension, for a theme to be searched in the known
3498     * theme paths for Elemementary.
3499     *
3500     * @see elm_theme_set()
3501     * @see elm_theme_get()
3502     */
3503    EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3504    /**
3505     * Return the full patrh for a theme element
3506     *
3507     * @param f The theme element name
3508     * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3509     * @return The full path to the file found.
3510     *
3511     * This returns a string you should free with free() on success, NULL on
3512     * failure. This will search for the given theme element, and if it is a
3513     * full or relative path element or a simple searchable name. The returned
3514     * path is the full path to the file, if searched, and the file exists, or it
3515     * is simply the full path given in the element or a resolved path if
3516     * relative to home. The @p in_search_path boolean pointed to is set to
3517     * EINA_TRUE if the file was a searchable file andis in the search path,
3518     * and EINA_FALSE otherwise.
3519     */
3520    EAPI char            *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3521    /**
3522     * Flush the current theme.
3523     *
3524     * @param th Theme to flush
3525     *
3526     * This flushes caches that let elementary know where to find theme elements
3527     * in the given theme. If @p th is NULL, then the default theme is flushed.
3528     * Call this function if source theme data has changed in such a way as to
3529     * make any caches Elementary kept invalid.
3530     */
3531    EAPI void             elm_theme_flush(Elm_Theme *th);
3532    /**
3533     * This flushes all themes (default and specific ones).
3534     *
3535     * This will flush all themes in the current application context, by calling
3536     * elm_theme_flush() on each of them.
3537     */
3538    EAPI void             elm_theme_full_flush(void);
3539    /**
3540     * Set the theme for all elementary using applications on the current display
3541     *
3542     * @param theme The name of the theme to use. Format same as the ELM_THEME
3543     * environment variable.
3544     */
3545    EAPI void             elm_theme_all_set(const char *theme);
3546    /**
3547     * Return a list of theme elements in the theme search path
3548     *
3549     * @return A list of strings that are the theme element names.
3550     *
3551     * This lists all available theme files in the standard Elementary search path
3552     * for theme elements, and returns them in alphabetical order as theme
3553     * element names in a list of strings. Free this with
3554     * elm_theme_name_available_list_free() when you are done with the list.
3555     */
3556    EAPI Eina_List       *elm_theme_name_available_list_new(void);
3557    /**
3558     * Free the list returned by elm_theme_name_available_list_new()
3559     *
3560     * This frees the list of themes returned by
3561     * elm_theme_name_available_list_new(). Once freed the list should no longer
3562     * be used. a new list mys be created.
3563     */
3564    EAPI void             elm_theme_name_available_list_free(Eina_List *list);
3565    /**
3566     * Set a specific theme to be used for this object and its children
3567     *
3568     * @param obj The object to set the theme on
3569     * @param th The theme to set
3570     *
3571     * This sets a specific theme that will be used for the given object and any
3572     * child objects it has. If @p th is NULL then the theme to be used is
3573     * cleared and the object will inherit its theme from its parent (which
3574     * ultimately will use the default theme if no specific themes are set).
3575     *
3576     * Use special themes with great care as this will annoy users and make
3577     * configuration difficult. Avoid any custom themes at all if it can be
3578     * helped.
3579     */
3580    EAPI void             elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3581    /**
3582     * Get the specific theme to be used
3583     *
3584     * @param obj The object to get the specific theme from
3585     * @return The specifc theme set.
3586     *
3587     * This will return a specific theme set, or NULL if no specific theme is
3588     * set on that object. It will not return inherited themes from parents, only
3589     * the specific theme set for that specific object. See elm_object_theme_set()
3590     * for more information.
3591     */
3592    EAPI Elm_Theme       *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3593
3594    /**
3595     * Get a data item from a theme
3596     *
3597     * @param th The theme, or NULL for default theme
3598     * @param key The data key to search with
3599     * @return The data value, or NULL on failure
3600     *
3601     * This function is used to return data items from edc in @p th, an overlay, or an extension.
3602     * It works the same way as edje_file_data_get() except that the return is stringshared.
3603     */
3604    EAPI const char      *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3605    /**
3606     * @}
3607     */
3608
3609    /* win */
3610    /** @defgroup Win Win
3611     *
3612     * @image html img/widget/win/preview-00.png
3613     * @image latex img/widget/win/preview-00.eps
3614     *
3615     * The window class of Elementary.  Contains functions to manipulate
3616     * windows. The Evas engine used to render the window contents is specified
3617     * in the system or user elementary config files (whichever is found last),
3618     * and can be overridden with the ELM_ENGINE environment variable for
3619     * testing.  Engines that may be supported (depending on Evas and Ecore-Evas
3620     * compilation setup and modules actually installed at runtime) are (listed
3621     * in order of best supported and most likely to be complete and work to
3622     * lowest quality).
3623     *
3624     * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3625     * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3626     * rendering in X11)
3627     * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3628     * exits)
3629     * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3630     * rendering)
3631     * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3632     * buffer)
3633     * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3634     * rendering using SDL as the buffer)
3635     * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3636     * GDI with software)
3637     * @li "dfb", "directfb" (Rendering to a DirectFB window)
3638     * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3639     * grayscale using dedicated 8bit software engine in X11)
3640     * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3641     * X11 using 16bit software engine)
3642     * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3643     * (Windows CE rendering via GDI with 16bit software renderer)
3644     * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3645     * buffer with 16bit software renderer)
3646     * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3647     *
3648     * All engines use a simple string to select the engine to render, EXCEPT
3649     * the "shot" engine. This actually encodes the output of the virtual
3650     * screenshot and how long to delay in the engine string. The engine string
3651     * is encoded in the following way:
3652     *
3653     *   "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3654     *
3655     * Where options are separated by a ":" char if more than one option is
3656     * given, with delay, if provided being the first option and file the last
3657     * (order is important). The delay specifies how long to wait after the
3658     * window is shown before doing the virtual "in memory" rendering and then
3659     * save the output to the file specified by the file option (and then exit).
3660     * If no delay is given, the default is 0.5 seconds. If no file is given the
3661     * default output file is "out.png". Repeat option is for continous
3662     * capturing screenshots. Repeat range is from 1 to 999 and filename is
3663     * fixed to "out001.png" Some examples of using the shot engine:
3664     *
3665     *   ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3666     *   ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3667     *   ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3668     *   ELM_ENGINE="shot:delay=2.0" elementary_test
3669     *   ELM_ENGINE="shot:" elementary_test
3670     *
3671     * Signals that you can add callbacks for are:
3672     *
3673     * @li "delete,request": the user requested to close the window. See
3674     * elm_win_autodel_set().
3675     * @li "focus,in": window got focus
3676     * @li "focus,out": window lost focus
3677     * @li "moved": window that holds the canvas was moved
3678     *
3679     * Examples:
3680     * @li @ref win_example_01
3681     *
3682     * @{
3683     */
3684    /**
3685     * Defines the types of window that can be created
3686     *
3687     * These are hints set on the window so that a running Window Manager knows
3688     * how the window should be handled and/or what kind of decorations it
3689     * should have.
3690     *
3691     * Currently, only the X11 backed engines use them.
3692     */
3693    typedef enum _Elm_Win_Type
3694      {
3695         ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3696                          window. Almost every window will be created with this
3697                          type. */
3698         ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3699         ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3700                            window holding desktop icons. */
3701         ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3702                         be kept on top of any other window by the Window
3703                         Manager. */
3704         ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3705                            similar. */
3706         ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3707         ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3708                            pallete. */
3709         ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3710         ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3711                                  entry in a menubar is clicked. Typically used
3712                                  with elm_win_override_set(). This hint exists
3713                                  for completion only, as the EFL way of
3714                                  implementing a menu would not normally use a
3715                                  separate window for its contents. */
3716         ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3717                               triggered by right-clicking an object. */
3718         ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3719                            explanatory text that typically appear after the
3720                            mouse cursor hovers over an object for a while.
3721                            Typically used with elm_win_override_set() and also
3722                            not very commonly used in the EFL. */
3723         ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3724                                 battery life or a new E-Mail received. */
3725         ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3726                          usually used in the EFL. */
3727         ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3728                        object being dragged across different windows, or even
3729                        applications. Typically used with
3730                        elm_win_override_set(). */
3731         ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3732                                  buffer. No actual window is created for this
3733                                  type, instead the window and all of its
3734                                  contents will be rendered to an image buffer.
3735                                  This allows to have children window inside a
3736                                  parent one just like any other object would
3737                                  be, and do other things like applying @c
3738                                  Evas_Map effects to it. This is the only type
3739                                  of window that requires the @c parent
3740                                  parameter of elm_win_add() to be a valid @c
3741                                  Evas_Object. */
3742      } Elm_Win_Type;
3743
3744    /**
3745     * The differents layouts that can be requested for the virtual keyboard.
3746     *
3747     * When the application window is being managed by Illume, it may request
3748     * any of the following layouts for the virtual keyboard.
3749     */
3750    typedef enum _Elm_Win_Keyboard_Mode
3751      {
3752         ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3753         ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3754         ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3755         ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3756         ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3757         ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3758         ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3759         ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3760         ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3761         ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3762         ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3763         ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3764         ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3765         ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3766         ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3767         ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3768      } Elm_Win_Keyboard_Mode;
3769
3770    /**
3771     * Available commands that can be sent to the Illume manager.
3772     *
3773     * When running under an Illume session, a window may send commands to the
3774     * Illume manager to perform different actions.
3775     */
3776    typedef enum _Elm_Illume_Command
3777      {
3778         ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3779                                          window */
3780         ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3781                                             in the list */
3782         ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3783                                          screen */
3784         ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3785      } Elm_Illume_Command;
3786
3787    /**
3788     * Adds a window object. If this is the first window created, pass NULL as
3789     * @p parent.
3790     *
3791     * @param parent Parent object to add the window to, or NULL
3792     * @param name The name of the window
3793     * @param type The window type, one of #Elm_Win_Type.
3794     *
3795     * The @p parent paramter can be @c NULL for every window @p type except
3796     * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3797     * which the image object will be created.
3798     *
3799     * @return The created object, or NULL on failure
3800     */
3801    EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3802    /**
3803     * Add @p subobj as a resize object of window @p obj.
3804     *
3805     *
3806     * Setting an object as a resize object of the window means that the
3807     * @p subobj child's size and position will be controlled by the window
3808     * directly. That is, the object will be resized to match the window size
3809     * and should never be moved or resized manually by the developer.
3810     *
3811     * In addition, resize objects of the window control what the minimum size
3812     * of it will be, as well as whether it can or not be resized by the user.
3813     *
3814     * For the end user to be able to resize a window by dragging the handles
3815     * or borders provided by the Window Manager, or using any other similar
3816     * mechanism, all of the resize objects in the window should have their
3817     * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3818     *
3819     * @param obj The window object
3820     * @param subobj The resize object to add
3821     */
3822    EAPI void         elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3823    /**
3824     * Delete @p subobj as a resize object of window @p obj.
3825     *
3826     * This function removes the object @p subobj from the resize objects of
3827     * the window @p obj. It will not delete the object itself, which will be
3828     * left unmanaged and should be deleted by the developer, manually handled
3829     * or set as child of some other container.
3830     *
3831     * @param obj The window object
3832     * @param subobj The resize object to add
3833     */
3834    EAPI void         elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3835    /**
3836     * Set the title of the window
3837     *
3838     * @param obj The window object
3839     * @param title The title to set
3840     */
3841    EAPI void         elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3842    /**
3843     * Get the title of the window
3844     *
3845     * The returned string is an internal one and should not be freed or
3846     * modified. It will also be rendered invalid if a new title is set or if
3847     * the window is destroyed.
3848     *
3849     * @param obj The window object
3850     * @return The title
3851     */
3852    EAPI const char  *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3853    /**
3854     * Set the window's autodel state.
3855     *
3856     * When closing the window in any way outside of the program control, like
3857     * pressing the X button in the titlebar or using a command from the
3858     * Window Manager, a "delete,request" signal is emitted to indicate that
3859     * this event occurred and the developer can take any action, which may
3860     * include, or not, destroying the window object.
3861     *
3862     * When the @p autodel parameter is set, the window will be automatically
3863     * destroyed when this event occurs, after the signal is emitted.
3864     * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3865     * and is up to the program to do so when it's required.
3866     *
3867     * @param obj The window object
3868     * @param autodel If true, the window will automatically delete itself when
3869     * closed
3870     */
3871    EAPI void         elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3872    /**
3873     * Get the window's autodel state.
3874     *
3875     * @param obj The window object
3876     * @return If the window will automatically delete itself when closed
3877     *
3878     * @see elm_win_autodel_set()
3879     */
3880    EAPI Eina_Bool    elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3881    /**
3882     * Activate a window object.
3883     *
3884     * This function sends a request to the Window Manager to activate the
3885     * window pointed by @p obj. If honored by the WM, the window will receive
3886     * the keyboard focus.
3887     *
3888     * @note This is just a request that a Window Manager may ignore, so calling
3889     * this function does not ensure in any way that the window will be the
3890     * active one after it.
3891     *
3892     * @param obj The window object
3893     */
3894    EAPI void         elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3895    /**
3896     * Lower a window object.
3897     *
3898     * Places the window pointed by @p obj at the bottom of the stack, so that
3899     * no other window is covered by it.
3900     *
3901     * If elm_win_override_set() is not set, the Window Manager may ignore this
3902     * request.
3903     *
3904     * @param obj The window object
3905     */
3906    EAPI void         elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3907    /**
3908     * Raise a window object.
3909     *
3910     * Places the window pointed by @p obj at the top of the stack, so that it's
3911     * not covered by any other window.
3912     *
3913     * If elm_win_override_set() is not set, the Window Manager may ignore this
3914     * request.
3915     *
3916     * @param obj The window object
3917     */
3918    EAPI void         elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3919    /**
3920     * Set the borderless state of a window.
3921     *
3922     * This function requests the Window Manager to not draw any decoration
3923     * around the window.
3924     *
3925     * @param obj The window object
3926     * @param borderless If true, the window is borderless
3927     */
3928    EAPI void         elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3929    /**
3930     * Get the borderless state of a window.
3931     *
3932     * @param obj The window object
3933     * @return If true, the window is borderless
3934     */
3935    EAPI Eina_Bool    elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3936    /**
3937     * Set the shaped state of a window.
3938     *
3939     * Shaped windows, when supported, will render the parts of the window that
3940     * has no content, transparent.
3941     *
3942     * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3943     * background object or cover the entire window in any other way, or the
3944     * parts of the canvas that have no data will show framebuffer artifacts.
3945     *
3946     * @param obj The window object
3947     * @param shaped If true, the window is shaped
3948     *
3949     * @see elm_win_alpha_set()
3950     */
3951    EAPI void         elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3952    /**
3953     * Get the shaped state of a window.
3954     *
3955     * @param obj The window object
3956     * @return If true, the window is shaped
3957     *
3958     * @see elm_win_shaped_set()
3959     */
3960    EAPI Eina_Bool    elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3961    /**
3962     * Set the alpha channel state of a window.
3963     *
3964     * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3965     * possibly making parts of the window completely or partially transparent.
3966     * This is also subject to the underlying system supporting it, like for
3967     * example, running under a compositing manager. If no compositing is
3968     * available, enabling this option will instead fallback to using shaped
3969     * windows, with elm_win_shaped_set().
3970     *
3971     * @param obj The window object
3972     * @param alpha If true, the window has an alpha channel
3973     *
3974     * @see elm_win_alpha_set()
3975     */
3976    EAPI void         elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
3977    /**
3978     * Get the transparency state of a window.
3979     *
3980     * @param obj The window object
3981     * @return If true, the window is transparent
3982     *
3983     * @see elm_win_transparent_set()
3984     */
3985    EAPI Eina_Bool    elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3986    /**
3987     * Set the transparency state of a window.
3988     *
3989     * Use elm_win_alpha_set() instead.
3990     *
3991     * @param obj The window object
3992     * @param transparent If true, the window is transparent
3993     *
3994     * @see elm_win_alpha_set()
3995     */
3996    EAPI void         elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
3997    /**
3998     * Get the alpha channel state of a window.
3999     *
4000     * @param obj The window object
4001     * @return If true, the window has an alpha channel
4002     */
4003    EAPI Eina_Bool    elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4004    /**
4005     * Set the override state of a window.
4006     *
4007     * A window with @p override set to EINA_TRUE will not be managed by the
4008     * Window Manager. This means that no decorations of any kind will be shown
4009     * for it, moving and resizing must be handled by the application, as well
4010     * as the window visibility.
4011     *
4012     * This should not be used for normal windows, and even for not so normal
4013     * ones, it should only be used when there's a good reason and with a lot
4014     * of care. Mishandling override windows may result situations that
4015     * disrupt the normal workflow of the end user.
4016     *
4017     * @param obj The window object
4018     * @param override If true, the window is overridden
4019     */
4020    EAPI void         elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
4021    /**
4022     * Get the override state of a window.
4023     *
4024     * @param obj The window object
4025     * @return If true, the window is overridden
4026     *
4027     * @see elm_win_override_set()
4028     */
4029    EAPI Eina_Bool    elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4030    /**
4031     * Set the fullscreen state of a window.
4032     *
4033     * @param obj The window object
4034     * @param fullscreen If true, the window is fullscreen
4035     */
4036    EAPI void         elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
4037    /**
4038     * Get the fullscreen state of a window.
4039     *
4040     * @param obj The window object
4041     * @return If true, the window is fullscreen
4042     */
4043    EAPI Eina_Bool    elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4044    /**
4045     * Set the maximized state of a window.
4046     *
4047     * @param obj The window object
4048     * @param maximized If true, the window is maximized
4049     */
4050    EAPI void         elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
4051    /**
4052     * Get the maximized state of a window.
4053     *
4054     * @param obj The window object
4055     * @return If true, the window is maximized
4056     */
4057    EAPI Eina_Bool    elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4058    /**
4059     * Set the iconified state of a window.
4060     *
4061     * @param obj The window object
4062     * @param iconified If true, the window is iconified
4063     */
4064    EAPI void         elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
4065    /**
4066     * Get the iconified state of a window.
4067     *
4068     * @param obj The window object
4069     * @return If true, the window is iconified
4070     */
4071    EAPI Eina_Bool    elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4072    /**
4073     * Set the layer of the window.
4074     *
4075     * What this means exactly will depend on the underlying engine used.
4076     *
4077     * In the case of X11 backed engines, the value in @p layer has the
4078     * following meanings:
4079     * @li < 3: The window will be placed below all others.
4080     * @li > 5: The window will be placed above all others.
4081     * @li other: The window will be placed in the default layer.
4082     *
4083     * @param obj The window object
4084     * @param layer The layer of the window
4085     */
4086    EAPI void         elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
4087    /**
4088     * Get the layer of the window.
4089     *
4090     * @param obj The window object
4091     * @return The layer of the window
4092     *
4093     * @see elm_win_layer_set()
4094     */
4095    EAPI int          elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4096    /**
4097     * Set the rotation of the window.
4098     *
4099     * Most engines only work with multiples of 90.
4100     *
4101     * This function is used to set the orientation of the window @p obj to
4102     * match that of the screen. The window itself will be resized to adjust
4103     * to the new geometry of its contents. If you want to keep the window size,
4104     * see elm_win_rotation_with_resize_set().
4105     *
4106     * @param obj The window object
4107     * @param rotation The rotation of the window, in degrees (0-360),
4108     * counter-clockwise.
4109     */
4110    EAPI void         elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4111    /**
4112     * Rotates the window and resizes it.
4113     *
4114     * Like elm_win_rotation_set(), but it also resizes the window's contents so
4115     * that they fit inside the current window geometry.
4116     *
4117     * @param obj The window object
4118     * @param layer The rotation of the window in degrees (0-360),
4119     * counter-clockwise.
4120     */
4121    EAPI void         elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4122    /**
4123     * Get the rotation of the window.
4124     *
4125     * @param obj The window object
4126     * @return The rotation of the window in degrees (0-360)
4127     *
4128     * @see elm_win_rotation_set()
4129     * @see elm_win_rotation_with_resize_set()
4130     */
4131    EAPI int          elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4132    /**
4133     * Set the sticky state of the window.
4134     *
4135     * Hints the Window Manager that the window in @p obj should be left fixed
4136     * at its position even when the virtual desktop it's on moves or changes.
4137     *
4138     * @param obj The window object
4139     * @param sticky If true, the window's sticky state is enabled
4140     */
4141    EAPI void         elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4142    /**
4143     * Get the sticky state of the window.
4144     *
4145     * @param obj The window object
4146     * @return If true, the window's sticky state is enabled
4147     *
4148     * @see elm_win_sticky_set()
4149     */
4150    EAPI Eina_Bool    elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4151    /**
4152     * Set if this window is an illume conformant window
4153     *
4154     * @param obj The window object
4155     * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4156     */
4157    EAPI void         elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4158    /**
4159     * Get if this window is an illume conformant window
4160     *
4161     * @param obj The window object
4162     * @return A boolean if this window is illume conformant or not
4163     */
4164    EAPI Eina_Bool    elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4165    /**
4166     * Set a window to be an illume quickpanel window
4167     *
4168     * By default window objects are not quickpanel windows.
4169     *
4170     * @param obj The window object
4171     * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4172     */
4173    EAPI void         elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4174    /**
4175     * Get if this window is a quickpanel or not
4176     *
4177     * @param obj The window object
4178     * @return A boolean if this window is a quickpanel or not
4179     */
4180    EAPI Eina_Bool    elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4181    /**
4182     * Set the major priority of a quickpanel window
4183     *
4184     * @param obj The window object
4185     * @param priority The major priority for this quickpanel
4186     */
4187    EAPI void         elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4188    /**
4189     * Get the major priority of a quickpanel window
4190     *
4191     * @param obj The window object
4192     * @return The major priority of this quickpanel
4193     */
4194    EAPI int          elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4195    /**
4196     * Set the minor priority of a quickpanel window
4197     *
4198     * @param obj The window object
4199     * @param priority The minor priority for this quickpanel
4200     */
4201    EAPI void         elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4202    /**
4203     * Get the minor priority of a quickpanel window
4204     *
4205     * @param obj The window object
4206     * @return The minor priority of this quickpanel
4207     */
4208    EAPI int          elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4209    /**
4210     * Set which zone this quickpanel should appear in
4211     *
4212     * @param obj The window object
4213     * @param zone The requested zone for this quickpanel
4214     */
4215    EAPI void         elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4216    /**
4217     * Get which zone this quickpanel should appear in
4218     *
4219     * @param obj The window object
4220     * @return The requested zone for this quickpanel
4221     */
4222    EAPI int          elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4223    /**
4224     * Set the window to be skipped by keyboard focus
4225     *
4226     * This sets the window to be skipped by normal keyboard input. This means
4227     * a window manager will be asked to not focus this window as well as omit
4228     * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4229     *
4230     * Call this and enable it on a window BEFORE you show it for the first time,
4231     * otherwise it may have no effect.
4232     *
4233     * Use this for windows that have only output information or might only be
4234     * interacted with by the mouse or fingers, and never for typing input.
4235     * Be careful that this may have side-effects like making the window
4236     * non-accessible in some cases unless the window is specially handled. Use
4237     * this with care.
4238     *
4239     * @param obj The window object
4240     * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4241     */
4242    EAPI void         elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4243    /**
4244     * Send a command to the windowing environment
4245     *
4246     * This is intended to work in touchscreen or small screen device
4247     * environments where there is a more simplistic window management policy in
4248     * place. This uses the window object indicated to select which part of the
4249     * environment to control (the part that this window lives in), and provides
4250     * a command and an optional parameter structure (use NULL for this if not
4251     * needed).
4252     *
4253     * @param obj The window object that lives in the environment to control
4254     * @param command The command to send
4255     * @param params Optional parameters for the command
4256     */
4257    EAPI void         elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4258    /**
4259     * Get the inlined image object handle
4260     *
4261     * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4262     * then the window is in fact an evas image object inlined in the parent
4263     * canvas. You can get this object (be careful to not manipulate it as it
4264     * is under control of elementary), and use it to do things like get pixel
4265     * data, save the image to a file, etc.
4266     *
4267     * @param obj The window object to get the inlined image from
4268     * @return The inlined image object, or NULL if none exists
4269     */
4270    EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4271    /**
4272     * Set the enabled status for the focus highlight in a window
4273     *
4274     * This function will enable or disable the focus highlight only for the
4275     * given window, regardless of the global setting for it
4276     *
4277     * @param obj The window where to enable the highlight
4278     * @param enabled The enabled value for the highlight
4279     */
4280    EAPI void         elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4281    /**
4282     * Get the enabled value of the focus highlight for this window
4283     *
4284     * @param obj The window in which to check if the focus highlight is enabled
4285     *
4286     * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4287     */
4288    EAPI Eina_Bool    elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4289    /**
4290     * Set the style for the focus highlight on this window
4291     *
4292     * Sets the style to use for theming the highlight of focused objects on
4293     * the given window. If @p style is NULL, the default will be used.
4294     *
4295     * @param obj The window where to set the style
4296     * @param style The style to set
4297     */
4298    EAPI void         elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4299    /**
4300     * Get the style set for the focus highlight object
4301     *
4302     * Gets the style set for this windows highilght object, or NULL if none
4303     * is set.
4304     *
4305     * @param obj The window to retrieve the highlights style from
4306     *
4307     * @return The style set or NULL if none was. Default is used in that case.
4308     */
4309    EAPI const char  *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4310    /*...
4311     * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4312     * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4313     * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4314     * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4315     * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4316     * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4317     * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4318     *
4319     * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4320     * (blank mouse, private mouse obj, defaultmouse)
4321     *
4322     */
4323    /**
4324     * Sets the keyboard mode of the window.
4325     *
4326     * @param obj The window object
4327     * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4328     */
4329    EAPI void                  elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4330    /**
4331     * Gets the keyboard mode of the window.
4332     *
4333     * @param obj The window object
4334     * @return The mode, one of #Elm_Win_Keyboard_Mode
4335     */
4336    EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4337    /**
4338     * Sets whether the window is a keyboard.
4339     *
4340     * @param obj The window object
4341     * @param is_keyboard If true, the window is a virtual keyboard
4342     */
4343    EAPI void                  elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4344    /**
4345     * Gets whether the window is a keyboard.
4346     *
4347     * @param obj The window object
4348     * @return If the window is a virtual keyboard
4349     */
4350    EAPI Eina_Bool             elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4351
4352    /**
4353     * Get the screen position of a window.
4354     *
4355     * @param obj The window object
4356     * @param x The int to store the x coordinate to
4357     * @param y The int to store the y coordinate to
4358     */
4359    EAPI void                  elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4360    /**
4361     * @}
4362     */
4363
4364    /**
4365     * @defgroup Inwin Inwin
4366     *
4367     * @image html img/widget/inwin/preview-00.png
4368     * @image latex img/widget/inwin/preview-00.eps
4369     * @image html img/widget/inwin/preview-01.png
4370     * @image latex img/widget/inwin/preview-01.eps
4371     * @image html img/widget/inwin/preview-02.png
4372     * @image latex img/widget/inwin/preview-02.eps
4373     *
4374     * An inwin is a window inside a window that is useful for a quick popup.
4375     * It does not hover.
4376     *
4377     * It works by creating an object that will occupy the entire window, so it
4378     * must be created using an @ref Win "elm_win" as parent only. The inwin
4379     * object can be hidden or restacked below every other object if it's
4380     * needed to show what's behind it without destroying it. If this is done,
4381     * the elm_win_inwin_activate() function can be used to bring it back to
4382     * full visibility again.
4383     *
4384     * There are three styles available in the default theme. These are:
4385     * @li default: The inwin is sized to take over most of the window it's
4386     * placed in.
4387     * @li minimal: The size of the inwin will be the minimum necessary to show
4388     * its contents.
4389     * @li minimal_vertical: Horizontally, the inwin takes as much space as
4390     * possible, but it's sized vertically the most it needs to fit its\
4391     * contents.
4392     *
4393     * Some examples of Inwin can be found in the following:
4394     * @li @ref inwin_example_01
4395     *
4396     * @{
4397     */
4398    /**
4399     * Adds an inwin to the current window
4400     *
4401     * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4402     * Never call this function with anything other than the top-most window
4403     * as its parameter, unless you are fond of undefined behavior.
4404     *
4405     * After creating the object, the widget will set itself as resize object
4406     * for the window with elm_win_resize_object_add(), so when shown it will
4407     * appear to cover almost the entire window (how much of it depends on its
4408     * content and the style used). It must not be added into other container
4409     * objects and it needs not be moved or resized manually.
4410     *
4411     * @param parent The parent object
4412     * @return The new object or NULL if it cannot be created
4413     */
4414    EAPI Evas_Object          *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4415    /**
4416     * Activates an inwin object, ensuring its visibility
4417     *
4418     * This function will make sure that the inwin @p obj is completely visible
4419     * by calling evas_object_show() and evas_object_raise() on it, to bring it
4420     * to the front. It also sets the keyboard focus to it, which will be passed
4421     * onto its content.
4422     *
4423     * The object's theme will also receive the signal "elm,action,show" with
4424     * source "elm".
4425     *
4426     * @param obj The inwin to activate
4427     */
4428    EAPI void                  elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4429    /**
4430     * Set the content of an inwin object.
4431     *
4432     * Once the content object is set, a previously set one will be deleted.
4433     * If you want to keep that old content object, use the
4434     * elm_win_inwin_content_unset() function.
4435     *
4436     * @param obj The inwin object
4437     * @param content The object to set as content
4438     */
4439    EAPI void                  elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4440    /**
4441     * Get the content of an inwin object.
4442     *
4443     * Return the content object which is set for this widget.
4444     *
4445     * The returned object is valid as long as the inwin is still alive and no
4446     * other content is set on it. Deleting the object will notify the inwin
4447     * about it and this one will be left empty.
4448     *
4449     * If you need to remove an inwin's content to be reused somewhere else,
4450     * see elm_win_inwin_content_unset().
4451     *
4452     * @param obj The inwin object
4453     * @return The content that is being used
4454     */
4455    EAPI Evas_Object          *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4456    /**
4457     * Unset the content of an inwin object.
4458     *
4459     * Unparent and return the content object which was set for this widget.
4460     *
4461     * @param obj The inwin object
4462     * @return The content that was being used
4463     */
4464    EAPI Evas_Object          *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4465    /**
4466     * @}
4467     */
4468    /* X specific calls - won't work on non-x engines (return 0) */
4469
4470    /**
4471     * Get the Ecore_X_Window of an Evas_Object
4472     *
4473     * @param obj The object
4474     *
4475     * @return The Ecore_X_Window of @p obj
4476     *
4477     * @ingroup Win
4478     */
4479    EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4480
4481    /* smart callbacks called:
4482     * "delete,request" - the user requested to delete the window
4483     * "focus,in" - window got focus
4484     * "focus,out" - window lost focus
4485     * "moved" - window that holds the canvas was moved
4486     */
4487
4488    /**
4489     * @defgroup Bg Bg
4490     *
4491     * @image html img/widget/bg/preview-00.png
4492     * @image latex img/widget/bg/preview-00.eps
4493     *
4494     * @brief Background object, used for setting a solid color, image or Edje
4495     * group as background to a window or any container object.
4496     *
4497     * The bg object is used for setting a solid background to a window or
4498     * packing into any container object. It works just like an image, but has
4499     * some properties useful to a background, like setting it to tiled,
4500     * centered, scaled or stretched.
4501     *
4502     * Here is some sample code using it:
4503     * @li @ref bg_01_example_page
4504     * @li @ref bg_02_example_page
4505     * @li @ref bg_03_example_page
4506     */
4507
4508    /* bg */
4509    typedef enum _Elm_Bg_Option
4510      {
4511         ELM_BG_OPTION_CENTER,  /**< center the background */
4512         ELM_BG_OPTION_SCALE,   /**< scale the background retaining aspect ratio */
4513         ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4514         ELM_BG_OPTION_TILE     /**< tile background at its original size */
4515      } Elm_Bg_Option;
4516
4517    /**
4518     * Add a new background to the parent
4519     *
4520     * @param parent The parent object
4521     * @return The new object or NULL if it cannot be created
4522     *
4523     * @ingroup Bg
4524     */
4525    EAPI Evas_Object  *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4526
4527    /**
4528     * Set the file (image or edje) used for the background
4529     *
4530     * @param obj The bg object
4531     * @param file The file path
4532     * @param group Optional key (group in Edje) within the file
4533     *
4534     * This sets the image file used in the background object. The image (or edje)
4535     * will be stretched (retaining aspect if its an image file) to completely fill
4536     * the bg object. This may mean some parts are not visible.
4537     *
4538     * @note  Once the image of @p obj is set, a previously set one will be deleted,
4539     * even if @p file is NULL.
4540     *
4541     * @ingroup Bg
4542     */
4543    EAPI void          elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4544
4545    /**
4546     * Get the file (image or edje) used for the background
4547     *
4548     * @param obj The bg object
4549     * @param file The file path
4550     * @param group Optional key (group in Edje) within the file
4551     *
4552     * @ingroup Bg
4553     */
4554    EAPI void          elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4555
4556    /**
4557     * Set the option used for the background image
4558     *
4559     * @param obj The bg object
4560     * @param option The desired background option (TILE, SCALE)
4561     *
4562     * This sets the option used for manipulating the display of the background
4563     * image. The image can be tiled or scaled.
4564     *
4565     * @ingroup Bg
4566     */
4567    EAPI void          elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4568
4569    /**
4570     * Get the option used for the background image
4571     *
4572     * @param obj The bg object
4573     * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4574     *
4575     * @ingroup Bg
4576     */
4577    EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4578    /**
4579     * Set the option used for the background color
4580     *
4581     * @param obj The bg object
4582     * @param r
4583     * @param g
4584     * @param b
4585     *
4586     * This sets the color used for the background rectangle. Its range goes
4587     * from 0 to 255.
4588     *
4589     * @ingroup Bg
4590     */
4591    EAPI void          elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4592    /**
4593     * Get the option used for the background color
4594     *
4595     * @param obj The bg object
4596     * @param r
4597     * @param g
4598     * @param b
4599     *
4600     * @ingroup Bg
4601     */
4602    EAPI void          elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4603
4604    /**
4605     * Set the overlay object used for the background object.
4606     *
4607     * @param obj The bg object
4608     * @param overlay The overlay object
4609     *
4610     * This provides a way for elm_bg to have an 'overlay' that will be on top
4611     * of the bg. Once the over object is set, a previously set one will be
4612     * deleted, even if you set the new one to NULL. If you want to keep that
4613     * old content object, use the elm_bg_overlay_unset() function.
4614     *
4615     * @ingroup Bg
4616     */
4617
4618    EAPI void          elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4619
4620    /**
4621     * Get the overlay object used for the background object.
4622     *
4623     * @param obj The bg object
4624     * @return The content that is being used
4625     *
4626     * Return the content object which is set for this widget
4627     *
4628     * @ingroup Bg
4629     */
4630    EAPI Evas_Object  *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4631
4632    /**
4633     * Get the overlay object used for the background object.
4634     *
4635     * @param obj The bg object
4636     * @return The content that was being used
4637     *
4638     * Unparent and return the overlay object which was set for this widget
4639     *
4640     * @ingroup Bg
4641     */
4642    EAPI Evas_Object  *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4643
4644    /**
4645     * Set the size of the pixmap representation of the image.
4646     *
4647     * This option just makes sense if an image is going to be set in the bg.
4648     *
4649     * @param obj The bg object
4650     * @param w The new width of the image pixmap representation.
4651     * @param h The new height of the image pixmap representation.
4652     *
4653     * This function sets a new size for pixmap representation of the given bg
4654     * image. It allows the image to be loaded already in the specified size,
4655     * reducing the memory usage and load time when loading a big image with load
4656     * size set to a smaller size.
4657     *
4658     * NOTE: this is just a hint, the real size of the pixmap may differ
4659     * depending on the type of image being loaded, being bigger than requested.
4660     *
4661     * @ingroup Bg
4662     */
4663    EAPI void          elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4664    /* smart callbacks called:
4665     */
4666
4667    /**
4668     * @defgroup Icon Icon
4669     *
4670     * @image html img/widget/icon/preview-00.png
4671     * @image latex img/widget/icon/preview-00.eps
4672     *
4673     * An object that provides standard icon images (delete, edit, arrows, etc.)
4674     * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4675     *
4676     * The icon image requested can be in the elementary theme, or in the
4677     * freedesktop.org paths. It's possible to set the order of preference from
4678     * where the image will be used.
4679     *
4680     * This API is very similar to @ref Image, but with ready to use images.
4681     *
4682     * Default images provided by the theme are described below.
4683     *
4684     * The first list contains icons that were first intended to be used in
4685     * toolbars, but can be used in many other places too:
4686     * @li home
4687     * @li close
4688     * @li apps
4689     * @li arrow_up
4690     * @li arrow_down
4691     * @li arrow_left
4692     * @li arrow_right
4693     * @li chat
4694     * @li clock
4695     * @li delete
4696     * @li edit
4697     * @li refresh
4698     * @li folder
4699     * @li file
4700     *
4701     * Now some icons that were designed to be used in menus (but again, you can
4702     * use them anywhere else):
4703     * @li menu/home
4704     * @li menu/close
4705     * @li menu/apps
4706     * @li menu/arrow_up
4707     * @li menu/arrow_down
4708     * @li menu/arrow_left
4709     * @li menu/arrow_right
4710     * @li menu/chat
4711     * @li menu/clock
4712     * @li menu/delete
4713     * @li menu/edit
4714     * @li menu/refresh
4715     * @li menu/folder
4716     * @li menu/file
4717     *
4718     * And here we have some media player specific icons:
4719     * @li media_player/forward
4720     * @li media_player/info
4721     * @li media_player/next
4722     * @li media_player/pause
4723     * @li media_player/play
4724     * @li media_player/prev
4725     * @li media_player/rewind
4726     * @li media_player/stop
4727     *
4728     * Signals that you can add callbacks for are:
4729     *
4730     * "clicked" - This is called when a user has clicked the icon
4731     *
4732     * An example of usage for this API follows:
4733     * @li @ref tutorial_icon
4734     */
4735
4736    /**
4737     * @addtogroup Icon
4738     * @{
4739     */
4740
4741    typedef enum _Elm_Icon_Type
4742      {
4743         ELM_ICON_NONE,
4744         ELM_ICON_FILE,
4745         ELM_ICON_STANDARD
4746      } Elm_Icon_Type;
4747    /**
4748     * @enum _Elm_Icon_Lookup_Order
4749     * @typedef Elm_Icon_Lookup_Order
4750     *
4751     * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4752     * theme, FDO paths, or both?
4753     *
4754     * @ingroup Icon
4755     */
4756    typedef enum _Elm_Icon_Lookup_Order
4757      {
4758         ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4759         ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4760         ELM_ICON_LOOKUP_FDO,       /**< icon look up order: freedesktop */
4761         ELM_ICON_LOOKUP_THEME      /**< icon look up order: theme */
4762      } Elm_Icon_Lookup_Order;
4763
4764    /**
4765     * Add a new icon object to the parent.
4766     *
4767     * @param parent The parent object
4768     * @return The new object or NULL if it cannot be created
4769     *
4770     * @see elm_icon_file_set()
4771     *
4772     * @ingroup Icon
4773     */
4774    EAPI Evas_Object          *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4775    /**
4776     * Set the file that will be used as icon.
4777     *
4778     * @param obj The icon object
4779     * @param file The path to file that will be used as icon image
4780     * @param group The group that the icon belongs to in edje file
4781     *
4782     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4783     *
4784     * @note The icon image set by this function can be changed by
4785     * elm_icon_standard_set().
4786     *
4787     * @see elm_icon_file_get()
4788     *
4789     * @ingroup Icon
4790     */
4791    EAPI Eina_Bool             elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4792    /**
4793     * Set a location in memory to be used as an icon
4794     *
4795     * @param obj The icon object
4796     * @param img The binary data that will be used as an image
4797     * @param size The size of binary data @p img
4798     * @param format Optional format of @p img to pass to the image loader
4799     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4800     *
4801     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4802     *
4803     * @note The icon image set by this function can be changed by
4804     * elm_icon_standard_set().
4805     *
4806     * @ingroup Icon
4807     */
4808    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);
4809    /**
4810     * Get the file that will be used as icon.
4811     *
4812     * @param obj The icon object
4813     * @param file The path to file that will be used as icon icon image
4814     * @param group The group that the icon belongs to in edje file
4815     *
4816     * @see elm_icon_file_set()
4817     *
4818     * @ingroup Icon
4819     */
4820    EAPI void                  elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4821    EAPI void                  elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4822    /**
4823     * Set the icon by icon standards names.
4824     *
4825     * @param obj The icon object
4826     * @param name The icon name
4827     *
4828     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4829     *
4830     * For example, freedesktop.org defines standard icon names such as "home",
4831     * "network", etc. There can be different icon sets to match those icon
4832     * keys. The @p name given as parameter is one of these "keys", and will be
4833     * used to look in the freedesktop.org paths and elementary theme. One can
4834     * change the lookup order with elm_icon_order_lookup_set().
4835     *
4836     * If name is not found in any of the expected locations and it is the
4837     * absolute path of an image file, this image will be used.
4838     *
4839     * @note The icon image set by this function can be changed by
4840     * elm_icon_file_set().
4841     *
4842     * @see elm_icon_standard_get()
4843     * @see elm_icon_file_set()
4844     *
4845     * @ingroup Icon
4846     */
4847    EAPI Eina_Bool             elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4848    /**
4849     * Get the icon name set by icon standard names.
4850     *
4851     * @param obj The icon object
4852     * @return The icon name
4853     *
4854     * If the icon image was set using elm_icon_file_set() instead of
4855     * elm_icon_standard_set(), then this function will return @c NULL.
4856     *
4857     * @see elm_icon_standard_set()
4858     *
4859     * @ingroup Icon
4860     */
4861    EAPI const char           *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4862    /**
4863     * Set the smooth effect for an icon object.
4864     *
4865     * @param obj The icon object
4866     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4867     * otherwise. Default is @c EINA_TRUE.
4868     *
4869     * Set the scaling algorithm to be used when scaling the icon image. Smooth
4870     * scaling provides a better resulting image, but is slower.
4871     *
4872     * The smooth scaling should be disabled when making animations that change
4873     * the icon size, since they will be faster. Animations that don't require
4874     * resizing of the icon can keep the smooth scaling enabled (even if the icon
4875     * is already scaled, since the scaled icon image will be cached).
4876     *
4877     * @see elm_icon_smooth_get()
4878     *
4879     * @ingroup Icon
4880     */
4881    EAPI void                  elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4882    /**
4883     * Get the smooth effect for an icon object.
4884     *
4885     * @param obj The icon object
4886     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4887     *
4888     * @see elm_icon_smooth_set()
4889     *
4890     * @ingroup Icon
4891     */
4892    EAPI Eina_Bool             elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4893    /**
4894     * Disable scaling of this object.
4895     *
4896     * @param obj The icon object.
4897     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4898     * otherwise. Default is @c EINA_FALSE.
4899     *
4900     * This function disables scaling of the icon object through the function
4901     * elm_object_scale_set(). However, this does not affect the object
4902     * size/resize in any way. For that effect, take a look at
4903     * elm_icon_scale_set().
4904     *
4905     * @see elm_icon_no_scale_get()
4906     * @see elm_icon_scale_set()
4907     * @see elm_object_scale_set()
4908     *
4909     * @ingroup Icon
4910     */
4911    EAPI void                  elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4912    /**
4913     * Get whether scaling is disabled on the object.
4914     *
4915     * @param obj The icon object
4916     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4917     *
4918     * @see elm_icon_no_scale_set()
4919     *
4920     * @ingroup Icon
4921     */
4922    EAPI Eina_Bool             elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4923    /**
4924     * Set if the object is (up/down) resizable.
4925     *
4926     * @param obj The icon object
4927     * @param scale_up A bool to set if the object is resizable up. Default is
4928     * @c EINA_TRUE.
4929     * @param scale_down A bool to set if the object is resizable down. Default
4930     * is @c EINA_TRUE.
4931     *
4932     * This function limits the icon object resize ability. If @p scale_up is set to
4933     * @c EINA_FALSE, the object can't have its height or width resized to a value
4934     * higher than the original icon size. Same is valid for @p scale_down.
4935     *
4936     * @see elm_icon_scale_get()
4937     *
4938     * @ingroup Icon
4939     */
4940    EAPI void                  elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4941    /**
4942     * Get if the object is (up/down) resizable.
4943     *
4944     * @param obj The icon object
4945     * @param scale_up A bool to set if the object is resizable up
4946     * @param scale_down A bool to set if the object is resizable down
4947     *
4948     * @see elm_icon_scale_set()
4949     *
4950     * @ingroup Icon
4951     */
4952    EAPI void                  elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4953    /**
4954     * Get the object's image size
4955     *
4956     * @param obj The icon object
4957     * @param w A pointer to store the width in
4958     * @param h A pointer to store the height in
4959     *
4960     * @ingroup Icon
4961     */
4962    EAPI void                  elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4963    /**
4964     * Set if the icon fill the entire object area.
4965     *
4966     * @param obj The icon object
4967     * @param fill_outside @c EINA_TRUE if the object is filled outside,
4968     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4969     *
4970     * When the icon object is resized to a different aspect ratio from the
4971     * original icon image, the icon image will still keep its aspect. This flag
4972     * tells how the image should fill the object's area. They are: keep the
4973     * entire icon inside the limits of height and width of the object (@p
4974     * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
4975     * of the object, and the icon will fill the entire object (@p fill_outside
4976     * is @c EINA_TRUE).
4977     *
4978     * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
4979     * retain property to false. Thus, the icon image will always keep its
4980     * original aspect ratio.
4981     *
4982     * @see elm_icon_fill_outside_get()
4983     * @see elm_image_fill_outside_set()
4984     *
4985     * @ingroup Icon
4986     */
4987    EAPI void                  elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
4988    /**
4989     * Get if the object is filled outside.
4990     *
4991     * @param obj The icon object
4992     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
4993     *
4994     * @see elm_icon_fill_outside_set()
4995     *
4996     * @ingroup Icon
4997     */
4998    EAPI Eina_Bool             elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4999    /**
5000     * Set the prescale size for the icon.
5001     *
5002     * @param obj The icon object
5003     * @param size The prescale size. This value is used for both width and
5004     * height.
5005     *
5006     * This function sets a new size for pixmap representation of the given
5007     * icon. It allows the icon to be loaded already in the specified size,
5008     * reducing the memory usage and load time when loading a big icon with load
5009     * size set to a smaller size.
5010     *
5011     * It's equivalent to the elm_bg_load_size_set() function for bg.
5012     *
5013     * @note this is just a hint, the real size of the pixmap may differ
5014     * depending on the type of icon being loaded, being bigger than requested.
5015     *
5016     * @see elm_icon_prescale_get()
5017     * @see elm_bg_load_size_set()
5018     *
5019     * @ingroup Icon
5020     */
5021    EAPI void                  elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5022    /**
5023     * Get the prescale size for the icon.
5024     *
5025     * @param obj The icon object
5026     * @return The prescale size
5027     *
5028     * @see elm_icon_prescale_set()
5029     *
5030     * @ingroup Icon
5031     */
5032    EAPI int                   elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5033    /**
5034     * Sets the icon lookup order used by elm_icon_standard_set().
5035     *
5036     * @param obj The icon object
5037     * @param order The icon lookup order (can be one of
5038     * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
5039     * or ELM_ICON_LOOKUP_THEME)
5040     *
5041     * @see elm_icon_order_lookup_get()
5042     * @see Elm_Icon_Lookup_Order
5043     *
5044     * @ingroup Icon
5045     */
5046    EAPI void                  elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5047    /**
5048     * Gets the icon lookup order.
5049     *
5050     * @param obj The icon object
5051     * @return The icon lookup order
5052     *
5053     * @see elm_icon_order_lookup_set()
5054     * @see Elm_Icon_Lookup_Order
5055     *
5056     * @ingroup Icon
5057     */
5058    EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5059    /**
5060     * Get if the icon supports animation or not.
5061     *
5062     * @param obj The icon object
5063     * @return @c EINA_TRUE if the icon supports animation,
5064     *         @c EINA_FALSE otherwise.
5065     *
5066     * Return if this elm icon's image can be animated. Currently Evas only
5067     * supports gif animation. If the return value is EINA_FALSE, other
5068     * elm_icon_animated_XXX APIs won't work.
5069     * @ingroup Icon
5070     */
5071    EAPI Eina_Bool           elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5072    /**
5073     * Set animation mode of the icon.
5074     *
5075     * @param obj The icon object
5076     * @param anim @c EINA_TRUE if the object do animation job,
5077     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5078     *
5079     * Even though elm icon's file can be animated,
5080     * sometimes appication developer want to just first page of image.
5081     * In that time, don't call this function, because default value is EINA_FALSE
5082     * Only when you want icon support anition,
5083     * use this function and set animated to EINA_TURE
5084     * @ingroup Icon
5085     */
5086    EAPI void                elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5087    /**
5088     * Get animation mode of the icon.
5089     *
5090     * @param obj The icon object
5091     * @return The animation mode of the icon object
5092     * @see elm_icon_animated_set
5093     * @ingroup Icon
5094     */
5095    EAPI Eina_Bool           elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5096    /**
5097     * Set animation play mode of the icon.
5098     *
5099     * @param obj The icon object
5100     * @param play @c EINA_TRUE the object play animation images,
5101     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5102     *
5103     * If you want to play elm icon's animation, you set play to EINA_TURE.
5104     * For example, you make gif player using this set/get API and click event.
5105     *
5106     * 1. Click event occurs
5107     * 2. Check play flag using elm_icon_animaged_play_get
5108     * 3. If elm icon was playing, set play to EINA_FALSE.
5109     *    Then animation will be stopped and vice versa
5110     * @ingroup Icon
5111     */
5112    EAPI void                elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5113    /**
5114     * Get animation play mode of the icon.
5115     *
5116     * @param obj The icon object
5117     * @return The play mode of the icon object
5118     *
5119     * @see elm_icon_animated_lay_get
5120     * @ingroup Icon
5121     */
5122    EAPI Eina_Bool           elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5123
5124    /**
5125     * @}
5126     */
5127
5128    /**
5129     * @defgroup Image Image
5130     *
5131     * @image html img/widget/image/preview-00.png
5132     * @image latex img/widget/image/preview-00.eps
5133
5134     *
5135     * An object that allows one to load an image file to it. It can be used
5136     * anywhere like any other elementary widget.
5137     *
5138     * This widget provides most of the functionality provided from @ref Bg or @ref
5139     * Icon, but with a slightly different API (use the one that fits better your
5140     * needs).
5141     *
5142     * The features not provided by those two other image widgets are:
5143     * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5144     * @li change the object orientation with elm_image_orient_set();
5145     * @li and turning the image editable with elm_image_editable_set().
5146     *
5147     * Signals that you can add callbacks for are:
5148     *
5149     * @li @c "clicked" - This is called when a user has clicked the image
5150     *
5151     * An example of usage for this API follows:
5152     * @li @ref tutorial_image
5153     */
5154
5155    /**
5156     * @addtogroup Image
5157     * @{
5158     */
5159
5160    /**
5161     * @enum _Elm_Image_Orient
5162     * @typedef Elm_Image_Orient
5163     *
5164     * Possible orientation options for elm_image_orient_set().
5165     *
5166     * @image html elm_image_orient_set.png
5167     * @image latex elm_image_orient_set.eps width=\textwidth
5168     *
5169     * @ingroup Image
5170     */
5171    typedef enum _Elm_Image_Orient
5172      {
5173         ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5174         ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5175         ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5176         ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5177         ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5178         ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5179         ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5180         ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5181      } Elm_Image_Orient;
5182
5183    /**
5184     * Add a new image to the parent.
5185     *
5186     * @param parent The parent object
5187     * @return The new object or NULL if it cannot be created
5188     *
5189     * @see elm_image_file_set()
5190     *
5191     * @ingroup Image
5192     */
5193    EAPI Evas_Object     *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5194    /**
5195     * Set the file that will be used as image.
5196     *
5197     * @param obj The image object
5198     * @param file The path to file that will be used as image
5199     * @param group The group that the image belongs in edje file (if it's an
5200     * edje image)
5201     *
5202     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5203     *
5204     * @see elm_image_file_get()
5205     *
5206     * @ingroup Image
5207     */
5208    EAPI Eina_Bool        elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5209    /**
5210     * Get the file that will be used as image.
5211     *
5212     * @param obj The image object
5213     * @param file The path to file
5214     * @param group The group that the image belongs in edje file
5215     *
5216     * @see elm_image_file_set()
5217     *
5218     * @ingroup Image
5219     */
5220    EAPI void             elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5221    /**
5222     * Set the smooth effect for an image.
5223     *
5224     * @param obj The image object
5225     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5226     * otherwise. Default is @c EINA_TRUE.
5227     *
5228     * Set the scaling algorithm to be used when scaling the image. Smooth
5229     * scaling provides a better resulting image, but is slower.
5230     *
5231     * The smooth scaling should be disabled when making animations that change
5232     * the image size, since it will be faster. Animations that don't require
5233     * resizing of the image can keep the smooth scaling enabled (even if the
5234     * image is already scaled, since the scaled image will be cached).
5235     *
5236     * @see elm_image_smooth_get()
5237     *
5238     * @ingroup Image
5239     */
5240    EAPI void             elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5241    /**
5242     * Get the smooth effect for an image.
5243     *
5244     * @param obj The image object
5245     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5246     *
5247     * @see elm_image_smooth_get()
5248     *
5249     * @ingroup Image
5250     */
5251    EAPI Eina_Bool        elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5252    /**
5253     * Gets the current size of the image.
5254     *
5255     * @param obj The image object.
5256     * @param w Pointer to store width, or NULL.
5257     * @param h Pointer to store height, or NULL.
5258     *
5259     * This is the real size of the image, not the size of the object.
5260     *
5261     * On error, neither w or h will be written.
5262     *
5263     * @ingroup Image
5264     */
5265    EAPI void             elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5266    /**
5267     * Disable scaling of this object.
5268     *
5269     * @param obj The image object.
5270     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5271     * otherwise. Default is @c EINA_FALSE.
5272     *
5273     * This function disables scaling of the elm_image widget through the
5274     * function elm_object_scale_set(). However, this does not affect the widget
5275     * size/resize in any way. For that effect, take a look at
5276     * elm_image_scale_set().
5277     *
5278     * @see elm_image_no_scale_get()
5279     * @see elm_image_scale_set()
5280     * @see elm_object_scale_set()
5281     *
5282     * @ingroup Image
5283     */
5284    EAPI void             elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5285    /**
5286     * Get whether scaling is disabled on the object.
5287     *
5288     * @param obj The image object
5289     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5290     *
5291     * @see elm_image_no_scale_set()
5292     *
5293     * @ingroup Image
5294     */
5295    EAPI Eina_Bool        elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5296    /**
5297     * Set if the object is (up/down) resizable.
5298     *
5299     * @param obj The image object
5300     * @param scale_up A bool to set if the object is resizable up. Default is
5301     * @c EINA_TRUE.
5302     * @param scale_down A bool to set if the object is resizable down. Default
5303     * is @c EINA_TRUE.
5304     *
5305     * This function limits the image resize ability. If @p scale_up is set to
5306     * @c EINA_FALSE, the object can't have its height or width resized to a value
5307     * higher than the original image size. Same is valid for @p scale_down.
5308     *
5309     * @see elm_image_scale_get()
5310     *
5311     * @ingroup Image
5312     */
5313    EAPI void             elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5314    /**
5315     * Get if the object is (up/down) resizable.
5316     *
5317     * @param obj The image object
5318     * @param scale_up A bool to set if the object is resizable up
5319     * @param scale_down A bool to set if the object is resizable down
5320     *
5321     * @see elm_image_scale_set()
5322     *
5323     * @ingroup Image
5324     */
5325    EAPI void             elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5326    /**
5327     * Set if the image fill the entire object area when keeping the aspect ratio.
5328     *
5329     * @param obj The image object
5330     * @param fill_outside @c EINA_TRUE if the object is filled outside,
5331     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5332     *
5333     * When the image should keep its aspect ratio even if resized to another
5334     * aspect ratio, there are two possibilities to resize it: keep the entire
5335     * image inside the limits of height and width of the object (@p fill_outside
5336     * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5337     * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5338     *
5339     * @note This option will have no effect if
5340     * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5341     *
5342     * @see elm_image_fill_outside_get()
5343     * @see elm_image_aspect_ratio_retained_set()
5344     *
5345     * @ingroup Image
5346     */
5347    EAPI void             elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5348    /**
5349     * Get if the object is filled outside
5350     *
5351     * @param obj The image object
5352     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5353     *
5354     * @see elm_image_fill_outside_set()
5355     *
5356     * @ingroup Image
5357     */
5358    EAPI Eina_Bool        elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5359    /**
5360     * Set the prescale size for the image
5361     *
5362     * @param obj The image object
5363     * @param size The prescale size. This value is used for both width and
5364     * height.
5365     *
5366     * This function sets a new size for pixmap representation of the given
5367     * image. It allows the image to be loaded already in the specified size,
5368     * reducing the memory usage and load time when loading a big image with load
5369     * size set to a smaller size.
5370     *
5371     * It's equivalent to the elm_bg_load_size_set() function for bg.
5372     *
5373     * @note this is just a hint, the real size of the pixmap may differ
5374     * depending on the type of image being loaded, being bigger than requested.
5375     *
5376     * @see elm_image_prescale_get()
5377     * @see elm_bg_load_size_set()
5378     *
5379     * @ingroup Image
5380     */
5381    EAPI void             elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5382    /**
5383     * Get the prescale size for the image
5384     *
5385     * @param obj The image object
5386     * @return The prescale size
5387     *
5388     * @see elm_image_prescale_set()
5389     *
5390     * @ingroup Image
5391     */
5392    EAPI int              elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5393    /**
5394     * Set the image orientation.
5395     *
5396     * @param obj The image object
5397     * @param orient The image orientation
5398     * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5399     *  #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5400     *  #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5401     *  #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
5402     *  Default is #ELM_IMAGE_ORIENT_NONE.
5403     *
5404     * This function allows to rotate or flip the given image.
5405     *
5406     * @see elm_image_orient_get()
5407     * @see @ref Elm_Image_Orient
5408     *
5409     * @ingroup Image
5410     */
5411    EAPI void             elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5412    /**
5413     * Get the image orientation.
5414     *
5415     * @param obj The image object
5416     * @return The image orientation
5417     * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5418     *  #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5419     *  #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5420     *  #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
5421     *
5422     * @see elm_image_orient_set()
5423     * @see @ref Elm_Image_Orient
5424     *
5425     * @ingroup Image
5426     */
5427    EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5428    /**
5429     * Make the image 'editable'.
5430     *
5431     * @param obj Image object.
5432     * @param set Turn on or off editability. Default is @c EINA_FALSE.
5433     *
5434     * This means the image is a valid drag target for drag and drop, and can be
5435     * cut or pasted too.
5436     *
5437     * @ingroup Image
5438     */
5439    EAPI void             elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5440    /**
5441     * Make the image 'editable'.
5442     *
5443     * @param obj Image object.
5444     * @return Editability.
5445     *
5446     * This means the image is a valid drag target for drag and drop, and can be
5447     * cut or pasted too.
5448     *
5449     * @ingroup Image
5450     */
5451    EAPI Eina_Bool        elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5452    /**
5453     * Get the basic Evas_Image object from this object (widget).
5454     *
5455     * @param obj The image object to get the inlined image from
5456     * @return The inlined image object, or NULL if none exists
5457     *
5458     * This function allows one to get the underlying @c Evas_Object of type
5459     * Image from this elementary widget. It can be useful to do things like get
5460     * the pixel data, save the image to a file, etc.
5461     *
5462     * @note Be careful to not manipulate it, as it is under control of
5463     * elementary.
5464     *
5465     * @ingroup Image
5466     */
5467    EAPI Evas_Object     *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5468    /**
5469     * Set whether the original aspect ratio of the image should be kept on resize.
5470     *
5471     * @param obj The image object.
5472     * @param retained @c EINA_TRUE if the image should retain the aspect,
5473     * @c EINA_FALSE otherwise.
5474     *
5475     * The original aspect ratio (width / height) of the image is usually
5476     * distorted to match the object's size. Enabling this option will retain
5477     * this original aspect, and the way that the image is fit into the object's
5478     * area depends on the option set by elm_image_fill_outside_set().
5479     *
5480     * @see elm_image_aspect_ratio_retained_get()
5481     * @see elm_image_fill_outside_set()
5482     *
5483     * @ingroup Image
5484     */
5485    EAPI void             elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5486    /**
5487     * Get if the object retains the original aspect ratio.
5488     *
5489     * @param obj The image object.
5490     * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5491     * otherwise.
5492     *
5493     * @ingroup Image
5494     */
5495    EAPI Eina_Bool        elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5496
5497    /**
5498     * @}
5499     */
5500
5501    /* glview */
5502    typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5503
5504    typedef enum _Elm_GLView_Mode
5505      {
5506         ELM_GLVIEW_ALPHA   = 1,
5507         ELM_GLVIEW_DEPTH   = 2,
5508         ELM_GLVIEW_STENCIL = 4
5509      } Elm_GLView_Mode;
5510
5511    /**
5512     * Defines a policy for the glview resizing.
5513     *
5514     * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5515     */
5516    typedef enum _Elm_GLView_Resize_Policy
5517      {
5518         ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1,      /**< Resize the internal surface along with the image */
5519         ELM_GLVIEW_RESIZE_POLICY_SCALE    = 2       /**< Only reize the internal image and not the surface */
5520      } Elm_GLView_Resize_Policy;
5521
5522    typedef enum _Elm_GLView_Render_Policy
5523      {
5524         ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1,     /**< Render only when there is a need for redrawing */
5525         ELM_GLVIEW_RENDER_POLICY_ALWAYS    = 2      /**< Render always even when it is not visible */
5526      } Elm_GLView_Render_Policy;
5527
5528    /**
5529     * @defgroup GLView
5530     *
5531     * A simple GLView widget that allows GL rendering.
5532     *
5533     * Signals that you can add callbacks for are:
5534     *
5535     * @{
5536     */
5537
5538    /**
5539     * Add a new glview to the parent
5540     *
5541     * @param parent The parent object
5542     * @return The new object or NULL if it cannot be created
5543     *
5544     * @ingroup GLView
5545     */
5546    EAPI Evas_Object     *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5547
5548    /**
5549     * Sets the size of the glview
5550     *
5551     * @param obj The glview object
5552     * @param width width of the glview object
5553     * @param height height of the glview object
5554     *
5555     * @ingroup GLView
5556     */
5557    EAPI void             elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5558
5559    /**
5560     * Gets the size of the glview.
5561     *
5562     * @param obj The glview object
5563     * @param width width of the glview object
5564     * @param height height of the glview object
5565     *
5566     * Note that this function returns the actual image size of the
5567     * glview.  This means that when the scale policy is set to
5568     * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5569     * size.
5570     *
5571     * @ingroup GLView
5572     */
5573    EAPI void             elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5574
5575    /**
5576     * Gets the gl api struct for gl rendering
5577     *
5578     * @param obj The glview object
5579     * @return The api object or NULL if it cannot be created
5580     *
5581     * @ingroup GLView
5582     */
5583    EAPI Evas_GL_API     *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5584
5585    /**
5586     * Set the mode of the GLView. Supports Three simple modes.
5587     *
5588     * @param obj The glview object
5589     * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5590     * @return True if set properly.
5591     *
5592     * @ingroup GLView
5593     */
5594    EAPI Eina_Bool        elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5595
5596    /**
5597     * Set the resize policy for the glview object.
5598     *
5599     * @param obj The glview object.
5600     * @param policy The scaling policy.
5601     *
5602     * By default, the resize policy is set to
5603     * ELM_GLVIEW_RESIZE_POLICY_RECREATE.  When resize is called it
5604     * destroys the previous surface and recreates the newly specified
5605     * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5606     * however, glview only scales the image object and not the underlying
5607     * GL Surface.
5608     *
5609     * @ingroup GLView
5610     */
5611    EAPI Eina_Bool        elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5612
5613    /**
5614     * Set the render policy for the glview object.
5615     *
5616     * @param obj The glview object.
5617     * @param policy The render policy.
5618     *
5619     * By default, the render policy is set to
5620     * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND.  This policy is set such
5621     * that during the render loop, glview is only redrawn if it needs
5622     * to be redrawn. (i.e. When it is visible) If the policy is set to
5623     * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5624     * whether it is visible/need redrawing or not.
5625     *
5626     * @ingroup GLView
5627     */
5628    EAPI Eina_Bool        elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5629
5630    /**
5631     * Set the init function that runs once in the main loop.
5632     *
5633     * @param obj The glview object.
5634     * @param func The init function to be registered.
5635     *
5636     * The registered init function gets called once during the render loop.
5637     *
5638     * @ingroup GLView
5639     */
5640    EAPI void             elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5641
5642    /**
5643     * Set the render function that runs in the main loop.
5644     *
5645     * @param obj The glview object.
5646     * @param func The delete function to be registered.
5647     *
5648     * The registered del function gets called when GLView object is deleted.
5649     *
5650     * @ingroup GLView
5651     */
5652    EAPI void             elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5653
5654    /**
5655     * Set the resize function that gets called when resize happens.
5656     *
5657     * @param obj The glview object.
5658     * @param func The resize function to be registered.
5659     *
5660     * @ingroup GLView
5661     */
5662    EAPI void             elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5663
5664    /**
5665     * Set the render function that runs in the main loop.
5666     *
5667     * @param obj The glview object.
5668     * @param func The render function to be registered.
5669     *
5670     * @ingroup GLView
5671     */
5672    EAPI void             elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5673
5674    /**
5675     * Notifies that there has been changes in the GLView.
5676     *
5677     * @param obj The glview object.
5678     *
5679     * @ingroup GLView
5680     */
5681    EAPI void             elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5682
5683    /**
5684     * @}
5685     */
5686
5687    /* box */
5688    /**
5689     * @defgroup Box Box
5690     *
5691     * @image html img/widget/box/preview-00.png
5692     * @image latex img/widget/box/preview-00.eps width=\textwidth
5693     *
5694     * @image html img/box.png
5695     * @image latex img/box.eps width=\textwidth
5696     *
5697     * A box arranges objects in a linear fashion, governed by a layout function
5698     * that defines the details of this arrangement.
5699     *
5700     * By default, the box will use an internal function to set the layout to
5701     * a single row, either vertical or horizontal. This layout is affected
5702     * by a number of parameters, such as the homogeneous flag set by
5703     * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5704     * elm_box_align_set() and the hints set to each object in the box.
5705     *
5706     * For this default layout, it's possible to change the orientation with
5707     * elm_box_horizontal_set(). The box will start in the vertical orientation,
5708     * placing its elements ordered from top to bottom. When horizontal is set,
5709     * the order will go from left to right. If the box is set to be
5710     * homogeneous, every object in it will be assigned the same space, that
5711     * of the largest object. Padding can be used to set some spacing between
5712     * the cell given to each object. The alignment of the box, set with
5713     * elm_box_align_set(), determines how the bounding box of all the elements
5714     * will be placed within the space given to the box widget itself.
5715     *
5716     * The size hints of each object also affect how they are placed and sized
5717     * within the box. evas_object_size_hint_min_set() will give the minimum
5718     * size the object can have, and the box will use it as the basis for all
5719     * latter calculations. Elementary widgets set their own minimum size as
5720     * needed, so there's rarely any need to use it manually.
5721     *
5722     * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5723     * used to tell whether the object will be allocated the minimum size it
5724     * needs or if the space given to it should be expanded. It's important
5725     * to realize that expanding the size given to the object is not the same
5726     * thing as resizing the object. It could very well end being a small
5727     * widget floating in a much larger empty space. If not set, the weight
5728     * for objects will normally be 0.0 for both axis, meaning the widget will
5729     * not be expanded. To take as much space possible, set the weight to
5730     * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5731     *
5732     * Besides how much space each object is allocated, it's possible to control
5733     * how the widget will be placed within that space using
5734     * evas_object_size_hint_align_set(). By default, this value will be 0.5
5735     * for both axis, meaning the object will be centered, but any value from
5736     * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5737     * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5738     * is -1.0, means the object will be resized to fill the entire space it
5739     * was allocated.
5740     *
5741     * In addition, customized functions to define the layout can be set, which
5742     * allow the application developer to organize the objects within the box
5743     * in any number of ways.
5744     *
5745     * The special elm_box_layout_transition() function can be used
5746     * to switch from one layout to another, animating the motion of the
5747     * children of the box.
5748     *
5749     * @note Objects should not be added to box objects using _add() calls.
5750     *
5751     * Some examples on how to use boxes follow:
5752     * @li @ref box_example_01
5753     * @li @ref box_example_02
5754     *
5755     * @{
5756     */
5757    /**
5758     * @typedef Elm_Box_Transition
5759     *
5760     * Opaque handler containing the parameters to perform an animated
5761     * transition of the layout the box uses.
5762     *
5763     * @see elm_box_transition_new()
5764     * @see elm_box_layout_set()
5765     * @see elm_box_layout_transition()
5766     */
5767    typedef struct _Elm_Box_Transition Elm_Box_Transition;
5768
5769    /**
5770     * Add a new box to the parent
5771     *
5772     * By default, the box will be in vertical mode and non-homogeneous.
5773     *
5774     * @param parent The parent object
5775     * @return The new object or NULL if it cannot be created
5776     */
5777    EAPI Evas_Object        *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5778    /**
5779     * Set the horizontal orientation
5780     *
5781     * By default, box object arranges their contents vertically from top to
5782     * bottom.
5783     * By calling this function with @p horizontal as EINA_TRUE, the box will
5784     * become horizontal, arranging contents from left to right.
5785     *
5786     * @note This flag is ignored if a custom layout function is set.
5787     *
5788     * @param obj The box object
5789     * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5790     * EINA_FALSE = vertical)
5791     */
5792    EAPI void                elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5793    /**
5794     * Get the horizontal orientation
5795     *
5796     * @param obj The box object
5797     * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5798     */
5799    EAPI Eina_Bool           elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5800    /**
5801     * Set the box to arrange its children homogeneously
5802     *
5803     * If enabled, homogeneous layout makes all items the same size, according
5804     * to the size of the largest of its children.
5805     *
5806     * @note This flag is ignored if a custom layout function is set.
5807     *
5808     * @param obj The box object
5809     * @param homogeneous The homogeneous flag
5810     */
5811    EAPI void                elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5812    /**
5813     * Get whether the box is using homogeneous mode or not
5814     *
5815     * @param obj The box object
5816     * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5817     */
5818    EAPI Eina_Bool           elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5819    EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5820    EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5821    /**
5822     * Add an object to the beginning of the pack list
5823     *
5824     * Pack @p subobj into the box @p obj, placing it first in the list of
5825     * children objects. The actual position the object will get on screen
5826     * depends on the layout used. If no custom layout is set, it will be at
5827     * the top or left, depending if the box is vertical or horizontal,
5828     * respectively.
5829     *
5830     * @param obj The box object
5831     * @param subobj The object to add to the box
5832     *
5833     * @see elm_box_pack_end()
5834     * @see elm_box_pack_before()
5835     * @see elm_box_pack_after()
5836     * @see elm_box_unpack()
5837     * @see elm_box_unpack_all()
5838     * @see elm_box_clear()
5839     */
5840    EAPI void                elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5841    /**
5842     * Add an object at the end of the pack list
5843     *
5844     * Pack @p subobj into the box @p obj, placing it last in the list of
5845     * children objects. The actual position the object will get on screen
5846     * depends on the layout used. If no custom layout is set, it will be at
5847     * the bottom or right, depending if the box is vertical or horizontal,
5848     * respectively.
5849     *
5850     * @param obj The box object
5851     * @param subobj The object to add to the box
5852     *
5853     * @see elm_box_pack_start()
5854     * @see elm_box_pack_before()
5855     * @see elm_box_pack_after()
5856     * @see elm_box_unpack()
5857     * @see elm_box_unpack_all()
5858     * @see elm_box_clear()
5859     */
5860    EAPI void                elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5861    /**
5862     * Adds an object to the box before the indicated object
5863     *
5864     * This will add the @p subobj to the box indicated before the object
5865     * indicated with @p before. If @p before is not already in the box, results
5866     * are undefined. Before means either to the left of the indicated object or
5867     * above it depending on orientation.
5868     *
5869     * @param obj The box object
5870     * @param subobj The object to add to the box
5871     * @param before The object before which to add it
5872     *
5873     * @see elm_box_pack_start()
5874     * @see elm_box_pack_end()
5875     * @see elm_box_pack_after()
5876     * @see elm_box_unpack()
5877     * @see elm_box_unpack_all()
5878     * @see elm_box_clear()
5879     */
5880    EAPI void                elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5881    /**
5882     * Adds an object to the box after the indicated object
5883     *
5884     * This will add the @p subobj to the box indicated after the object
5885     * indicated with @p after. If @p after is not already in the box, results
5886     * are undefined. After means either to the right of the indicated object or
5887     * below it depending on orientation.
5888     *
5889     * @param obj The box object
5890     * @param subobj The object to add to the box
5891     * @param after The object after which to add it
5892     *
5893     * @see elm_box_pack_start()
5894     * @see elm_box_pack_end()
5895     * @see elm_box_pack_before()
5896     * @see elm_box_unpack()
5897     * @see elm_box_unpack_all()
5898     * @see elm_box_clear()
5899     */
5900    EAPI void                elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5901    /**
5902     * Clear the box of all children
5903     *
5904     * Remove all the elements contained by the box, deleting the respective
5905     * objects.
5906     *
5907     * @param obj The box object
5908     *
5909     * @see elm_box_unpack()
5910     * @see elm_box_unpack_all()
5911     */
5912    EAPI void                elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5913    /**
5914     * Unpack a box item
5915     *
5916     * Remove the object given by @p subobj from the box @p obj without
5917     * deleting it.
5918     *
5919     * @param obj The box object
5920     *
5921     * @see elm_box_unpack_all()
5922     * @see elm_box_clear()
5923     */
5924    EAPI void                elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5925    /**
5926     * Remove all items from the box, without deleting them
5927     *
5928     * Clear the box from all children, but don't delete the respective objects.
5929     * If no other references of the box children exist, the objects will never
5930     * be deleted, and thus the application will leak the memory. Make sure
5931     * when using this function that you hold a reference to all the objects
5932     * in the box @p obj.
5933     *
5934     * @param obj The box object
5935     *
5936     * @see elm_box_clear()
5937     * @see elm_box_unpack()
5938     */
5939    EAPI void                elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5940    /**
5941     * Retrieve a list of the objects packed into the box
5942     *
5943     * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5944     * The order of the list corresponds to the packing order the box uses.
5945     *
5946     * You must free this list with eina_list_free() once you are done with it.
5947     *
5948     * @param obj The box object
5949     */
5950    EAPI const Eina_List    *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5951    /**
5952     * Set the space (padding) between the box's elements.
5953     *
5954     * Extra space in pixels that will be added between a box child and its
5955     * neighbors after its containing cell has been calculated. This padding
5956     * is set for all elements in the box, besides any possible padding that
5957     * individual elements may have through their size hints.
5958     *
5959     * @param obj The box object
5960     * @param horizontal The horizontal space between elements
5961     * @param vertical The vertical space between elements
5962     */
5963    EAPI void                elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5964    /**
5965     * Get the space (padding) between the box's elements.
5966     *
5967     * @param obj The box object
5968     * @param horizontal The horizontal space between elements
5969     * @param vertical The vertical space between elements
5970     *
5971     * @see elm_box_padding_set()
5972     */
5973    EAPI void                elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5974    /**
5975     * Set the alignment of the whole bouding box of contents.
5976     *
5977     * Sets how the bounding box containing all the elements of the box, after
5978     * their sizes and position has been calculated, will be aligned within
5979     * the space given for the whole box widget.
5980     *
5981     * @param obj The box object
5982     * @param horizontal The horizontal alignment of elements
5983     * @param vertical The vertical alignment of elements
5984     */
5985    EAPI void                elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
5986    /**
5987     * Get the alignment of the whole bouding box of contents.
5988     *
5989     * @param obj The box object
5990     * @param horizontal The horizontal alignment of elements
5991     * @param vertical The vertical alignment of elements
5992     *
5993     * @see elm_box_align_set()
5994     */
5995    EAPI void                elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
5996
5997    /**
5998     * Force the box to recalculate its children packing.
5999     *
6000     * If any children was added or removed, box will not calculate the
6001     * values immediately rather leaving it to the next main loop
6002     * iteration. While this is great as it would save lots of
6003     * recalculation, whenever you need to get the position of a just
6004     * added item you must force recalculate before doing so.
6005     *
6006     * @param obj The box object.
6007     */
6008    EAPI void                 elm_box_recalculate(Evas_Object *obj);
6009
6010    /**
6011     * Set the layout defining function to be used by the box
6012     *
6013     * Whenever anything changes that requires the box in @p obj to recalculate
6014     * the size and position of its elements, the function @p cb will be called
6015     * to determine what the layout of the children will be.
6016     *
6017     * Once a custom function is set, everything about the children layout
6018     * is defined by it. The flags set by elm_box_horizontal_set() and
6019     * elm_box_homogeneous_set() no longer have any meaning, and the values
6020     * given by elm_box_padding_set() and elm_box_align_set() are up to this
6021     * layout function to decide if they are used and how. These last two
6022     * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
6023     * passed to @p cb. The @c Evas_Object the function receives is not the
6024     * Elementary widget, but the internal Evas Box it uses, so none of the
6025     * functions described here can be used on it.
6026     *
6027     * Any of the layout functions in @c Evas can be used here, as well as the
6028     * special elm_box_layout_transition().
6029     *
6030     * The final @p data argument received by @p cb is the same @p data passed
6031     * here, and the @p free_data function will be called to free it
6032     * whenever the box is destroyed or another layout function is set.
6033     *
6034     * Setting @p cb to NULL will revert back to the default layout function.
6035     *
6036     * @param obj The box object
6037     * @param cb The callback function used for layout
6038     * @param data Data that will be passed to layout function
6039     * @param free_data Function called to free @p data
6040     *
6041     * @see elm_box_layout_transition()
6042     */
6043    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);
6044    /**
6045     * Special layout function that animates the transition from one layout to another
6046     *
6047     * Normally, when switching the layout function for a box, this will be
6048     * reflected immediately on screen on the next render, but it's also
6049     * possible to do this through an animated transition.
6050     *
6051     * This is done by creating an ::Elm_Box_Transition and setting the box
6052     * layout to this function.
6053     *
6054     * For example:
6055     * @code
6056     * Elm_Box_Transition *t = elm_box_transition_new(1.0,
6057     *                            evas_object_box_layout_vertical, // start
6058     *                            NULL, // data for initial layout
6059     *                            NULL, // free function for initial data
6060     *                            evas_object_box_layout_horizontal, // end
6061     *                            NULL, // data for final layout
6062     *                            NULL, // free function for final data
6063     *                            anim_end, // will be called when animation ends
6064     *                            NULL); // data for anim_end function\
6065     * elm_box_layout_set(box, elm_box_layout_transition, t,
6066     *                    elm_box_transition_free);
6067     * @endcode
6068     *
6069     * @note This function can only be used with elm_box_layout_set(). Calling
6070     * it directly will not have the expected results.
6071     *
6072     * @see elm_box_transition_new
6073     * @see elm_box_transition_free
6074     * @see elm_box_layout_set
6075     */
6076    EAPI void                elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
6077    /**
6078     * Create a new ::Elm_Box_Transition to animate the switch of layouts
6079     *
6080     * If you want to animate the change from one layout to another, you need
6081     * to set the layout function of the box to elm_box_layout_transition(),
6082     * passing as user data to it an instance of ::Elm_Box_Transition with the
6083     * necessary information to perform this animation. The free function to
6084     * set for the layout is elm_box_transition_free().
6085     *
6086     * The parameters to create an ::Elm_Box_Transition sum up to how long
6087     * will it be, in seconds, a layout function to describe the initial point,
6088     * another for the final position of the children and one function to be
6089     * called when the whole animation ends. This last function is useful to
6090     * set the definitive layout for the box, usually the same as the end
6091     * layout for the animation, but could be used to start another transition.
6092     *
6093     * @param start_layout The layout function that will be used to start the animation
6094     * @param start_layout_data The data to be passed the @p start_layout function
6095     * @param start_layout_free_data Function to free @p start_layout_data
6096     * @param end_layout The layout function that will be used to end the animation
6097     * @param end_layout_free_data The data to be passed the @p end_layout function
6098     * @param end_layout_free_data Function to free @p end_layout_data
6099     * @param transition_end_cb Callback function called when animation ends
6100     * @param transition_end_data Data to be passed to @p transition_end_cb
6101     * @return An instance of ::Elm_Box_Transition
6102     *
6103     * @see elm_box_transition_new
6104     * @see elm_box_layout_transition
6105     */
6106    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);
6107    /**
6108     * Free a Elm_Box_Transition instance created with elm_box_transition_new().
6109     *
6110     * This function is mostly useful as the @c free_data parameter in
6111     * elm_box_layout_set() when elm_box_layout_transition().
6112     *
6113     * @param data The Elm_Box_Transition instance to be freed.
6114     *
6115     * @see elm_box_transition_new
6116     * @see elm_box_layout_transition
6117     */
6118    EAPI void                elm_box_transition_free(void *data);
6119    /**
6120     * @}
6121     */
6122
6123    /* button */
6124    /**
6125     * @defgroup Button Button
6126     *
6127     * @image html img/widget/button/preview-00.png
6128     * @image latex img/widget/button/preview-00.eps
6129     * @image html img/widget/button/preview-01.png
6130     * @image latex img/widget/button/preview-01.eps
6131     * @image html img/widget/button/preview-02.png
6132     * @image latex img/widget/button/preview-02.eps
6133     *
6134     * This is a push-button. Press it and run some function. It can contain
6135     * a simple label and icon object and it also has an autorepeat feature.
6136     *
6137     * This widgets emits the following signals:
6138     * @li "clicked": the user clicked the button (press/release).
6139     * @li "repeated": the user pressed the button without releasing it.
6140     * @li "pressed": button was pressed.
6141     * @li "unpressed": button was released after being pressed.
6142     * In all three cases, the @c event parameter of the callback will be
6143     * @c NULL.
6144     *
6145     * Also, defined in the default theme, the button has the following styles
6146     * available:
6147     * @li default: a normal button.
6148     * @li anchor: Like default, but the button fades away when the mouse is not
6149     * over it, leaving only the text or icon.
6150     * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6151     * continuous look across its options.
6152     * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6153     *
6154     * Follow through a complete example @ref button_example_01 "here".
6155     * @{
6156     */
6157    /**
6158     * Add a new button to the parent's canvas
6159     *
6160     * @param parent The parent object
6161     * @return The new object or NULL if it cannot be created
6162     */
6163    EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6164    /**
6165     * Set the label used in the button
6166     *
6167     * The passed @p label can be NULL to clean any existing text in it and
6168     * leave the button as an icon only object.
6169     *
6170     * @param obj The button object
6171     * @param label The text will be written on the button
6172     * @deprecated use elm_object_text_set() instead.
6173     */
6174    EINA_DEPRECATED EAPI void         elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6175    /**
6176     * Get the label set for the button
6177     *
6178     * The string returned is an internal pointer and should not be freed or
6179     * altered. It will also become invalid when the button is destroyed.
6180     * The string returned, if not NULL, is a stringshare, so if you need to
6181     * keep it around even after the button is destroyed, you can use
6182     * eina_stringshare_ref().
6183     *
6184     * @param obj The button object
6185     * @return The text set to the label, or NULL if nothing is set
6186     * @deprecated use elm_object_text_set() instead.
6187     */
6188    EINA_DEPRECATED EAPI const char  *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6189    /**
6190     * Set the icon used for the button
6191     *
6192     * Setting a new icon will delete any other that was previously set, making
6193     * any reference to them invalid. If you need to maintain the previous
6194     * object alive, unset it first with elm_button_icon_unset().
6195     *
6196     * @param obj The button object
6197     * @param icon The icon object for the button
6198     */
6199    EAPI void         elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6200    /**
6201     * Get the icon used for the button
6202     *
6203     * Return the icon object which is set for this widget. If the button is
6204     * destroyed or another icon is set, the returned object will be deleted
6205     * and any reference to it will be invalid.
6206     *
6207     * @param obj The button object
6208     * @return The icon object that is being used
6209     *
6210     * @see elm_button_icon_unset()
6211     */
6212    EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6213    /**
6214     * Remove the icon set without deleting it and return the object
6215     *
6216     * This function drops the reference the button holds of the icon object
6217     * and returns this last object. It is used in case you want to remove any
6218     * icon, or set another one, without deleting the actual object. The button
6219     * will be left without an icon set.
6220     *
6221     * @param obj The button object
6222     * @return The icon object that was being used
6223     */
6224    EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6225    /**
6226     * Turn on/off the autorepeat event generated when the button is kept pressed
6227     *
6228     * When off, no autorepeat is performed and buttons emit a normal @c clicked
6229     * signal when they are clicked.
6230     *
6231     * When on, keeping a button pressed will continuously emit a @c repeated
6232     * signal until the button is released. The time it takes until it starts
6233     * emitting the signal is given by
6234     * elm_button_autorepeat_initial_timeout_set(), and the time between each
6235     * new emission by elm_button_autorepeat_gap_timeout_set().
6236     *
6237     * @param obj The button object
6238     * @param on  A bool to turn on/off the event
6239     */
6240    EAPI void         elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6241    /**
6242     * Get whether the autorepeat feature is enabled
6243     *
6244     * @param obj The button object
6245     * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6246     *
6247     * @see elm_button_autorepeat_set()
6248     */
6249    EAPI Eina_Bool    elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6250    /**
6251     * Set the initial timeout before the autorepeat event is generated
6252     *
6253     * Sets the timeout, in seconds, since the button is pressed until the
6254     * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6255     * won't be any delay and the even will be fired the moment the button is
6256     * pressed.
6257     *
6258     * @param obj The button object
6259     * @param t   Timeout in seconds
6260     *
6261     * @see elm_button_autorepeat_set()
6262     * @see elm_button_autorepeat_gap_timeout_set()
6263     */
6264    EAPI void         elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6265    /**
6266     * Get the initial timeout before the autorepeat event is generated
6267     *
6268     * @param obj The button object
6269     * @return Timeout in seconds
6270     *
6271     * @see elm_button_autorepeat_initial_timeout_set()
6272     */
6273    EAPI double       elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6274    /**
6275     * Set the interval between each generated autorepeat event
6276     *
6277     * After the first @c repeated event is fired, all subsequent ones will
6278     * follow after a delay of @p t seconds for each.
6279     *
6280     * @param obj The button object
6281     * @param t   Interval in seconds
6282     *
6283     * @see elm_button_autorepeat_initial_timeout_set()
6284     */
6285    EAPI void         elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6286    /**
6287     * Get the interval between each generated autorepeat event
6288     *
6289     * @param obj The button object
6290     * @return Interval in seconds
6291     */
6292    EAPI double       elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6293    /**
6294     * @}
6295     */
6296
6297    /**
6298     * @defgroup File_Selector_Button File Selector Button
6299     *
6300     * @image html img/widget/fileselector_button/preview-00.png
6301     * @image latex img/widget/fileselector_button/preview-00.eps
6302     * @image html img/widget/fileselector_button/preview-01.png
6303     * @image latex img/widget/fileselector_button/preview-01.eps
6304     * @image html img/widget/fileselector_button/preview-02.png
6305     * @image latex img/widget/fileselector_button/preview-02.eps
6306     *
6307     * This is a button that, when clicked, creates an Elementary
6308     * window (or inner window) <b> with a @ref Fileselector "file
6309     * selector widget" within</b>. When a file is chosen, the (inner)
6310     * window is closed and the button emits a signal having the
6311     * selected file as it's @c event_info.
6312     *
6313     * This widget encapsulates operations on its internal file
6314     * selector on its own API. There is less control over its file
6315     * selector than that one would have instatiating one directly.
6316     *
6317     * The following styles are available for this button:
6318     * @li @c "default"
6319     * @li @c "anchor"
6320     * @li @c "hoversel_vertical"
6321     * @li @c "hoversel_vertical_entry"
6322     *
6323     * Smart callbacks one can register to:
6324     * - @c "file,chosen" - the user has selected a path, whose string
6325     *   pointer comes as the @c event_info data (a stringshared
6326     *   string)
6327     *
6328     * Here is an example on its usage:
6329     * @li @ref fileselector_button_example
6330     *
6331     * @see @ref File_Selector_Entry for a similar widget.
6332     * @{
6333     */
6334
6335    /**
6336     * Add a new file selector button widget to the given parent
6337     * Elementary (container) object
6338     *
6339     * @param parent The parent object
6340     * @return a new file selector button widget handle or @c NULL, on
6341     * errors
6342     */
6343    EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6344
6345    /**
6346     * Set the label for a given file selector button widget
6347     *
6348     * @param obj The file selector button widget
6349     * @param label The text label to be displayed on @p obj
6350     *
6351     * @deprecated use elm_object_text_set() instead.
6352     */
6353    EINA_DEPRECATED EAPI void         elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6354
6355    /**
6356     * Get the label set for a given file selector button widget
6357     *
6358     * @param obj The file selector button widget
6359     * @return The button label
6360     *
6361     * @deprecated use elm_object_text_set() instead.
6362     */
6363    EINA_DEPRECATED EAPI const char  *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6364
6365    /**
6366     * Set the icon on a given file selector button widget
6367     *
6368     * @param obj The file selector button widget
6369     * @param icon The icon object for the button
6370     *
6371     * Once the icon object is set, a previously set one will be
6372     * deleted. If you want to keep the latter, use the
6373     * elm_fileselector_button_icon_unset() function.
6374     *
6375     * @see elm_fileselector_button_icon_get()
6376     */
6377    EAPI void         elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6378
6379    /**
6380     * Get the icon set for a given file selector button widget
6381     *
6382     * @param obj The file selector button widget
6383     * @return The icon object currently set on @p obj or @c NULL, if
6384     * none is
6385     *
6386     * @see elm_fileselector_button_icon_set()
6387     */
6388    EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6389
6390    /**
6391     * Unset the icon used in a given file selector button widget
6392     *
6393     * @param obj The file selector button widget
6394     * @return The icon object that was being used on @p obj or @c
6395     * NULL, on errors
6396     *
6397     * Unparent and return the icon object which was set for this
6398     * widget.
6399     *
6400     * @see elm_fileselector_button_icon_set()
6401     */
6402    EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6403
6404    /**
6405     * Set the title for a given file selector button widget's window
6406     *
6407     * @param obj The file selector button widget
6408     * @param title The title string
6409     *
6410     * This will change the window's title, when the file selector pops
6411     * out after a click on the button. Those windows have the default
6412     * (unlocalized) value of @c "Select a file" as titles.
6413     *
6414     * @note It will only take any effect if the file selector
6415     * button widget is @b not under "inwin mode".
6416     *
6417     * @see elm_fileselector_button_window_title_get()
6418     */
6419    EAPI void         elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6420
6421    /**
6422     * Get the title set for a given file selector button widget's
6423     * window
6424     *
6425     * @param obj The file selector button widget
6426     * @return Title of the file selector button's window
6427     *
6428     * @see elm_fileselector_button_window_title_get() for more details
6429     */
6430    EAPI const char  *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6431
6432    /**
6433     * Set the size of a given file selector button widget's window,
6434     * holding the file selector itself.
6435     *
6436     * @param obj The file selector button widget
6437     * @param width The window's width
6438     * @param height The window's height
6439     *
6440     * @note it will only take any effect if the file selector button
6441     * widget is @b not under "inwin mode". The default size for the
6442     * window (when applicable) is 400x400 pixels.
6443     *
6444     * @see elm_fileselector_button_window_size_get()
6445     */
6446    EAPI void         elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6447
6448    /**
6449     * Get the size of a given file selector button widget's window,
6450     * holding the file selector itself.
6451     *
6452     * @param obj The file selector button widget
6453     * @param width Pointer into which to store the width value
6454     * @param height Pointer into which to store the height value
6455     *
6456     * @note Use @c NULL pointers on the size values you're not
6457     * interested in: they'll be ignored by the function.
6458     *
6459     * @see elm_fileselector_button_window_size_set(), for more details
6460     */
6461    EAPI void         elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6462
6463    /**
6464     * Set the initial file system path for a given file selector
6465     * button widget
6466     *
6467     * @param obj The file selector button widget
6468     * @param path The path string
6469     *
6470     * It must be a <b>directory</b> path, which will have the contents
6471     * displayed initially in the file selector's view, when invoked
6472     * from @p obj. The default initial path is the @c "HOME"
6473     * environment variable's value.
6474     *
6475     * @see elm_fileselector_button_path_get()
6476     */
6477    EAPI void         elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6478
6479    /**
6480     * Get the initial file system path set for a given file selector
6481     * button widget
6482     *
6483     * @param obj The file selector button widget
6484     * @return path The path string
6485     *
6486     * @see elm_fileselector_button_path_set() for more details
6487     */
6488    EAPI const char  *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6489
6490    /**
6491     * Enable/disable a tree view in the given file selector button
6492     * widget's internal file selector
6493     *
6494     * @param obj The file selector button widget
6495     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6496     * disable
6497     *
6498     * This has the same effect as elm_fileselector_expandable_set(),
6499     * but now applied to a file selector button's internal file
6500     * selector.
6501     *
6502     * @note There's no way to put a file selector button's internal
6503     * file selector in "grid mode", as one may do with "pure" file
6504     * selectors.
6505     *
6506     * @see elm_fileselector_expandable_get()
6507     */
6508    EAPI void         elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6509
6510    /**
6511     * Get whether tree view is enabled for the given file selector
6512     * button widget's internal file selector
6513     *
6514     * @param obj The file selector button widget
6515     * @return @c EINA_TRUE if @p obj widget's internal file selector
6516     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6517     *
6518     * @see elm_fileselector_expandable_set() for more details
6519     */
6520    EAPI Eina_Bool    elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6521
6522    /**
6523     * Set whether a given file selector button widget's internal file
6524     * selector is to display folders only or the directory contents,
6525     * as well.
6526     *
6527     * @param obj The file selector button widget
6528     * @param only @c EINA_TRUE to make @p obj widget's internal file
6529     * selector only display directories, @c EINA_FALSE to make files
6530     * to be displayed in it too
6531     *
6532     * This has the same effect as elm_fileselector_folder_only_set(),
6533     * but now applied to a file selector button's internal file
6534     * selector.
6535     *
6536     * @see elm_fileselector_folder_only_get()
6537     */
6538    EAPI void         elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6539
6540    /**
6541     * Get whether a given file selector button widget's internal file
6542     * selector is displaying folders only or the directory contents,
6543     * as well.
6544     *
6545     * @param obj The file selector button widget
6546     * @return @c EINA_TRUE if @p obj widget's internal file
6547     * selector is only displaying directories, @c EINA_FALSE if files
6548     * are being displayed in it too (and on errors)
6549     *
6550     * @see elm_fileselector_button_folder_only_set() for more details
6551     */
6552    EAPI Eina_Bool    elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6553
6554    /**
6555     * Enable/disable the file name entry box where the user can type
6556     * in a name for a file, in a given file selector button widget's
6557     * internal file selector.
6558     *
6559     * @param obj The file selector button widget
6560     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6561     * file selector a "saving dialog", @c EINA_FALSE otherwise
6562     *
6563     * This has the same effect as elm_fileselector_is_save_set(),
6564     * but now applied to a file selector button's internal file
6565     * selector.
6566     *
6567     * @see elm_fileselector_is_save_get()
6568     */
6569    EAPI void         elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6570
6571    /**
6572     * Get whether the given file selector button widget's internal
6573     * file selector is in "saving dialog" mode
6574     *
6575     * @param obj The file selector button widget
6576     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6577     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6578     * errors)
6579     *
6580     * @see elm_fileselector_button_is_save_set() for more details
6581     */
6582    EAPI Eina_Bool    elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6583
6584    /**
6585     * Set whether a given file selector button widget's internal file
6586     * selector will raise an Elementary "inner window", instead of a
6587     * dedicated Elementary window. By default, it won't.
6588     *
6589     * @param obj The file selector button widget
6590     * @param value @c EINA_TRUE to make it use an inner window, @c
6591     * EINA_TRUE to make it use a dedicated window
6592     *
6593     * @see elm_win_inwin_add() for more information on inner windows
6594     * @see elm_fileselector_button_inwin_mode_get()
6595     */
6596    EAPI void         elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6597
6598    /**
6599     * Get whether a given file selector button widget's internal file
6600     * selector will raise an Elementary "inner window", instead of a
6601     * dedicated Elementary window.
6602     *
6603     * @param obj The file selector button widget
6604     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6605     * if it will use a dedicated window
6606     *
6607     * @see elm_fileselector_button_inwin_mode_set() for more details
6608     */
6609    EAPI Eina_Bool    elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6610
6611    /**
6612     * @}
6613     */
6614
6615     /**
6616     * @defgroup File_Selector_Entry File Selector Entry
6617     *
6618     * @image html img/widget/fileselector_entry/preview-00.png
6619     * @image latex img/widget/fileselector_entry/preview-00.eps
6620     *
6621     * This is an entry made to be filled with or display a <b>file
6622     * system path string</b>. Besides the entry itself, the widget has
6623     * a @ref File_Selector_Button "file selector button" on its side,
6624     * which will raise an internal @ref Fileselector "file selector widget",
6625     * when clicked, for path selection aided by file system
6626     * navigation.
6627     *
6628     * This file selector may appear in an Elementary window or in an
6629     * inner window. When a file is chosen from it, the (inner) window
6630     * is closed and the selected file's path string is exposed both as
6631     * an smart event and as the new text on the entry.
6632     *
6633     * This widget encapsulates operations on its internal file
6634     * selector on its own API. There is less control over its file
6635     * selector than that one would have instatiating one directly.
6636     *
6637     * Smart callbacks one can register to:
6638     * - @c "changed" - The text within the entry was changed
6639     * - @c "activated" - The entry has had editing finished and
6640     *   changes are to be "committed"
6641     * - @c "press" - The entry has been clicked
6642     * - @c "longpressed" - The entry has been clicked (and held) for a
6643     *   couple seconds
6644     * - @c "clicked" - The entry has been clicked
6645     * - @c "clicked,double" - The entry has been double clicked
6646     * - @c "focused" - The entry has received focus
6647     * - @c "unfocused" - The entry has lost focus
6648     * - @c "selection,paste" - A paste action has occurred on the
6649     *   entry
6650     * - @c "selection,copy" - A copy action has occurred on the entry
6651     * - @c "selection,cut" - A cut action has occurred on the entry
6652     * - @c "unpressed" - The file selector entry's button was released
6653     *   after being pressed.
6654     * - @c "file,chosen" - The user has selected a path via the file
6655     *   selector entry's internal file selector, whose string pointer
6656     *   comes as the @c event_info data (a stringshared string)
6657     *
6658     * Here is an example on its usage:
6659     * @li @ref fileselector_entry_example
6660     *
6661     * @see @ref File_Selector_Button for a similar widget.
6662     * @{
6663     */
6664
6665    /**
6666     * Add a new file selector entry widget to the given parent
6667     * Elementary (container) object
6668     *
6669     * @param parent The parent object
6670     * @return a new file selector entry widget handle or @c NULL, on
6671     * errors
6672     */
6673    EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6674
6675    /**
6676     * Set the label for a given file selector entry widget's button
6677     *
6678     * @param obj The file selector entry widget
6679     * @param label The text label to be displayed on @p obj widget's
6680     * button
6681     *
6682     * @deprecated use elm_object_text_set() instead.
6683     */
6684    EINA_DEPRECATED EAPI void         elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6685
6686    /**
6687     * Get the label set for a given file selector entry widget's button
6688     *
6689     * @param obj The file selector entry widget
6690     * @return The widget button's label
6691     *
6692     * @deprecated use elm_object_text_set() instead.
6693     */
6694    EINA_DEPRECATED EAPI const char  *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6695
6696    /**
6697     * Set the icon on a given file selector entry widget's button
6698     *
6699     * @param obj The file selector entry widget
6700     * @param icon The icon object for the entry's button
6701     *
6702     * Once the icon object is set, a previously set one will be
6703     * deleted. If you want to keep the latter, use the
6704     * elm_fileselector_entry_button_icon_unset() function.
6705     *
6706     * @see elm_fileselector_entry_button_icon_get()
6707     */
6708    EAPI void         elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6709
6710    /**
6711     * Get the icon set for a given file selector entry widget's button
6712     *
6713     * @param obj The file selector entry widget
6714     * @return The icon object currently set on @p obj widget's button
6715     * or @c NULL, if none is
6716     *
6717     * @see elm_fileselector_entry_button_icon_set()
6718     */
6719    EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6720
6721    /**
6722     * Unset the icon used in a given file selector entry widget's
6723     * button
6724     *
6725     * @param obj The file selector entry widget
6726     * @return The icon object that was being used on @p obj widget's
6727     * button or @c NULL, on errors
6728     *
6729     * Unparent and return the icon object which was set for this
6730     * widget's button.
6731     *
6732     * @see elm_fileselector_entry_button_icon_set()
6733     */
6734    EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6735
6736    /**
6737     * Set the title for a given file selector entry widget's window
6738     *
6739     * @param obj The file selector entry widget
6740     * @param title The title string
6741     *
6742     * This will change the window's title, when the file selector pops
6743     * out after a click on the entry's button. Those windows have the
6744     * default (unlocalized) value of @c "Select a file" as titles.
6745     *
6746     * @note It will only take any effect if the file selector
6747     * entry widget is @b not under "inwin mode".
6748     *
6749     * @see elm_fileselector_entry_window_title_get()
6750     */
6751    EAPI void         elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6752
6753    /**
6754     * Get the title set for a given file selector entry widget's
6755     * window
6756     *
6757     * @param obj The file selector entry widget
6758     * @return Title of the file selector entry's window
6759     *
6760     * @see elm_fileselector_entry_window_title_get() for more details
6761     */
6762    EAPI const char  *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6763
6764    /**
6765     * Set the size of a given file selector entry widget's window,
6766     * holding the file selector itself.
6767     *
6768     * @param obj The file selector entry widget
6769     * @param width The window's width
6770     * @param height The window's height
6771     *
6772     * @note it will only take any effect if the file selector entry
6773     * widget is @b not under "inwin mode". The default size for the
6774     * window (when applicable) is 400x400 pixels.
6775     *
6776     * @see elm_fileselector_entry_window_size_get()
6777     */
6778    EAPI void         elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6779
6780    /**
6781     * Get the size of a given file selector entry widget's window,
6782     * holding the file selector itself.
6783     *
6784     * @param obj The file selector entry widget
6785     * @param width Pointer into which to store the width value
6786     * @param height Pointer into which to store the height value
6787     *
6788     * @note Use @c NULL pointers on the size values you're not
6789     * interested in: they'll be ignored by the function.
6790     *
6791     * @see elm_fileselector_entry_window_size_set(), for more details
6792     */
6793    EAPI void         elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6794
6795    /**
6796     * Set the initial file system path and the entry's path string for
6797     * a given file selector entry widget
6798     *
6799     * @param obj The file selector entry widget
6800     * @param path The path string
6801     *
6802     * It must be a <b>directory</b> path, which will have the contents
6803     * displayed initially in the file selector's view, when invoked
6804     * from @p obj. The default initial path is the @c "HOME"
6805     * environment variable's value.
6806     *
6807     * @see elm_fileselector_entry_path_get()
6808     */
6809    EAPI void         elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6810
6811    /**
6812     * Get the entry's path string for a given file selector entry
6813     * widget
6814     *
6815     * @param obj The file selector entry widget
6816     * @return path The path string
6817     *
6818     * @see elm_fileselector_entry_path_set() for more details
6819     */
6820    EAPI const char  *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6821
6822    /**
6823     * Enable/disable a tree view in the given file selector entry
6824     * widget's internal file selector
6825     *
6826     * @param obj The file selector entry widget
6827     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6828     * disable
6829     *
6830     * This has the same effect as elm_fileselector_expandable_set(),
6831     * but now applied to a file selector entry's internal file
6832     * selector.
6833     *
6834     * @note There's no way to put a file selector entry's internal
6835     * file selector in "grid mode", as one may do with "pure" file
6836     * selectors.
6837     *
6838     * @see elm_fileselector_expandable_get()
6839     */
6840    EAPI void         elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6841
6842    /**
6843     * Get whether tree view is enabled for the given file selector
6844     * entry widget's internal file selector
6845     *
6846     * @param obj The file selector entry widget
6847     * @return @c EINA_TRUE if @p obj widget's internal file selector
6848     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6849     *
6850     * @see elm_fileselector_expandable_set() for more details
6851     */
6852    EAPI Eina_Bool    elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6853
6854    /**
6855     * Set whether a given file selector entry widget's internal file
6856     * selector is to display folders only or the directory contents,
6857     * as well.
6858     *
6859     * @param obj The file selector entry widget
6860     * @param only @c EINA_TRUE to make @p obj widget's internal file
6861     * selector only display directories, @c EINA_FALSE to make files
6862     * to be displayed in it too
6863     *
6864     * This has the same effect as elm_fileselector_folder_only_set(),
6865     * but now applied to a file selector entry's internal file
6866     * selector.
6867     *
6868     * @see elm_fileselector_folder_only_get()
6869     */
6870    EAPI void         elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6871
6872    /**
6873     * Get whether a given file selector entry widget's internal file
6874     * selector is displaying folders only or the directory contents,
6875     * as well.
6876     *
6877     * @param obj The file selector entry widget
6878     * @return @c EINA_TRUE if @p obj widget's internal file
6879     * selector is only displaying directories, @c EINA_FALSE if files
6880     * are being displayed in it too (and on errors)
6881     *
6882     * @see elm_fileselector_entry_folder_only_set() for more details
6883     */
6884    EAPI Eina_Bool    elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6885
6886    /**
6887     * Enable/disable the file name entry box where the user can type
6888     * in a name for a file, in a given file selector entry widget's
6889     * internal file selector.
6890     *
6891     * @param obj The file selector entry widget
6892     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6893     * file selector a "saving dialog", @c EINA_FALSE otherwise
6894     *
6895     * This has the same effect as elm_fileselector_is_save_set(),
6896     * but now applied to a file selector entry's internal file
6897     * selector.
6898     *
6899     * @see elm_fileselector_is_save_get()
6900     */
6901    EAPI void         elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6902
6903    /**
6904     * Get whether the given file selector entry widget's internal
6905     * file selector is in "saving dialog" mode
6906     *
6907     * @param obj The file selector entry widget
6908     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6909     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6910     * errors)
6911     *
6912     * @see elm_fileselector_entry_is_save_set() for more details
6913     */
6914    EAPI Eina_Bool    elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6915
6916    /**
6917     * Set whether a given file selector entry widget's internal file
6918     * selector will raise an Elementary "inner window", instead of a
6919     * dedicated Elementary window. By default, it won't.
6920     *
6921     * @param obj The file selector entry widget
6922     * @param value @c EINA_TRUE to make it use an inner window, @c
6923     * EINA_TRUE to make it use a dedicated window
6924     *
6925     * @see elm_win_inwin_add() for more information on inner windows
6926     * @see elm_fileselector_entry_inwin_mode_get()
6927     */
6928    EAPI void         elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6929
6930    /**
6931     * Get whether a given file selector entry widget's internal file
6932     * selector will raise an Elementary "inner window", instead of a
6933     * dedicated Elementary window.
6934     *
6935     * @param obj The file selector entry widget
6936     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6937     * if it will use a dedicated window
6938     *
6939     * @see elm_fileselector_entry_inwin_mode_set() for more details
6940     */
6941    EAPI Eina_Bool    elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6942
6943    /**
6944     * Set the initial file system path for a given file selector entry
6945     * widget
6946     *
6947     * @param obj The file selector entry widget
6948     * @param path The path string
6949     *
6950     * It must be a <b>directory</b> path, which will have the contents
6951     * displayed initially in the file selector's view, when invoked
6952     * from @p obj. The default initial path is the @c "HOME"
6953     * environment variable's value.
6954     *
6955     * @see elm_fileselector_entry_path_get()
6956     */
6957    EAPI void         elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6958
6959    /**
6960     * Get the parent directory's path to the latest file selection on
6961     * a given filer selector entry widget
6962     *
6963     * @param obj The file selector object
6964     * @return The (full) path of the directory of the last selection
6965     * on @p obj widget, a @b stringshared string
6966     *
6967     * @see elm_fileselector_entry_path_set()
6968     */
6969    EAPI const char  *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6970
6971    /**
6972     * @}
6973     */
6974
6975    /**
6976     * @defgroup Scroller Scroller
6977     *
6978     * A scroller holds a single object and "scrolls it around". This means that
6979     * it allows the user to use a scrollbar (or a finger) to drag the viewable
6980     * region around, allowing to move through a much larger object that is
6981     * contained in the scroller. The scroiller will always have a small minimum
6982     * size by default as it won't be limited by the contents of the scroller.
6983     *
6984     * Signals that you can add callbacks for are:
6985     * @li "edge,left" - the left edge of the content has been reached
6986     * @li "edge,right" - the right edge of the content has been reached
6987     * @li "edge,top" - the top edge of the content has been reached
6988     * @li "edge,bottom" - the bottom edge of the content has been reached
6989     * @li "scroll" - the content has been scrolled (moved)
6990     * @li "scroll,anim,start" - scrolling animation has started
6991     * @li "scroll,anim,stop" - scrolling animation has stopped
6992     * @li "scroll,drag,start" - dragging the contents around has started
6993     * @li "scroll,drag,stop" - dragging the contents around has stopped
6994     * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
6995     * user intervetion.
6996     *
6997     * @note When Elemementary is in embedded mode the scrollbars will not be
6998     * dragable, they appear merely as indicators of how much has been scrolled.
6999     * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
7000     * fingerscroll) won't work.
7001     *
7002     * In @ref tutorial_scroller you'll find an example of how to use most of
7003     * this API.
7004     * @{
7005     */
7006    /**
7007     * @brief Type that controls when scrollbars should appear.
7008     *
7009     * @see elm_scroller_policy_set()
7010     */
7011    typedef enum _Elm_Scroller_Policy
7012      {
7013         ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
7014         ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
7015         ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
7016         ELM_SCROLLER_POLICY_LAST
7017      } Elm_Scroller_Policy;
7018    /**
7019     * @brief Add a new scroller to the parent
7020     *
7021     * @param parent The parent object
7022     * @return The new object or NULL if it cannot be created
7023     */
7024    EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7025    /**
7026     * @brief Set the content of the scroller widget (the object to be scrolled around).
7027     *
7028     * @param obj The scroller object
7029     * @param content The new content object
7030     *
7031     * Once the content object is set, a previously set one will be deleted.
7032     * If you want to keep that old content object, use the
7033     * elm_scroller_content_unset() function.
7034     */
7035    EAPI void         elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
7036    /**
7037     * @brief Get the content of the scroller widget
7038     *
7039     * @param obj The slider object
7040     * @return The content that is being used
7041     *
7042     * Return the content object which is set for this widget
7043     *
7044     * @see elm_scroller_content_set()
7045     */
7046    EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7047    /**
7048     * @brief Unset the content of the scroller widget
7049     *
7050     * @param obj The slider object
7051     * @return The content that was being used
7052     *
7053     * Unparent and return the content object which was set for this widget
7054     *
7055     * @see elm_scroller_content_set()
7056     */
7057    EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7058    /**
7059     * @brief Set custom theme elements for the scroller
7060     *
7061     * @param obj The scroller object
7062     * @param widget The widget name to use (default is "scroller")
7063     * @param base The base name to use (default is "base")
7064     */
7065    EAPI void         elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
7066    /**
7067     * @brief Make the scroller minimum size limited to the minimum size of the content
7068     *
7069     * @param obj The scroller object
7070     * @param w Enable limiting minimum size horizontally
7071     * @param h Enable limiting minimum size vertically
7072     *
7073     * By default the scroller will be as small as its design allows,
7074     * irrespective of its content. This will make the scroller minimum size the
7075     * right size horizontally and/or vertically to perfectly fit its content in
7076     * that direction.
7077     */
7078    EAPI void         elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7079    /**
7080     * @brief Show a specific virtual region within the scroller content object
7081     *
7082     * @param obj The scroller object
7083     * @param x X coordinate of the region
7084     * @param y Y coordinate of the region
7085     * @param w Width of the region
7086     * @param h Height of the region
7087     *
7088     * This will ensure all (or part if it does not fit) of the designated
7089     * region in the virtual content object (0, 0 starting at the top-left of the
7090     * virtual content object) is shown within the scroller.
7091     */
7092    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);
7093    /**
7094     * @brief Set the scrollbar visibility policy
7095     *
7096     * @param obj The scroller object
7097     * @param policy_h Horizontal scrollbar policy
7098     * @param policy_v Vertical scrollbar policy
7099     *
7100     * This sets the scrollbar visibility policy for the given scroller.
7101     * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7102     * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7103     * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7104     * respectively for the horizontal and vertical scrollbars.
7105     */
7106    EAPI void         elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7107    /**
7108     * @brief Gets scrollbar visibility policy
7109     *
7110     * @param obj The scroller object
7111     * @param policy_h Horizontal scrollbar policy
7112     * @param policy_v Vertical scrollbar policy
7113     *
7114     * @see elm_scroller_policy_set()
7115     */
7116    EAPI void         elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7117    /**
7118     * @brief Get the currently visible content region
7119     *
7120     * @param obj The scroller object
7121     * @param x X coordinate of the region
7122     * @param y Y coordinate of the region
7123     * @param w Width of the region
7124     * @param h Height of the region
7125     *
7126     * This gets the current region in the content object that is visible through
7127     * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7128     * w, @p h values pointed to.
7129     *
7130     * @note All coordinates are relative to the content.
7131     *
7132     * @see elm_scroller_region_show()
7133     */
7134    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);
7135    /**
7136     * @brief Get the size of the content object
7137     *
7138     * @param obj The scroller object
7139     * @param w Width return
7140     * @param h Height return
7141     *
7142     * This gets the size of the content object of the scroller.
7143     */
7144    EAPI void         elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7145    /**
7146     * @brief Set bouncing behavior
7147     *
7148     * @param obj The scroller object
7149     * @param h_bounce Will the scroller bounce horizontally or not
7150     * @param v_bounce Will the scroller bounce vertically or not
7151     *
7152     * When scrolling, the scroller may "bounce" when reaching an edge of the
7153     * content object. This is a visual way to indicate the end has been reached.
7154     * This is enabled by default for both axis. This will set if it is enabled
7155     * for that axis with the boolean parameters for each axis.
7156     */
7157    EAPI void         elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7158    /**
7159     * @brief Get the bounce mode
7160     *
7161     * @param obj The Scroller object
7162     * @param h_bounce Allow bounce horizontally
7163     * @param v_bounce Allow bounce vertically
7164     *
7165     * @see elm_scroller_bounce_set()
7166     */
7167    EAPI void         elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7168    /**
7169     * @brief Set scroll page size relative to viewport size.
7170     *
7171     * @param obj The scroller object
7172     * @param h_pagerel The horizontal page relative size
7173     * @param v_pagerel The vertical page relative size
7174     *
7175     * The scroller is capable of limiting scrolling by the user to "pages". That
7176     * is to jump by and only show a "whole page" at a time as if the continuous
7177     * area of the scroller content is split into page sized pieces. This sets
7178     * the size of a page relative to the viewport of the scroller. 1.0 is "1
7179     * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7180     * axis. This is mutually exclusive with page size
7181     * (see elm_scroller_page_size_set()  for more information). Likewise 0.5
7182     * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
7183     * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7184     * the other axis.
7185     */
7186    EAPI void         elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7187    /**
7188     * @brief Set scroll page size.
7189     *
7190     * @param obj The scroller object
7191     * @param h_pagesize The horizontal page size
7192     * @param v_pagesize The vertical page size
7193     *
7194     * This sets the page size to an absolute fixed value, with 0 turning it off
7195     * for that axis.
7196     *
7197     * @see elm_scroller_page_relative_set()
7198     */
7199    EAPI void         elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7200    /**
7201     * @brief Get scroll current page number.
7202     *
7203     * @param obj The scroller object
7204     * @param h_pagenumber The horizontal page number
7205     * @param v_pagenumber The vertical page number
7206     *
7207     * The page number starts from 0. 0 is the first page.
7208     * Current page means the page which meet the top-left of the viewport.
7209     * If there are two or more pages in the viewport, it returns the number of page
7210     * which meet the top-left of the viewport.
7211     *
7212     * @see elm_scroller_last_page_get()
7213     * @see elm_scroller_page_show()
7214     * @see elm_scroller_page_brint_in()
7215     */
7216    EAPI void         elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7217    /**
7218     * @brief Get scroll last page number.
7219     *
7220     * @param obj The scroller object
7221     * @param h_pagenumber The horizontal page number
7222     * @param v_pagenumber The vertical page number
7223     *
7224     * The page number starts from 0. 0 is the first page.
7225     * This returns the last page number among the pages.
7226     *
7227     * @see elm_scroller_current_page_get()
7228     * @see elm_scroller_page_show()
7229     * @see elm_scroller_page_brint_in()
7230     */
7231    EAPI void         elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7232    /**
7233     * Show a specific virtual region within the scroller content object by page number.
7234     *
7235     * @param obj The scroller object
7236     * @param h_pagenumber The horizontal page number
7237     * @param v_pagenumber The vertical page number
7238     *
7239     * 0, 0 of the indicated page is located at the top-left of the viewport.
7240     * This will jump to the page directly without animation.
7241     *
7242     * Example of usage:
7243     *
7244     * @code
7245     * sc = elm_scroller_add(win);
7246     * elm_scroller_content_set(sc, content);
7247     * elm_scroller_page_relative_set(sc, 1, 0);
7248     * elm_scroller_current_page_get(sc, &h_page, &v_page);
7249     * elm_scroller_page_show(sc, h_page + 1, v_page);
7250     * @endcode
7251     *
7252     * @see elm_scroller_page_bring_in()
7253     */
7254    EAPI void         elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7255    /**
7256     * Show a specific virtual region within the scroller content object by page number.
7257     *
7258     * @param obj The scroller object
7259     * @param h_pagenumber The horizontal page number
7260     * @param v_pagenumber The vertical page number
7261     *
7262     * 0, 0 of the indicated page is located at the top-left of the viewport.
7263     * This will slide to the page with animation.
7264     *
7265     * Example of usage:
7266     *
7267     * @code
7268     * sc = elm_scroller_add(win);
7269     * elm_scroller_content_set(sc, content);
7270     * elm_scroller_page_relative_set(sc, 1, 0);
7271     * elm_scroller_last_page_get(sc, &h_page, &v_page);
7272     * elm_scroller_page_bring_in(sc, h_page, v_page);
7273     * @endcode
7274     *
7275     * @see elm_scroller_page_show()
7276     */
7277    EAPI void         elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7278    /**
7279     * @brief Show a specific virtual region within the scroller content object.
7280     *
7281     * @param obj The scroller object
7282     * @param x X coordinate of the region
7283     * @param y Y coordinate of the region
7284     * @param w Width of the region
7285     * @param h Height of the region
7286     *
7287     * This will ensure all (or part if it does not fit) of the designated
7288     * region in the virtual content object (0, 0 starting at the top-left of the
7289     * virtual content object) is shown within the scroller. Unlike
7290     * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7291     * to this location (if configuration in general calls for transitions). It
7292     * may not jump immediately to the new location and make take a while and
7293     * show other content along the way.
7294     *
7295     * @see elm_scroller_region_show()
7296     */
7297    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);
7298    /**
7299     * @brief Set event propagation on a scroller
7300     *
7301     * @param obj The scroller object
7302     * @param propagation If propagation is enabled or not
7303     *
7304     * This enables or disabled event propagation from the scroller content to
7305     * the scroller and its parent. By default event propagation is disabled.
7306     */
7307    EAPI void         elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7308    /**
7309     * @brief Get event propagation for a scroller
7310     *
7311     * @param obj The scroller object
7312     * @return The propagation state
7313     *
7314     * This gets the event propagation for a scroller.
7315     *
7316     * @see elm_scroller_propagate_events_set()
7317     */
7318    EAPI Eina_Bool    elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7319    /**
7320     * @brief Set scrolling gravity on a scroller
7321     *
7322     * @param obj The scroller object
7323     * @param x The scrolling horizontal gravity
7324     * @param y The scrolling vertical gravity
7325     *
7326     * It set scrolling gravity. It adds scrolling weight values
7327     * to the scroller. Usually it uses for stopping the scroller.
7328     * To set y as 0.0 for lower growing child objects,
7329     * even though child objects are added to bottom, the scroller doesn't move.
7330     * To set y as 1.0 for upper growing child objects. And x is horizontal gravity.
7331     * By default 0.0 for x and y.
7332     */
7333    EAPI void         elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7334    /**
7335     * @brief Get scrolling gravity values for a scroller
7336     *
7337     * @param obj The scroller object
7338     * @param x The scrolling horizontal gravity
7339     * @param y The scrolling vertical gravity
7340     *
7341     * This gets gravity values for a scroller.
7342     *
7343     * @see elm_scroller_gravity_set()
7344     *
7345     */
7346    EAPI void         elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7347    /**
7348     * @}
7349     */
7350
7351    /**
7352     * @defgroup Label Label
7353     *
7354     * @image html img/widget/label/preview-00.png
7355     * @image latex img/widget/label/preview-00.eps
7356     *
7357     * @brief Widget to display text, with simple html-like markup.
7358     *
7359     * The Label widget @b doesn't allow text to overflow its boundaries, if the
7360     * text doesn't fit the geometry of the label it will be ellipsized or be
7361     * cut. Elementary provides several themes for this widget:
7362     * @li default - No animation
7363     * @li marker - Centers the text in the label and make it bold by default
7364     * @li slide_long - The entire text appears from the right of the screen and
7365     * slides until it disappears in the left of the screen(reappering on the
7366     * right again).
7367     * @li slide_short - The text appears in the left of the label and slides to
7368     * the right to show the overflow. When all of the text has been shown the
7369     * position is reset.
7370     * @li slide_bounce - The text appears in the left of the label and slides to
7371     * the right to show the overflow. When all of the text has been shown the
7372     * animation reverses, moving the text to the left.
7373     *
7374     * Custom themes can of course invent new markup tags and style them any way
7375     * they like.
7376     *
7377     * The following signals may be emitted by the label widget:
7378     * @li "language,changed": The program's language changed.
7379     *
7380     * See @ref tutorial_label for a demonstration of how to use a label widget.
7381     * @{
7382     */
7383    /**
7384     * @brief Add a new label to the parent
7385     *
7386     * @param parent The parent object
7387     * @return The new object or NULL if it cannot be created
7388     */
7389    EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7390    /**
7391     * @brief Set the label on the label object
7392     *
7393     * @param obj The label object
7394     * @param label The label will be used on the label object
7395     * @deprecated See elm_object_text_set()
7396     */
7397    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 */
7398    /**
7399     * @brief Get the label used on the label object
7400     *
7401     * @param obj The label object
7402     * @return The string inside the label
7403     * @deprecated See elm_object_text_get()
7404     */
7405    EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7406    /**
7407     * @brief Set the wrapping behavior of the label
7408     *
7409     * @param obj The label object
7410     * @param wrap To wrap text or not
7411     *
7412     * By default no wrapping is done. Possible values for @p wrap are:
7413     * @li ELM_WRAP_NONE - No wrapping
7414     * @li ELM_WRAP_CHAR - wrap between characters
7415     * @li ELM_WRAP_WORD - wrap between words
7416     * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7417     */
7418    EAPI void         elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7419    /**
7420     * @brief Get the wrapping behavior of the label
7421     *
7422     * @param obj The label object
7423     * @return Wrap type
7424     *
7425     * @see elm_label_line_wrap_set()
7426     */
7427    EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7428    /**
7429     * @brief Set wrap width of the label
7430     *
7431     * @param obj The label object
7432     * @param w The wrap width in pixels at a minimum where words need to wrap
7433     *
7434     * This function sets the maximum width size hint of the label.
7435     *
7436     * @warning This is only relevant if the label is inside a container.
7437     */
7438    EAPI void         elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7439    /**
7440     * @brief Get wrap width of the label
7441     *
7442     * @param obj The label object
7443     * @return The wrap width in pixels at a minimum where words need to wrap
7444     *
7445     * @see elm_label_wrap_width_set()
7446     */
7447    EAPI Evas_Coord   elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7448    /**
7449     * @brief Set wrap height of the label
7450     *
7451     * @param obj The label object
7452     * @param h The wrap height in pixels at a minimum where words need to wrap
7453     *
7454     * This function sets the maximum height size hint of the label.
7455     *
7456     * @warning This is only relevant if the label is inside a container.
7457     */
7458    EAPI void         elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7459    /**
7460     * @brief get wrap width of the label
7461     *
7462     * @param obj The label object
7463     * @return The wrap height in pixels at a minimum where words need to wrap
7464     */
7465    EAPI Evas_Coord   elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7466    /**
7467     * @brief Set the font size on the label object.
7468     *
7469     * @param obj The label object
7470     * @param size font size
7471     *
7472     * @warning NEVER use this. It is for hyper-special cases only. use styles
7473     * instead. e.g. "big", "medium", "small" - or better name them by use:
7474     * "title", "footnote", "quote" etc.
7475     */
7476    EAPI void         elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7477    /**
7478     * @brief Set the text color on the label object
7479     *
7480     * @param obj The label object
7481     * @param r Red property background color of The label object
7482     * @param g Green property background color of The label object
7483     * @param b Blue property background color of The label object
7484     * @param a Alpha property background color of The label object
7485     *
7486     * @warning NEVER use this. It is for hyper-special cases only. use styles
7487     * instead. e.g. "big", "medium", "small" - or better name them by use:
7488     * "title", "footnote", "quote" etc.
7489     */
7490    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);
7491    /**
7492     * @brief Set the text align on the label object
7493     *
7494     * @param obj The label object
7495     * @param align align mode ("left", "center", "right")
7496     *
7497     * @warning NEVER use this. It is for hyper-special cases only. use styles
7498     * instead. e.g. "big", "medium", "small" - or better name them by use:
7499     * "title", "footnote", "quote" etc.
7500     */
7501    EAPI void         elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7502    /**
7503     * @brief Set background color of the label
7504     *
7505     * @param obj The label object
7506     * @param r Red property background color of The label object
7507     * @param g Green property background color of The label object
7508     * @param b Blue property background color of The label object
7509     * @param a Alpha property background alpha of The label object
7510     *
7511     * @warning NEVER use this. It is for hyper-special cases only. use styles
7512     * instead. e.g. "big", "medium", "small" - or better name them by use:
7513     * "title", "footnote", "quote" etc.
7514     */
7515    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);
7516    /**
7517     * @brief Set the ellipsis behavior of the label
7518     *
7519     * @param obj The label object
7520     * @param ellipsis To ellipsis text or not
7521     *
7522     * If set to true and the text doesn't fit in the label an ellipsis("...")
7523     * will be shown at the end of the widget.
7524     *
7525     * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7526     * choosen wrap method was ELM_WRAP_WORD.
7527     */
7528    EAPI void         elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7529    /**
7530     * @brief Set the text slide of the label
7531     *
7532     * @param obj The label object
7533     * @param slide To start slide or stop
7534     *
7535     * If set to true the text of the label will slide throught the length of
7536     * label.
7537     *
7538     * @warning This only work with the themes "slide_short", "slide_long" and
7539     * "slide_bounce".
7540     */
7541    EAPI void         elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7542    /**
7543     * @brief Get the text slide mode of the label
7544     *
7545     * @param obj The label object
7546     * @return slide slide mode value
7547     *
7548     * @see elm_label_slide_set()
7549     */
7550    EAPI Eina_Bool    elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7551    /**
7552     * @brief Set the slide duration(speed) of the label
7553     *
7554     * @param obj The label object
7555     * @return The duration in seconds in moving text from slide begin position
7556     * to slide end position
7557     */
7558    EAPI void         elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7559    /**
7560     * @brief Get the slide duration(speed) of the label
7561     *
7562     * @param obj The label object
7563     * @return The duration time in moving text from slide begin position to slide end position
7564     *
7565     * @see elm_label_slide_duration_set()
7566     */
7567    EAPI double       elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7568    /**
7569     * @}
7570     */
7571
7572    /**
7573     * @defgroup Toggle Toggle
7574     *
7575     * @image html img/widget/toggle/preview-00.png
7576     * @image latex img/widget/toggle/preview-00.eps
7577     *
7578     * @brief A toggle is a slider which can be used to toggle between
7579     * two values.  It has two states: on and off.
7580     *
7581     * This widget is deprecated. Please use elm_check_add() instead using the
7582     * toggle style like:
7583     * 
7584     * @code
7585     * obj = elm_check_add(parent);
7586     * elm_object_style_set(obj, "toggle");
7587     * elm_check_states_labels_set(obj, "ON", "OFF");
7588     * @endcode
7589     * 
7590     * Signals that you can add callbacks for are:
7591     * @li "changed" - Whenever the toggle value has been changed.  Is not called
7592     *                 until the toggle is released by the cursor (assuming it
7593     *                 has been triggered by the cursor in the first place).
7594     *
7595     * @ref tutorial_toggle show how to use a toggle.
7596     * @{
7597     */
7598    /**
7599     * @brief Add a toggle to @p parent.
7600     *
7601     * @param parent The parent object
7602     *
7603     * @return The toggle object
7604     */
7605    EINA_DEPRECATED EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7606    /**
7607     * @brief Sets the label to be displayed with the toggle.
7608     *
7609     * @param obj The toggle object
7610     * @param label The label to be displayed
7611     *
7612     * @deprecated use elm_object_text_set() instead.
7613     */
7614    EINA_DEPRECATED EAPI void         elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7615    /**
7616     * @brief Gets the label of the toggle
7617     *
7618     * @param obj  toggle object
7619     * @return The label of the toggle
7620     *
7621     * @deprecated use elm_object_text_get() instead.
7622     */
7623    EINA_DEPRECATED EAPI const char  *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7624    /**
7625     * @brief Set the icon used for the toggle
7626     *
7627     * @param obj The toggle object
7628     * @param icon The icon object for the button
7629     *
7630     * Once the icon object is set, a previously set one will be deleted
7631     * If you want to keep that old content object, use the
7632     * elm_toggle_icon_unset() function.
7633     */
7634    EINA_DEPRECATED EAPI void         elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7635    /**
7636     * @brief Get the icon used for the toggle
7637     *
7638     * @param obj The toggle object
7639     * @return The icon object that is being used
7640     *
7641     * Return the icon object which is set for this widget.
7642     *
7643     * @see elm_toggle_icon_set()
7644     */
7645    EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7646    /**
7647     * @brief Unset the icon used for the toggle
7648     *
7649     * @param obj The toggle object
7650     * @return The icon object that was being used
7651     *
7652     * Unparent and return the icon object which was set for this widget.
7653     *
7654     * @see elm_toggle_icon_set()
7655     */
7656    EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7657    /**
7658     * @brief Sets the labels to be associated with the on and off states of the toggle.
7659     *
7660     * @param obj The toggle object
7661     * @param onlabel The label displayed when the toggle is in the "on" state
7662     * @param offlabel The label displayed when the toggle is in the "off" state
7663     */
7664    EINA_DEPRECATED EAPI void         elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7665    /**
7666     * @brief Gets the labels associated with the on and off states of the toggle.
7667     *
7668     * @param obj The toggle object
7669     * @param onlabel A char** to place the onlabel of @p obj into
7670     * @param offlabel A char** to place the offlabel of @p obj into
7671     */
7672    EINA_DEPRECATED EAPI void         elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7673    /**
7674     * @brief Sets the state of the toggle to @p state.
7675     *
7676     * @param obj The toggle object
7677     * @param state The state of @p obj
7678     */
7679    EINA_DEPRECATED EAPI void         elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7680    /**
7681     * @brief Gets the state of the toggle to @p state.
7682     *
7683     * @param obj The toggle object
7684     * @return The state of @p obj
7685     */
7686    EINA_DEPRECATED EAPI Eina_Bool    elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7687    /**
7688     * @brief Sets the state pointer of the toggle to @p statep.
7689     *
7690     * @param obj The toggle object
7691     * @param statep The state pointer of @p obj
7692     */
7693    EINA_DEPRECATED EAPI void         elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7694    /**
7695     * @}
7696     */
7697
7698    /**
7699     * @defgroup Frame Frame
7700     *
7701     * @image html img/widget/frame/preview-00.png
7702     * @image latex img/widget/frame/preview-00.eps
7703     *
7704     * @brief Frame is a widget that holds some content and has a title.
7705     *
7706     * The default look is a frame with a title, but Frame supports multple
7707     * styles:
7708     * @li default
7709     * @li pad_small
7710     * @li pad_medium
7711     * @li pad_large
7712     * @li pad_huge
7713     * @li outdent_top
7714     * @li outdent_bottom
7715     *
7716     * Of all this styles only default shows the title. Frame emits no signals.
7717     *
7718     * For a detailed example see the @ref tutorial_frame.
7719     *
7720     * @{
7721     */
7722    /**
7723     * @brief Add a new frame to the parent
7724     *
7725     * @param parent The parent object
7726     * @return The new object or NULL if it cannot be created
7727     */
7728    EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7729    /**
7730     * @brief Set the frame label
7731     *
7732     * @param obj The frame object
7733     * @param label The label of this frame object
7734     *
7735     * @deprecated use elm_object_text_set() instead.
7736     */
7737    EINA_DEPRECATED EAPI void         elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7738    /**
7739     * @brief Get the frame label
7740     *
7741     * @param obj The frame object
7742     *
7743     * @return The label of this frame objet or NULL if unable to get frame
7744     *
7745     * @deprecated use elm_object_text_get() instead.
7746     */
7747    EINA_DEPRECATED EAPI const char  *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7748    /**
7749     * @brief Set the content of the frame widget
7750     *
7751     * Once the content object is set, a previously set one will be deleted.
7752     * If you want to keep that old content object, use the
7753     * elm_frame_content_unset() function.
7754     *
7755     * @param obj The frame object
7756     * @param content The content will be filled in this frame object
7757     */
7758    EAPI void         elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7759    /**
7760     * @brief Get the content of the frame widget
7761     *
7762     * Return the content object which is set for this widget
7763     *
7764     * @param obj The frame object
7765     * @return The content that is being used
7766     */
7767    EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7768    /**
7769     * @brief Unset the content of the frame widget
7770     *
7771     * Unparent and return the content object which was set for this widget
7772     *
7773     * @param obj The frame object
7774     * @return The content that was being used
7775     */
7776    EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7777    /**
7778     * @}
7779     */
7780
7781    /**
7782     * @defgroup Table Table
7783     *
7784     * A container widget to arrange other widgets in a table where items can
7785     * also span multiple columns or rows - even overlap (and then be raised or
7786     * lowered accordingly to adjust stacking if they do overlap).
7787     *
7788     * The followin are examples of how to use a table:
7789     * @li @ref tutorial_table_01
7790     * @li @ref tutorial_table_02
7791     *
7792     * @{
7793     */
7794    /**
7795     * @brief Add a new table to the parent
7796     *
7797     * @param parent The parent object
7798     * @return The new object or NULL if it cannot be created
7799     */
7800    EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7801    /**
7802     * @brief Set the homogeneous layout in the table
7803     *
7804     * @param obj The layout object
7805     * @param homogeneous A boolean to set if the layout is homogeneous in the
7806     * table (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7807     */
7808    EAPI void         elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7809    /**
7810     * @brief Get the current table homogeneous mode.
7811     *
7812     * @param obj The table object
7813     * @return A boolean to indicating if the layout is homogeneous in the table
7814     * (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7815     */
7816    EAPI Eina_Bool    elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7817    /**
7818     * @warning <b>Use elm_table_homogeneous_set() instead</b>
7819     */
7820    EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7821    /**
7822     * @warning <b>Use elm_table_homogeneous_get() instead</b>
7823     */
7824    EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7825    /**
7826     * @brief Set padding between cells.
7827     *
7828     * @param obj The layout object.
7829     * @param horizontal set the horizontal padding.
7830     * @param vertical set the vertical padding.
7831     *
7832     * Default value is 0.
7833     */
7834    EAPI void         elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7835    /**
7836     * @brief Get padding between cells.
7837     *
7838     * @param obj The layout object.
7839     * @param horizontal set the horizontal padding.
7840     * @param vertical set the vertical padding.
7841     */
7842    EAPI void         elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7843    /**
7844     * @brief Add a subobject on the table with the coordinates passed
7845     *
7846     * @param obj The table object
7847     * @param subobj The subobject to be added to the table
7848     * @param x Row number
7849     * @param y Column number
7850     * @param w rowspan
7851     * @param h colspan
7852     *
7853     * @note All positioning inside the table is relative to rows and columns, so
7854     * a value of 0 for x and y, means the top left cell of the table, and a
7855     * value of 1 for w and h means @p subobj only takes that 1 cell.
7856     */
7857    EAPI void         elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7858    /**
7859     * @brief Remove child from table.
7860     *
7861     * @param obj The table object
7862     * @param subobj The subobject
7863     */
7864    EAPI void         elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7865    /**
7866     * @brief Faster way to remove all child objects from a table object.
7867     *
7868     * @param obj The table object
7869     * @param clear If true, will delete children, else just remove from table.
7870     */
7871    EAPI void         elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7872    /**
7873     * @brief Set the packing location of an existing child of the table
7874     *
7875     * @param subobj The subobject to be modified in the table
7876     * @param x Row number
7877     * @param y Column number
7878     * @param w rowspan
7879     * @param h colspan
7880     *
7881     * Modifies the position of an object already in the table.
7882     *
7883     * @note All positioning inside the table is relative to rows and columns, so
7884     * a value of 0 for x and y, means the top left cell of the table, and a
7885     * value of 1 for w and h means @p subobj only takes that 1 cell.
7886     */
7887    EAPI void         elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7888    /**
7889     * @brief Get the packing location of an existing child of the table
7890     *
7891     * @param subobj The subobject to be modified in the table
7892     * @param x Row number
7893     * @param y Column number
7894     * @param w rowspan
7895     * @param h colspan
7896     *
7897     * @see elm_table_pack_set()
7898     */
7899    EAPI void         elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7900    /**
7901     * @}
7902     */
7903
7904    /* TEMPORARY: DOCS WILL BE FILLED IN WITH CNP/SED */
7905    typedef struct Elm_Gen_Item Elm_Gen_Item;
7906    typedef struct _Elm_Gen_Item_Class Elm_Gen_Item_Class;
7907    typedef struct _Elm_Gen_Item_Class_Func Elm_Gen_Item_Class_Func; /**< Class functions for gen item classes. */
7908    typedef char        *(*Elm_Gen_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gen item classes. */
7909    typedef Evas_Object *(*Elm_Gen_Item_Icon_Get_Cb)  (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for gen item classes. */
7910    typedef Eina_Bool    (*Elm_Gen_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for gen item classes. */
7911    typedef void         (*Elm_Gen_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for gen item classes. */
7912    struct _Elm_Gen_Item_Class
7913      {
7914         const char             *item_style;
7915         struct _Elm_Gen_Item_Class_Func
7916           {
7917              Elm_Gen_Item_Label_Get_Cb label_get;
7918              Elm_Gen_Item_Icon_Get_Cb  icon_get;
7919              Elm_Gen_Item_State_Get_Cb state_get;
7920              Elm_Gen_Item_Del_Cb       del;
7921           } func;
7922      };
7923    EAPI void elm_gen_clear(Evas_Object *obj);
7924    EAPI void elm_gen_item_selected_set(Elm_Gen_Item *it, Eina_Bool selected);
7925    EAPI Eina_Bool elm_gen_item_selected_get(const Elm_Gen_Item *it);
7926    EAPI void elm_gen_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select);
7927    EAPI Eina_Bool elm_gen_always_select_mode_get(const Evas_Object *obj);
7928    EAPI void elm_gen_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select);
7929    EAPI Eina_Bool elm_gen_no_select_mode_get(const Evas_Object *obj);
7930    EAPI void elm_gen_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
7931    EAPI void elm_gen_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
7932    EAPI void elm_gen_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel);
7933    EAPI void elm_gen_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel);
7934    EAPI void elm_gen_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize);
7935    EAPI void elm_gen_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
7936    EAPI void elm_gen_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
7937    EAPI void elm_gen_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
7938    EAPI void elm_gen_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
7939    EAPI Elm_Gen_Item *elm_gen_first_item_get(const Evas_Object *obj);
7940    EAPI Elm_Gen_Item *elm_gen_last_item_get(const Evas_Object *obj);
7941    EAPI Elm_Gen_Item *elm_gen_item_next_get(const Elm_Gen_Item *it);
7942    EAPI Elm_Gen_Item *elm_gen_item_prev_get(const Elm_Gen_Item *it);
7943    EAPI Evas_Object *elm_gen_item_widget_get(const Elm_Gen_Item *it);
7944
7945    /**
7946     * @defgroup Gengrid Gengrid (Generic grid)
7947     *
7948     * This widget aims to position objects in a grid layout while
7949     * actually creating and rendering only the visible ones, using the
7950     * same idea as the @ref Genlist "genlist": the user defines a @b
7951     * class for each item, specifying functions that will be called at
7952     * object creation, deletion, etc. When those items are selected by
7953     * the user, a callback function is issued. Users may interact with
7954     * a gengrid via the mouse (by clicking on items to select them and
7955     * clicking on the grid's viewport and swiping to pan the whole
7956     * view) or via the keyboard, navigating through item with the
7957     * arrow keys.
7958     *
7959     * @section Gengrid_Layouts Gengrid layouts
7960     *
7961     * Gengrids may layout its items in one of two possible layouts:
7962     * - horizontal or
7963     * - vertical.
7964     *
7965     * When in "horizontal mode", items will be placed in @b columns,
7966     * from top to bottom and, when the space for a column is filled,
7967     * another one is started on the right, thus expanding the grid
7968     * horizontally, making for horizontal scrolling. When in "vertical
7969     * mode" , though, items will be placed in @b rows, from left to
7970     * right and, when the space for a row is filled, another one is
7971     * started below, thus expanding the grid vertically (and making
7972     * for vertical scrolling).
7973     *
7974     * @section Gengrid_Items Gengrid items
7975     *
7976     * An item in a gengrid can have 0 or more text labels (they can be
7977     * regular text or textblock Evas objects - that's up to the style
7978     * to determine), 0 or more icons (which are simply objects
7979     * swallowed into the gengrid item's theming Edje object) and 0 or
7980     * more <b>boolean states</b>, which have the behavior left to the
7981     * user to define. The Edje part names for each of these properties
7982     * will be looked up, in the theme file for the gengrid, under the
7983     * Edje (string) data items named @c "labels", @c "icons" and @c
7984     * "states", respectively. For each of those properties, if more
7985     * than one part is provided, they must have names listed separated
7986     * by spaces in the data fields. For the default gengrid item
7987     * theme, we have @b one label part (@c "elm.text"), @b two icon
7988     * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
7989     * no state parts.
7990     *
7991     * A gengrid item may be at one of several styles. Elementary
7992     * provides one by default - "default", but this can be extended by
7993     * system or application custom themes/overlays/extensions (see
7994     * @ref Theme "themes" for more details).
7995     *
7996     * @section Gengrid_Item_Class Gengrid item classes
7997     *
7998     * In order to have the ability to add and delete items on the fly,
7999     * gengrid implements a class (callback) system where the
8000     * application provides a structure with information about that
8001     * type of item (gengrid may contain multiple different items with
8002     * different classes, states and styles). Gengrid will call the
8003     * functions in this struct (methods) when an item is "realized"
8004     * (i.e., created dynamically, while the user is scrolling the
8005     * grid). All objects will simply be deleted when no longer needed
8006     * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
8007     * contains the following members:
8008     * - @c item_style - This is a constant string and simply defines
8009     * the name of the item style. It @b must be specified and the
8010     * default should be @c "default".
8011     * - @c func.label_get - This function is called when an item
8012     * object is actually created. The @c data parameter will point to
8013     * the same data passed to elm_gengrid_item_append() and related
8014     * item creation functions. The @c obj parameter is the gengrid
8015     * object itself, while the @c part one is the name string of one
8016     * of the existing text parts in the Edje group implementing the
8017     * item's theme. This function @b must return a strdup'()ed string,
8018     * as the caller will free() it when done. See
8019     * #Elm_Gengrid_Item_Label_Get_Cb.
8020     * - @c func.icon_get - This function is called when an item object
8021     * is actually created. The @c data parameter will point to the
8022     * same data passed to elm_gengrid_item_append() and related item
8023     * creation functions. The @c obj parameter is the gengrid object
8024     * itself, while the @c part one is the name string of one of the
8025     * existing (icon) swallow parts in the Edje group implementing the
8026     * item's theme. It must return @c NULL, when no icon is desired,
8027     * or a valid object handle, otherwise. The object will be deleted
8028     * by the gengrid on its deletion or when the item is "unrealized".
8029     * See #Elm_Gengrid_Item_Icon_Get_Cb.
8030     * - @c func.state_get - This function is called when an item
8031     * object is actually created. The @c data parameter will point to
8032     * the same data passed to elm_gengrid_item_append() and related
8033     * item creation functions. The @c obj parameter is the gengrid
8034     * object itself, while the @c part one is the name string of one
8035     * of the state parts in the Edje group implementing the item's
8036     * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
8037     * true/on. Gengrids will emit a signal to its theming Edje object
8038     * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
8039     * "source" arguments, respectively, when the state is true (the
8040     * default is false), where @c XXX is the name of the (state) part.
8041     * See #Elm_Gengrid_Item_State_Get_Cb.
8042     * - @c func.del - This is called when elm_gengrid_item_del() is
8043     * called on an item or elm_gengrid_clear() is called on the
8044     * gengrid. This is intended for use when gengrid items are
8045     * deleted, so any data attached to the item (e.g. its data
8046     * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
8047     *
8048     * @section Gengrid_Usage_Hints Usage hints
8049     *
8050     * If the user wants to have multiple items selected at the same
8051     * time, elm_gengrid_multi_select_set() will permit it. If the
8052     * gengrid is single-selection only (the default), then
8053     * elm_gengrid_select_item_get() will return the selected item or
8054     * @c NULL, if none is selected. If the gengrid is under
8055     * multi-selection, then elm_gengrid_selected_items_get() will
8056     * return a list (that is only valid as long as no items are
8057     * modified (added, deleted, selected or unselected) of child items
8058     * on a gengrid.
8059     *
8060     * If an item changes (internal (boolean) state, label or icon
8061     * changes), then use elm_gengrid_item_update() to have gengrid
8062     * update the item with the new state. A gengrid will re-"realize"
8063     * the item, thus calling the functions in the
8064     * #Elm_Gengrid_Item_Class set for that item.
8065     *
8066     * To programmatically (un)select an item, use
8067     * elm_gengrid_item_selected_set(). To get its selected state use
8068     * elm_gengrid_item_selected_get(). To make an item disabled
8069     * (unable to be selected and appear differently) use
8070     * elm_gengrid_item_disabled_set() to set this and
8071     * elm_gengrid_item_disabled_get() to get the disabled state.
8072     *
8073     * Grid cells will only have their selection smart callbacks called
8074     * when firstly getting selected. Any further clicks will do
8075     * nothing, unless you enable the "always select mode", with
8076     * elm_gengrid_always_select_mode_set(), thus making every click to
8077     * issue selection callbacks. elm_gengrid_no_select_mode_set() will
8078     * turn off the ability to select items entirely in the widget and
8079     * they will neither appear selected nor call the selection smart
8080     * callbacks.
8081     *
8082     * Remember that you can create new styles and add your own theme
8083     * augmentation per application with elm_theme_extension_add(). If
8084     * you absolutely must have a specific style that overrides any
8085     * theme the user or system sets up you can use
8086     * elm_theme_overlay_add() to add such a file.
8087     *
8088     * @section Gengrid_Smart_Events Gengrid smart events
8089     *
8090     * Smart events that you can add callbacks for are:
8091     * - @c "activated" - The user has double-clicked or pressed
8092     *   (enter|return|spacebar) on an item. The @c event_info parameter
8093     *   is the gengrid item that was activated.
8094     * - @c "clicked,double" - The user has double-clicked an item.
8095     *   The @c event_info parameter is the gengrid item that was double-clicked.
8096     * - @c "longpressed" - This is called when the item is pressed for a certain
8097     *   amount of time. By default it's 1 second.
8098     * - @c "selected" - The user has made an item selected. The
8099     *   @c event_info parameter is the gengrid item that was selected.
8100     * - @c "unselected" - The user has made an item unselected. The
8101     *   @c event_info parameter is the gengrid item that was unselected.
8102     * - @c "realized" - This is called when the item in the gengrid
8103     *   has its implementing Evas object instantiated, de facto. @c
8104     *   event_info is the gengrid item that was created. The object
8105     *   may be deleted at any time, so it is highly advised to the
8106     *   caller @b not to use the object pointer returned from
8107     *   elm_gengrid_item_object_get(), because it may point to freed
8108     *   objects.
8109     * - @c "unrealized" - This is called when the implementing Evas
8110     *   object for this item is deleted. @c event_info is the gengrid
8111     *   item that was deleted.
8112     * - @c "changed" - Called when an item is added, removed, resized
8113     *   or moved and when the gengrid is resized or gets "horizontal"
8114     *   property changes.
8115     * - @c "scroll,anim,start" - This is called when scrolling animation has
8116     *   started.
8117     * - @c "scroll,anim,stop" - This is called when scrolling animation has
8118     *   stopped.
8119     * - @c "drag,start,up" - Called when the item in the gengrid has
8120     *   been dragged (not scrolled) up.
8121     * - @c "drag,start,down" - Called when the item in the gengrid has
8122     *   been dragged (not scrolled) down.
8123     * - @c "drag,start,left" - Called when the item in the gengrid has
8124     *   been dragged (not scrolled) left.
8125     * - @c "drag,start,right" - Called when the item in the gengrid has
8126     *   been dragged (not scrolled) right.
8127     * - @c "drag,stop" - Called when the item in the gengrid has
8128     *   stopped being dragged.
8129     * - @c "drag" - Called when the item in the gengrid is being
8130     *   dragged.
8131     * - @c "scroll" - called when the content has been scrolled
8132     *   (moved).
8133     * - @c "scroll,drag,start" - called when dragging the content has
8134     *   started.
8135     * - @c "scroll,drag,stop" - called when dragging the content has
8136     *   stopped.
8137     * - @c "edge,top" - This is called when the gengrid is scrolled until
8138     *   the top edge.
8139     * - @c "edge,bottom" - This is called when the gengrid is scrolled
8140     *   until the bottom edge.
8141     * - @c "edge,left" - This is called when the gengrid is scrolled
8142     *   until the left edge.
8143     * - @c "edge,right" - This is called when the gengrid is scrolled
8144     *   until the right edge.
8145     *
8146     * List of gengrid examples:
8147     * @li @ref gengrid_example
8148     */
8149
8150    /**
8151     * @addtogroup Gengrid
8152     * @{
8153     */
8154
8155    typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8156    #define Elm_Gengrid_Item_Class Elm_Gen_Item_Class
8157    typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8158    #define Elm_Gengrid_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
8159    typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8160    typedef char        *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
8161    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. */
8162    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. */
8163    typedef void         (*Elm_Gengrid_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
8164
8165    /**
8166     * @struct _Elm_Gengrid_Item_Class
8167     *
8168     * Gengrid item class definition. See @ref Gengrid_Item_Class for
8169     * field details.
8170     */
8171    struct _Elm_Gengrid_Item_Class
8172      {
8173         const char             *item_style;
8174         struct _Elm_Gengrid_Item_Class_Func
8175           {
8176              Elm_Gengrid_Item_Label_Get_Cb label_get;
8177              Elm_Gengrid_Item_Icon_Get_Cb  icon_get;
8178              Elm_Gengrid_Item_State_Get_Cb state_get;
8179              Elm_Gengrid_Item_Del_Cb       del;
8180           } func;
8181      }; /**< #Elm_Gengrid_Item_Class member definitions */
8182    #define Elm_Gengrid_Item_Class_Func Elm_Gen_Item_Class_Func
8183    /**
8184     * Add a new gengrid widget to the given parent Elementary
8185     * (container) object
8186     *
8187     * @param parent The parent object
8188     * @return a new gengrid widget handle or @c NULL, on errors
8189     *
8190     * This function inserts a new gengrid widget on the canvas.
8191     *
8192     * @see elm_gengrid_item_size_set()
8193     * @see elm_gengrid_group_item_size_set()
8194     * @see elm_gengrid_horizontal_set()
8195     * @see elm_gengrid_item_append()
8196     * @see elm_gengrid_item_del()
8197     * @see elm_gengrid_clear()
8198     *
8199     * @ingroup Gengrid
8200     */
8201    EAPI Evas_Object       *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8202
8203    /**
8204     * Set the size for the items of a given gengrid widget
8205     *
8206     * @param obj The gengrid object.
8207     * @param w The items' width.
8208     * @param h The items' height;
8209     *
8210     * A gengrid, after creation, has still no information on the size
8211     * to give to each of its cells. So, you most probably will end up
8212     * with squares one @ref Fingers "finger" wide, the default
8213     * size. Use this function to force a custom size for you items,
8214     * making them as big as you wish.
8215     *
8216     * @see elm_gengrid_item_size_get()
8217     *
8218     * @ingroup Gengrid
8219     */
8220    EAPI void               elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8221
8222    /**
8223     * Get the size set for the items of a given gengrid widget
8224     *
8225     * @param obj The gengrid object.
8226     * @param w Pointer to a variable where to store the items' width.
8227     * @param h Pointer to a variable where to store the items' height.
8228     *
8229     * @note Use @c NULL pointers on the size values you're not
8230     * interested in: they'll be ignored by the function.
8231     *
8232     * @see elm_gengrid_item_size_get() for more details
8233     *
8234     * @ingroup Gengrid
8235     */
8236    EAPI void               elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8237
8238    /**
8239     * Set the size for the group items of a given gengrid widget
8240     *
8241     * @param obj The gengrid object.
8242     * @param w The group items' width.
8243     * @param h The group items' height;
8244     *
8245     * A gengrid, after creation, has still no information on the size
8246     * to give to each of its cells. So, you most probably will end up
8247     * with squares one @ref Fingers "finger" wide, the default
8248     * size. Use this function to force a custom size for you group items,
8249     * making them as big as you wish.
8250     *
8251     * @see elm_gengrid_group_item_size_get()
8252     *
8253     * @ingroup Gengrid
8254     */
8255    EAPI void               elm_gengrid_group_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8256
8257    /**
8258     * Get the size set for the group items of a given gengrid widget
8259     *
8260     * @param obj The gengrid object.
8261     * @param w Pointer to a variable where to store the group items' width.
8262     * @param h Pointer to a variable where to store the group items' height.
8263     *
8264     * @note Use @c NULL pointers on the size values you're not
8265     * interested in: they'll be ignored by the function.
8266     *
8267     * @see elm_gengrid_group_item_size_get() for more details
8268     *
8269     * @ingroup Gengrid
8270     */
8271    EAPI void               elm_gengrid_group_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8272
8273    /**
8274     * Set the items grid's alignment within a given gengrid widget
8275     *
8276     * @param obj The gengrid object.
8277     * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8278     * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8279     *
8280     * This sets the alignment of the whole grid of items of a gengrid
8281     * within its given viewport. By default, those values are both
8282     * 0.5, meaning that the gengrid will have its items grid placed
8283     * exactly in the middle of its viewport.
8284     *
8285     * @note If given alignment values are out of the cited ranges,
8286     * they'll be changed to the nearest boundary values on the valid
8287     * ranges.
8288     *
8289     * @see elm_gengrid_align_get()
8290     *
8291     * @ingroup Gengrid
8292     */
8293    EAPI void               elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8294
8295    /**
8296     * Get the items grid's alignment values within a given gengrid
8297     * widget
8298     *
8299     * @param obj The gengrid object.
8300     * @param align_x Pointer to a variable where to store the
8301     * horizontal alignment.
8302     * @param align_y Pointer to a variable where to store the vertical
8303     * alignment.
8304     *
8305     * @note Use @c NULL pointers on the alignment values you're not
8306     * interested in: they'll be ignored by the function.
8307     *
8308     * @see elm_gengrid_align_set() for more details
8309     *
8310     * @ingroup Gengrid
8311     */
8312    EAPI void               elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8313
8314    /**
8315     * Set whether a given gengrid widget is or not able have items
8316     * @b reordered
8317     *
8318     * @param obj The gengrid object
8319     * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8320     * @c EINA_FALSE to turn it off
8321     *
8322     * If a gengrid is set to allow reordering, a click held for more
8323     * than 0.5 over a given item will highlight it specially,
8324     * signalling the gengrid has entered the reordering state. From
8325     * that time on, the user will be able to, while still holding the
8326     * mouse button down, move the item freely in the gengrid's
8327     * viewport, replacing to said item to the locations it goes to.
8328     * The replacements will be animated and, whenever the user
8329     * releases the mouse button, the item being replaced gets a new
8330     * definitive place in the grid.
8331     *
8332     * @see elm_gengrid_reorder_mode_get()
8333     *
8334     * @ingroup Gengrid
8335     */
8336    EAPI void               elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8337
8338    /**
8339     * Get whether a given gengrid widget is or not able have items
8340     * @b reordered
8341     *
8342     * @param obj The gengrid object
8343     * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8344     * off
8345     *
8346     * @see elm_gengrid_reorder_mode_set() for more details
8347     *
8348     * @ingroup Gengrid
8349     */
8350    EAPI Eina_Bool          elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8351
8352    /**
8353     * Append a new item in a given gengrid widget.
8354     *
8355     * @param obj The gengrid object.
8356     * @param gic The item class for the item.
8357     * @param data The item data.
8358     * @param func Convenience function called when the item is
8359     * selected.
8360     * @param func_data Data to be passed to @p func.
8361     * @return A handle to the item added or @c NULL, on errors.
8362     *
8363     * This adds an item to the beginning of the gengrid.
8364     *
8365     * @see elm_gengrid_item_prepend()
8366     * @see elm_gengrid_item_insert_before()
8367     * @see elm_gengrid_item_insert_after()
8368     * @see elm_gengrid_item_del()
8369     *
8370     * @ingroup Gengrid
8371     */
8372    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);
8373
8374    /**
8375     * Prepend a new item in a given gengrid widget.
8376     *
8377     * @param obj The gengrid object.
8378     * @param gic The item class for the item.
8379     * @param data The item data.
8380     * @param func Convenience function called when the item is
8381     * selected.
8382     * @param func_data Data to be passed to @p func.
8383     * @return A handle to the item added or @c NULL, on errors.
8384     *
8385     * This adds an item to the end of the gengrid.
8386     *
8387     * @see elm_gengrid_item_append()
8388     * @see elm_gengrid_item_insert_before()
8389     * @see elm_gengrid_item_insert_after()
8390     * @see elm_gengrid_item_del()
8391     *
8392     * @ingroup Gengrid
8393     */
8394    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);
8395
8396    /**
8397     * Insert an item before another in a gengrid widget
8398     *
8399     * @param obj The gengrid object.
8400     * @param gic The item class for the item.
8401     * @param data The item data.
8402     * @param relative The item to place this new one before.
8403     * @param func Convenience function called when the item is
8404     * selected.
8405     * @param func_data Data to be passed to @p func.
8406     * @return A handle to the item added or @c NULL, on errors.
8407     *
8408     * This inserts an item before another in the gengrid.
8409     *
8410     * @see elm_gengrid_item_append()
8411     * @see elm_gengrid_item_prepend()
8412     * @see elm_gengrid_item_insert_after()
8413     * @see elm_gengrid_item_del()
8414     *
8415     * @ingroup Gengrid
8416     */
8417    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);
8418
8419    /**
8420     * Insert an item after another in a gengrid widget
8421     *
8422     * @param obj The gengrid object.
8423     * @param gic The item class for the item.
8424     * @param data The item data.
8425     * @param relative The item to place this new one after.
8426     * @param func Convenience function called when the item is
8427     * selected.
8428     * @param func_data Data to be passed to @p func.
8429     * @return A handle to the item added or @c NULL, on errors.
8430     *
8431     * This inserts an item after another in the gengrid.
8432     *
8433     * @see elm_gengrid_item_append()
8434     * @see elm_gengrid_item_prepend()
8435     * @see elm_gengrid_item_insert_after()
8436     * @see elm_gengrid_item_del()
8437     *
8438     * @ingroup Gengrid
8439     */
8440    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);
8441
8442    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);
8443
8444    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);
8445
8446    /**
8447     * Set whether items on a given gengrid widget are to get their
8448     * selection callbacks issued for @b every subsequent selection
8449     * click on them or just for the first click.
8450     *
8451     * @param obj The gengrid object
8452     * @param always_select @c EINA_TRUE to make items "always
8453     * selected", @c EINA_FALSE, otherwise
8454     *
8455     * By default, grid items will only call their selection callback
8456     * function when firstly getting selected, any subsequent further
8457     * clicks will do nothing. With this call, you make those
8458     * subsequent clicks also to issue the selection callbacks.
8459     *
8460     * @note <b>Double clicks</b> will @b always be reported on items.
8461     *
8462     * @see elm_gengrid_always_select_mode_get()
8463     *
8464     * @ingroup Gengrid
8465     */
8466    EINA_DEPRECATED EAPI void               elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8467
8468    /**
8469     * Get whether items on a given gengrid widget have their selection
8470     * callbacks issued for @b every subsequent selection click on them
8471     * or just for the first click.
8472     *
8473     * @param obj The gengrid object.
8474     * @return @c EINA_TRUE if the gengrid items are "always selected",
8475     * @c EINA_FALSE, otherwise
8476     *
8477     * @see elm_gengrid_always_select_mode_set() for more details
8478     *
8479     * @ingroup Gengrid
8480     */
8481    EINA_DEPRECATED EAPI Eina_Bool          elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8482
8483    /**
8484     * Set whether items on a given gengrid widget can be selected or not.
8485     *
8486     * @param obj The gengrid object
8487     * @param no_select @c EINA_TRUE to make items selectable,
8488     * @c EINA_FALSE otherwise
8489     *
8490     * This will make items in @p obj selectable or not. In the latter
8491     * case, any user interaction on the gengrid items will neither make
8492     * them appear selected nor them call their selection callback
8493     * functions.
8494     *
8495     * @see elm_gengrid_no_select_mode_get()
8496     *
8497     * @ingroup Gengrid
8498     */
8499    EINA_DEPRECATED EAPI void               elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8500
8501    /**
8502     * Get whether items on a given gengrid widget can be selected or
8503     * not.
8504     *
8505     * @param obj The gengrid object
8506     * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8507     * otherwise
8508     *
8509     * @see elm_gengrid_no_select_mode_set() for more details
8510     *
8511     * @ingroup Gengrid
8512     */
8513    EINA_DEPRECATED EAPI Eina_Bool          elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8514
8515    /**
8516     * Enable or disable multi-selection in a given gengrid widget
8517     *
8518     * @param obj The gengrid object.
8519     * @param multi @c EINA_TRUE, to enable multi-selection,
8520     * @c EINA_FALSE to disable it.
8521     *
8522     * Multi-selection is the ability for one to have @b more than one
8523     * item selected, on a given gengrid, simultaneously. When it is
8524     * enabled, a sequence of clicks on different items will make them
8525     * all selected, progressively. A click on an already selected item
8526     * will unselect it. If interecting via the keyboard,
8527     * multi-selection is enabled while holding the "Shift" key.
8528     *
8529     * @note By default, multi-selection is @b disabled on gengrids
8530     *
8531     * @see elm_gengrid_multi_select_get()
8532     *
8533     * @ingroup Gengrid
8534     */
8535    EAPI void               elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8536
8537    /**
8538     * Get whether multi-selection is enabled or disabled for a given
8539     * gengrid widget
8540     *
8541     * @param obj The gengrid object.
8542     * @return @c EINA_TRUE, if multi-selection is enabled, @c
8543     * EINA_FALSE otherwise
8544     *
8545     * @see elm_gengrid_multi_select_set() for more details
8546     *
8547     * @ingroup Gengrid
8548     */
8549    EAPI Eina_Bool          elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8550
8551    /**
8552     * Enable or disable bouncing effect for a given gengrid widget
8553     *
8554     * @param obj The gengrid object
8555     * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8556     * @c EINA_FALSE to disable it
8557     * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8558     * @c EINA_FALSE to disable it
8559     *
8560     * The bouncing effect occurs whenever one reaches the gengrid's
8561     * edge's while panning it -- it will scroll past its limits a
8562     * little bit and return to the edge again, in a animated for,
8563     * automatically.
8564     *
8565     * @note By default, gengrids have bouncing enabled on both axis
8566     *
8567     * @see elm_gengrid_bounce_get()
8568     *
8569     * @ingroup Gengrid
8570     */
8571    EINA_DEPRECATED EAPI void               elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8572
8573    /**
8574     * Get whether bouncing effects are enabled or disabled, for a
8575     * given gengrid widget, on each axis
8576     *
8577     * @param obj The gengrid object
8578     * @param h_bounce Pointer to a variable where to store the
8579     * horizontal bouncing flag.
8580     * @param v_bounce Pointer to a variable where to store the
8581     * vertical bouncing flag.
8582     *
8583     * @see elm_gengrid_bounce_set() for more details
8584     *
8585     * @ingroup Gengrid
8586     */
8587    EINA_DEPRECATED EAPI void               elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8588
8589    /**
8590     * Set a given gengrid widget's scrolling page size, relative to
8591     * its viewport size.
8592     *
8593     * @param obj The gengrid object
8594     * @param h_pagerel The horizontal page (relative) size
8595     * @param v_pagerel The vertical page (relative) size
8596     *
8597     * The gengrid's scroller is capable of binding scrolling by the
8598     * user to "pages". It means that, while scrolling and, specially
8599     * after releasing the mouse button, the grid will @b snap to the
8600     * nearest displaying page's area. When page sizes are set, the
8601     * grid's continuous content area is split into (equal) page sized
8602     * pieces.
8603     *
8604     * This function sets the size of a page <b>relatively to the
8605     * viewport dimensions</b> of the gengrid, for each axis. A value
8606     * @c 1.0 means "the exact viewport's size", in that axis, while @c
8607     * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8608     * a viewport". Sane usable values are, than, between @c 0.0 and @c
8609     * 1.0. Values beyond those will make it behave behave
8610     * inconsistently. If you only want one axis to snap to pages, use
8611     * the value @c 0.0 for the other one.
8612     *
8613     * There is a function setting page size values in @b absolute
8614     * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8615     * is mutually exclusive to this one.
8616     *
8617     * @see elm_gengrid_page_relative_get()
8618     *
8619     * @ingroup Gengrid
8620     */
8621    EINA_DEPRECATED EAPI void               elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8622
8623    /**
8624     * Get a given gengrid widget's scrolling page size, relative to
8625     * its viewport size.
8626     *
8627     * @param obj The gengrid object
8628     * @param h_pagerel Pointer to a variable where to store the
8629     * horizontal page (relative) size
8630     * @param v_pagerel Pointer to a variable where to store the
8631     * vertical page (relative) size
8632     *
8633     * @see elm_gengrid_page_relative_set() for more details
8634     *
8635     * @ingroup Gengrid
8636     */
8637    EINA_DEPRECATED EAPI void               elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8638
8639    /**
8640     * Set a given gengrid widget's scrolling page size
8641     *
8642     * @param obj The gengrid object
8643     * @param h_pagerel The horizontal page size, in pixels
8644     * @param v_pagerel The vertical page size, in pixels
8645     *
8646     * The gengrid's scroller is capable of binding scrolling by the
8647     * user to "pages". It means that, while scrolling and, specially
8648     * after releasing the mouse button, the grid will @b snap to the
8649     * nearest displaying page's area. When page sizes are set, the
8650     * grid's continuous content area is split into (equal) page sized
8651     * pieces.
8652     *
8653     * This function sets the size of a page of the gengrid, in pixels,
8654     * for each axis. Sane usable values are, between @c 0 and the
8655     * dimensions of @p obj, for each axis. Values beyond those will
8656     * make it behave behave inconsistently. If you only want one axis
8657     * to snap to pages, use the value @c 0 for the other one.
8658     *
8659     * There is a function setting page size values in @b relative
8660     * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8661     * use is mutually exclusive to this one.
8662     *
8663     * @ingroup Gengrid
8664     */
8665    EINA_DEPRECATED EAPI void               elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8666
8667    /**
8668     * @brief Get gengrid current page number.
8669     *
8670     * @param obj The gengrid object
8671     * @param h_pagenumber The horizontal page number
8672     * @param v_pagenumber The vertical page number
8673     *
8674     * The page number starts from 0. 0 is the first page.
8675     * Current page means the page which meet the top-left of the viewport.
8676     * If there are two or more pages in the viewport, it returns the number of page
8677     * which meet the top-left of the viewport.
8678     *
8679     * @see elm_gengrid_last_page_get()
8680     * @see elm_gengrid_page_show()
8681     * @see elm_gengrid_page_brint_in()
8682     */
8683    EINA_DEPRECATED EAPI void         elm_gengrid_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8684
8685    /**
8686     * @brief Get scroll last page number.
8687     *
8688     * @param obj The gengrid object
8689     * @param h_pagenumber The horizontal page number
8690     * @param v_pagenumber The vertical page number
8691     *
8692     * The page number starts from 0. 0 is the first page.
8693     * This returns the last page number among the pages.
8694     *
8695     * @see elm_gengrid_current_page_get()
8696     * @see elm_gengrid_page_show()
8697     * @see elm_gengrid_page_brint_in()
8698     */
8699    EINA_DEPRECATED EAPI void         elm_gengrid_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8700
8701    /**
8702     * Show a specific virtual region within the gengrid content object by page number.
8703     *
8704     * @param obj The gengrid object
8705     * @param h_pagenumber The horizontal page number
8706     * @param v_pagenumber The vertical page number
8707     *
8708     * 0, 0 of the indicated page is located at the top-left of the viewport.
8709     * This will jump to the page directly without animation.
8710     *
8711     * Example of usage:
8712     *
8713     * @code
8714     * sc = elm_gengrid_add(win);
8715     * elm_gengrid_content_set(sc, content);
8716     * elm_gengrid_page_relative_set(sc, 1, 0);
8717     * elm_gengrid_current_page_get(sc, &h_page, &v_page);
8718     * elm_gengrid_page_show(sc, h_page + 1, v_page);
8719     * @endcode
8720     *
8721     * @see elm_gengrid_page_bring_in()
8722     */
8723    EINA_DEPRECATED EAPI void         elm_gengrid_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8724
8725    /**
8726     * Show a specific virtual region within the gengrid content object by page number.
8727     *
8728     * @param obj The gengrid object
8729     * @param h_pagenumber The horizontal page number
8730     * @param v_pagenumber The vertical page number
8731     *
8732     * 0, 0 of the indicated page is located at the top-left of the viewport.
8733     * This will slide to the page with animation.
8734     *
8735     * Example of usage:
8736     *
8737     * @code
8738     * sc = elm_gengrid_add(win);
8739     * elm_gengrid_content_set(sc, content);
8740     * elm_gengrid_page_relative_set(sc, 1, 0);
8741     * elm_gengrid_last_page_get(sc, &h_page, &v_page);
8742     * elm_gengrid_page_bring_in(sc, h_page, v_page);
8743     * @endcode
8744     *
8745     * @see elm_gengrid_page_show()
8746     */
8747     EINA_DEPRECATED EAPI void         elm_gengrid_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8748
8749    /**
8750     * Set for what direction a given gengrid widget will expand while
8751     * placing its items.
8752     *
8753     * @param obj The gengrid object.
8754     * @param setting @c EINA_TRUE to make the gengrid expand
8755     * horizontally, @c EINA_FALSE to expand vertically.
8756     *
8757     * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8758     * in @b columns, from top to bottom and, when the space for a
8759     * column is filled, another one is started on the right, thus
8760     * expanding the grid horizontally. When in "vertical mode"
8761     * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8762     * to right and, when the space for a row is filled, another one is
8763     * started below, thus expanding the grid vertically.
8764     *
8765     * @see elm_gengrid_horizontal_get()
8766     *
8767     * @ingroup Gengrid
8768     */
8769    EAPI void               elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8770
8771    /**
8772     * Get for what direction a given gengrid widget will expand while
8773     * placing its items.
8774     *
8775     * @param obj The gengrid object.
8776     * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8777     * @c EINA_FALSE if it's set to expand vertically.
8778     *
8779     * @see elm_gengrid_horizontal_set() for more detais
8780     *
8781     * @ingroup Gengrid
8782     */
8783    EAPI Eina_Bool          elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8784
8785    /**
8786     * Get the first item in a given gengrid widget
8787     *
8788     * @param obj The gengrid object
8789     * @return The first item's handle or @c NULL, if there are no
8790     * items in @p obj (and on errors)
8791     *
8792     * This returns the first item in the @p obj's internal list of
8793     * items.
8794     *
8795     * @see elm_gengrid_last_item_get()
8796     *
8797     * @ingroup Gengrid
8798     */
8799    EINA_DEPRECATED EAPI Elm_Gengrid_Item  *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8800
8801    /**
8802     * Get the last item in a given gengrid widget
8803     *
8804     * @param obj The gengrid object
8805     * @return The last item's handle or @c NULL, if there are no
8806     * items in @p obj (and on errors)
8807     *
8808     * This returns the last item in the @p obj's internal list of
8809     * items.
8810     *
8811     * @see elm_gengrid_first_item_get()
8812     *
8813     * @ingroup Gengrid
8814     */
8815    EINA_DEPRECATED EAPI Elm_Gengrid_Item  *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8816
8817    /**
8818     * Get the @b next item in a gengrid widget's internal list of items,
8819     * given a handle to one of those items.
8820     *
8821     * @param item The gengrid item to fetch next from
8822     * @return The item after @p item, or @c NULL if there's none (and
8823     * on errors)
8824     *
8825     * This returns the item placed after the @p item, on the container
8826     * gengrid.
8827     *
8828     * @see elm_gengrid_item_prev_get()
8829     *
8830     * @ingroup Gengrid
8831     */
8832    EINA_DEPRECATED EAPI Elm_Gengrid_Item  *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8833
8834    /**
8835     * Get the @b previous item in a gengrid widget's internal list of items,
8836     * given a handle to one of those items.
8837     *
8838     * @param item The gengrid item to fetch previous from
8839     * @return The item before @p item, or @c NULL if there's none (and
8840     * on errors)
8841     *
8842     * This returns the item placed before the @p item, on the container
8843     * gengrid.
8844     *
8845     * @see elm_gengrid_item_next_get()
8846     *
8847     * @ingroup Gengrid
8848     */
8849    EINA_DEPRECATED EAPI Elm_Gengrid_Item  *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8850
8851    /**
8852     * Get the gengrid object's handle which contains a given gengrid
8853     * item
8854     *
8855     * @param item The item to fetch the container from
8856     * @return The gengrid (parent) object
8857     *
8858     * This returns the gengrid object itself that an item belongs to.
8859     *
8860     * @ingroup Gengrid
8861     */
8862    EINA_DEPRECATED EAPI Evas_Object       *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8863
8864    /**
8865     * Remove a gengrid item from the its parent, deleting it.
8866     *
8867     * @param item The item to be removed.
8868     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8869     *
8870     * @see elm_gengrid_clear(), to remove all items in a gengrid at
8871     * once.
8872     *
8873     * @ingroup Gengrid
8874     */
8875    EAPI void               elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8876
8877    /**
8878     * Update the contents of a given gengrid item
8879     *
8880     * @param item The gengrid item
8881     *
8882     * This updates an item by calling all the item class functions
8883     * again to get the icons, labels and states. Use this when the
8884     * original item data has changed and you want thta changes to be
8885     * reflected.
8886     *
8887     * @ingroup Gengrid
8888     */
8889    EAPI void               elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8890    EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8891    EAPI void               elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8892
8893    /**
8894     * Return the data associated to a given gengrid item
8895     *
8896     * @param item The gengrid item.
8897     * @return the data associated to this item.
8898     *
8899     * This returns the @c data value passed on the
8900     * elm_gengrid_item_append() and related item addition calls.
8901     *
8902     * @see elm_gengrid_item_append()
8903     * @see elm_gengrid_item_data_set()
8904     *
8905     * @ingroup Gengrid
8906     */
8907    EAPI void              *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8908
8909    /**
8910     * Set the data associated to a given gengrid item
8911     *
8912     * @param item The gengrid item
8913     * @param data The new data pointer to set on it
8914     *
8915     * This @b overrides the @c data value passed on the
8916     * elm_gengrid_item_append() and related item addition calls. This
8917     * function @b won't call elm_gengrid_item_update() automatically,
8918     * so you'd issue it afterwards if you want to hove the item
8919     * updated to reflect the that new data.
8920     *
8921     * @see elm_gengrid_item_data_get()
8922     *
8923     * @ingroup Gengrid
8924     */
8925    EAPI void               elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8926
8927    /**
8928     * Get a given gengrid item's position, relative to the whole
8929     * gengrid's grid area.
8930     *
8931     * @param item The Gengrid item.
8932     * @param x Pointer to variable where to store the item's <b>row
8933     * number</b>.
8934     * @param y Pointer to variable where to store the item's <b>column
8935     * number</b>.
8936     *
8937     * This returns the "logical" position of the item whithin the
8938     * gengrid. For example, @c (0, 1) would stand for first row,
8939     * second column.
8940     *
8941     * @ingroup Gengrid
8942     */
8943    EAPI void               elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
8944
8945    /**
8946     * Set whether a given gengrid item is selected or not
8947     *
8948     * @param item The gengrid item
8949     * @param selected Use @c EINA_TRUE, to make it selected, @c
8950     * EINA_FALSE to make it unselected
8951     *
8952     * This sets the selected state of an item. If multi selection is
8953     * not enabled on the containing gengrid and @p selected is @c
8954     * EINA_TRUE, any other previously selected items will get
8955     * unselected in favor of this new one.
8956     *
8957     * @see elm_gengrid_item_selected_get()
8958     *
8959     * @ingroup Gengrid
8960     */
8961    EINA_DEPRECATED EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
8962
8963    /**
8964     * Get whether a given gengrid item is selected or not
8965     *
8966     * @param item The gengrid item
8967     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
8968     *
8969     * @see elm_gengrid_item_selected_set() for more details
8970     *
8971     * @ingroup Gengrid
8972     */
8973    EINA_DEPRECATED EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8974
8975    /**
8976     * Get the real Evas object created to implement the view of a
8977     * given gengrid item
8978     *
8979     * @param item The gengrid item.
8980     * @return the Evas object implementing this item's view.
8981     *
8982     * This returns the actual Evas object used to implement the
8983     * specified gengrid item's view. This may be @c NULL, as it may
8984     * not have been created or may have been deleted, at any time, by
8985     * the gengrid. <b>Do not modify this object</b> (move, resize,
8986     * show, hide, etc.), as the gengrid is controlling it. This
8987     * function is for querying, emitting custom signals or hooking
8988     * lower level callbacks for events on that object. Do not delete
8989     * this object under any circumstances.
8990     *
8991     * @see elm_gengrid_item_data_get()
8992     *
8993     * @ingroup Gengrid
8994     */
8995    EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8996
8997    /**
8998     * Show the portion of a gengrid's internal grid containing a given
8999     * item, @b immediately.
9000     *
9001     * @param item The item to display
9002     *
9003     * This causes gengrid to @b redraw its viewport's contents to the
9004     * region contining the given @p item item, if it is not fully
9005     * visible.
9006     *
9007     * @see elm_gengrid_item_bring_in()
9008     *
9009     * @ingroup Gengrid
9010     */
9011    EAPI void               elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9012
9013    /**
9014     * Animatedly bring in, to the visible are of a gengrid, a given
9015     * item on it.
9016     *
9017     * @param item The gengrid item to display
9018     *
9019     * This causes gengrig to jump to the given @p item item and show
9020     * it (by scrolling), if it is not fully visible. This will use
9021     * animation to do so and take a period of time to complete.
9022     *
9023     * @see elm_gengrid_item_show()
9024     *
9025     * @ingroup Gengrid
9026     */
9027    EAPI void               elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9028
9029    /**
9030     * Set whether a given gengrid item is disabled or not.
9031     *
9032     * @param item The gengrid item
9033     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
9034     * to enable it back.
9035     *
9036     * A disabled item cannot be selected or unselected. It will also
9037     * change its appearance, to signal the user it's disabled.
9038     *
9039     * @see elm_gengrid_item_disabled_get()
9040     *
9041     * @ingroup Gengrid
9042     */
9043    EAPI void               elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9044
9045    /**
9046     * Get whether a given gengrid item is disabled or not.
9047     *
9048     * @param item The gengrid item
9049     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
9050     * (and on errors).
9051     *
9052     * @see elm_gengrid_item_disabled_set() for more details
9053     *
9054     * @ingroup Gengrid
9055     */
9056    EAPI Eina_Bool          elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9057
9058    /**
9059     * Set the text to be shown in a given gengrid item's tooltips.
9060     *
9061     * @param item The gengrid item
9062     * @param text The text to set in the content
9063     *
9064     * This call will setup the text to be used as tooltip to that item
9065     * (analogous to elm_object_tooltip_text_set(), but being item
9066     * tooltips with higher precedence than object tooltips). It can
9067     * have only one tooltip at a time, so any previous tooltip data
9068     * will get removed.
9069     *
9070     * @ingroup Gengrid
9071     */
9072    EAPI void               elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
9073
9074    /**
9075     * Set the content to be shown in a given gengrid item's tooltips
9076     *
9077     * @param item The gengrid item.
9078     * @param func The function returning the tooltip contents.
9079     * @param data What to provide to @a func as callback data/context.
9080     * @param del_cb Called when data is not needed anymore, either when
9081     *        another callback replaces @p func, the tooltip is unset with
9082     *        elm_gengrid_item_tooltip_unset() or the owner @p item
9083     *        dies. This callback receives as its first parameter the
9084     *        given @p data, being @c event_info the item handle.
9085     *
9086     * This call will setup the tooltip's contents to @p item
9087     * (analogous to elm_object_tooltip_content_cb_set(), but being
9088     * item tooltips with higher precedence than object tooltips). It
9089     * can have only one tooltip at a time, so any previous tooltip
9090     * content will get removed. @p func (with @p data) will be called
9091     * every time Elementary needs to show the tooltip and it should
9092     * return a valid Evas object, which will be fully managed by the
9093     * tooltip system, getting deleted when the tooltip is gone.
9094     *
9095     * @ingroup Gengrid
9096     */
9097    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);
9098
9099    /**
9100     * Unset a tooltip from a given gengrid item
9101     *
9102     * @param item gengrid item to remove a previously set tooltip from.
9103     *
9104     * This call removes any tooltip set on @p item. The callback
9105     * provided as @c del_cb to
9106     * elm_gengrid_item_tooltip_content_cb_set() will be called to
9107     * notify it is not used anymore (and have resources cleaned, if
9108     * need be).
9109     *
9110     * @see elm_gengrid_item_tooltip_content_cb_set()
9111     *
9112     * @ingroup Gengrid
9113     */
9114    EAPI void               elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9115
9116    /**
9117     * Set a different @b style for a given gengrid item's tooltip.
9118     *
9119     * @param item gengrid item with tooltip set
9120     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9121     * "default", @c "transparent", etc)
9122     *
9123     * Tooltips can have <b>alternate styles</b> to be displayed on,
9124     * which are defined by the theme set on Elementary. This function
9125     * works analogously as elm_object_tooltip_style_set(), but here
9126     * applied only to gengrid item objects. The default style for
9127     * tooltips is @c "default".
9128     *
9129     * @note before you set a style you should define a tooltip with
9130     *       elm_gengrid_item_tooltip_content_cb_set() or
9131     *       elm_gengrid_item_tooltip_text_set()
9132     *
9133     * @see elm_gengrid_item_tooltip_style_get()
9134     *
9135     * @ingroup Gengrid
9136     */
9137    EAPI void               elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9138
9139    /**
9140     * Get the style set a given gengrid item's tooltip.
9141     *
9142     * @param item gengrid item with tooltip already set on.
9143     * @return style the theme style in use, which defaults to
9144     *         "default". If the object does not have a tooltip set,
9145     *         then @c NULL is returned.
9146     *
9147     * @see elm_gengrid_item_tooltip_style_set() for more details
9148     *
9149     * @ingroup Gengrid
9150     */
9151    EAPI const char        *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9152    /**
9153     * @brief Disable size restrictions on an object's tooltip
9154     * @param item The tooltip's anchor object
9155     * @param disable If EINA_TRUE, size restrictions are disabled
9156     * @return EINA_FALSE on failure, EINA_TRUE on success
9157     *
9158     * This function allows a tooltip to expand beyond its parant window's canvas.
9159     * It will instead be limited only by the size of the display.
9160     */
9161    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
9162    /**
9163     * @brief Retrieve size restriction state of an object's tooltip
9164     * @param item The tooltip's anchor object
9165     * @return If EINA_TRUE, size restrictions are disabled
9166     *
9167     * This function returns whether a tooltip is allowed to expand beyond
9168     * its parant window's canvas.
9169     * It will instead be limited only by the size of the display.
9170     */
9171    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
9172    /**
9173     * Set the type of mouse pointer/cursor decoration to be shown,
9174     * when the mouse pointer is over the given gengrid widget item
9175     *
9176     * @param item gengrid item to customize cursor on
9177     * @param cursor the cursor type's name
9178     *
9179     * This function works analogously as elm_object_cursor_set(), but
9180     * here the cursor's changing area is restricted to the item's
9181     * area, and not the whole widget's. Note that that item cursors
9182     * have precedence over widget cursors, so that a mouse over @p
9183     * item will always show cursor @p type.
9184     *
9185     * If this function is called twice for an object, a previously set
9186     * cursor will be unset on the second call.
9187     *
9188     * @see elm_object_cursor_set()
9189     * @see elm_gengrid_item_cursor_get()
9190     * @see elm_gengrid_item_cursor_unset()
9191     *
9192     * @ingroup Gengrid
9193     */
9194    EAPI void               elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9195
9196    /**
9197     * Get the type of mouse pointer/cursor decoration set to be shown,
9198     * when the mouse pointer is over the given gengrid widget item
9199     *
9200     * @param item gengrid item with custom cursor set
9201     * @return the cursor type's name or @c NULL, if no custom cursors
9202     * were set to @p item (and on errors)
9203     *
9204     * @see elm_object_cursor_get()
9205     * @see elm_gengrid_item_cursor_set() for more details
9206     * @see elm_gengrid_item_cursor_unset()
9207     *
9208     * @ingroup Gengrid
9209     */
9210    EAPI const char        *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9211
9212    /**
9213     * Unset any custom mouse pointer/cursor decoration set to be
9214     * shown, when the mouse pointer is over the given gengrid widget
9215     * item, thus making it show the @b default cursor again.
9216     *
9217     * @param item a gengrid item
9218     *
9219     * Use this call to undo any custom settings on this item's cursor
9220     * decoration, bringing it back to defaults (no custom style set).
9221     *
9222     * @see elm_object_cursor_unset()
9223     * @see elm_gengrid_item_cursor_set() for more details
9224     *
9225     * @ingroup Gengrid
9226     */
9227    EAPI void               elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9228
9229    /**
9230     * Set a different @b style for a given custom cursor set for a
9231     * gengrid item.
9232     *
9233     * @param item gengrid item with custom cursor set
9234     * @param style the <b>theme style</b> to use (e.g. @c "default",
9235     * @c "transparent", etc)
9236     *
9237     * This function only makes sense when one is using custom mouse
9238     * cursor decorations <b>defined in a theme file</b> , which can
9239     * have, given a cursor name/type, <b>alternate styles</b> on
9240     * it. It works analogously as elm_object_cursor_style_set(), but
9241     * here applied only to gengrid item objects.
9242     *
9243     * @warning Before you set a cursor style you should have defined a
9244     *       custom cursor previously on the item, with
9245     *       elm_gengrid_item_cursor_set()
9246     *
9247     * @see elm_gengrid_item_cursor_engine_only_set()
9248     * @see elm_gengrid_item_cursor_style_get()
9249     *
9250     * @ingroup Gengrid
9251     */
9252    EAPI void               elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9253
9254    /**
9255     * Get the current @b style set for a given gengrid item's custom
9256     * cursor
9257     *
9258     * @param item gengrid item with custom cursor set.
9259     * @return style the cursor style in use. If the object does not
9260     *         have a cursor set, then @c NULL is returned.
9261     *
9262     * @see elm_gengrid_item_cursor_style_set() for more details
9263     *
9264     * @ingroup Gengrid
9265     */
9266    EAPI const char        *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9267
9268    /**
9269     * Set if the (custom) cursor for a given gengrid item should be
9270     * searched in its theme, also, or should only rely on the
9271     * rendering engine.
9272     *
9273     * @param item item with custom (custom) cursor already set on
9274     * @param engine_only Use @c EINA_TRUE to have cursors looked for
9275     * only on those provided by the rendering engine, @c EINA_FALSE to
9276     * have them searched on the widget's theme, as well.
9277     *
9278     * @note This call is of use only if you've set a custom cursor
9279     * for gengrid items, with elm_gengrid_item_cursor_set().
9280     *
9281     * @note By default, cursors will only be looked for between those
9282     * provided by the rendering engine.
9283     *
9284     * @ingroup Gengrid
9285     */
9286    EAPI void               elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9287
9288    /**
9289     * Get if the (custom) cursor for a given gengrid item is being
9290     * searched in its theme, also, or is only relying on the rendering
9291     * engine.
9292     *
9293     * @param item a gengrid item
9294     * @return @c EINA_TRUE, if cursors are being looked for only on
9295     * those provided by the rendering engine, @c EINA_FALSE if they
9296     * are being searched on the widget's theme, as well.
9297     *
9298     * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9299     *
9300     * @ingroup Gengrid
9301     */
9302    EAPI Eina_Bool          elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9303
9304    /**
9305     * Remove all items from a given gengrid widget
9306     *
9307     * @param obj The gengrid object.
9308     *
9309     * This removes (and deletes) all items in @p obj, leaving it
9310     * empty.
9311     *
9312     * @see elm_gengrid_item_del(), to remove just one item.
9313     *
9314     * @ingroup Gengrid
9315     */
9316    EINA_DEPRECATED EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9317
9318    /**
9319     * Get the selected item in a given gengrid widget
9320     *
9321     * @param obj The gengrid object.
9322     * @return The selected item's handleor @c NULL, if none is
9323     * selected at the moment (and on errors)
9324     *
9325     * This returns the selected item in @p obj. If multi selection is
9326     * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9327     * the first item in the list is selected, which might not be very
9328     * useful. For that case, see elm_gengrid_selected_items_get().
9329     *
9330     * @ingroup Gengrid
9331     */
9332    EAPI Elm_Gengrid_Item  *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9333
9334    /**
9335     * Get <b>a list</b> of selected items in a given gengrid
9336     *
9337     * @param obj The gengrid object.
9338     * @return The list of selected items or @c NULL, if none is
9339     * selected at the moment (and on errors)
9340     *
9341     * This returns a list of the selected items, in the order that
9342     * they appear in the grid. This list is only valid as long as no
9343     * more items are selected or unselected (or unselected implictly
9344     * by deletion). The list contains #Elm_Gengrid_Item pointers as
9345     * data, naturally.
9346     *
9347     * @see elm_gengrid_selected_item_get()
9348     *
9349     * @ingroup Gengrid
9350     */
9351    EAPI const Eina_List   *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9352
9353    /**
9354     * @}
9355     */
9356
9357    /**
9358     * @defgroup Clock Clock
9359     *
9360     * @image html img/widget/clock/preview-00.png
9361     * @image latex img/widget/clock/preview-00.eps
9362     *
9363     * This is a @b digital clock widget. In its default theme, it has a
9364     * vintage "flipping numbers clock" appearance, which will animate
9365     * sheets of individual algarisms individually as time goes by.
9366     *
9367     * A newly created clock will fetch system's time (already
9368     * considering local time adjustments) to start with, and will tick
9369     * accondingly. It may or may not show seconds.
9370     *
9371     * Clocks have an @b edition mode. When in it, the sheets will
9372     * display extra arrow indications on the top and bottom and the
9373     * user may click on them to raise or lower the time values. After
9374     * it's told to exit edition mode, it will keep ticking with that
9375     * new time set (it keeps the difference from local time).
9376     *
9377     * Also, when under edition mode, user clicks on the cited arrows
9378     * which are @b held for some time will make the clock to flip the
9379     * sheet, thus editing the time, continuosly and automatically for
9380     * the user. The interval between sheet flips will keep growing in
9381     * time, so that it helps the user to reach a time which is distant
9382     * from the one set.
9383     *
9384     * The time display is, by default, in military mode (24h), but an
9385     * am/pm indicator may be optionally shown, too, when it will
9386     * switch to 12h.
9387     *
9388     * Smart callbacks one can register to:
9389     * - "changed" - the clock's user changed the time
9390     *
9391     * Here is an example on its usage:
9392     * @li @ref clock_example
9393     */
9394
9395    /**
9396     * @addtogroup Clock
9397     * @{
9398     */
9399
9400    /**
9401     * Identifiers for which clock digits should be editable, when a
9402     * clock widget is in edition mode. Values may be ORed together to
9403     * make a mask, naturally.
9404     *
9405     * @see elm_clock_edit_set()
9406     * @see elm_clock_digit_edit_set()
9407     */
9408    typedef enum _Elm_Clock_Digedit
9409      {
9410         ELM_CLOCK_NONE         = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9411         ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9412         ELM_CLOCK_HOUR_UNIT    = 1 << 1, /**< Unit algarism of hours value should be editable */
9413         ELM_CLOCK_MIN_DECIMAL  = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9414         ELM_CLOCK_MIN_UNIT     = 1 << 3, /**< Unit algarism of minutes value should be editable */
9415         ELM_CLOCK_SEC_DECIMAL  = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9416         ELM_CLOCK_SEC_UNIT     = 1 << 5, /**< Unit algarism of seconds value should be editable */
9417         ELM_CLOCK_ALL          = (1 << 6) - 1 /**< All digits should be editable */
9418      } Elm_Clock_Digedit;
9419
9420    /**
9421     * Add a new clock widget to the given parent Elementary
9422     * (container) object
9423     *
9424     * @param parent The parent object
9425     * @return a new clock widget handle or @c NULL, on errors
9426     *
9427     * This function inserts a new clock widget on the canvas.
9428     *
9429     * @ingroup Clock
9430     */
9431    EAPI Evas_Object      *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9432
9433    /**
9434     * Set a clock widget's time, programmatically
9435     *
9436     * @param obj The clock widget object
9437     * @param hrs The hours to set
9438     * @param min The minutes to set
9439     * @param sec The secondes to set
9440     *
9441     * This function updates the time that is showed by the clock
9442     * widget.
9443     *
9444     *  Values @b must be set within the following ranges:
9445     * - 0 - 23, for hours
9446     * - 0 - 59, for minutes
9447     * - 0 - 59, for seconds,
9448     *
9449     * even if the clock is not in "military" mode.
9450     *
9451     * @warning The behavior for values set out of those ranges is @b
9452     * indefined.
9453     *
9454     * @ingroup Clock
9455     */
9456    EAPI void              elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9457
9458    /**
9459     * Get a clock widget's time values
9460     *
9461     * @param obj The clock object
9462     * @param[out] hrs Pointer to the variable to get the hours value
9463     * @param[out] min Pointer to the variable to get the minutes value
9464     * @param[out] sec Pointer to the variable to get the seconds value
9465     *
9466     * This function gets the time set for @p obj, returning
9467     * it on the variables passed as the arguments to function
9468     *
9469     * @note Use @c NULL pointers on the time values you're not
9470     * interested in: they'll be ignored by the function.
9471     *
9472     * @ingroup Clock
9473     */
9474    EAPI void              elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9475
9476    /**
9477     * Set whether a given clock widget is under <b>edition mode</b> or
9478     * under (default) displaying-only mode.
9479     *
9480     * @param obj The clock object
9481     * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9482     * put it back to "displaying only" mode
9483     *
9484     * This function makes a clock's time to be editable or not <b>by
9485     * user interaction</b>. When in edition mode, clocks @b stop
9486     * ticking, until one brings them back to canonical mode. The
9487     * elm_clock_digit_edit_set() function will influence which digits
9488     * of the clock will be editable. By default, all of them will be
9489     * (#ELM_CLOCK_NONE).
9490     *
9491     * @note am/pm sheets, if being shown, will @b always be editable
9492     * under edition mode.
9493     *
9494     * @see elm_clock_edit_get()
9495     *
9496     * @ingroup Clock
9497     */
9498    EAPI void              elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9499
9500    /**
9501     * Retrieve whether a given clock widget is under <b>edition
9502     * mode</b> or under (default) displaying-only mode.
9503     *
9504     * @param obj The clock object
9505     * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9506     * otherwise
9507     *
9508     * This function retrieves whether the clock's time can be edited
9509     * or not by user interaction.
9510     *
9511     * @see elm_clock_edit_set() for more details
9512     *
9513     * @ingroup Clock
9514     */
9515    EAPI Eina_Bool         elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9516
9517    /**
9518     * Set what digits of the given clock widget should be editable
9519     * when in edition mode.
9520     *
9521     * @param obj The clock object
9522     * @param digedit Bit mask indicating the digits to be editable
9523     * (values in #Elm_Clock_Digedit).
9524     *
9525     * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9526     * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9527     * EINA_FALSE).
9528     *
9529     * @see elm_clock_digit_edit_get()
9530     *
9531     * @ingroup Clock
9532     */
9533    EAPI void              elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9534
9535    /**
9536     * Retrieve what digits of the given clock widget should be
9537     * editable when in edition mode.
9538     *
9539     * @param obj The clock object
9540     * @return Bit mask indicating the digits to be editable
9541     * (values in #Elm_Clock_Digedit).
9542     *
9543     * @see elm_clock_digit_edit_set() for more details
9544     *
9545     * @ingroup Clock
9546     */
9547    EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9548
9549    /**
9550     * Set if the given clock widget must show hours in military or
9551     * am/pm mode
9552     *
9553     * @param obj The clock object
9554     * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9555     * to military mode
9556     *
9557     * This function sets if the clock must show hours in military or
9558     * am/pm mode. In some countries like Brazil the military mode
9559     * (00-24h-format) is used, in opposition to the USA, where the
9560     * am/pm mode is more commonly used.
9561     *
9562     * @see elm_clock_show_am_pm_get()
9563     *
9564     * @ingroup Clock
9565     */
9566    EAPI void              elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9567
9568    /**
9569     * Get if the given clock widget shows hours in military or am/pm
9570     * mode
9571     *
9572     * @param obj The clock object
9573     * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9574     * military
9575     *
9576     * This function gets if the clock shows hours in military or am/pm
9577     * mode.
9578     *
9579     * @see elm_clock_show_am_pm_set() for more details
9580     *
9581     * @ingroup Clock
9582     */
9583    EAPI Eina_Bool         elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9584
9585    /**
9586     * Set if the given clock widget must show time with seconds or not
9587     *
9588     * @param obj The clock object
9589     * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9590     *
9591     * This function sets if the given clock must show or not elapsed
9592     * seconds. By default, they are @b not shown.
9593     *
9594     * @see elm_clock_show_seconds_get()
9595     *
9596     * @ingroup Clock
9597     */
9598    EAPI void              elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9599
9600    /**
9601     * Get whether the given clock widget is showing time with seconds
9602     * or not
9603     *
9604     * @param obj The clock object
9605     * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9606     *
9607     * This function gets whether @p obj is showing or not the elapsed
9608     * seconds.
9609     *
9610     * @see elm_clock_show_seconds_set()
9611     *
9612     * @ingroup Clock
9613     */
9614    EAPI Eina_Bool         elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9615
9616    /**
9617     * Set the interval on time updates for an user mouse button hold
9618     * on clock widgets' time edition.
9619     *
9620     * @param obj The clock object
9621     * @param interval The (first) interval value in seconds
9622     *
9623     * This interval value is @b decreased while the user holds the
9624     * mouse pointer either incrementing or decrementing a given the
9625     * clock digit's value.
9626     *
9627     * This helps the user to get to a given time distant from the
9628     * current one easier/faster, as it will start to flip quicker and
9629     * quicker on mouse button holds.
9630     *
9631     * The calculation for the next flip interval value, starting from
9632     * the one set with this call, is the previous interval divided by
9633     * 1.05, so it decreases a little bit.
9634     *
9635     * The default starting interval value for automatic flips is
9636     * @b 0.85 seconds.
9637     *
9638     * @see elm_clock_interval_get()
9639     *
9640     * @ingroup Clock
9641     */
9642    EAPI void              elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9643
9644    /**
9645     * Get the interval on time updates for an user mouse button hold
9646     * on clock widgets' time edition.
9647     *
9648     * @param obj The clock object
9649     * @return The (first) interval value, in seconds, set on it
9650     *
9651     * @see elm_clock_interval_set() for more details
9652     *
9653     * @ingroup Clock
9654     */
9655    EAPI double            elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9656
9657    /**
9658     * @}
9659     */
9660
9661    /**
9662     * @defgroup Layout Layout
9663     *
9664     * @image html img/widget/layout/preview-00.png
9665     * @image latex img/widget/layout/preview-00.eps width=\textwidth
9666     *
9667     * @image html img/layout-predefined.png
9668     * @image latex img/layout-predefined.eps width=\textwidth
9669     *
9670     * This is a container widget that takes a standard Edje design file and
9671     * wraps it very thinly in a widget.
9672     *
9673     * An Edje design (theme) file has a very wide range of possibilities to
9674     * describe the behavior of elements added to the Layout. Check out the Edje
9675     * documentation and the EDC reference to get more information about what can
9676     * be done with Edje.
9677     *
9678     * Just like @ref List, @ref Box, and other container widgets, any
9679     * object added to the Layout will become its child, meaning that it will be
9680     * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9681     *
9682     * The Layout widget can contain as many Contents, Boxes or Tables as
9683     * described in its theme file. For instance, objects can be added to
9684     * different Tables by specifying the respective Table part names. The same
9685     * is valid for Content and Box.
9686     *
9687     * The objects added as child of the Layout will behave as described in the
9688     * part description where they were added. There are 3 possible types of
9689     * parts where a child can be added:
9690     *
9691     * @section secContent Content (SWALLOW part)
9692     *
9693     * Only one object can be added to the @c SWALLOW part (but you still can
9694     * have many @c SWALLOW parts and one object on each of them). Use the @c
9695     * elm_layout_content_* set of functions to set, retrieve and unset objects
9696     * as content of the @c SWALLOW. After being set to this part, the object
9697     * size, position, visibility, clipping and other description properties
9698     * will be totally controled by the description of the given part (inside
9699     * the Edje theme file).
9700     *
9701     * One can use @c evas_object_size_hint_* functions on the child to have some
9702     * kind of control over its behavior, but the resulting behavior will still
9703     * depend heavily on the @c SWALLOW part description.
9704     *
9705     * The Edje theme also can change the part description, based on signals or
9706     * scripts running inside the theme. This change can also be animated. All of
9707     * this will affect the child object set as content accordingly. The object
9708     * size will be changed if the part size is changed, it will animate move if
9709     * the part is moving, and so on.
9710     *
9711     * The following picture demonstrates a Layout widget with a child object
9712     * added to its @c SWALLOW:
9713     *
9714     * @image html layout_swallow.png
9715     * @image latex layout_swallow.eps width=\textwidth
9716     *
9717     * @section secBox Box (BOX part)
9718     *
9719     * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9720     * allows one to add objects to the box and have them distributed along its
9721     * area, accordingly to the specified @a layout property (now by @a layout we
9722     * mean the chosen layouting design of the Box, not the Layout widget
9723     * itself).
9724     *
9725     * A similar effect for having a box with its position, size and other things
9726     * controled by the Layout theme would be to create an Elementary @ref Box
9727     * widget and add it as a Content in the @c SWALLOW part.
9728     *
9729     * The main difference of using the Layout Box is that its behavior, the box
9730     * properties like layouting format, padding, align, etc. will be all
9731     * controled by the theme. This means, for example, that a signal could be
9732     * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9733     * handled the signal by changing the box padding, or align, or both. Using
9734     * the Elementary @ref Box widget is not necessarily harder or easier, it
9735     * just depends on the circunstances and requirements.
9736     *
9737     * The Layout Box can be used through the @c elm_layout_box_* set of
9738     * functions.
9739     *
9740     * The following picture demonstrates a Layout widget with many child objects
9741     * added to its @c BOX part:
9742     *
9743     * @image html layout_box.png
9744     * @image latex layout_box.eps width=\textwidth
9745     *
9746     * @section secTable Table (TABLE part)
9747     *
9748     * Just like the @ref secBox, the Layout Table is very similar to the
9749     * Elementary @ref Table widget. It allows one to add objects to the Table
9750     * specifying the row and column where the object should be added, and any
9751     * column or row span if necessary.
9752     *
9753     * Again, we could have this design by adding a @ref Table widget to the @c
9754     * SWALLOW part using elm_layout_content_set(). The same difference happens
9755     * here when choosing to use the Layout Table (a @c TABLE part) instead of
9756     * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9757     *
9758     * The Layout Table can be used through the @c elm_layout_table_* set of
9759     * functions.
9760     *
9761     * The following picture demonstrates a Layout widget with many child objects
9762     * added to its @c TABLE part:
9763     *
9764     * @image html layout_table.png
9765     * @image latex layout_table.eps width=\textwidth
9766     *
9767     * @section secPredef Predefined Layouts
9768     *
9769     * Another interesting thing about the Layout widget is that it offers some
9770     * predefined themes that come with the default Elementary theme. These
9771     * themes can be set by the call elm_layout_theme_set(), and provide some
9772     * basic functionality depending on the theme used.
9773     *
9774     * Most of them already send some signals, some already provide a toolbar or
9775     * back and next buttons.
9776     *
9777     * These are available predefined theme layouts. All of them have class = @c
9778     * layout, group = @c application, and style = one of the following options:
9779     *
9780     * @li @c toolbar-content - application with toolbar and main content area
9781     * @li @c toolbar-content-back - application with toolbar and main content
9782     * area with a back button and title area
9783     * @li @c toolbar-content-back-next - application with toolbar and main
9784     * content area with a back and next buttons and title area
9785     * @li @c content-back - application with a main content area with a back
9786     * button and title area
9787     * @li @c content-back-next - application with a main content area with a
9788     * back and next buttons and title area
9789     * @li @c toolbar-vbox - application with toolbar and main content area as a
9790     * vertical box
9791     * @li @c toolbar-table - application with toolbar and main content area as a
9792     * table
9793     *
9794     * @section secExamples Examples
9795     *
9796     * Some examples of the Layout widget can be found here:
9797     * @li @ref layout_example_01
9798     * @li @ref layout_example_02
9799     * @li @ref layout_example_03
9800     * @li @ref layout_example_edc
9801     *
9802     */
9803
9804    /**
9805     * Add a new layout to the parent
9806     *
9807     * @param parent The parent object
9808     * @return The new object or NULL if it cannot be created
9809     *
9810     * @see elm_layout_file_set()
9811     * @see elm_layout_theme_set()
9812     *
9813     * @ingroup Layout
9814     */
9815    EAPI Evas_Object       *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9816    /**
9817     * Set the file that will be used as layout
9818     *
9819     * @param obj The layout object
9820     * @param file The path to file (edj) that will be used as layout
9821     * @param group The group that the layout belongs in edje file
9822     *
9823     * @return (1 = success, 0 = error)
9824     *
9825     * @ingroup Layout
9826     */
9827    EAPI Eina_Bool          elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9828    /**
9829     * Set the edje group from the elementary theme that will be used as layout
9830     *
9831     * @param obj The layout object
9832     * @param clas the clas of the group
9833     * @param group the group
9834     * @param style the style to used
9835     *
9836     * @return (1 = success, 0 = error)
9837     *
9838     * @ingroup Layout
9839     */
9840    EAPI Eina_Bool          elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9841    /**
9842     * Set the layout content.
9843     *
9844     * @param obj The layout object
9845     * @param swallow The swallow part name in the edje file
9846     * @param content The child that will be added in this layout object
9847     *
9848     * Once the content object is set, a previously set one will be deleted.
9849     * If you want to keep that old content object, use the
9850     * elm_layout_content_unset() function.
9851     *
9852     * @note In an Edje theme, the part used as a content container is called @c
9853     * SWALLOW. This is why the parameter name is called @p swallow, but it is
9854     * expected to be a part name just like the second parameter of
9855     * elm_layout_box_append().
9856     *
9857     * @see elm_layout_box_append()
9858     * @see elm_layout_content_get()
9859     * @see elm_layout_content_unset()
9860     * @see @ref secBox
9861     *
9862     * @ingroup Layout
9863     */
9864    EAPI void               elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9865    /**
9866     * Get the child object in the given content part.
9867     *
9868     * @param obj The layout object
9869     * @param swallow The SWALLOW part to get its content
9870     *
9871     * @return The swallowed object or NULL if none or an error occurred
9872     *
9873     * @see elm_layout_content_set()
9874     *
9875     * @ingroup Layout
9876     */
9877    EAPI Evas_Object       *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9878    /**
9879     * Unset the layout content.
9880     *
9881     * @param obj The layout object
9882     * @param swallow The swallow part name in the edje file
9883     * @return The content that was being used
9884     *
9885     * Unparent and return the content object which was set for this part.
9886     *
9887     * @see elm_layout_content_set()
9888     *
9889     * @ingroup Layout
9890     */
9891     EAPI Evas_Object       *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9892    /**
9893     * Set the text of the given part
9894     *
9895     * @param obj The layout object
9896     * @param part The TEXT part where to set the text
9897     * @param text The text to set
9898     *
9899     * @ingroup Layout
9900     * @deprecated use elm_object_text_* instead.
9901     */
9902    EINA_DEPRECATED EAPI void               elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9903    /**
9904     * Get the text set in the given part
9905     *
9906     * @param obj The layout object
9907     * @param part The TEXT part to retrieve the text off
9908     *
9909     * @return The text set in @p part
9910     *
9911     * @ingroup Layout
9912     * @deprecated use elm_object_text_* instead.
9913     */
9914    EINA_DEPRECATED EAPI const char        *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9915    /**
9916     * Append child to layout box part.
9917     *
9918     * @param obj the layout object
9919     * @param part the box part to which the object will be appended.
9920     * @param child the child object to append to box.
9921     *
9922     * Once the object is appended, it will become child of the layout. Its
9923     * lifetime will be bound to the layout, whenever the layout dies the child
9924     * will be deleted automatically. One should use elm_layout_box_remove() to
9925     * make this layout forget about the object.
9926     *
9927     * @see elm_layout_box_prepend()
9928     * @see elm_layout_box_insert_before()
9929     * @see elm_layout_box_insert_at()
9930     * @see elm_layout_box_remove()
9931     *
9932     * @ingroup Layout
9933     */
9934    EAPI void               elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9935    /**
9936     * Prepend child to layout box part.
9937     *
9938     * @param obj the layout object
9939     * @param part the box part to prepend.
9940     * @param child the child object to prepend to box.
9941     *
9942     * Once the object is prepended, it will become child of the layout. Its
9943     * lifetime will be bound to the layout, whenever the layout dies the child
9944     * will be deleted automatically. One should use elm_layout_box_remove() to
9945     * make this layout forget about the object.
9946     *
9947     * @see elm_layout_box_append()
9948     * @see elm_layout_box_insert_before()
9949     * @see elm_layout_box_insert_at()
9950     * @see elm_layout_box_remove()
9951     *
9952     * @ingroup Layout
9953     */
9954    EAPI void               elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9955    /**
9956     * Insert child to layout box part before a reference object.
9957     *
9958     * @param obj the layout object
9959     * @param part the box part to insert.
9960     * @param child the child object to insert into box.
9961     * @param reference another reference object to insert before in box.
9962     *
9963     * Once the object is inserted, it will become child of the layout. Its
9964     * lifetime will be bound to the layout, whenever the layout dies the child
9965     * will be deleted automatically. One should use elm_layout_box_remove() to
9966     * make this layout forget about the object.
9967     *
9968     * @see elm_layout_box_append()
9969     * @see elm_layout_box_prepend()
9970     * @see elm_layout_box_insert_before()
9971     * @see elm_layout_box_remove()
9972     *
9973     * @ingroup Layout
9974     */
9975    EAPI void               elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
9976    /**
9977     * Insert child to layout box part at a given position.
9978     *
9979     * @param obj the layout object
9980     * @param part the box part to insert.
9981     * @param child the child object to insert into box.
9982     * @param pos the numeric position >=0 to insert the child.
9983     *
9984     * Once the object is inserted, it will become child of the layout. Its
9985     * lifetime will be bound to the layout, whenever the layout dies the child
9986     * will be deleted automatically. One should use elm_layout_box_remove() to
9987     * make this layout forget about the object.
9988     *
9989     * @see elm_layout_box_append()
9990     * @see elm_layout_box_prepend()
9991     * @see elm_layout_box_insert_before()
9992     * @see elm_layout_box_remove()
9993     *
9994     * @ingroup Layout
9995     */
9996    EAPI void               elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
9997    /**
9998     * Remove a child of the given part box.
9999     *
10000     * @param obj The layout object
10001     * @param part The box part name to remove child.
10002     * @param child The object to remove from box.
10003     * @return The object that was being used, or NULL if not found.
10004     *
10005     * The object will be removed from the box part and its lifetime will
10006     * not be handled by the layout anymore. This is equivalent to
10007     * elm_layout_content_unset() for box.
10008     *
10009     * @see elm_layout_box_append()
10010     * @see elm_layout_box_remove_all()
10011     *
10012     * @ingroup Layout
10013     */
10014    EAPI Evas_Object       *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
10015    /**
10016     * Remove all child of the given part box.
10017     *
10018     * @param obj The layout object
10019     * @param part The box part name to remove child.
10020     * @param clear If EINA_TRUE, then all objects will be deleted as
10021     *        well, otherwise they will just be removed and will be
10022     *        dangling on the canvas.
10023     *
10024     * The objects will be removed from the box part and their lifetime will
10025     * not be handled by the layout anymore. This is equivalent to
10026     * elm_layout_box_remove() for all box children.
10027     *
10028     * @see elm_layout_box_append()
10029     * @see elm_layout_box_remove()
10030     *
10031     * @ingroup Layout
10032     */
10033    EAPI void               elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10034    /**
10035     * Insert child to layout table part.
10036     *
10037     * @param obj the layout object
10038     * @param part the box part to pack child.
10039     * @param child_obj the child object to pack into table.
10040     * @param col the column to which the child should be added. (>= 0)
10041     * @param row the row to which the child should be added. (>= 0)
10042     * @param colspan how many columns should be used to store this object. (>=
10043     *        1)
10044     * @param rowspan how many rows should be used to store this object. (>= 1)
10045     *
10046     * Once the object is inserted, it will become child of the table. Its
10047     * lifetime will be bound to the layout, and whenever the layout dies the
10048     * child will be deleted automatically. One should use
10049     * elm_layout_table_remove() to make this layout forget about the object.
10050     *
10051     * If @p colspan or @p rowspan are bigger than 1, that object will occupy
10052     * more space than a single cell. For instance, the following code:
10053     * @code
10054     * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
10055     * @endcode
10056     *
10057     * Would result in an object being added like the following picture:
10058     *
10059     * @image html layout_colspan.png
10060     * @image latex layout_colspan.eps width=\textwidth
10061     *
10062     * @see elm_layout_table_unpack()
10063     * @see elm_layout_table_clear()
10064     *
10065     * @ingroup Layout
10066     */
10067    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);
10068    /**
10069     * Unpack (remove) a child of the given part table.
10070     *
10071     * @param obj The layout object
10072     * @param part The table part name to remove child.
10073     * @param child_obj The object to remove from table.
10074     * @return The object that was being used, or NULL if not found.
10075     *
10076     * The object will be unpacked from the table part and its lifetime
10077     * will not be handled by the layout anymore. This is equivalent to
10078     * elm_layout_content_unset() for table.
10079     *
10080     * @see elm_layout_table_pack()
10081     * @see elm_layout_table_clear()
10082     *
10083     * @ingroup Layout
10084     */
10085    EAPI Evas_Object       *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
10086    /**
10087     * Remove all child of the given part table.
10088     *
10089     * @param obj The layout object
10090     * @param part The table part name to remove child.
10091     * @param clear If EINA_TRUE, then all objects will be deleted as
10092     *        well, otherwise they will just be removed and will be
10093     *        dangling on the canvas.
10094     *
10095     * The objects will be removed from the table part and their lifetime will
10096     * not be handled by the layout anymore. This is equivalent to
10097     * elm_layout_table_unpack() for all table children.
10098     *
10099     * @see elm_layout_table_pack()
10100     * @see elm_layout_table_unpack()
10101     *
10102     * @ingroup Layout
10103     */
10104    EAPI void               elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10105    /**
10106     * Get the edje layout
10107     *
10108     * @param obj The layout object
10109     *
10110     * @return A Evas_Object with the edje layout settings loaded
10111     * with function elm_layout_file_set
10112     *
10113     * This returns the edje object. It is not expected to be used to then
10114     * swallow objects via edje_object_part_swallow() for example. Use
10115     * elm_layout_content_set() instead so child object handling and sizing is
10116     * done properly.
10117     *
10118     * @note This function should only be used if you really need to call some
10119     * low level Edje function on this edje object. All the common stuff (setting
10120     * text, emitting signals, hooking callbacks to signals, etc.) can be done
10121     * with proper elementary functions.
10122     *
10123     * @see elm_object_signal_callback_add()
10124     * @see elm_object_signal_emit()
10125     * @see elm_object_text_part_set()
10126     * @see elm_layout_content_set()
10127     * @see elm_layout_box_append()
10128     * @see elm_layout_table_pack()
10129     * @see elm_layout_data_get()
10130     *
10131     * @ingroup Layout
10132     */
10133    EAPI Evas_Object       *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10134    /**
10135     * Get the edje data from the given layout
10136     *
10137     * @param obj The layout object
10138     * @param key The data key
10139     *
10140     * @return The edje data string
10141     *
10142     * This function fetches data specified inside the edje theme of this layout.
10143     * This function return NULL if data is not found.
10144     *
10145     * In EDC this comes from a data block within the group block that @p
10146     * obj was loaded from. E.g.
10147     *
10148     * @code
10149     * collections {
10150     *   group {
10151     *     name: "a_group";
10152     *     data {
10153     *       item: "key1" "value1";
10154     *       item: "key2" "value2";
10155     *     }
10156     *   }
10157     * }
10158     * @endcode
10159     *
10160     * @ingroup Layout
10161     */
10162    EAPI const char        *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10163    /**
10164     * Eval sizing
10165     *
10166     * @param obj The layout object
10167     *
10168     * Manually forces a sizing re-evaluation. This is useful when the minimum
10169     * size required by the edje theme of this layout has changed. The change on
10170     * the minimum size required by the edje theme is not immediately reported to
10171     * the elementary layout, so one needs to call this function in order to tell
10172     * the widget (layout) that it needs to reevaluate its own size.
10173     *
10174     * The minimum size of the theme is calculated based on minimum size of
10175     * parts, the size of elements inside containers like box and table, etc. All
10176     * of this can change due to state changes, and that's when this function
10177     * should be called.
10178     *
10179     * Also note that a standard signal of "size,eval" "elm" emitted from the
10180     * edje object will cause this to happen too.
10181     *
10182     * @ingroup Layout
10183     */
10184    EAPI void               elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10185
10186    /**
10187     * Sets a specific cursor for an edje part.
10188     *
10189     * @param obj The layout object.
10190     * @param part_name a part from loaded edje group.
10191     * @param cursor cursor name to use, see Elementary_Cursor.h
10192     *
10193     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10194     *         part not exists or it has "mouse_events: 0".
10195     *
10196     * @ingroup Layout
10197     */
10198    EAPI Eina_Bool          elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10199
10200    /**
10201     * Get the cursor to be shown when mouse is over an edje part
10202     *
10203     * @param obj The layout object.
10204     * @param part_name a part from loaded edje group.
10205     * @return the cursor name.
10206     *
10207     * @ingroup Layout
10208     */
10209    EAPI const char        *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10210
10211    /**
10212     * Unsets a cursor previously set with elm_layout_part_cursor_set().
10213     *
10214     * @param obj The layout object.
10215     * @param part_name a part from loaded edje group, that had a cursor set
10216     *        with elm_layout_part_cursor_set().
10217     *
10218     * @ingroup Layout
10219     */
10220    EAPI void               elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10221
10222    /**
10223     * Sets a specific cursor style for an edje part.
10224     *
10225     * @param obj The layout object.
10226     * @param part_name a part from loaded edje group.
10227     * @param style the theme style to use (default, transparent, ...)
10228     *
10229     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10230     *         part not exists or it did not had a cursor set.
10231     *
10232     * @ingroup Layout
10233     */
10234    EAPI Eina_Bool          elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10235
10236    /**
10237     * Gets a specific cursor style for an edje part.
10238     *
10239     * @param obj The layout object.
10240     * @param part_name a part from loaded edje group.
10241     *
10242     * @return the theme style in use, defaults to "default". If the
10243     *         object does not have a cursor set, then NULL is returned.
10244     *
10245     * @ingroup Layout
10246     */
10247    EAPI const char        *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10248
10249    /**
10250     * Sets if the cursor set should be searched on the theme or should use
10251     * the provided by the engine, only.
10252     *
10253     * @note before you set if should look on theme you should define a
10254     * cursor with elm_layout_part_cursor_set(). By default it will only
10255     * look for cursors provided by the engine.
10256     *
10257     * @param obj The layout object.
10258     * @param part_name a part from loaded edje group.
10259     * @param engine_only if cursors should be just provided by the engine
10260     *        or should also search on widget's theme as well
10261     *
10262     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10263     *         part not exists or it did not had a cursor set.
10264     *
10265     * @ingroup Layout
10266     */
10267    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);
10268
10269    /**
10270     * Gets a specific cursor engine_only for an edje part.
10271     *
10272     * @param obj The layout object.
10273     * @param part_name a part from loaded edje group.
10274     *
10275     * @return whenever the cursor is just provided by engine or also from theme.
10276     *
10277     * @ingroup Layout
10278     */
10279    EAPI Eina_Bool          elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10280
10281 /**
10282  * @def elm_layout_icon_set
10283  * Convienience macro to set the icon object in a layout that follows the
10284  * Elementary naming convention for its parts.
10285  *
10286  * @ingroup Layout
10287  */
10288 #define elm_layout_icon_set(_ly, _obj) \
10289   do { \
10290     const char *sig; \
10291     elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
10292     if ((_obj)) sig = "elm,state,icon,visible"; \
10293     else sig = "elm,state,icon,hidden"; \
10294     elm_object_signal_emit((_ly), sig, "elm"); \
10295   } while (0)
10296
10297 /**
10298  * @def elm_layout_icon_get
10299  * Convienience macro to get the icon object from a layout that follows the
10300  * Elementary naming convention for its parts.
10301  *
10302  * @ingroup Layout
10303  */
10304 #define elm_layout_icon_get(_ly) \
10305   elm_layout_content_get((_ly), "elm.swallow.icon")
10306
10307 /**
10308  * @def elm_layout_end_set
10309  * Convienience macro to set the end object in a layout that follows the
10310  * Elementary naming convention for its parts.
10311  *
10312  * @ingroup Layout
10313  */
10314 #define elm_layout_end_set(_ly, _obj) \
10315   do { \
10316     const char *sig; \
10317     elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
10318     if ((_obj)) sig = "elm,state,end,visible"; \
10319     else sig = "elm,state,end,hidden"; \
10320     elm_object_signal_emit((_ly), sig, "elm"); \
10321   } while (0)
10322
10323 /**
10324  * @def elm_layout_end_get
10325  * Convienience macro to get the end object in a layout that follows the
10326  * Elementary naming convention for its parts.
10327  *
10328  * @ingroup Layout
10329  */
10330 #define elm_layout_end_get(_ly) \
10331   elm_layout_content_get((_ly), "elm.swallow.end")
10332
10333 /**
10334  * @def elm_layout_label_set
10335  * Convienience macro to set the label in a layout that follows the
10336  * Elementary naming convention for its parts.
10337  *
10338  * @ingroup Layout
10339  * @deprecated use elm_object_text_* instead.
10340  */
10341 #define elm_layout_label_set(_ly, _txt) \
10342   elm_layout_text_set((_ly), "elm.text", (_txt))
10343
10344 /**
10345  * @def elm_layout_label_get
10346  * Convienience macro to get the label in a layout that follows the
10347  * Elementary naming convention for its parts.
10348  *
10349  * @ingroup Layout
10350  * @deprecated use elm_object_text_* instead.
10351  */
10352 #define elm_layout_label_get(_ly) \
10353   elm_layout_text_get((_ly), "elm.text")
10354
10355    /* smart callbacks called:
10356     * "theme,changed" - when elm theme is changed.
10357     */
10358
10359    /**
10360     * @defgroup Notify Notify
10361     *
10362     * @image html img/widget/notify/preview-00.png
10363     * @image latex img/widget/notify/preview-00.eps
10364     *
10365     * Display a container in a particular region of the parent(top, bottom,
10366     * etc.  A timeout can be set to automatically hide the notify. This is so
10367     * that, after an evas_object_show() on a notify object, if a timeout was set
10368     * on it, it will @b automatically get hidden after that time.
10369     *
10370     * Signals that you can add callbacks for are:
10371     * @li "timeout" - when timeout happens on notify and it's hidden
10372     * @li "block,clicked" - when a click outside of the notify happens
10373     *
10374     * @ref tutorial_notify show usage of the API.
10375     *
10376     * @{
10377     */
10378    /**
10379     * @brief Possible orient values for notify.
10380     *
10381     * This values should be used in conjunction to elm_notify_orient_set() to
10382     * set the position in which the notify should appear(relative to its parent)
10383     * and in conjunction with elm_notify_orient_get() to know where the notify
10384     * is appearing.
10385     */
10386    typedef enum _Elm_Notify_Orient
10387      {
10388         ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10389         ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10390         ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10391         ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10392         ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10393         ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10394         ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10395         ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10396         ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10397         ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10398      } Elm_Notify_Orient;
10399    /**
10400     * @brief Add a new notify to the parent
10401     *
10402     * @param parent The parent object
10403     * @return The new object or NULL if it cannot be created
10404     */
10405    EAPI Evas_Object      *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10406    /**
10407     * @brief Set the content of the notify widget
10408     *
10409     * @param obj The notify object
10410     * @param content The content will be filled in this notify object
10411     *
10412     * Once the content object is set, a previously set one will be deleted. If
10413     * you want to keep that old content object, use the
10414     * elm_notify_content_unset() function.
10415     */
10416    EAPI void              elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10417    /**
10418     * @brief Unset the content of the notify widget
10419     *
10420     * @param obj The notify object
10421     * @return The content that was being used
10422     *
10423     * Unparent and return the content object which was set for this widget
10424     *
10425     * @see elm_notify_content_set()
10426     */
10427    EAPI Evas_Object      *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10428    /**
10429     * @brief Return the content of the notify widget
10430     *
10431     * @param obj The notify object
10432     * @return The content that is being used
10433     *
10434     * @see elm_notify_content_set()
10435     */
10436    EAPI Evas_Object      *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10437    /**
10438     * @brief Set the notify parent
10439     *
10440     * @param obj The notify object
10441     * @param content The new parent
10442     *
10443     * Once the parent object is set, a previously set one will be disconnected
10444     * and replaced.
10445     */
10446    EAPI void              elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10447    /**
10448     * @brief Get the notify parent
10449     *
10450     * @param obj The notify object
10451     * @return The parent
10452     *
10453     * @see elm_notify_parent_set()
10454     */
10455    EAPI Evas_Object      *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10456    /**
10457     * @brief Set the orientation
10458     *
10459     * @param obj The notify object
10460     * @param orient The new orientation
10461     *
10462     * Sets the position in which the notify will appear in its parent.
10463     *
10464     * @see @ref Elm_Notify_Orient for possible values.
10465     */
10466    EAPI void              elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10467    /**
10468     * @brief Return the orientation
10469     * @param obj The notify object
10470     * @return The orientation of the notification
10471     *
10472     * @see elm_notify_orient_set()
10473     * @see Elm_Notify_Orient
10474     */
10475    EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10476    /**
10477     * @brief Set the time interval after which the notify window is going to be
10478     * hidden.
10479     *
10480     * @param obj The notify object
10481     * @param time The timeout in seconds
10482     *
10483     * This function sets a timeout and starts the timer controlling when the
10484     * notify is hidden. Since calling evas_object_show() on a notify restarts
10485     * the timer controlling when the notify is hidden, setting this before the
10486     * notify is shown will in effect mean starting the timer when the notify is
10487     * shown.
10488     *
10489     * @note Set a value <= 0.0 to disable a running timer.
10490     *
10491     * @note If the value > 0.0 and the notify is previously visible, the
10492     * timer will be started with this value, canceling any running timer.
10493     */
10494    EAPI void              elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10495    /**
10496     * @brief Return the timeout value (in seconds)
10497     * @param obj the notify object
10498     *
10499     * @see elm_notify_timeout_set()
10500     */
10501    EAPI double            elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10502    /**
10503     * @brief Sets whether events should be passed to by a click outside
10504     * its area.
10505     *
10506     * @param obj The notify object
10507     * @param repeats EINA_TRUE Events are repeats, else no
10508     *
10509     * When true if the user clicks outside the window the events will be caught
10510     * by the others widgets, else the events are blocked.
10511     *
10512     * @note The default value is EINA_TRUE.
10513     */
10514    EAPI void              elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10515    /**
10516     * @brief Return true if events are repeat below the notify object
10517     * @param obj the notify object
10518     *
10519     * @see elm_notify_repeat_events_set()
10520     */
10521    EAPI Eina_Bool         elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10522    /**
10523     * @}
10524     */
10525
10526    /**
10527     * @defgroup Hover Hover
10528     *
10529     * @image html img/widget/hover/preview-00.png
10530     * @image latex img/widget/hover/preview-00.eps
10531     *
10532     * A Hover object will hover over its @p parent object at the @p target
10533     * location. Anything in the background will be given a darker coloring to
10534     * indicate that the hover object is on top (at the default theme). When the
10535     * hover is clicked it is dismissed(hidden), if the contents of the hover are
10536     * clicked that @b doesn't cause the hover to be dismissed.
10537     *
10538     * A Hover object has two parents. One parent that owns it during creation
10539     * and the other parent being the one over which the hover object spans.
10540     *
10541     *
10542     * @note The hover object will take up the entire space of @p target
10543     * object.
10544     *
10545     * Elementary has the following styles for the hover widget:
10546     * @li default
10547     * @li popout
10548     * @li menu
10549     * @li hoversel_vertical
10550     *
10551     * The following are the available position for content:
10552     * @li left
10553     * @li top-left
10554     * @li top
10555     * @li top-right
10556     * @li right
10557     * @li bottom-right
10558     * @li bottom
10559     * @li bottom-left
10560     * @li middle
10561     * @li smart
10562     *
10563     * Signals that you can add callbacks for are:
10564     * @li "clicked" - the user clicked the empty space in the hover to dismiss
10565     * @li "smart,changed" - a content object placed under the "smart"
10566     *                   policy was replaced to a new slot direction.
10567     *
10568     * See @ref tutorial_hover for more information.
10569     *
10570     * @{
10571     */
10572    typedef enum _Elm_Hover_Axis
10573      {
10574         ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10575         ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10576         ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10577         ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10578      } Elm_Hover_Axis;
10579    /**
10580     * @brief Adds a hover object to @p parent
10581     *
10582     * @param parent The parent object
10583     * @return The hover object or NULL if one could not be created
10584     */
10585    EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10586    /**
10587     * @brief Sets the target object for the hover.
10588     *
10589     * @param obj The hover object
10590     * @param target The object to center the hover onto. The hover
10591     *
10592     * This function will cause the hover to be centered on the target object.
10593     */
10594    EAPI void         elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10595    /**
10596     * @brief Gets the target object for the hover.
10597     *
10598     * @param obj The hover object
10599     * @param parent The object to locate the hover over.
10600     *
10601     * @see elm_hover_target_set()
10602     */
10603    EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10604    /**
10605     * @brief Sets the parent object for the hover.
10606     *
10607     * @param obj The hover object
10608     * @param parent The object to locate the hover over.
10609     *
10610     * This function will cause the hover to take up the entire space that the
10611     * parent object fills.
10612     */
10613    EAPI void         elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10614    /**
10615     * @brief Gets the parent object for the hover.
10616     *
10617     * @param obj The hover object
10618     * @return The parent object to locate the hover over.
10619     *
10620     * @see elm_hover_parent_set()
10621     */
10622    EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10623    /**
10624     * @brief Sets the content of the hover object and the direction in which it
10625     * will pop out.
10626     *
10627     * @param obj The hover object
10628     * @param swallow The direction that the object will be displayed
10629     * at. Accepted values are "left", "top-left", "top", "top-right",
10630     * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10631     * "smart".
10632     * @param content The content to place at @p swallow
10633     *
10634     * Once the content object is set for a given direction, a previously
10635     * set one (on the same direction) will be deleted. If you want to
10636     * keep that old content object, use the elm_hover_content_unset()
10637     * function.
10638     *
10639     * All directions may have contents at the same time, except for
10640     * "smart". This is a special placement hint and its use case
10641     * independs of the calculations coming from
10642     * elm_hover_best_content_location_get(). Its use is for cases when
10643     * one desires only one hover content, but with a dinamic special
10644     * placement within the hover area. The content's geometry, whenever
10645     * it changes, will be used to decide on a best location not
10646     * extrapolating the hover's parent object view to show it in (still
10647     * being the hover's target determinant of its medium part -- move and
10648     * resize it to simulate finger sizes, for example). If one of the
10649     * directions other than "smart" are used, a previously content set
10650     * using it will be deleted, and vice-versa.
10651     */
10652    EAPI void         elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10653    /**
10654     * @brief Get the content of the hover object, in a given direction.
10655     *
10656     * Return the content object which was set for this widget in the
10657     * @p swallow direction.
10658     *
10659     * @param obj The hover object
10660     * @param swallow The direction that the object was display at.
10661     * @return The content that was being used
10662     *
10663     * @see elm_hover_content_set()
10664     */
10665    EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10666    /**
10667     * @brief Unset the content of the hover object, in a given direction.
10668     *
10669     * Unparent and return the content object set at @p swallow direction.
10670     *
10671     * @param obj The hover object
10672     * @param swallow The direction that the object was display at.
10673     * @return The content that was being used.
10674     *
10675     * @see elm_hover_content_set()
10676     */
10677    EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10678    /**
10679     * @brief Returns the best swallow location for content in the hover.
10680     *
10681     * @param obj The hover object
10682     * @param pref_axis The preferred orientation axis for the hover object to use
10683     * @return The edje location to place content into the hover or @c
10684     *         NULL, on errors.
10685     *
10686     * Best is defined here as the location at which there is the most available
10687     * space.
10688     *
10689     * @p pref_axis may be one of
10690     * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10691     * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10692     * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10693     * - @c ELM_HOVER_AXIS_BOTH -- both
10694     *
10695     * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10696     * nescessarily be along the horizontal axis("left" or "right"). If
10697     * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10698     * be along the vertical axis("top" or "bottom"). Chossing
10699     * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10700     * returned position may be in either axis.
10701     *
10702     * @see elm_hover_content_set()
10703     */
10704    EAPI const char  *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10705    /**
10706     * @}
10707     */
10708
10709    /* entry */
10710    /**
10711     * @defgroup Entry Entry
10712     *
10713     * @image html img/widget/entry/preview-00.png
10714     * @image latex img/widget/entry/preview-00.eps width=\textwidth
10715     * @image html img/widget/entry/preview-01.png
10716     * @image latex img/widget/entry/preview-01.eps width=\textwidth
10717     * @image html img/widget/entry/preview-02.png
10718     * @image latex img/widget/entry/preview-02.eps width=\textwidth
10719     * @image html img/widget/entry/preview-03.png
10720     * @image latex img/widget/entry/preview-03.eps width=\textwidth
10721     *
10722     * An entry is a convenience widget which shows a box that the user can
10723     * enter text into. Entries by default don't scroll, so they grow to
10724     * accomodate the entire text, resizing the parent window as needed. This
10725     * can be changed with the elm_entry_scrollable_set() function.
10726     *
10727     * They can also be single line or multi line (the default) and when set
10728     * to multi line mode they support text wrapping in any of the modes
10729     * indicated by #Elm_Wrap_Type.
10730     *
10731     * Other features include password mode, filtering of inserted text with
10732     * elm_entry_text_filter_append() and related functions, inline "items" and
10733     * formatted markup text.
10734     *
10735     * @section entry-markup Formatted text
10736     *
10737     * The markup tags supported by the Entry are defined by the theme, but
10738     * even when writing new themes or extensions it's a good idea to stick to
10739     * a sane default, to maintain coherency and avoid application breakages.
10740     * Currently defined by the default theme are the following tags:
10741     * @li \<br\>: Inserts a line break.
10742     * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10743     * breaks.
10744     * @li \<tab\>: Inserts a tab.
10745     * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10746     * enclosed text.
10747     * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10748     * @li \<link\>...\</link\>: Underlines the enclosed text.
10749     * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10750     *
10751     * @section entry-special Special markups
10752     *
10753     * Besides those used to format text, entries support two special markup
10754     * tags used to insert clickable portions of text or items inlined within
10755     * the text.
10756     *
10757     * @subsection entry-anchors Anchors
10758     *
10759     * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10760     * \</a\> tags and an event will be generated when this text is clicked,
10761     * like this:
10762     *
10763     * @code
10764     * This text is outside <a href=anc-01>but this one is an anchor</a>
10765     * @endcode
10766     *
10767     * The @c href attribute in the opening tag gives the name that will be
10768     * used to identify the anchor and it can be any valid utf8 string.
10769     *
10770     * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10771     * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10772     * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10773     * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10774     * an anchor.
10775     *
10776     * @subsection entry-items Items
10777     *
10778     * Inlined in the text, any other @c Evas_Object can be inserted by using
10779     * \<item\> tags this way:
10780     *
10781     * @code
10782     * <item size=16x16 vsize=full href=emoticon/haha></item>
10783     * @endcode
10784     *
10785     * Just like with anchors, the @c href identifies each item, but these need,
10786     * in addition, to indicate their size, which is done using any one of
10787     * @c size, @c absize or @c relsize attributes. These attributes take their
10788     * value in the WxH format, where W is the width and H the height of the
10789     * item.
10790     *
10791     * @li absize: Absolute pixel size for the item. Whatever value is set will
10792     * be the item's size regardless of any scale value the object may have
10793     * been set to. The final line height will be adjusted to fit larger items.
10794     * @li size: Similar to @c absize, but it's adjusted to the scale value set
10795     * for the object.
10796     * @li relsize: Size is adjusted for the item to fit within the current
10797     * line height.
10798     *
10799     * Besides their size, items are specificed a @c vsize value that affects
10800     * how their final size and position are calculated. The possible values
10801     * are:
10802     * @li ascent: Item will be placed within the line's baseline and its
10803     * ascent. That is, the height between the line where all characters are
10804     * positioned and the highest point in the line. For @c size and @c absize
10805     * items, the descent value will be added to the total line height to make
10806     * them fit. @c relsize items will be adjusted to fit within this space.
10807     * @li full: Items will be placed between the descent and ascent, or the
10808     * lowest point in the line and its highest.
10809     *
10810     * The next image shows different configurations of items and how they
10811     * are the previously mentioned options affect their sizes. In all cases,
10812     * the green line indicates the ascent, blue for the baseline and red for
10813     * the descent.
10814     *
10815     * @image html entry_item.png
10816     * @image latex entry_item.eps width=\textwidth
10817     *
10818     * And another one to show how size differs from absize. In the first one,
10819     * the scale value is set to 1.0, while the second one is using one of 2.0.
10820     *
10821     * @image html entry_item_scale.png
10822     * @image latex entry_item_scale.eps width=\textwidth
10823     *
10824     * After the size for an item is calculated, the entry will request an
10825     * object to place in its space. For this, the functions set with
10826     * elm_entry_item_provider_append() and related functions will be called
10827     * in order until one of them returns a @c non-NULL value. If no providers
10828     * are available, or all of them return @c NULL, then the entry falls back
10829     * to one of the internal defaults, provided the name matches with one of
10830     * them.
10831     *
10832     * All of the following are currently supported:
10833     *
10834     * - emoticon/angry
10835     * - emoticon/angry-shout
10836     * - emoticon/crazy-laugh
10837     * - emoticon/evil-laugh
10838     * - emoticon/evil
10839     * - emoticon/goggle-smile
10840     * - emoticon/grumpy
10841     * - emoticon/grumpy-smile
10842     * - emoticon/guilty
10843     * - emoticon/guilty-smile
10844     * - emoticon/haha
10845     * - emoticon/half-smile
10846     * - emoticon/happy-panting
10847     * - emoticon/happy
10848     * - emoticon/indifferent
10849     * - emoticon/kiss
10850     * - emoticon/knowing-grin
10851     * - emoticon/laugh
10852     * - emoticon/little-bit-sorry
10853     * - emoticon/love-lots
10854     * - emoticon/love
10855     * - emoticon/minimal-smile
10856     * - emoticon/not-happy
10857     * - emoticon/not-impressed
10858     * - emoticon/omg
10859     * - emoticon/opensmile
10860     * - emoticon/smile
10861     * - emoticon/sorry
10862     * - emoticon/squint-laugh
10863     * - emoticon/surprised
10864     * - emoticon/suspicious
10865     * - emoticon/tongue-dangling
10866     * - emoticon/tongue-poke
10867     * - emoticon/uh
10868     * - emoticon/unhappy
10869     * - emoticon/very-sorry
10870     * - emoticon/what
10871     * - emoticon/wink
10872     * - emoticon/worried
10873     * - emoticon/wtf
10874     *
10875     * Alternatively, an item may reference an image by its path, using
10876     * the URI form @c file:///path/to/an/image.png and the entry will then
10877     * use that image for the item.
10878     *
10879     * @section entry-files Loading and saving files
10880     *
10881     * Entries have convinience functions to load text from a file and save
10882     * changes back to it after a short delay. The automatic saving is enabled
10883     * by default, but can be disabled with elm_entry_autosave_set() and files
10884     * can be loaded directly as plain text or have any markup in them
10885     * recognized. See elm_entry_file_set() for more details.
10886     *
10887     * @section entry-signals Emitted signals
10888     *
10889     * This widget emits the following signals:
10890     *
10891     * @li "changed": The text within the entry was changed.
10892     * @li "changed,user": The text within the entry was changed because of user interaction.
10893     * @li "activated": The enter key was pressed on a single line entry.
10894     * @li "press": A mouse button has been pressed on the entry.
10895     * @li "longpressed": A mouse button has been pressed and held for a couple
10896     * seconds.
10897     * @li "clicked": The entry has been clicked (mouse press and release).
10898     * @li "clicked,double": The entry has been double clicked.
10899     * @li "clicked,triple": The entry has been triple clicked.
10900     * @li "focused": The entry has received focus.
10901     * @li "unfocused": The entry has lost focus.
10902     * @li "selection,paste": A paste of the clipboard contents was requested.
10903     * @li "selection,copy": A copy of the selected text into the clipboard was
10904     * requested.
10905     * @li "selection,cut": A cut of the selected text into the clipboard was
10906     * requested.
10907     * @li "selection,start": A selection has begun and no previous selection
10908     * existed.
10909     * @li "selection,changed": The current selection has changed.
10910     * @li "selection,cleared": The current selection has been cleared.
10911     * @li "cursor,changed": The cursor has changed position.
10912     * @li "anchor,clicked": An anchor has been clicked. The event_info
10913     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10914     * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10915     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10916     * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10917     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10918     * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10919     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10920     * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10921     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10922     * @li "preedit,changed": The preedit string has changed.
10923     * @li "language,changed": Program language changed.
10924     *
10925     * @section entry-examples
10926     *
10927     * An overview of the Entry API can be seen in @ref entry_example_01
10928     *
10929     * @{
10930     */
10931    /**
10932     * @typedef Elm_Entry_Anchor_Info
10933     *
10934     * The info sent in the callback for the "anchor,clicked" signals emitted
10935     * by entries.
10936     */
10937    typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10938    /**
10939     * @struct _Elm_Entry_Anchor_Info
10940     *
10941     * The info sent in the callback for the "anchor,clicked" signals emitted
10942     * by entries.
10943     */
10944    struct _Elm_Entry_Anchor_Info
10945      {
10946         const char *name; /**< The name of the anchor, as stated in its href */
10947         int         button; /**< The mouse button used to click on it */
10948         Evas_Coord  x, /**< Anchor geometry, relative to canvas */
10949                     y, /**< Anchor geometry, relative to canvas */
10950                     w, /**< Anchor geometry, relative to canvas */
10951                     h; /**< Anchor geometry, relative to canvas */
10952      };
10953    /**
10954     * @typedef Elm_Entry_Filter_Cb
10955     * This callback type is used by entry filters to modify text.
10956     * @param data The data specified as the last param when adding the filter
10957     * @param entry The entry object
10958     * @param text A pointer to the location of the text being filtered. This data can be modified,
10959     * but any additional allocations must be managed by the user.
10960     * @see elm_entry_text_filter_append
10961     * @see elm_entry_text_filter_prepend
10962     */
10963    typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
10964
10965    /**
10966     * This adds an entry to @p parent object.
10967     *
10968     * By default, entries are:
10969     * @li not scrolled
10970     * @li multi-line
10971     * @li word wrapped
10972     * @li autosave is enabled
10973     *
10974     * @param parent The parent object
10975     * @return The new object or NULL if it cannot be created
10976     */
10977    EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10978    /**
10979     * Sets the entry to single line mode.
10980     *
10981     * In single line mode, entries don't ever wrap when the text reaches the
10982     * edge, and instead they keep growing horizontally. Pressing the @c Enter
10983     * key will generate an @c "activate" event instead of adding a new line.
10984     *
10985     * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
10986     * and pressing enter will break the text into a different line
10987     * without generating any events.
10988     *
10989     * @param obj The entry object
10990     * @param single_line If true, the text in the entry
10991     * will be on a single line.
10992     */
10993    EAPI void         elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
10994    /**
10995     * Gets whether the entry is set to be single line.
10996     *
10997     * @param obj The entry object
10998     * @return single_line If true, the text in the entry is set to display
10999     * on a single line.
11000     *
11001     * @see elm_entry_single_line_set()
11002     */
11003    EAPI Eina_Bool    elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11004    /**
11005     * Sets the entry to password mode.
11006     *
11007     * In password mode, entries are implicitly single line and the display of
11008     * any text in them is replaced with asterisks (*).
11009     *
11010     * @param obj The entry object
11011     * @param password If true, password mode is enabled.
11012     */
11013    EAPI void         elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
11014    /**
11015     * Gets whether the entry is set to password mode.
11016     *
11017     * @param obj The entry object
11018     * @return If true, the entry is set to display all characters
11019     * as asterisks (*).
11020     *
11021     * @see elm_entry_password_set()
11022     */
11023    EAPI Eina_Bool    elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11024    /**
11025     * This sets the text displayed within the entry to @p entry.
11026     *
11027     * @param obj The entry object
11028     * @param entry The text to be displayed
11029     *
11030     * @deprecated Use elm_object_text_set() instead.
11031     */
11032    EAPI void         elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11033    /**
11034     * This returns the text currently shown in object @p entry.
11035     * See also elm_entry_entry_set().
11036     *
11037     * @param obj The entry object
11038     * @return The currently displayed text or NULL on failure
11039     *
11040     * @deprecated Use elm_object_text_get() instead.
11041     */
11042    EAPI const char  *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11043    /**
11044     * Appends @p entry to the text of the entry.
11045     *
11046     * Adds the text in @p entry to the end of any text already present in the
11047     * widget.
11048     *
11049     * The appended text is subject to any filters set for the widget.
11050     *
11051     * @param obj The entry object
11052     * @param entry The text to be displayed
11053     *
11054     * @see elm_entry_text_filter_append()
11055     */
11056    EAPI void         elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11057    /**
11058     * Gets whether the entry is empty.
11059     *
11060     * Empty means no text at all. If there are any markup tags, like an item
11061     * tag for which no provider finds anything, and no text is displayed, this
11062     * function still returns EINA_FALSE.
11063     *
11064     * @param obj The entry object
11065     * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
11066     */
11067    EAPI Eina_Bool    elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11068    /**
11069     * Gets any selected text within the entry.
11070     *
11071     * If there's any selected text in the entry, this function returns it as
11072     * a string in markup format. NULL is returned if no selection exists or
11073     * if an error occurred.
11074     *
11075     * The returned value points to an internal string and should not be freed
11076     * or modified in any way. If the @p entry object is deleted or its
11077     * contents are changed, the returned pointer should be considered invalid.
11078     *
11079     * @param obj The entry object
11080     * @return The selected text within the entry or NULL on failure
11081     */
11082    EAPI const char  *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11083    /**
11084     * Inserts the given text into the entry at the current cursor position.
11085     *
11086     * This inserts text at the cursor position as if it was typed
11087     * by the user (note that this also allows markup which a user
11088     * can't just "type" as it would be converted to escaped text, so this
11089     * call can be used to insert things like emoticon items or bold push/pop
11090     * tags, other font and color change tags etc.)
11091     *
11092     * If any selection exists, it will be replaced by the inserted text.
11093     *
11094     * The inserted text is subject to any filters set for the widget.
11095     *
11096     * @param obj The entry object
11097     * @param entry The text to insert
11098     *
11099     * @see elm_entry_text_filter_append()
11100     */
11101    EAPI void         elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11102    /**
11103     * Set the line wrap type to use on multi-line entries.
11104     *
11105     * Sets the wrap type used by the entry to any of the specified in
11106     * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
11107     * line (without inserting a line break or paragraph separator) when it
11108     * reaches the far edge of the widget.
11109     *
11110     * Note that this only makes sense for multi-line entries. A widget set
11111     * to be single line will never wrap.
11112     *
11113     * @param obj The entry object
11114     * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
11115     */
11116    EAPI void         elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
11117    /**
11118     * Gets the wrap mode the entry was set to use.
11119     *
11120     * @param obj The entry object
11121     * @return Wrap type
11122     *
11123     * @see also elm_entry_line_wrap_set()
11124     */
11125    EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11126    /**
11127     * Sets if the entry is to be editable or not.
11128     *
11129     * By default, entries are editable and when focused, any text input by the
11130     * user will be inserted at the current cursor position. But calling this
11131     * function with @p editable as EINA_FALSE will prevent the user from
11132     * inputting text into the entry.
11133     *
11134     * The only way to change the text of a non-editable entry is to use
11135     * elm_object_text_set(), elm_entry_entry_insert() and other related
11136     * functions.
11137     *
11138     * @param obj The entry object
11139     * @param editable If EINA_TRUE, user input will be inserted in the entry,
11140     * if not, the entry is read-only and no user input is allowed.
11141     */
11142    EAPI void         elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
11143    /**
11144     * Gets whether the entry is editable or not.
11145     *
11146     * @param obj The entry object
11147     * @return If true, the entry is editable by the user.
11148     * If false, it is not editable by the user
11149     *
11150     * @see elm_entry_editable_set()
11151     */
11152    EAPI Eina_Bool    elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11153    /**
11154     * This drops any existing text selection within the entry.
11155     *
11156     * @param obj The entry object
11157     */
11158    EAPI void         elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
11159    /**
11160     * This selects all text within the entry.
11161     *
11162     * @param obj The entry object
11163     */
11164    EAPI void         elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
11165    /**
11166     * This moves the cursor one place to the right within the entry.
11167     *
11168     * @param obj The entry object
11169     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11170     */
11171    EAPI Eina_Bool    elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
11172    /**
11173     * This moves the cursor one place to the left within the entry.
11174     *
11175     * @param obj The entry object
11176     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11177     */
11178    EAPI Eina_Bool    elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
11179    /**
11180     * This moves the cursor one line up within the entry.
11181     *
11182     * @param obj The entry object
11183     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11184     */
11185    EAPI Eina_Bool    elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
11186    /**
11187     * This moves the cursor one line down within the entry.
11188     *
11189     * @param obj The entry object
11190     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11191     */
11192    EAPI Eina_Bool    elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
11193    /**
11194     * This moves the cursor to the beginning of the entry.
11195     *
11196     * @param obj The entry object
11197     */
11198    EAPI void         elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11199    /**
11200     * This moves the cursor to the end of the entry.
11201     *
11202     * @param obj The entry object
11203     */
11204    EAPI void         elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11205    /**
11206     * This moves the cursor to the beginning of the current line.
11207     *
11208     * @param obj The entry object
11209     */
11210    EAPI void         elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11211    /**
11212     * This moves the cursor to the end of the current line.
11213     *
11214     * @param obj The entry object
11215     */
11216    EAPI void         elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11217    /**
11218     * This begins a selection within the entry as though
11219     * the user were holding down the mouse button to make a selection.
11220     *
11221     * @param obj The entry object
11222     */
11223    EAPI void         elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11224    /**
11225     * This ends a selection within the entry as though
11226     * the user had just released the mouse button while making a selection.
11227     *
11228     * @param obj The entry object
11229     */
11230    EAPI void         elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11231    /**
11232     * Gets whether a format node exists at the current cursor position.
11233     *
11234     * A format node is anything that defines how the text is rendered. It can
11235     * be a visible format node, such as a line break or a paragraph separator,
11236     * or an invisible one, such as bold begin or end tag.
11237     * This function returns whether any format node exists at the current
11238     * cursor position.
11239     *
11240     * @param obj The entry object
11241     * @return EINA_TRUE if the current cursor position contains a format node,
11242     * EINA_FALSE otherwise.
11243     *
11244     * @see elm_entry_cursor_is_visible_format_get()
11245     */
11246    EAPI Eina_Bool    elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11247    /**
11248     * Gets if the current cursor position holds a visible format node.
11249     *
11250     * @param obj The entry object
11251     * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11252     * if it's an invisible one or no format exists.
11253     *
11254     * @see elm_entry_cursor_is_format_get()
11255     */
11256    EAPI Eina_Bool    elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11257    /**
11258     * Gets the character pointed by the cursor at its current position.
11259     *
11260     * This function returns a string with the utf8 character stored at the
11261     * current cursor position.
11262     * Only the text is returned, any format that may exist will not be part
11263     * of the return value.
11264     *
11265     * @param obj The entry object
11266     * @return The text pointed by the cursors.
11267     */
11268    EAPI const char  *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11269    /**
11270     * This function returns the geometry of the cursor.
11271     *
11272     * It's useful if you want to draw something on the cursor (or where it is),
11273     * or for example in the case of scrolled entry where you want to show the
11274     * cursor.
11275     *
11276     * @param obj The entry object
11277     * @param x returned geometry
11278     * @param y returned geometry
11279     * @param w returned geometry
11280     * @param h returned geometry
11281     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11282     */
11283    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);
11284    /**
11285     * Sets the cursor position in the entry to the given value
11286     *
11287     * The value in @p pos is the index of the character position within the
11288     * contents of the string as returned by elm_entry_cursor_pos_get().
11289     *
11290     * @param obj The entry object
11291     * @param pos The position of the cursor
11292     */
11293    EAPI void         elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11294    /**
11295     * Retrieves the current position of the cursor in the entry
11296     *
11297     * @param obj The entry object
11298     * @return The cursor position
11299     */
11300    EAPI int          elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11301    /**
11302     * This executes a "cut" action on the selected text in the entry.
11303     *
11304     * @param obj The entry object
11305     */
11306    EAPI void         elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11307    /**
11308     * This executes a "copy" action on the selected text in the entry.
11309     *
11310     * @param obj The entry object
11311     */
11312    EAPI void         elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11313    /**
11314     * This executes a "paste" action in the entry.
11315     *
11316     * @param obj The entry object
11317     */
11318    EAPI void         elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11319    /**
11320     * This clears and frees the items in a entry's contextual (longpress)
11321     * menu.
11322     *
11323     * @param obj The entry object
11324     *
11325     * @see elm_entry_context_menu_item_add()
11326     */
11327    EAPI void         elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11328    /**
11329     * This adds an item to the entry's contextual menu.
11330     *
11331     * A longpress on an entry will make the contextual menu show up, if this
11332     * hasn't been disabled with elm_entry_context_menu_disabled_set().
11333     * By default, this menu provides a few options like enabling selection mode,
11334     * which is useful on embedded devices that need to be explicit about it,
11335     * and when a selection exists it also shows the copy and cut actions.
11336     *
11337     * With this function, developers can add other options to this menu to
11338     * perform any action they deem necessary.
11339     *
11340     * @param obj The entry object
11341     * @param label The item's text label
11342     * @param icon_file The item's icon file
11343     * @param icon_type The item's icon type
11344     * @param func The callback to execute when the item is clicked
11345     * @param data The data to associate with the item for related functions
11346     */
11347    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);
11348    /**
11349     * This disables the entry's contextual (longpress) menu.
11350     *
11351     * @param obj The entry object
11352     * @param disabled If true, the menu is disabled
11353     */
11354    EAPI void         elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11355    /**
11356     * This returns whether the entry's contextual (longpress) menu is
11357     * disabled.
11358     *
11359     * @param obj The entry object
11360     * @return If true, the menu is disabled
11361     */
11362    EAPI Eina_Bool    elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11363    /**
11364     * This appends a custom item provider to the list for that entry
11365     *
11366     * This appends the given callback. The list is walked from beginning to end
11367     * with each function called given the item href string in the text. If the
11368     * function returns an object handle other than NULL (it should create an
11369     * object to do this), then this object is used to replace that item. If
11370     * not the next provider is called until one provides an item object, or the
11371     * default provider in entry does.
11372     *
11373     * @param obj The entry object
11374     * @param func The function called to provide the item object
11375     * @param data The data passed to @p func
11376     *
11377     * @see @ref entry-items
11378     */
11379    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);
11380    /**
11381     * This prepends a custom item provider to the list for that entry
11382     *
11383     * This prepends the given callback. See elm_entry_item_provider_append() for
11384     * more information
11385     *
11386     * @param obj The entry object
11387     * @param func The function called to provide the item object
11388     * @param data The data passed to @p func
11389     */
11390    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);
11391    /**
11392     * This removes a custom item provider to the list for that entry
11393     *
11394     * This removes the given callback. See elm_entry_item_provider_append() for
11395     * more information
11396     *
11397     * @param obj The entry object
11398     * @param func The function called to provide the item object
11399     * @param data The data passed to @p func
11400     */
11401    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);
11402    /**
11403     * Append a filter function for text inserted in the entry
11404     *
11405     * Append the given callback to the list. This functions will be called
11406     * whenever any text is inserted into the entry, with the text to be inserted
11407     * as a parameter. The callback function is free to alter the text in any way
11408     * it wants, but it must remember to free the given pointer and update it.
11409     * If the new text is to be discarded, the function can free it and set its
11410     * text parameter to NULL. This will also prevent any following filters from
11411     * being called.
11412     *
11413     * @param obj The entry object
11414     * @param func The function to use as text filter
11415     * @param data User data to pass to @p func
11416     */
11417    EAPI void         elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11418    /**
11419     * Prepend a filter function for text insdrted in the entry
11420     *
11421     * Prepend the given callback to the list. See elm_entry_text_filter_append()
11422     * for more information
11423     *
11424     * @param obj The entry object
11425     * @param func The function to use as text filter
11426     * @param data User data to pass to @p func
11427     */
11428    EAPI void         elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11429    /**
11430     * Remove a filter from the list
11431     *
11432     * Removes the given callback from the filter list. See
11433     * elm_entry_text_filter_append() for more information.
11434     *
11435     * @param obj The entry object
11436     * @param func The filter function to remove
11437     * @param data The user data passed when adding the function
11438     */
11439    EAPI void         elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11440    /**
11441     * This converts a markup (HTML-like) string into UTF-8.
11442     *
11443     * The returned string is a malloc'ed buffer and it should be freed when
11444     * not needed anymore.
11445     *
11446     * @param s The string (in markup) to be converted
11447     * @return The converted string (in UTF-8). It should be freed.
11448     */
11449    EAPI char        *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11450    /**
11451     * This converts a UTF-8 string into markup (HTML-like).
11452     *
11453     * The returned string is a malloc'ed buffer and it should be freed when
11454     * not needed anymore.
11455     *
11456     * @param s The string (in UTF-8) to be converted
11457     * @return The converted string (in markup). It should be freed.
11458     */
11459    EAPI char        *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11460    /**
11461     * This sets the file (and implicitly loads it) for the text to display and
11462     * then edit. All changes are written back to the file after a short delay if
11463     * the entry object is set to autosave (which is the default).
11464     *
11465     * If the entry had any other file set previously, any changes made to it
11466     * will be saved if the autosave feature is enabled, otherwise, the file
11467     * will be silently discarded and any non-saved changes will be lost.
11468     *
11469     * @param obj The entry object
11470     * @param file The path to the file to load and save
11471     * @param format The file format
11472     */
11473    EAPI void         elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11474    /**
11475     * Gets the file being edited by the entry.
11476     *
11477     * This function can be used to retrieve any file set on the entry for
11478     * edition, along with the format used to load and save it.
11479     *
11480     * @param obj The entry object
11481     * @param file The path to the file to load and save
11482     * @param format The file format
11483     */
11484    EAPI void         elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11485    /**
11486     * This function writes any changes made to the file set with
11487     * elm_entry_file_set()
11488     *
11489     * @param obj The entry object
11490     */
11491    EAPI void         elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11492    /**
11493     * This sets the entry object to 'autosave' the loaded text file or not.
11494     *
11495     * @param obj The entry object
11496     * @param autosave Autosave the loaded file or not
11497     *
11498     * @see elm_entry_file_set()
11499     */
11500    EAPI void         elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11501    /**
11502     * This gets the entry object's 'autosave' status.
11503     *
11504     * @param obj The entry object
11505     * @return Autosave the loaded file or not
11506     *
11507     * @see elm_entry_file_set()
11508     */
11509    EAPI Eina_Bool    elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11510    /**
11511     * Control pasting of text and images for the widget.
11512     *
11513     * Normally the entry allows both text and images to be pasted.  By setting
11514     * textonly to be true, this prevents images from being pasted.
11515     *
11516     * Note this only changes the behaviour of text.
11517     *
11518     * @param obj The entry object
11519     * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11520     * text+image+other.
11521     */
11522    EAPI void         elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11523    /**
11524     * Getting elm_entry text paste/drop mode.
11525     *
11526     * In textonly mode, only text may be pasted or dropped into the widget.
11527     *
11528     * @param obj The entry object
11529     * @return If the widget only accepts text from pastes.
11530     */
11531    EAPI Eina_Bool    elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11532    /**
11533     * Enable or disable scrolling in entry
11534     *
11535     * Normally the entry is not scrollable unless you enable it with this call.
11536     *
11537     * @param obj The entry object
11538     * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11539     */
11540    EAPI void         elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11541    /**
11542     * Get the scrollable state of the entry
11543     *
11544     * Normally the entry is not scrollable. This gets the scrollable state
11545     * of the entry. See elm_entry_scrollable_set() for more information.
11546     *
11547     * @param obj The entry object
11548     * @return The scrollable state
11549     */
11550    EAPI Eina_Bool    elm_entry_scrollable_get(const Evas_Object *obj);
11551    /**
11552     * This sets a widget to be displayed to the left of a scrolled entry.
11553     *
11554     * @param obj The scrolled entry object
11555     * @param icon The widget to display on the left side of the scrolled
11556     * entry.
11557     *
11558     * @note A previously set widget will be destroyed.
11559     * @note If the object being set does not have minimum size hints set,
11560     * it won't get properly displayed.
11561     *
11562     * @see elm_entry_end_set()
11563     */
11564    EAPI void         elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11565    /**
11566     * Gets the leftmost widget of the scrolled entry. This object is
11567     * owned by the scrolled entry and should not be modified.
11568     *
11569     * @param obj The scrolled entry object
11570     * @return the left widget inside the scroller
11571     */
11572    EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11573    /**
11574     * Unset the leftmost widget of the scrolled entry, unparenting and
11575     * returning it.
11576     *
11577     * @param obj The scrolled entry object
11578     * @return the previously set icon sub-object of this entry, on
11579     * success.
11580     *
11581     * @see elm_entry_icon_set()
11582     */
11583    EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11584    /**
11585     * Sets the visibility of the left-side widget of the scrolled entry,
11586     * set by elm_entry_icon_set().
11587     *
11588     * @param obj The scrolled entry object
11589     * @param setting EINA_TRUE if the object should be displayed,
11590     * EINA_FALSE if not.
11591     */
11592    EAPI void         elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11593    /**
11594     * This sets a widget to be displayed to the end of a scrolled entry.
11595     *
11596     * @param obj The scrolled entry object
11597     * @param end The widget to display on the right side of the scrolled
11598     * entry.
11599     *
11600     * @note A previously set widget will be destroyed.
11601     * @note If the object being set does not have minimum size hints set,
11602     * it won't get properly displayed.
11603     *
11604     * @see elm_entry_icon_set
11605     */
11606    EAPI void         elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11607    /**
11608     * Gets the endmost widget of the scrolled entry. This object is owned
11609     * by the scrolled entry and should not be modified.
11610     *
11611     * @param obj The scrolled entry object
11612     * @return the right widget inside the scroller
11613     */
11614    EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11615    /**
11616     * Unset the endmost widget of the scrolled entry, unparenting and
11617     * returning it.
11618     *
11619     * @param obj The scrolled entry object
11620     * @return the previously set icon sub-object of this entry, on
11621     * success.
11622     *
11623     * @see elm_entry_icon_set()
11624     */
11625    EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11626    /**
11627     * Sets the visibility of the end widget of the scrolled entry, set by
11628     * elm_entry_end_set().
11629     *
11630     * @param obj The scrolled entry object
11631     * @param setting EINA_TRUE if the object should be displayed,
11632     * EINA_FALSE if not.
11633     */
11634    EAPI void         elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11635    /**
11636     * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11637     * them).
11638     *
11639     * Setting an entry to single-line mode with elm_entry_single_line_set()
11640     * will automatically disable the display of scrollbars when the entry
11641     * moves inside its scroller.
11642     *
11643     * @param obj The scrolled entry object
11644     * @param h The horizontal scrollbar policy to apply
11645     * @param v The vertical scrollbar policy to apply
11646     */
11647    EAPI void         elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11648    /**
11649     * This enables/disables bouncing within the entry.
11650     *
11651     * This function sets whether the entry will bounce when scrolling reaches
11652     * the end of the contained entry.
11653     *
11654     * @param obj The scrolled entry object
11655     * @param h The horizontal bounce state
11656     * @param v The vertical bounce state
11657     */
11658    EAPI void         elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11659    /**
11660     * Get the bounce mode
11661     *
11662     * @param obj The Entry object
11663     * @param h_bounce Allow bounce horizontally
11664     * @param v_bounce Allow bounce vertically
11665     */
11666    EAPI void         elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11667
11668    /* pre-made filters for entries */
11669    /**
11670     * @typedef Elm_Entry_Filter_Limit_Size
11671     *
11672     * Data for the elm_entry_filter_limit_size() entry filter.
11673     */
11674    typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11675    /**
11676     * @struct _Elm_Entry_Filter_Limit_Size
11677     *
11678     * Data for the elm_entry_filter_limit_size() entry filter.
11679     */
11680    struct _Elm_Entry_Filter_Limit_Size
11681      {
11682         int max_char_count; /**< The maximum number of characters allowed. */
11683         int max_byte_count; /**< The maximum number of bytes allowed*/
11684      };
11685    /**
11686     * Filter inserted text based on user defined character and byte limits
11687     *
11688     * Add this filter to an entry to limit the characters that it will accept
11689     * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11690     * The funtion works on the UTF-8 representation of the string, converting
11691     * it from the set markup, thus not accounting for any format in it.
11692     *
11693     * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11694     * it as data when setting the filter. In it, it's possible to set limits
11695     * by character count or bytes (any of them is disabled if 0), and both can
11696     * be set at the same time. In that case, it first checks for characters,
11697     * then bytes.
11698     *
11699     * The function will cut the inserted text in order to allow only the first
11700     * number of characters that are still allowed. The cut is made in
11701     * characters, even when limiting by bytes, in order to always contain
11702     * valid ones and avoid half unicode characters making it in.
11703     *
11704     * This filter, like any others, does not apply when setting the entry text
11705     * directly with elm_object_text_set() (or the deprecated
11706     * elm_entry_entry_set()).
11707     */
11708    EAPI void         elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11709    /**
11710     * @typedef Elm_Entry_Filter_Accept_Set
11711     *
11712     * Data for the elm_entry_filter_accept_set() entry filter.
11713     */
11714    typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11715    /**
11716     * @struct _Elm_Entry_Filter_Accept_Set
11717     *
11718     * Data for the elm_entry_filter_accept_set() entry filter.
11719     */
11720    struct _Elm_Entry_Filter_Accept_Set
11721      {
11722         const char *accepted; /**< Set of characters accepted in the entry. */
11723         const char *rejected; /**< Set of characters rejected from the entry. */
11724      };
11725    /**
11726     * Filter inserted text based on accepted or rejected sets of characters
11727     *
11728     * Add this filter to an entry to restrict the set of accepted characters
11729     * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11730     * This structure contains both accepted and rejected sets, but they are
11731     * mutually exclusive.
11732     *
11733     * The @c accepted set takes preference, so if it is set, the filter will
11734     * only work based on the accepted characters, ignoring anything in the
11735     * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11736     *
11737     * In both cases, the function filters by matching utf8 characters to the
11738     * raw markup text, so it can be used to remove formatting tags.
11739     *
11740     * This filter, like any others, does not apply when setting the entry text
11741     * directly with elm_object_text_set() (or the deprecated
11742     * elm_entry_entry_set()).
11743     */
11744    EAPI void         elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11745    /**
11746     * Set the input panel layout of the entry
11747     *
11748     * @param obj The entry object
11749     * @param layout layout type
11750     */
11751    EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11752    /**
11753     * Get the input panel layout of the entry
11754     *
11755     * @param obj The entry object
11756     * @return layout type
11757     *
11758     * @see elm_entry_input_panel_layout_set
11759     */
11760    EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11761    /**
11762     * @}
11763     */
11764
11765    /* composite widgets - these basically put together basic widgets above
11766     * in convenient packages that do more than basic stuff */
11767
11768    /* anchorview */
11769    /**
11770     * @defgroup Anchorview Anchorview
11771     *
11772     * @image html img/widget/anchorview/preview-00.png
11773     * @image latex img/widget/anchorview/preview-00.eps
11774     *
11775     * Anchorview is for displaying text that contains markup with anchors
11776     * like <c>\<a href=1234\>something\</\></c> in it.
11777     *
11778     * Besides being styled differently, the anchorview widget provides the
11779     * necessary functionality so that clicking on these anchors brings up a
11780     * popup with user defined content such as "call", "add to contacts" or
11781     * "open web page". This popup is provided using the @ref Hover widget.
11782     *
11783     * This widget is very similar to @ref Anchorblock, so refer to that
11784     * widget for an example. The only difference Anchorview has is that the
11785     * widget is already provided with scrolling functionality, so if the
11786     * text set to it is too large to fit in the given space, it will scroll,
11787     * whereas the @ref Anchorblock widget will keep growing to ensure all the
11788     * text can be displayed.
11789     *
11790     * This widget emits the following signals:
11791     * @li "anchor,clicked": will be called when an anchor is clicked. The
11792     * @p event_info parameter on the callback will be a pointer of type
11793     * ::Elm_Entry_Anchorview_Info.
11794     *
11795     * See @ref Anchorblock for an example on how to use both of them.
11796     *
11797     * @see Anchorblock
11798     * @see Entry
11799     * @see Hover
11800     *
11801     * @{
11802     */
11803    /**
11804     * @typedef Elm_Entry_Anchorview_Info
11805     *
11806     * The info sent in the callback for "anchor,clicked" signals emitted by
11807     * the Anchorview widget.
11808     */
11809    typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11810    /**
11811     * @struct _Elm_Entry_Anchorview_Info
11812     *
11813     * The info sent in the callback for "anchor,clicked" signals emitted by
11814     * the Anchorview widget.
11815     */
11816    struct _Elm_Entry_Anchorview_Info
11817      {
11818         const char     *name; /**< Name of the anchor, as indicated in its href
11819                                    attribute */
11820         int             button; /**< The mouse button used to click on it */
11821         Evas_Object    *hover; /**< The hover object to use for the popup */
11822         struct {
11823              Evas_Coord    x, y, w, h;
11824         } anchor, /**< Geometry selection of text used as anchor */
11825           hover_parent; /**< Geometry of the object used as parent by the
11826                              hover */
11827         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
11828                                              for content on the left side of
11829                                              the hover. Before calling the
11830                                              callback, the widget will make the
11831                                              necessary calculations to check
11832                                              which sides are fit to be set with
11833                                              content, based on the position the
11834                                              hover is activated and its distance
11835                                              to the edges of its parent object
11836                                              */
11837         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
11838                                               the right side of the hover.
11839                                               See @ref hover_left */
11840         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
11841                                             of the hover. See @ref hover_left */
11842         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
11843                                                below the hover. See @ref
11844                                                hover_left */
11845      };
11846    /**
11847     * Add a new Anchorview object
11848     *
11849     * @param parent The parent object
11850     * @return The new object or NULL if it cannot be created
11851     */
11852    EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11853    /**
11854     * Set the text to show in the anchorview
11855     *
11856     * Sets the text of the anchorview to @p text. This text can include markup
11857     * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11858     * text that will be specially styled and react to click events, ended with
11859     * either of \</a\> or \</\>. When clicked, the anchor will emit an
11860     * "anchor,clicked" signal that you can attach a callback to with
11861     * evas_object_smart_callback_add(). The name of the anchor given in the
11862     * event info struct will be the one set in the href attribute, in this
11863     * case, anchorname.
11864     *
11865     * Other markup can be used to style the text in different ways, but it's
11866     * up to the style defined in the theme which tags do what.
11867     * @deprecated use elm_object_text_set() instead.
11868     */
11869    EINA_DEPRECATED EAPI void         elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11870    /**
11871     * Get the markup text set for the anchorview
11872     *
11873     * Retrieves the text set on the anchorview, with markup tags included.
11874     *
11875     * @param obj The anchorview object
11876     * @return The markup text set or @c NULL if nothing was set or an error
11877     * occurred
11878     * @deprecated use elm_object_text_set() instead.
11879     */
11880    EINA_DEPRECATED EAPI const char  *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11881    /**
11882     * Set the parent of the hover popup
11883     *
11884     * Sets the parent object to use by the hover created by the anchorview
11885     * when an anchor is clicked. See @ref Hover for more details on this.
11886     * If no parent is set, the same anchorview object will be used.
11887     *
11888     * @param obj The anchorview object
11889     * @param parent The object to use as parent for the hover
11890     */
11891    EAPI void         elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11892    /**
11893     * Get the parent of the hover popup
11894     *
11895     * Get the object used as parent for the hover created by the anchorview
11896     * widget. See @ref Hover for more details on this.
11897     *
11898     * @param obj The anchorview object
11899     * @return The object used as parent for the hover, NULL if none is set.
11900     */
11901    EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11902    /**
11903     * Set the style that the hover should use
11904     *
11905     * When creating the popup hover, anchorview will request that it's
11906     * themed according to @p style.
11907     *
11908     * @param obj The anchorview object
11909     * @param style The style to use for the underlying hover
11910     *
11911     * @see elm_object_style_set()
11912     */
11913    EAPI void         elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11914    /**
11915     * Get the style that the hover should use
11916     *
11917     * Get the style the hover created by anchorview will use.
11918     *
11919     * @param obj The anchorview object
11920     * @return The style to use by the hover. NULL means the default is used.
11921     *
11922     * @see elm_object_style_set()
11923     */
11924    EAPI const char  *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11925    /**
11926     * Ends the hover popup in the anchorview
11927     *
11928     * When an anchor is clicked, the anchorview widget will create a hover
11929     * object to use as a popup with user provided content. This function
11930     * terminates this popup, returning the anchorview to its normal state.
11931     *
11932     * @param obj The anchorview object
11933     */
11934    EAPI void         elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11935    /**
11936     * Set bouncing behaviour when the scrolled content reaches an edge
11937     *
11938     * Tell the internal scroller object whether it should bounce or not
11939     * when it reaches the respective edges for each axis.
11940     *
11941     * @param obj The anchorview object
11942     * @param h_bounce Whether to bounce or not in the horizontal axis
11943     * @param v_bounce Whether to bounce or not in the vertical axis
11944     *
11945     * @see elm_scroller_bounce_set()
11946     */
11947    EAPI void         elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
11948    /**
11949     * Get the set bouncing behaviour of the internal scroller
11950     *
11951     * Get whether the internal scroller should bounce when the edge of each
11952     * axis is reached scrolling.
11953     *
11954     * @param obj The anchorview object
11955     * @param h_bounce Pointer where to store the bounce state of the horizontal
11956     *                 axis
11957     * @param v_bounce Pointer where to store the bounce state of the vertical
11958     *                 axis
11959     *
11960     * @see elm_scroller_bounce_get()
11961     */
11962    EAPI void         elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
11963    /**
11964     * Appends a custom item provider to the given anchorview
11965     *
11966     * Appends the given function to the list of items providers. This list is
11967     * called, one function at a time, with the given @p data pointer, the
11968     * anchorview object and, in the @p item parameter, the item name as
11969     * referenced in its href string. Following functions in the list will be
11970     * called in order until one of them returns something different to NULL,
11971     * which should be an Evas_Object which will be used in place of the item
11972     * element.
11973     *
11974     * Items in the markup text take the form \<item relsize=16x16 vsize=full
11975     * href=item/name\>\</item\>
11976     *
11977     * @param obj The anchorview object
11978     * @param func The function to add to the list of providers
11979     * @param data User data that will be passed to the callback function
11980     *
11981     * @see elm_entry_item_provider_append()
11982     */
11983    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);
11984    /**
11985     * Prepend a custom item provider to the given anchorview
11986     *
11987     * Like elm_anchorview_item_provider_append(), but it adds the function
11988     * @p func to the beginning of the list, instead of the end.
11989     *
11990     * @param obj The anchorview object
11991     * @param func The function to add to the list of providers
11992     * @param data User data that will be passed to the callback function
11993     */
11994    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);
11995    /**
11996     * Remove a custom item provider from the list of the given anchorview
11997     *
11998     * Removes the function and data pairing that matches @p func and @p data.
11999     * That is, unless the same function and same user data are given, the
12000     * function will not be removed from the list. This allows us to add the
12001     * same callback several times, with different @p data pointers and be
12002     * able to remove them later without conflicts.
12003     *
12004     * @param obj The anchorview object
12005     * @param func The function to remove from the list
12006     * @param data The data matching the function to remove from the list
12007     */
12008    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);
12009    /**
12010     * @}
12011     */
12012
12013    /* anchorblock */
12014    /**
12015     * @defgroup Anchorblock Anchorblock
12016     *
12017     * @image html img/widget/anchorblock/preview-00.png
12018     * @image latex img/widget/anchorblock/preview-00.eps
12019     *
12020     * Anchorblock is for displaying text that contains markup with anchors
12021     * like <c>\<a href=1234\>something\</\></c> in it.
12022     *
12023     * Besides being styled differently, the anchorblock widget provides the
12024     * necessary functionality so that clicking on these anchors brings up a
12025     * popup with user defined content such as "call", "add to contacts" or
12026     * "open web page". This popup is provided using the @ref Hover widget.
12027     *
12028     * This widget emits the following signals:
12029     * @li "anchor,clicked": will be called when an anchor is clicked. The
12030     * @p event_info parameter on the callback will be a pointer of type
12031     * ::Elm_Entry_Anchorblock_Info.
12032     *
12033     * @see Anchorview
12034     * @see Entry
12035     * @see Hover
12036     *
12037     * Since examples are usually better than plain words, we might as well
12038     * try @ref tutorial_anchorblock_example "one".
12039     */
12040    /**
12041     * @addtogroup Anchorblock
12042     * @{
12043     */
12044    /**
12045     * @typedef Elm_Entry_Anchorblock_Info
12046     *
12047     * The info sent in the callback for "anchor,clicked" signals emitted by
12048     * the Anchorblock widget.
12049     */
12050    typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
12051    /**
12052     * @struct _Elm_Entry_Anchorblock_Info
12053     *
12054     * The info sent in the callback for "anchor,clicked" signals emitted by
12055     * the Anchorblock widget.
12056     */
12057    struct _Elm_Entry_Anchorblock_Info
12058      {
12059         const char     *name; /**< Name of the anchor, as indicated in its href
12060                                    attribute */
12061         int             button; /**< The mouse button used to click on it */
12062         Evas_Object    *hover; /**< The hover object to use for the popup */
12063         struct {
12064              Evas_Coord    x, y, w, h;
12065         } anchor, /**< Geometry selection of text used as anchor */
12066           hover_parent; /**< Geometry of the object used as parent by the
12067                              hover */
12068         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
12069                                              for content on the left side of
12070                                              the hover. Before calling the
12071                                              callback, the widget will make the
12072                                              necessary calculations to check
12073                                              which sides are fit to be set with
12074                                              content, based on the position the
12075                                              hover is activated and its distance
12076                                              to the edges of its parent object
12077                                              */
12078         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
12079                                               the right side of the hover.
12080                                               See @ref hover_left */
12081         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
12082                                             of the hover. See @ref hover_left */
12083         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
12084                                                below the hover. See @ref
12085                                                hover_left */
12086      };
12087    /**
12088     * Add a new Anchorblock object
12089     *
12090     * @param parent The parent object
12091     * @return The new object or NULL if it cannot be created
12092     */
12093    EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12094    /**
12095     * Set the text to show in the anchorblock
12096     *
12097     * Sets the text of the anchorblock to @p text. This text can include markup
12098     * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
12099     * of text that will be specially styled and react to click events, ended
12100     * with either of \</a\> or \</\>. When clicked, the anchor will emit an
12101     * "anchor,clicked" signal that you can attach a callback to with
12102     * evas_object_smart_callback_add(). The name of the anchor given in the
12103     * event info struct will be the one set in the href attribute, in this
12104     * case, anchorname.
12105     *
12106     * Other markup can be used to style the text in different ways, but it's
12107     * up to the style defined in the theme which tags do what.
12108     * @deprecated use elm_object_text_set() instead.
12109     */
12110    EINA_DEPRECATED EAPI void         elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12111    /**
12112     * Get the markup text set for the anchorblock
12113     *
12114     * Retrieves the text set on the anchorblock, with markup tags included.
12115     *
12116     * @param obj The anchorblock object
12117     * @return The markup text set or @c NULL if nothing was set or an error
12118     * occurred
12119     * @deprecated use elm_object_text_set() instead.
12120     */
12121    EINA_DEPRECATED EAPI const char  *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12122    /**
12123     * Set the parent of the hover popup
12124     *
12125     * Sets the parent object to use by the hover created by the anchorblock
12126     * when an anchor is clicked. See @ref Hover for more details on this.
12127     *
12128     * @param obj The anchorblock object
12129     * @param parent The object to use as parent for the hover
12130     */
12131    EAPI void         elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12132    /**
12133     * Get the parent of the hover popup
12134     *
12135     * Get the object used as parent for the hover created by the anchorblock
12136     * widget. See @ref Hover for more details on this.
12137     * If no parent is set, the same anchorblock object will be used.
12138     *
12139     * @param obj The anchorblock object
12140     * @return The object used as parent for the hover, NULL if none is set.
12141     */
12142    EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12143    /**
12144     * Set the style that the hover should use
12145     *
12146     * When creating the popup hover, anchorblock will request that it's
12147     * themed according to @p style.
12148     *
12149     * @param obj The anchorblock object
12150     * @param style The style to use for the underlying hover
12151     *
12152     * @see elm_object_style_set()
12153     */
12154    EAPI void         elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12155    /**
12156     * Get the style that the hover should use
12157     *
12158     * Get the style the hover created by anchorblock will use.
12159     *
12160     * @param obj The anchorblock object
12161     * @return The style to use by the hover. NULL means the default is used.
12162     *
12163     * @see elm_object_style_set()
12164     */
12165    EAPI const char  *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12166    /**
12167     * Ends the hover popup in the anchorblock
12168     *
12169     * When an anchor is clicked, the anchorblock widget will create a hover
12170     * object to use as a popup with user provided content. This function
12171     * terminates this popup, returning the anchorblock to its normal state.
12172     *
12173     * @param obj The anchorblock object
12174     */
12175    EAPI void         elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12176    /**
12177     * Appends a custom item provider to the given anchorblock
12178     *
12179     * Appends the given function to the list of items providers. This list is
12180     * called, one function at a time, with the given @p data pointer, the
12181     * anchorblock object and, in the @p item parameter, the item name as
12182     * referenced in its href string. Following functions in the list will be
12183     * called in order until one of them returns something different to NULL,
12184     * which should be an Evas_Object which will be used in place of the item
12185     * element.
12186     *
12187     * Items in the markup text take the form \<item relsize=16x16 vsize=full
12188     * href=item/name\>\</item\>
12189     *
12190     * @param obj The anchorblock object
12191     * @param func The function to add to the list of providers
12192     * @param data User data that will be passed to the callback function
12193     *
12194     * @see elm_entry_item_provider_append()
12195     */
12196    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);
12197    /**
12198     * Prepend a custom item provider to the given anchorblock
12199     *
12200     * Like elm_anchorblock_item_provider_append(), but it adds the function
12201     * @p func to the beginning of the list, instead of the end.
12202     *
12203     * @param obj The anchorblock object
12204     * @param func The function to add to the list of providers
12205     * @param data User data that will be passed to the callback function
12206     */
12207    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);
12208    /**
12209     * Remove a custom item provider from the list of the given anchorblock
12210     *
12211     * Removes the function and data pairing that matches @p func and @p data.
12212     * That is, unless the same function and same user data are given, the
12213     * function will not be removed from the list. This allows us to add the
12214     * same callback several times, with different @p data pointers and be
12215     * able to remove them later without conflicts.
12216     *
12217     * @param obj The anchorblock object
12218     * @param func The function to remove from the list
12219     * @param data The data matching the function to remove from the list
12220     */
12221    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);
12222    /**
12223     * @}
12224     */
12225
12226    /**
12227     * @defgroup Bubble Bubble
12228     *
12229     * @image html img/widget/bubble/preview-00.png
12230     * @image latex img/widget/bubble/preview-00.eps
12231     * @image html img/widget/bubble/preview-01.png
12232     * @image latex img/widget/bubble/preview-01.eps
12233     * @image html img/widget/bubble/preview-02.png
12234     * @image latex img/widget/bubble/preview-02.eps
12235     *
12236     * @brief The Bubble is a widget to show text similarly to how speech is
12237     * represented in comics.
12238     *
12239     * The bubble widget contains 5 important visual elements:
12240     * @li The frame is a rectangle with rounded rectangles and an "arrow".
12241     * @li The @p icon is an image to which the frame's arrow points to.
12242     * @li The @p label is a text which appears to the right of the icon if the
12243     * corner is "top_left" or "bottom_left" and is right aligned to the frame
12244     * otherwise.
12245     * @li The @p info is a text which appears to the right of the label. Info's
12246     * font is of a ligther color than label.
12247     * @li The @p content is an evas object that is shown inside the frame.
12248     *
12249     * The position of the arrow, icon, label and info depends on which corner is
12250     * selected. The four available corners are:
12251     * @li "top_left" - Default
12252     * @li "top_right"
12253     * @li "bottom_left"
12254     * @li "bottom_right"
12255     *
12256     * Signals that you can add callbacks for are:
12257     * @li "clicked" - This is called when a user has clicked the bubble.
12258     *
12259     * For an example of using a buble see @ref bubble_01_example_page "this".
12260     *
12261     * @{
12262     */
12263    /**
12264     * Add a new bubble to the parent
12265     *
12266     * @param parent The parent object
12267     * @return The new object or NULL if it cannot be created
12268     *
12269     * This function adds a text bubble to the given parent evas object.
12270     */
12271    EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12272    /**
12273     * Set the label of the bubble
12274     *
12275     * @param obj The bubble object
12276     * @param label The string to set in the label
12277     *
12278     * This function sets the title of the bubble. Where this appears depends on
12279     * the selected corner.
12280     * @deprecated use elm_object_text_set() instead.
12281     */
12282    EINA_DEPRECATED EAPI void         elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12283    /**
12284     * Get the label of the bubble
12285     *
12286     * @param obj The bubble object
12287     * @return The string of set in the label
12288     *
12289     * This function gets the title of the bubble.
12290     * @deprecated use elm_object_text_get() instead.
12291     */
12292    EINA_DEPRECATED EAPI const char  *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12293    /**
12294     * Set the info of the bubble
12295     *
12296     * @param obj The bubble object
12297     * @param info The given info about the bubble
12298     *
12299     * This function sets the info of the bubble. Where this appears depends on
12300     * the selected corner.
12301     * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
12302     */
12303    EINA_DEPRECATED EAPI void         elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12304    /**
12305     * Get the info of the bubble
12306     *
12307     * @param obj The bubble object
12308     *
12309     * @return The "info" string of the bubble
12310     *
12311     * This function gets the info text.
12312     * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
12313     */
12314    EINA_DEPRECATED EAPI const char  *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12315    /**
12316     * Set the content to be shown in the bubble
12317     *
12318     * Once the content object is set, a previously set one will be deleted.
12319     * If you want to keep the old content object, use the
12320     * elm_bubble_content_unset() function.
12321     *
12322     * @param obj The bubble object
12323     * @param content The given content of the bubble
12324     *
12325     * This function sets the content shown on the middle of the bubble.
12326     */
12327    EAPI void         elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12328    /**
12329     * Get the content shown in the bubble
12330     *
12331     * Return the content object which is set for this widget.
12332     *
12333     * @param obj The bubble object
12334     * @return The content that is being used
12335     */
12336    EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12337    /**
12338     * Unset the content shown in the bubble
12339     *
12340     * Unparent and return the content object which was set for this widget.
12341     *
12342     * @param obj The bubble object
12343     * @return The content that was being used
12344     */
12345    EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12346    /**
12347     * Set the icon of the bubble
12348     *
12349     * Once the icon object is set, a previously set one will be deleted.
12350     * If you want to keep the old content object, use the
12351     * elm_icon_content_unset() function.
12352     *
12353     * @param obj The bubble object
12354     * @param icon The given icon for the bubble
12355     */
12356    EAPI void         elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12357    /**
12358     * Get the icon of the bubble
12359     *
12360     * @param obj The bubble object
12361     * @return The icon for the bubble
12362     *
12363     * This function gets the icon shown on the top left of bubble.
12364     */
12365    EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12366    /**
12367     * Unset the icon of the bubble
12368     *
12369     * Unparent and return the icon object which was set for this widget.
12370     *
12371     * @param obj The bubble object
12372     * @return The icon that was being used
12373     */
12374    EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12375    /**
12376     * Set the corner of the bubble
12377     *
12378     * @param obj The bubble object.
12379     * @param corner The given corner for the bubble.
12380     *
12381     * This function sets the corner of the bubble. The corner will be used to
12382     * determine where the arrow in the frame points to and where label, icon and
12383     * info arre shown.
12384     *
12385     * Possible values for corner are:
12386     * @li "top_left" - Default
12387     * @li "top_right"
12388     * @li "bottom_left"
12389     * @li "bottom_right"
12390     */
12391    EAPI void         elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12392    /**
12393     * Get the corner of the bubble
12394     *
12395     * @param obj The bubble object.
12396     * @return The given corner for the bubble.
12397     *
12398     * This function gets the selected corner of the bubble.
12399     */
12400    EAPI const char  *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12401    /**
12402     * @}
12403     */
12404
12405    /**
12406     * @defgroup Photo Photo
12407     *
12408     * For displaying the photo of a person (contact). Simple yet
12409     * with a very specific purpose.
12410     *
12411     * Signals that you can add callbacks for are:
12412     *
12413     * "clicked" - This is called when a user has clicked the photo
12414     * "drag,start" - Someone started dragging the image out of the object
12415     * "drag,end" - Dragged item was dropped (somewhere)
12416     *
12417     * @{
12418     */
12419
12420    /**
12421     * Add a new photo to the parent
12422     *
12423     * @param parent The parent object
12424     * @return The new object or NULL if it cannot be created
12425     *
12426     * @ingroup Photo
12427     */
12428    EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12429
12430    /**
12431     * Set the file that will be used as photo
12432     *
12433     * @param obj The photo object
12434     * @param file The path to file that will be used as photo
12435     *
12436     * @return (1 = success, 0 = error)
12437     *
12438     * @ingroup Photo
12439     */
12440    EAPI Eina_Bool    elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12441
12442     /**
12443     * Set the file that will be used as thumbnail in the photo.
12444     *
12445     * @param obj The photo object.
12446     * @param file The path to file that will be used as thumb.
12447     * @param group The key used in case of an EET file.
12448     *
12449     * @ingroup Photo
12450     */
12451    EAPI void         elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12452
12453    /**
12454     * Set the size that will be used on the photo
12455     *
12456     * @param obj The photo object
12457     * @param size The size that the photo will be
12458     *
12459     * @ingroup Photo
12460     */
12461    EAPI void         elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12462
12463    /**
12464     * Set if the photo should be completely visible or not.
12465     *
12466     * @param obj The photo object
12467     * @param fill if true the photo will be completely visible
12468     *
12469     * @ingroup Photo
12470     */
12471    EAPI void         elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12472
12473    /**
12474     * Set editability of the photo.
12475     *
12476     * An editable photo can be dragged to or from, and can be cut or
12477     * pasted too.  Note that pasting an image or dropping an item on
12478     * the image will delete the existing content.
12479     *
12480     * @param obj The photo object.
12481     * @param set To set of clear editablity.
12482     */
12483    EAPI void         elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12484
12485    /**
12486     * @}
12487     */
12488
12489    /* gesture layer */
12490    /**
12491     * @defgroup Elm_Gesture_Layer Gesture Layer
12492     * Gesture Layer Usage:
12493     *
12494     * Use Gesture Layer to detect gestures.
12495     * The advantage is that you don't have to implement
12496     * gesture detection, just set callbacks of gesture state.
12497     * By using gesture layer we make standard interface.
12498     *
12499     * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12500     * with a parent object parameter.
12501     * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12502     * call. Usually with same object as target (2nd parameter).
12503     *
12504     * Now you need to tell gesture layer what gestures you follow.
12505     * This is done with @ref elm_gesture_layer_cb_set call.
12506     * By setting the callback you actually saying to gesture layer:
12507     * I would like to know when the gesture @ref Elm_Gesture_Types
12508     * switches to state @ref Elm_Gesture_State.
12509     *
12510     * Next, you need to implement the actual action that follows the input
12511     * in your callback.
12512     *
12513     * Note that if you like to stop being reported about a gesture, just set
12514     * all callbacks referring this gesture to NULL.
12515     * (again with @ref elm_gesture_layer_cb_set)
12516     *
12517     * The information reported by gesture layer to your callback is depending
12518     * on @ref Elm_Gesture_Types:
12519     * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12520     * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12521     * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12522     *
12523     * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12524     * @ref ELM_GESTURE_MOMENTUM.
12525     *
12526     * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12527     * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12528     * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12529     * Note that we consider a flick as a line-gesture that should be completed
12530     * in flick-time-limit as defined in @ref Config.
12531     *
12532     * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12533     *
12534     * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12535     *
12536     *
12537     * Gesture Layer Tweaks:
12538     *
12539     * Note that line, flick, gestures can start without the need to remove fingers from surface.
12540     * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12541     *
12542     * Setting glayer_continues_enable to false in @ref Config will change this behavior
12543     * so gesture starts when user touches (a *DOWN event) touch-surface
12544     * and ends when no fingers touches surface (a *UP event).
12545     */
12546
12547    /**
12548     * @enum _Elm_Gesture_Types
12549     * Enum of supported gesture types.
12550     * @ingroup Elm_Gesture_Layer
12551     */
12552    enum _Elm_Gesture_Types
12553      {
12554         ELM_GESTURE_FIRST = 0,
12555
12556         ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12557         ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12558         ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12559         ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12560
12561         ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12562
12563         ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12564         ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12565
12566         ELM_GESTURE_ZOOM, /**< Zoom */
12567         ELM_GESTURE_ROTATE, /**< Rotate */
12568
12569         ELM_GESTURE_LAST
12570      };
12571
12572    /**
12573     * @typedef Elm_Gesture_Types
12574     * gesture types enum
12575     * @ingroup Elm_Gesture_Layer
12576     */
12577    typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12578
12579    /**
12580     * @enum _Elm_Gesture_State
12581     * Enum of gesture states.
12582     * @ingroup Elm_Gesture_Layer
12583     */
12584    enum _Elm_Gesture_State
12585      {
12586         ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12587         ELM_GESTURE_STATE_START,          /**< Gesture STARTed     */
12588         ELM_GESTURE_STATE_MOVE,           /**< Gesture is ongoing  */
12589         ELM_GESTURE_STATE_END,            /**< Gesture completed   */
12590         ELM_GESTURE_STATE_ABORT    /**< Onging gesture was ABORTed */
12591      };
12592
12593    /**
12594     * @typedef Elm_Gesture_State
12595     * gesture states enum
12596     * @ingroup Elm_Gesture_Layer
12597     */
12598    typedef enum _Elm_Gesture_State Elm_Gesture_State;
12599
12600    /**
12601     * @struct _Elm_Gesture_Taps_Info
12602     * Struct holds taps info for user
12603     * @ingroup Elm_Gesture_Layer
12604     */
12605    struct _Elm_Gesture_Taps_Info
12606      {
12607         Evas_Coord x, y;         /**< Holds center point between fingers */
12608         unsigned int n;          /**< Number of fingers tapped           */
12609         unsigned int timestamp;  /**< event timestamp       */
12610      };
12611
12612    /**
12613     * @typedef Elm_Gesture_Taps_Info
12614     * holds taps info for user
12615     * @ingroup Elm_Gesture_Layer
12616     */
12617    typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12618
12619    /**
12620     * @struct _Elm_Gesture_Momentum_Info
12621     * Struct holds momentum info for user
12622     * x1 and y1 are not necessarily in sync
12623     * x1 holds x value of x direction starting point
12624     * and same holds for y1.
12625     * This is noticeable when doing V-shape movement
12626     * @ingroup Elm_Gesture_Layer
12627     */
12628    struct _Elm_Gesture_Momentum_Info
12629      {  /* Report line ends, timestamps, and momentum computed        */
12630         Evas_Coord x1; /**< Final-swipe direction starting point on X */
12631         Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12632         Evas_Coord x2; /**< Final-swipe direction ending point on X   */
12633         Evas_Coord y2; /**< Final-swipe direction ending point on Y   */
12634
12635         unsigned int tx; /**< Timestamp of start of final x-swipe */
12636         unsigned int ty; /**< Timestamp of start of final y-swipe */
12637
12638         Evas_Coord mx; /**< Momentum on X */
12639         Evas_Coord my; /**< Momentum on Y */
12640      };
12641
12642    /**
12643     * @typedef Elm_Gesture_Momentum_Info
12644     * holds momentum info for user
12645     * @ingroup Elm_Gesture_Layer
12646     */
12647     typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12648
12649    /**
12650     * @struct _Elm_Gesture_Line_Info
12651     * Struct holds line info for user
12652     * @ingroup Elm_Gesture_Layer
12653     */
12654    struct _Elm_Gesture_Line_Info
12655      {  /* Report line ends, timestamps, and momentum computed      */
12656         Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12657         unsigned int n;            /**< Number of fingers (lines)   */
12658         /* FIXME should be radians, bot degrees */
12659         double angle;              /**< Angle (direction) of lines  */
12660      };
12661
12662    /**
12663     * @typedef Elm_Gesture_Line_Info
12664     * Holds line info for user
12665     * @ingroup Elm_Gesture_Layer
12666     */
12667     typedef struct  _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12668
12669    /**
12670     * @struct _Elm_Gesture_Zoom_Info
12671     * Struct holds zoom info for user
12672     * @ingroup Elm_Gesture_Layer
12673     */
12674    struct _Elm_Gesture_Zoom_Info
12675      {
12676         Evas_Coord x, y;       /**< Holds zoom center point reported to user  */
12677         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12678         double zoom;            /**< Zoom value: 1.0 means no zoom             */
12679         double momentum;        /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12680      };
12681
12682    /**
12683     * @typedef Elm_Gesture_Zoom_Info
12684     * Holds zoom info for user
12685     * @ingroup Elm_Gesture_Layer
12686     */
12687    typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12688
12689    /**
12690     * @struct _Elm_Gesture_Rotate_Info
12691     * Struct holds rotation info for user
12692     * @ingroup Elm_Gesture_Layer
12693     */
12694    struct _Elm_Gesture_Rotate_Info
12695      {
12696         Evas_Coord x, y;   /**< Holds zoom center point reported to user      */
12697         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12698         double base_angle; /**< Holds start-angle */
12699         double angle;      /**< Rotation value: 0.0 means no rotation         */
12700         double momentum;   /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12701      };
12702
12703    /**
12704     * @typedef Elm_Gesture_Rotate_Info
12705     * Holds rotation info for user
12706     * @ingroup Elm_Gesture_Layer
12707     */
12708    typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12709
12710    /**
12711     * @typedef Elm_Gesture_Event_Cb
12712     * User callback used to stream gesture info from gesture layer
12713     * @param data user data
12714     * @param event_info gesture report info
12715     * Returns a flag field to be applied on the causing event.
12716     * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12717     * upon the event, in an irreversible way.
12718     *
12719     * @ingroup Elm_Gesture_Layer
12720     */
12721    typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12722
12723    /**
12724     * Use function to set callbacks to be notified about
12725     * change of state of gesture.
12726     * When a user registers a callback with this function
12727     * this means this gesture has to be tested.
12728     *
12729     * When ALL callbacks for a gesture are set to NULL
12730     * it means user isn't interested in gesture-state
12731     * and it will not be tested.
12732     *
12733     * @param obj Pointer to gesture-layer.
12734     * @param idx The gesture you would like to track its state.
12735     * @param cb callback function pointer.
12736     * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12737     * @param data user info to be sent to callback (usually, Smart Data)
12738     *
12739     * @ingroup Elm_Gesture_Layer
12740     */
12741    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);
12742
12743    /**
12744     * Call this function to get repeat-events settings.
12745     *
12746     * @param obj Pointer to gesture-layer.
12747     *
12748     * @return repeat events settings.
12749     * @see elm_gesture_layer_hold_events_set()
12750     * @ingroup Elm_Gesture_Layer
12751     */
12752    EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12753
12754    /**
12755     * This function called in order to make gesture-layer repeat events.
12756     * Set this of you like to get the raw events only if gestures were not detected.
12757     * Clear this if you like gesture layer to fwd events as testing gestures.
12758     *
12759     * @param obj Pointer to gesture-layer.
12760     * @param r Repeat: TRUE/FALSE
12761     *
12762     * @ingroup Elm_Gesture_Layer
12763     */
12764    EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12765
12766    /**
12767     * This function sets step-value for zoom action.
12768     * Set step to any positive value.
12769     * Cancel step setting by setting to 0.0
12770     *
12771     * @param obj Pointer to gesture-layer.
12772     * @param s new zoom step value.
12773     *
12774     * @ingroup Elm_Gesture_Layer
12775     */
12776    EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12777
12778    /**
12779     * This function sets step-value for rotate action.
12780     * Set step to any positive value.
12781     * Cancel step setting by setting to 0.0
12782     *
12783     * @param obj Pointer to gesture-layer.
12784     * @param s new roatate step value.
12785     *
12786     * @ingroup Elm_Gesture_Layer
12787     */
12788    EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12789
12790    /**
12791     * This function called to attach gesture-layer to an Evas_Object.
12792     * @param obj Pointer to gesture-layer.
12793     * @param t Pointer to underlying object (AKA Target)
12794     *
12795     * @return TRUE, FALSE on success, failure.
12796     *
12797     * @ingroup Elm_Gesture_Layer
12798     */
12799    EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12800
12801    /**
12802     * Call this function to construct a new gesture-layer object.
12803     * This does not activate the gesture layer. You have to
12804     * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12805     *
12806     * @param parent the parent object.
12807     *
12808     * @return Pointer to new gesture-layer object.
12809     *
12810     * @ingroup Elm_Gesture_Layer
12811     */
12812    EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12813
12814    /**
12815     * @defgroup Thumb Thumb
12816     *
12817     * @image html img/widget/thumb/preview-00.png
12818     * @image latex img/widget/thumb/preview-00.eps
12819     *
12820     * A thumb object is used for displaying the thumbnail of an image or video.
12821     * You must have compiled Elementary with Ethumb_Client support and the DBus
12822     * service must be present and auto-activated in order to have thumbnails to
12823     * be generated.
12824     *
12825     * Once the thumbnail object becomes visible, it will check if there is a
12826     * previously generated thumbnail image for the file set on it. If not, it
12827     * will start generating this thumbnail.
12828     *
12829     * Different config settings will cause different thumbnails to be generated
12830     * even on the same file.
12831     *
12832     * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12833     * Ethumb documentation to change this path, and to see other configuration
12834     * options.
12835     *
12836     * Signals that you can add callbacks for are:
12837     *
12838     * - "clicked" - This is called when a user has clicked the thumb without dragging
12839     *             around.
12840     * - "clicked,double" - This is called when a user has double-clicked the thumb.
12841     * - "press" - This is called when a user has pressed down the thumb.
12842     * - "generate,start" - The thumbnail generation started.
12843     * - "generate,stop" - The generation process stopped.
12844     * - "generate,error" - The generation failed.
12845     * - "load,error" - The thumbnail image loading failed.
12846     *
12847     * available styles:
12848     * - default
12849     * - noframe
12850     *
12851     * An example of use of thumbnail:
12852     *
12853     * - @ref thumb_example_01
12854     */
12855
12856    /**
12857     * @addtogroup Thumb
12858     * @{
12859     */
12860
12861    /**
12862     * @enum _Elm_Thumb_Animation_Setting
12863     * @typedef Elm_Thumb_Animation_Setting
12864     *
12865     * Used to set if a video thumbnail is animating or not.
12866     *
12867     * @ingroup Thumb
12868     */
12869    typedef enum _Elm_Thumb_Animation_Setting
12870      {
12871         ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12872         ELM_THUMB_ANIMATION_LOOP,      /**< Keep playing animation until stop is requested */
12873         ELM_THUMB_ANIMATION_STOP,      /**< Stop playing the animation */
12874         ELM_THUMB_ANIMATION_LAST
12875      } Elm_Thumb_Animation_Setting;
12876
12877    /**
12878     * Add a new thumb object to the parent.
12879     *
12880     * @param parent The parent object.
12881     * @return The new object or NULL if it cannot be created.
12882     *
12883     * @see elm_thumb_file_set()
12884     * @see elm_thumb_ethumb_client_get()
12885     *
12886     * @ingroup Thumb
12887     */
12888    EAPI Evas_Object                 *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12889    /**
12890     * Reload thumbnail if it was generated before.
12891     *
12892     * @param obj The thumb object to reload
12893     *
12894     * This is useful if the ethumb client configuration changed, like its
12895     * size, aspect or any other property one set in the handle returned
12896     * by elm_thumb_ethumb_client_get().
12897     *
12898     * If the options didn't change, the thumbnail won't be generated again, but
12899     * the old one will still be used.
12900     *
12901     * @see elm_thumb_file_set()
12902     *
12903     * @ingroup Thumb
12904     */
12905    EAPI void                         elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
12906    /**
12907     * Set the file that will be used as thumbnail.
12908     *
12909     * @param obj The thumb object.
12910     * @param file The path to file that will be used as thumb.
12911     * @param key The key used in case of an EET file.
12912     *
12913     * The file can be an image or a video (in that case, acceptable extensions are:
12914     * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
12915     * function elm_thumb_animate().
12916     *
12917     * @see elm_thumb_file_get()
12918     * @see elm_thumb_reload()
12919     * @see elm_thumb_animate()
12920     *
12921     * @ingroup Thumb
12922     */
12923    EAPI void                         elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
12924    /**
12925     * Get the image or video path and key used to generate the thumbnail.
12926     *
12927     * @param obj The thumb object.
12928     * @param file Pointer to filename.
12929     * @param key Pointer to key.
12930     *
12931     * @see elm_thumb_file_set()
12932     * @see elm_thumb_path_get()
12933     *
12934     * @ingroup Thumb
12935     */
12936    EAPI void                         elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12937    /**
12938     * Get the path and key to the image or video generated by ethumb.
12939     *
12940     * One just need to make sure that the thumbnail was generated before getting
12941     * its path; otherwise, the path will be NULL. One way to do that is by asking
12942     * for the path when/after the "generate,stop" smart callback is called.
12943     *
12944     * @param obj The thumb object.
12945     * @param file Pointer to thumb path.
12946     * @param key Pointer to thumb key.
12947     *
12948     * @see elm_thumb_file_get()
12949     *
12950     * @ingroup Thumb
12951     */
12952    EAPI void                         elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12953    /**
12954     * Set the animation state for the thumb object. If its content is an animated
12955     * video, you may start/stop the animation or tell it to play continuously and
12956     * looping.
12957     *
12958     * @param obj The thumb object.
12959     * @param setting The animation setting.
12960     *
12961     * @see elm_thumb_file_set()
12962     *
12963     * @ingroup Thumb
12964     */
12965    EAPI void                         elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
12966    /**
12967     * Get the animation state for the thumb object.
12968     *
12969     * @param obj The thumb object.
12970     * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
12971     * on errors.
12972     *
12973     * @see elm_thumb_animate_set()
12974     *
12975     * @ingroup Thumb
12976     */
12977    EAPI Elm_Thumb_Animation_Setting  elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12978    /**
12979     * Get the ethumb_client handle so custom configuration can be made.
12980     *
12981     * @return Ethumb_Client instance or NULL.
12982     *
12983     * This must be called before the objects are created to be sure no object is
12984     * visible and no generation started.
12985     *
12986     * Example of usage:
12987     *
12988     * @code
12989     * #include <Elementary.h>
12990     * #ifndef ELM_LIB_QUICKLAUNCH
12991     * EAPI_MAIN int
12992     * elm_main(int argc, char **argv)
12993     * {
12994     *    Ethumb_Client *client;
12995     *
12996     *    elm_need_ethumb();
12997     *
12998     *    // ... your code
12999     *
13000     *    client = elm_thumb_ethumb_client_get();
13001     *    if (!client)
13002     *      {
13003     *         ERR("could not get ethumb_client");
13004     *         return 1;
13005     *      }
13006     *    ethumb_client_size_set(client, 100, 100);
13007     *    ethumb_client_crop_align_set(client, 0.5, 0.5);
13008     *    // ... your code
13009     *
13010     *    // Create elm_thumb objects here
13011     *
13012     *    elm_run();
13013     *    elm_shutdown();
13014     *    return 0;
13015     * }
13016     * #endif
13017     * ELM_MAIN()
13018     * @endcode
13019     *
13020     * @note There's only one client handle for Ethumb, so once a configuration
13021     * change is done to it, any other request for thumbnails (for any thumbnail
13022     * object) will use that configuration. Thus, this configuration is global.
13023     *
13024     * @ingroup Thumb
13025     */
13026    EAPI void                        *elm_thumb_ethumb_client_get(void);
13027    /**
13028     * Get the ethumb_client connection state.
13029     *
13030     * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
13031     * otherwise.
13032     */
13033    EAPI Eina_Bool                    elm_thumb_ethumb_client_connected(void);
13034    /**
13035     * Make the thumbnail 'editable'.
13036     *
13037     * @param obj Thumb object.
13038     * @param set Turn on or off editability. Default is @c EINA_FALSE.
13039     *
13040     * This means the thumbnail is a valid drag target for drag and drop, and can be
13041     * cut or pasted too.
13042     *
13043     * @see elm_thumb_editable_get()
13044     *
13045     * @ingroup Thumb
13046     */
13047    EAPI Eina_Bool                    elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
13048    /**
13049     * Make the thumbnail 'editable'.
13050     *
13051     * @param obj Thumb object.
13052     * @return Editability.
13053     *
13054     * This means the thumbnail is a valid drag target for drag and drop, and can be
13055     * cut or pasted too.
13056     *
13057     * @see elm_thumb_editable_set()
13058     *
13059     * @ingroup Thumb
13060     */
13061    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13062
13063    /**
13064     * @}
13065     */
13066
13067    /**
13068     * @defgroup Web Web
13069     *
13070     * @image html img/widget/web/preview-00.png
13071     * @image latex img/widget/web/preview-00.eps
13072     *
13073     * A web object is used for displaying web pages (HTML/CSS/JS)
13074     * using WebKit-EFL. You must have compiled Elementary with
13075     * ewebkit support.
13076     *
13077     * Signals that you can add callbacks for are:
13078     * @li "download,request": A file download has been requested. Event info is
13079     * a pointer to a Elm_Web_Download
13080     * @li "editorclient,contents,changed": Editor client's contents changed
13081     * @li "editorclient,selection,changed": Editor client's selection changed
13082     * @li "frame,created": A new frame was created. Event info is an
13083     * Evas_Object which can be handled with WebKit's ewk_frame API
13084     * @li "icon,received": An icon was received by the main frame
13085     * @li "inputmethod,changed": Input method changed. Event info is an
13086     * Eina_Bool indicating whether it's enabled or not
13087     * @li "js,windowobject,clear": JS window object has been cleared
13088     * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
13089     * is a char *link[2], where the first string contains the URL the link
13090     * points to, and the second one the title of the link
13091     * @li "link,hover,out": Mouse cursor left the link
13092     * @li "load,document,finished": Loading of a document finished. Event info
13093     * is the frame that finished loading
13094     * @li "load,error": Load failed. Event info is a pointer to
13095     * Elm_Web_Frame_Load_Error
13096     * @li "load,finished": Load finished. Event info is NULL on success, on
13097     * error it's a pointer to Elm_Web_Frame_Load_Error
13098     * @li "load,newwindow,show": A new window was created and is ready to be
13099     * shown
13100     * @li "load,progress": Overall load progress. Event info is a pointer to
13101     * a double containing a value between 0.0 and 1.0
13102     * @li "load,provisional": Started provisional load
13103     * @li "load,started": Loading of a document started
13104     * @li "menubar,visible,get": Queries if the menubar is visible. Event info
13105     * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
13106     * the menubar is visible, or EINA_FALSE in case it's not
13107     * @li "menubar,visible,set": Informs menubar visibility. Event info is
13108     * an Eina_Bool indicating the visibility
13109     * @li "popup,created": A dropdown widget was activated, requesting its
13110     * popup menu to be created. Event info is a pointer to Elm_Web_Menu
13111     * @li "popup,willdelete": The web object is ready to destroy the popup
13112     * object created. Event info is a pointer to Elm_Web_Menu
13113     * @li "ready": Page is fully loaded
13114     * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
13115     * info is a pointer to Eina_Bool where the visibility state should be set
13116     * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
13117     * is an Eina_Bool with the visibility state set
13118     * @li "statusbar,text,set": Text of the statusbar changed. Even info is
13119     * a string with the new text
13120     * @li "statusbar,visible,get": Queries visibility of the status bar.
13121     * Event info is a pointer to Eina_Bool where the visibility state should be
13122     * set.
13123     * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
13124     * an Eina_Bool with the visibility value
13125     * @li "title,changed": Title of the main frame changed. Event info is a
13126     * string with the new title
13127     * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
13128     * is a pointer to Eina_Bool where the visibility state should be set
13129     * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
13130     * info is an Eina_Bool with the visibility state
13131     * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
13132     * a string with the text to show
13133     * @li "uri,changed": URI of the main frame changed. Event info is a string
13134     * with the new URI
13135     * @li "view,resized": The web object internal's view changed sized
13136     * @li "windows,close,request": A JavaScript request to close the current
13137     * window was requested
13138     * @li "zoom,animated,end": Animated zoom finished
13139     *
13140     * available styles:
13141     * - default
13142     *
13143     * An example of use of web:
13144     *
13145     * - @ref web_example_01 TBD
13146     */
13147
13148    /**
13149     * @addtogroup Web
13150     * @{
13151     */
13152
13153    /**
13154     * Structure used to report load errors.
13155     *
13156     * Load errors are reported as signal by elm_web. All the strings are
13157     * temporary references and should @b not be used after the signal
13158     * callback returns. If it's required, make copies with strdup() or
13159     * eina_stringshare_add() (they are not even guaranteed to be
13160     * stringshared, so must use eina_stringshare_add() and not
13161     * eina_stringshare_ref()).
13162     */
13163    typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
13164    /**
13165     * Structure used to report load errors.
13166     *
13167     * Load errors are reported as signal by elm_web. All the strings are
13168     * temporary references and should @b not be used after the signal
13169     * callback returns. If it's required, make copies with strdup() or
13170     * eina_stringshare_add() (they are not even guaranteed to be
13171     * stringshared, so must use eina_stringshare_add() and not
13172     * eina_stringshare_ref()).
13173     */
13174    struct _Elm_Web_Frame_Load_Error
13175      {
13176         int code; /**< Numeric error code */
13177         Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
13178         const char *domain; /**< Error domain name */
13179         const char *description; /**< Error description (already localized) */
13180         const char *failing_url; /**< The URL that failed to load */
13181         Evas_Object *frame; /**< Frame object that produced the error */
13182      };
13183
13184    /**
13185     * The possibles types that the items in a menu can be
13186     */
13187    typedef enum _Elm_Web_Menu_Item_Type
13188      {
13189         ELM_WEB_MENU_SEPARATOR,
13190         ELM_WEB_MENU_GROUP,
13191         ELM_WEB_MENU_OPTION
13192      } Elm_Web_Menu_Item_Type;
13193
13194    /**
13195     * Structure describing the items in a menu
13196     */
13197    typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
13198    /**
13199     * Structure describing the items in a menu
13200     */
13201    struct _Elm_Web_Menu_Item
13202      {
13203         const char *text; /**< The text for the item */
13204         Elm_Web_Menu_Item_Type type; /**< The type of the item */
13205      };
13206
13207    /**
13208     * Structure describing the menu of a popup
13209     *
13210     * This structure will be passed as the @c event_info for the "popup,create"
13211     * signal, which is emitted when a dropdown menu is opened. Users wanting
13212     * to handle these popups by themselves should listen to this signal and
13213     * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13214     * property as @c EINA_FALSE means that the user will not handle the popup
13215     * and the default implementation will be used.
13216     *
13217     * When the popup is ready to be dismissed, a "popup,willdelete" signal
13218     * will be emitted to notify the user that it can destroy any objects and
13219     * free all data related to it.
13220     *
13221     * @see elm_web_popup_selected_set()
13222     * @see elm_web_popup_destroy()
13223     */
13224    typedef struct _Elm_Web_Menu Elm_Web_Menu;
13225    /**
13226     * Structure describing the menu of a popup
13227     *
13228     * This structure will be passed as the @c event_info for the "popup,create"
13229     * signal, which is emitted when a dropdown menu is opened. Users wanting
13230     * to handle these popups by themselves should listen to this signal and
13231     * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13232     * property as @c EINA_FALSE means that the user will not handle the popup
13233     * and the default implementation will be used.
13234     *
13235     * When the popup is ready to be dismissed, a "popup,willdelete" signal
13236     * will be emitted to notify the user that it can destroy any objects and
13237     * free all data related to it.
13238     *
13239     * @see elm_web_popup_selected_set()
13240     * @see elm_web_popup_destroy()
13241     */
13242    struct _Elm_Web_Menu
13243      {
13244         Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13245         int x; /**< The X position of the popup, relative to the elm_web object */
13246         int y; /**< The Y position of the popup, relative to the elm_web object */
13247         int width; /**< Width of the popup menu */
13248         int height; /**< Height of the popup menu */
13249
13250         Eina_Bool handled : 1; /**< Set to @c EINA_TRUE by the user to indicate that the popup has been handled and the default implementation should be ignored. Leave as @c EINA_FALSE otherwise. */
13251      };
13252
13253    typedef struct _Elm_Web_Download Elm_Web_Download;
13254    struct _Elm_Web_Download
13255      {
13256         const char *url;
13257      };
13258
13259    /**
13260     * Types of zoom available.
13261     */
13262    typedef enum _Elm_Web_Zoom_Mode
13263      {
13264         ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_web_zoom_set */
13265         ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13266         ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13267         ELM_WEB_ZOOM_MODE_LAST
13268      } Elm_Web_Zoom_Mode;
13269    /**
13270     * Opaque handler containing the features (such as statusbar, menubar, etc)
13271     * that are to be set on a newly requested window.
13272     */
13273    typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13274    /**
13275     * Callback type for the create_window hook.
13276     *
13277     * The function parameters are:
13278     * @li @p data User data pointer set when setting the hook function
13279     * @li @p obj The elm_web object requesting the new window
13280     * @li @p js Set to @c EINA_TRUE if the request was originated from
13281     * JavaScript. @c EINA_FALSE otherwise.
13282     * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13283     * the features requested for the new window.
13284     *
13285     * The returned value of the function should be the @c elm_web widget where
13286     * the request will be loaded. That is, if a new window or tab is created,
13287     * the elm_web widget in it should be returned, and @b NOT the window
13288     * object.
13289     * Returning @c NULL should cancel the request.
13290     *
13291     * @see elm_web_window_create_hook_set()
13292     */
13293    typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13294    /**
13295     * Callback type for the JS alert hook.
13296     *
13297     * The function parameters are:
13298     * @li @p data User data pointer set when setting the hook function
13299     * @li @p obj The elm_web object requesting the new window
13300     * @li @p message The message to show in the alert dialog
13301     *
13302     * The function should return the object representing the alert dialog.
13303     * Elm_Web will run a second main loop to handle the dialog and normal
13304     * flow of the application will be restored when the object is deleted, so
13305     * the user should handle the popup properly in order to delete the object
13306     * when the action is finished.
13307     * If the function returns @c NULL the popup will be ignored.
13308     *
13309     * @see elm_web_dialog_alert_hook_set()
13310     */
13311    typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13312    /**
13313     * Callback type for the JS confirm hook.
13314     *
13315     * The function parameters are:
13316     * @li @p data User data pointer set when setting the hook function
13317     * @li @p obj The elm_web object requesting the new window
13318     * @li @p message The message to show in the confirm dialog
13319     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13320     * the user selected @c Ok, @c EINA_FALSE otherwise.
13321     *
13322     * The function should return the object representing the confirm dialog.
13323     * Elm_Web will run a second main loop to handle the dialog and normal
13324     * flow of the application will be restored when the object is deleted, so
13325     * the user should handle the popup properly in order to delete the object
13326     * when the action is finished.
13327     * If the function returns @c NULL the popup will be ignored.
13328     *
13329     * @see elm_web_dialog_confirm_hook_set()
13330     */
13331    typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13332    /**
13333     * Callback type for the JS prompt hook.
13334     *
13335     * The function parameters are:
13336     * @li @p data User data pointer set when setting the hook function
13337     * @li @p obj The elm_web object requesting the new window
13338     * @li @p message The message to show in the prompt dialog
13339     * @li @p def_value The default value to present the user in the entry
13340     * @li @p value Pointer where to store the value given by the user. Must
13341     * be a malloc'ed string or @c NULL if the user cancelled the popup.
13342     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13343     * the user selected @c Ok, @c EINA_FALSE otherwise.
13344     *
13345     * The function should return the object representing the prompt dialog.
13346     * Elm_Web will run a second main loop to handle the dialog and normal
13347     * flow of the application will be restored when the object is deleted, so
13348     * the user should handle the popup properly in order to delete the object
13349     * when the action is finished.
13350     * If the function returns @c NULL the popup will be ignored.
13351     *
13352     * @see elm_web_dialog_prompt_hook_set()
13353     */
13354    typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13355    /**
13356     * Callback type for the JS file selector hook.
13357     *
13358     * The function parameters are:
13359     * @li @p data User data pointer set when setting the hook function
13360     * @li @p obj The elm_web object requesting the new window
13361     * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13362     * @li @p accept_types Mime types accepted
13363     * @li @p selected Pointer where to store the list of malloc'ed strings
13364     * containing the path to each file selected. Must be @c NULL if the file
13365     * dialog is cancelled
13366     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13367     * the user selected @c Ok, @c EINA_FALSE otherwise.
13368     *
13369     * The function should return the object representing the file selector
13370     * dialog.
13371     * Elm_Web will run a second main loop to handle the dialog and normal
13372     * flow of the application will be restored when the object is deleted, so
13373     * the user should handle the popup properly in order to delete the object
13374     * when the action is finished.
13375     * If the function returns @c NULL the popup will be ignored.
13376     *
13377     * @see elm_web_dialog_file selector_hook_set()
13378     */
13379    typedef Evas_Object *(*Elm_Web_Dialog_File_Selector)(void *data, Evas_Object *obj, Eina_Bool allows_multiple, Eina_List *accept_types, Eina_List **selected, Eina_Bool *ret);
13380    /**
13381     * Callback type for the JS console message hook.
13382     *
13383     * When a console message is added from JavaScript, any set function to the
13384     * console message hook will be called for the user to handle. There is no
13385     * default implementation of this hook.
13386     *
13387     * The function parameters are:
13388     * @li @p data User data pointer set when setting the hook function
13389     * @li @p obj The elm_web object that originated the message
13390     * @li @p message The message sent
13391     * @li @p line_number The line number
13392     * @li @p source_id Source id
13393     *
13394     * @see elm_web_console_message_hook_set()
13395     */
13396    typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13397    /**
13398     * Add a new web object to the parent.
13399     *
13400     * @param parent The parent object.
13401     * @return The new object or NULL if it cannot be created.
13402     *
13403     * @see elm_web_uri_set()
13404     * @see elm_web_webkit_view_get()
13405     */
13406    EAPI Evas_Object                 *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13407
13408    /**
13409     * Get internal ewk_view object from web object.
13410     *
13411     * Elementary may not provide some low level features of EWebKit,
13412     * instead of cluttering the API with proxy methods we opted to
13413     * return the internal reference. Be careful using it as it may
13414     * interfere with elm_web behavior.
13415     *
13416     * @param obj The web object.
13417     * @return The internal ewk_view object or NULL if it does not
13418     *         exist. (Failure to create or Elementary compiled without
13419     *         ewebkit)
13420     *
13421     * @see elm_web_add()
13422     */
13423    EAPI Evas_Object                 *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13424
13425    /**
13426     * Sets the function to call when a new window is requested
13427     *
13428     * This hook will be called when a request to create a new window is
13429     * issued from the web page loaded.
13430     * There is no default implementation for this feature, so leaving this
13431     * unset or passing @c NULL in @p func will prevent new windows from
13432     * opening.
13433     *
13434     * @param obj The web object where to set the hook function
13435     * @param func The hook function to be called when a window is requested
13436     * @param data User data
13437     */
13438    EAPI void                         elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13439    /**
13440     * Sets the function to call when an alert dialog
13441     *
13442     * This hook will be called when a JavaScript alert dialog is requested.
13443     * If no function is set or @c NULL is passed in @p func, the default
13444     * implementation will take place.
13445     *
13446     * @param obj The web object where to set the hook function
13447     * @param func The callback function to be used
13448     * @param data User data
13449     *
13450     * @see elm_web_inwin_mode_set()
13451     */
13452    EAPI void                         elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13453    /**
13454     * Sets the function to call when an confirm dialog
13455     *
13456     * This hook will be called when a JavaScript confirm dialog is requested.
13457     * If no function is set or @c NULL is passed in @p func, the default
13458     * implementation will take place.
13459     *
13460     * @param obj The web object where to set the hook function
13461     * @param func The callback function to be used
13462     * @param data User data
13463     *
13464     * @see elm_web_inwin_mode_set()
13465     */
13466    EAPI void                         elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13467    /**
13468     * Sets the function to call when an prompt dialog
13469     *
13470     * This hook will be called when a JavaScript prompt dialog is requested.
13471     * If no function is set or @c NULL is passed in @p func, the default
13472     * implementation will take place.
13473     *
13474     * @param obj The web object where to set the hook function
13475     * @param func The callback function to be used
13476     * @param data User data
13477     *
13478     * @see elm_web_inwin_mode_set()
13479     */
13480    EAPI void                         elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13481    /**
13482     * Sets the function to call when an file selector dialog
13483     *
13484     * This hook will be called when a JavaScript file selector dialog is
13485     * requested.
13486     * If no function is set or @c NULL is passed in @p func, the default
13487     * implementation will take place.
13488     *
13489     * @param obj The web object where to set the hook function
13490     * @param func The callback function to be used
13491     * @param data User data
13492     *
13493     * @see elm_web_inwin_mode_set()
13494     */
13495    EAPI void                         elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13496    /**
13497     * Sets the function to call when a console message is emitted from JS
13498     *
13499     * This hook will be called when a console message is emitted from
13500     * JavaScript. There is no default implementation for this feature.
13501     *
13502     * @param obj The web object where to set the hook function
13503     * @param func The callback function to be used
13504     * @param data User data
13505     */
13506    EAPI void                         elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13507    /**
13508     * Gets the status of the tab propagation
13509     *
13510     * @param obj The web object to query
13511     * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13512     *
13513     * @see elm_web_tab_propagate_set()
13514     */
13515    EAPI Eina_Bool                    elm_web_tab_propagate_get(const Evas_Object *obj);
13516    /**
13517     * Sets whether to use tab propagation
13518     *
13519     * If tab propagation is enabled, whenever the user presses the Tab key,
13520     * Elementary will handle it and switch focus to the next widget.
13521     * The default value is disabled, where WebKit will handle the Tab key to
13522     * cycle focus though its internal objects, jumping to the next widget
13523     * only when that cycle ends.
13524     *
13525     * @param obj The web object
13526     * @param propagate Whether to propagate Tab keys to Elementary or not
13527     */
13528    EAPI void                         elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13529    /**
13530     * Sets the URI for the web object
13531     *
13532     * It must be a full URI, with resource included, in the form
13533     * http://www.enlightenment.org or file:///tmp/something.html
13534     *
13535     * @param obj The web object
13536     * @param uri The URI to set
13537     * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13538     */
13539    EAPI Eina_Bool                    elm_web_uri_set(Evas_Object *obj, const char *uri);
13540    /**
13541     * Gets the current URI for the object
13542     *
13543     * The returned string must not be freed and is guaranteed to be
13544     * stringshared.
13545     *
13546     * @param obj The web object
13547     * @return A stringshared internal string with the current URI, or NULL on
13548     * failure
13549     */
13550    EAPI const char                  *elm_web_uri_get(const Evas_Object *obj);
13551    /**
13552     * Gets the current title
13553     *
13554     * The returned string must not be freed and is guaranteed to be
13555     * stringshared.
13556     *
13557     * @param obj The web object
13558     * @return A stringshared internal string with the current title, or NULL on
13559     * failure
13560     */
13561    EAPI const char                  *elm_web_title_get(const Evas_Object *obj);
13562    /**
13563     * Sets the background color to be used by the web object
13564     *
13565     * This is the color that will be used by default when the loaded page
13566     * does not set it's own. Color values are pre-multiplied.
13567     *
13568     * @param obj The web object
13569     * @param r Red component
13570     * @param g Green component
13571     * @param b Blue component
13572     * @param a Alpha component
13573     */
13574    EAPI void                         elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13575    /**
13576     * Gets the background color to be used by the web object
13577     *
13578     * This is the color that will be used by default when the loaded page
13579     * does not set it's own. Color values are pre-multiplied.
13580     *
13581     * @param obj The web object
13582     * @param r Red component
13583     * @param g Green component
13584     * @param b Blue component
13585     * @param a Alpha component
13586     */
13587    EAPI void                         elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
13588    /**
13589     * Gets a copy of the currently selected text
13590     *
13591     * The string returned must be freed by the user when it's done with it.
13592     *
13593     * @param obj The web object
13594     * @return A newly allocated string, or NULL if nothing is selected or an
13595     * error occurred
13596     */
13597    EAPI char                        *elm_view_selection_get(const Evas_Object *obj);
13598    /**
13599     * Tells the web object which index in the currently open popup was selected
13600     *
13601     * When the user handles the popup creation from the "popup,created" signal,
13602     * it needs to tell the web object which item was selected by calling this
13603     * function with the index corresponding to the item.
13604     *
13605     * @param obj The web object
13606     * @param index The index selected
13607     *
13608     * @see elm_web_popup_destroy()
13609     */
13610    EAPI void                         elm_web_popup_selected_set(Evas_Object *obj, int index);
13611    /**
13612     * Dismisses an open dropdown popup
13613     *
13614     * When the popup from a dropdown widget is to be dismissed, either after
13615     * selecting an option or to cancel it, this function must be called, which
13616     * will later emit an "popup,willdelete" signal to notify the user that
13617     * any memory and objects related to this popup can be freed.
13618     *
13619     * @param obj The web object
13620     * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
13621     * if there was no menu to destroy
13622     */
13623    EAPI Eina_Bool                    elm_web_popup_destroy(Evas_Object *obj);
13624    /**
13625     * Searches the given string in a document.
13626     *
13627     * @param obj The web object where to search the text
13628     * @param string String to search
13629     * @param case_sensitive If search should be case sensitive or not
13630     * @param forward If search is from cursor and on or backwards
13631     * @param wrap If search should wrap at the end
13632     *
13633     * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
13634     * or failure
13635     */
13636    EAPI Eina_Bool                    elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
13637    /**
13638     * Marks matches of the given string in a document.
13639     *
13640     * @param obj The web object where to search text
13641     * @param string String to match
13642     * @param case_sensitive If match should be case sensitive or not
13643     * @param highlight If matches should be highlighted
13644     * @param limit Maximum amount of matches, or zero to unlimited
13645     *
13646     * @return number of matched @a string
13647     */
13648    EAPI unsigned int                 elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
13649    /**
13650     * Clears all marked matches in the document
13651     *
13652     * @param obj The web object
13653     *
13654     * @return EINA_TRUE on success, EINA_FALSE otherwise
13655     */
13656    EAPI Eina_Bool                    elm_web_text_matches_unmark_all(Evas_Object *obj);
13657    /**
13658     * Sets whether to highlight the matched marks
13659     *
13660     * If enabled, marks set with elm_web_text_matches_mark() will be
13661     * highlighted.
13662     *
13663     * @param obj The web object
13664     * @param highlight Whether to highlight the marks or not
13665     *
13666     * @return EINA_TRUE on success, EINA_FALSE otherwise
13667     */
13668    EAPI Eina_Bool                    elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
13669    /**
13670     * Gets whether highlighting marks is enabled
13671     *
13672     * @param The web object
13673     *
13674     * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
13675     * otherwise
13676     */
13677    EAPI Eina_Bool                    elm_web_text_matches_highlight_get(const Evas_Object *obj);
13678    /**
13679     * Gets the overall loading progress of the page
13680     *
13681     * Returns the estimated loading progress of the page, with a value between
13682     * 0.0 and 1.0. This is an estimated progress accounting for all the frames
13683     * included in the page.
13684     *
13685     * @param The web object
13686     *
13687     * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
13688     * failure
13689     */
13690    EAPI double                       elm_web_load_progress_get(const Evas_Object *obj);
13691    /**
13692     * Stops loading the current page
13693     *
13694     * Cancels the loading of the current page in the web object. This will
13695     * cause a "load,error" signal to be emitted, with the is_cancellation
13696     * flag set to EINA_TRUE.
13697     *
13698     * @param obj The web object
13699     *
13700     * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
13701     */
13702    EAPI Eina_Bool                    elm_web_stop(Evas_Object *obj);
13703    /**
13704     * Requests a reload of the current document in the object
13705     *
13706     * @param obj The web object
13707     *
13708     * @return EINA_TRUE on success, EINA_FALSE otherwise
13709     */
13710    EAPI Eina_Bool                    elm_web_reload(Evas_Object *obj);
13711    /**
13712     * Requests a reload of the current document, avoiding any existing caches
13713     *
13714     * @param obj The web object
13715     *
13716     * @return EINA_TRUE on success, EINA_FALSE otherwise
13717     */
13718    EAPI Eina_Bool                    elm_web_reload_full(Evas_Object *obj);
13719    /**
13720     * Goes back one step in the browsing history
13721     *
13722     * This is equivalent to calling elm_web_object_navigate(obj, -1);
13723     *
13724     * @param obj The web object
13725     *
13726     * @return EINA_TRUE on success, EINA_FALSE otherwise
13727     *
13728     * @see elm_web_history_enable_set()
13729     * @see elm_web_back_possible()
13730     * @see elm_web_forward()
13731     * @see elm_web_navigate()
13732     */
13733    EAPI Eina_Bool                    elm_web_back(Evas_Object *obj);
13734    /**
13735     * Goes forward one step in the browsing history
13736     *
13737     * This is equivalent to calling elm_web_object_navigate(obj, 1);
13738     *
13739     * @param obj The web object
13740     *
13741     * @return EINA_TRUE on success, EINA_FALSE otherwise
13742     *
13743     * @see elm_web_history_enable_set()
13744     * @see elm_web_forward_possible()
13745     * @see elm_web_back()
13746     * @see elm_web_navigate()
13747     */
13748    EAPI Eina_Bool                    elm_web_forward(Evas_Object *obj);
13749    /**
13750     * Jumps the given number of steps in the browsing history
13751     *
13752     * The @p steps value can be a negative integer to back in history, or a
13753     * positive to move forward.
13754     *
13755     * @param obj The web object
13756     * @param steps The number of steps to jump
13757     *
13758     * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
13759     * history exists to jump the given number of steps
13760     *
13761     * @see elm_web_history_enable_set()
13762     * @see elm_web_navigate_possible()
13763     * @see elm_web_back()
13764     * @see elm_web_forward()
13765     */
13766    EAPI Eina_Bool                    elm_web_navigate(Evas_Object *obj, int steps);
13767    /**
13768     * Queries whether it's possible to go back in history
13769     *
13770     * @param obj The web object
13771     *
13772     * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
13773     * otherwise
13774     */
13775    EAPI Eina_Bool                    elm_web_back_possible(Evas_Object *obj);
13776    /**
13777     * Queries whether it's possible to go forward in history
13778     *
13779     * @param obj The web object
13780     *
13781     * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
13782     * otherwise
13783     */
13784    EAPI Eina_Bool                    elm_web_forward_possible(Evas_Object *obj);
13785    /**
13786     * Queries whether it's possible to jump the given number of steps
13787     *
13788     * The @p steps value can be a negative integer to back in history, or a
13789     * positive to move forward.
13790     *
13791     * @param obj The web object
13792     * @param steps The number of steps to check for
13793     *
13794     * @return EINA_TRUE if enough history exists to perform the given jump,
13795     * EINA_FALSE otherwise
13796     */
13797    EAPI Eina_Bool                    elm_web_navigate_possible(Evas_Object *obj, int steps);
13798    /**
13799     * Gets whether browsing history is enabled for the given object
13800     *
13801     * @param obj The web object
13802     *
13803     * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
13804     */
13805    EAPI Eina_Bool                    elm_web_history_enable_get(const Evas_Object *obj);
13806    /**
13807     * Enables or disables the browsing history
13808     *
13809     * @param obj The web object
13810     * @param enable Whether to enable or disable the browsing history
13811     */
13812    EAPI void                         elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
13813    /**
13814     * Sets the zoom level of the web object
13815     *
13816     * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
13817     * values meaning zoom in and lower meaning zoom out. This function will
13818     * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
13819     * is ::ELM_WEB_ZOOM_MODE_MANUAL.
13820     *
13821     * @param obj The web object
13822     * @param zoom The zoom level to set
13823     */
13824    EAPI void                         elm_web_zoom_set(Evas_Object *obj, double zoom);
13825    /**
13826     * Gets the current zoom level set on the web object
13827     *
13828     * Note that this is the zoom level set on the web object and not that
13829     * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
13830     * the two zoom levels should match, but for the other two modes the
13831     * Webkit zoom is calculated internally to match the chosen mode without
13832     * changing the zoom level set for the web object.
13833     *
13834     * @param obj The web object
13835     *
13836     * @return The zoom level set on the object
13837     */
13838    EAPI double                       elm_web_zoom_get(const Evas_Object *obj);
13839    /**
13840     * Sets the zoom mode to use
13841     *
13842     * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
13843     * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
13844     *
13845     * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
13846     * with the elm_web_zoom_set() function.
13847     * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
13848     * make sure the entirety of the web object's contents are shown.
13849     * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
13850     * fit the contents in the web object's size, without leaving any space
13851     * unused.
13852     *
13853     * @param obj The web object
13854     * @param mode The mode to set
13855     */
13856    EAPI void                         elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
13857    /**
13858     * Gets the currently set zoom mode
13859     *
13860     * @param obj The web object
13861     *
13862     * @return The current zoom mode set for the object, or
13863     * ::ELM_WEB_ZOOM_MODE_LAST on error
13864     */
13865    EAPI Elm_Web_Zoom_Mode            elm_web_zoom_mode_get(const Evas_Object *obj);
13866    /**
13867     * Shows the given region in the web object
13868     *
13869     * @param obj The web object
13870     * @param x The x coordinate of the region to show
13871     * @param y The y coordinate of the region to show
13872     * @param w The width of the region to show
13873     * @param h The height of the region to show
13874     */
13875    EAPI void                         elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
13876    /**
13877     * Brings in the region to the visible area
13878     *
13879     * Like elm_web_region_show(), but it animates the scrolling of the object
13880     * to show the area
13881     *
13882     * @param obj The web object
13883     * @param x The x coordinate of the region to show
13884     * @param y The y coordinate of the region to show
13885     * @param w The width of the region to show
13886     * @param h The height of the region to show
13887     */
13888    EAPI void                         elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
13889    /**
13890     * Sets the default dialogs to use an Inwin instead of a normal window
13891     *
13892     * If set, then the default implementation for the JavaScript dialogs and
13893     * file selector will be opened in an Inwin. Otherwise they will use a
13894     * normal separated window.
13895     *
13896     * @param obj The web object
13897     * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
13898     */
13899    EAPI void                         elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
13900    /**
13901     * Gets whether Inwin mode is set for the current object
13902     *
13903     * @param obj The web object
13904     *
13905     * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
13906     */
13907    EAPI Eina_Bool                    elm_web_inwin_mode_get(const Evas_Object *obj);
13908
13909    EAPI void                         elm_web_window_features_ref(Elm_Web_Window_Features *wf);
13910    EAPI void                         elm_web_window_features_unref(Elm_Web_Window_Features *wf);
13911    EAPI void                         elm_web_window_features_bool_property_get(const Elm_Web_Window_Features *wf, Eina_Bool *toolbar_visible, Eina_Bool *statusbar_visible, Eina_Bool *scrollbars_visible, Eina_Bool *menubar_visible, Eina_Bool *locationbar_visble, Eina_Bool *fullscreen);
13912    EAPI void                         elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
13913
13914    /**
13915     * @}
13916     */
13917
13918    /**
13919     * @defgroup Hoversel Hoversel
13920     *
13921     * @image html img/widget/hoversel/preview-00.png
13922     * @image latex img/widget/hoversel/preview-00.eps
13923     *
13924     * A hoversel is a button that pops up a list of items (automatically
13925     * choosing the direction to display) that have a label and, optionally, an
13926     * icon to select from. It is a convenience widget to avoid the need to do
13927     * all the piecing together yourself. It is intended for a small number of
13928     * items in the hoversel menu (no more than 8), though is capable of many
13929     * more.
13930     *
13931     * Signals that you can add callbacks for are:
13932     * "clicked" - the user clicked the hoversel button and popped up the sel
13933     * "selected" - an item in the hoversel list is selected. event_info is the item
13934     * "dismissed" - the hover is dismissed
13935     *
13936     * See @ref tutorial_hoversel for an example.
13937     * @{
13938     */
13939    typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
13940    /**
13941     * @brief Add a new Hoversel object
13942     *
13943     * @param parent The parent object
13944     * @return The new object or NULL if it cannot be created
13945     */
13946    EAPI Evas_Object       *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13947    /**
13948     * @brief This sets the hoversel to expand horizontally.
13949     *
13950     * @param obj The hoversel object
13951     * @param horizontal If true, the hover will expand horizontally to the
13952     * right.
13953     *
13954     * @note The initial button will display horizontally regardless of this
13955     * setting.
13956     */
13957    EAPI void               elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
13958    /**
13959     * @brief This returns whether the hoversel is set to expand horizontally.
13960     *
13961     * @param obj The hoversel object
13962     * @return If true, the hover will expand horizontally to the right.
13963     *
13964     * @see elm_hoversel_horizontal_set()
13965     */
13966    EAPI Eina_Bool          elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13967    /**
13968     * @brief Set the Hover parent
13969     *
13970     * @param obj The hoversel object
13971     * @param parent The parent to use
13972     *
13973     * Sets the hover parent object, the area that will be darkened when the
13974     * hoversel is clicked. Should probably be the window that the hoversel is
13975     * in. See @ref Hover objects for more information.
13976     */
13977    EAPI void               elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
13978    /**
13979     * @brief Get the Hover parent
13980     *
13981     * @param obj The hoversel object
13982     * @return The used parent
13983     *
13984     * Gets the hover parent object.
13985     *
13986     * @see elm_hoversel_hover_parent_set()
13987     */
13988    EAPI Evas_Object       *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13989    /**
13990     * @brief Set the hoversel button label
13991     *
13992     * @param obj The hoversel object
13993     * @param label The label text.
13994     *
13995     * This sets the label of the button that is always visible (before it is
13996     * clicked and expanded).
13997     *
13998     * @deprecated elm_object_text_set()
13999     */
14000    EINA_DEPRECATED EAPI void               elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14001    /**
14002     * @brief Get the hoversel button label
14003     *
14004     * @param obj The hoversel object
14005     * @return The label text.
14006     *
14007     * @deprecated elm_object_text_get()
14008     */
14009    EINA_DEPRECATED EAPI const char        *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14010    /**
14011     * @brief Set the icon of the hoversel button
14012     *
14013     * @param obj The hoversel object
14014     * @param icon The icon object
14015     *
14016     * Sets the icon of the button that is always visible (before it is clicked
14017     * and expanded).  Once the icon object is set, a previously set one will be
14018     * deleted, if you want to keep that old content object, use the
14019     * elm_hoversel_icon_unset() function.
14020     *
14021     * @see elm_button_icon_set()
14022     */
14023    EAPI void               elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
14024    /**
14025     * @brief Get the icon of the hoversel button
14026     *
14027     * @param obj The hoversel object
14028     * @return The icon object
14029     *
14030     * Get the icon of the button that is always visible (before it is clicked
14031     * and expanded). Also see elm_button_icon_get().
14032     *
14033     * @see elm_hoversel_icon_set()
14034     */
14035    EAPI Evas_Object       *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14036    /**
14037     * @brief Get and unparent the icon of the hoversel button
14038     *
14039     * @param obj The hoversel object
14040     * @return The icon object that was being used
14041     *
14042     * Unparent and return the icon of the button that is always visible
14043     * (before it is clicked and expanded).
14044     *
14045     * @see elm_hoversel_icon_set()
14046     * @see elm_button_icon_unset()
14047     */
14048    EAPI Evas_Object       *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14049    /**
14050     * @brief This triggers the hoversel popup from code, the same as if the user
14051     * had clicked the button.
14052     *
14053     * @param obj The hoversel object
14054     */
14055    EAPI void               elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
14056    /**
14057     * @brief This dismisses the hoversel popup as if the user had clicked
14058     * outside the hover.
14059     *
14060     * @param obj The hoversel object
14061     */
14062    EAPI void               elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
14063    /**
14064     * @brief Returns whether the hoversel is expanded.
14065     *
14066     * @param obj The hoversel object
14067     * @return  This will return EINA_TRUE if the hoversel is expanded or
14068     * EINA_FALSE if it is not expanded.
14069     */
14070    EAPI Eina_Bool          elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14071    /**
14072     * @brief This will remove all the children items from the hoversel.
14073     *
14074     * @param obj The hoversel object
14075     *
14076     * @warning Should @b not be called while the hoversel is active; use
14077     * elm_hoversel_expanded_get() to check first.
14078     *
14079     * @see elm_hoversel_item_del_cb_set()
14080     * @see elm_hoversel_item_del()
14081     */
14082    EAPI void               elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14083    /**
14084     * @brief Get the list of items within the given hoversel.
14085     *
14086     * @param obj The hoversel object
14087     * @return Returns a list of Elm_Hoversel_Item*
14088     *
14089     * @see elm_hoversel_item_add()
14090     */
14091    EAPI const Eina_List   *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14092    /**
14093     * @brief Add an item to the hoversel button
14094     *
14095     * @param obj The hoversel object
14096     * @param label The text label to use for the item (NULL if not desired)
14097     * @param icon_file An image file path on disk to use for the icon or standard
14098     * icon name (NULL if not desired)
14099     * @param icon_type The icon type if relevant
14100     * @param func Convenience function to call when this item is selected
14101     * @param data Data to pass to item-related functions
14102     * @return A handle to the item added.
14103     *
14104     * This adds an item to the hoversel to show when it is clicked. Note: if you
14105     * need to use an icon from an edje file then use
14106     * elm_hoversel_item_icon_set() right after the this function, and set
14107     * icon_file to NULL here.
14108     *
14109     * For more information on what @p icon_file and @p icon_type are see the
14110     * @ref Icon "icon documentation".
14111     */
14112    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);
14113    /**
14114     * @brief Delete an item from the hoversel
14115     *
14116     * @param item The item to delete
14117     *
14118     * This deletes the item from the hoversel (should not be called while the
14119     * hoversel is active; use elm_hoversel_expanded_get() to check first).
14120     *
14121     * @see elm_hoversel_item_add()
14122     * @see elm_hoversel_item_del_cb_set()
14123     */
14124    EAPI void               elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
14125    /**
14126     * @brief Set the function to be called when an item from the hoversel is
14127     * freed.
14128     *
14129     * @param item The item to set the callback on
14130     * @param func The function called
14131     *
14132     * That function will receive these parameters:
14133     * @li void *item_data
14134     * @li Evas_Object *the_item_object
14135     * @li Elm_Hoversel_Item *the_object_struct
14136     *
14137     * @see elm_hoversel_item_add()
14138     */
14139    EAPI void               elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14140    /**
14141     * @brief This returns the data pointer supplied with elm_hoversel_item_add()
14142     * that will be passed to associated function callbacks.
14143     *
14144     * @param item The item to get the data from
14145     * @return The data pointer set with elm_hoversel_item_add()
14146     *
14147     * @see elm_hoversel_item_add()
14148     */
14149    EAPI void              *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14150    /**
14151     * @brief This returns the label text of the given hoversel item.
14152     *
14153     * @param item The item to get the label
14154     * @return The label text of the hoversel item
14155     *
14156     * @see elm_hoversel_item_add()
14157     */
14158    EAPI const char        *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14159    /**
14160     * @brief This sets the icon for the given hoversel item.
14161     *
14162     * @param item The item to set the icon
14163     * @param icon_file An image file path on disk to use for the icon or standard
14164     * icon name
14165     * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
14166     * to NULL if the icon is not an edje file
14167     * @param icon_type The icon type
14168     *
14169     * The icon can be loaded from the standard set, from an image file, or from
14170     * an edje file.
14171     *
14172     * @see elm_hoversel_item_add()
14173     */
14174    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);
14175    /**
14176     * @brief Get the icon object of the hoversel item
14177     *
14178     * @param item The item to get the icon from
14179     * @param icon_file The image file path on disk used for the icon or standard
14180     * icon name
14181     * @param icon_group The edje group used if @p icon_file is an edje file. NULL
14182     * if the icon is not an edje file
14183     * @param icon_type The icon type
14184     *
14185     * @see elm_hoversel_item_icon_set()
14186     * @see elm_hoversel_item_add()
14187     */
14188    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);
14189    /**
14190     * @}
14191     */
14192
14193    /**
14194     * @defgroup Toolbar Toolbar
14195     * @ingroup Elementary
14196     *
14197     * @image html img/widget/toolbar/preview-00.png
14198     * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
14199     *
14200     * @image html img/toolbar.png
14201     * @image latex img/toolbar.eps width=\textwidth
14202     *
14203     * A toolbar is a widget that displays a list of items inside
14204     * a box. It can be scrollable, show a menu with items that don't fit
14205     * to toolbar size or even crop them.
14206     *
14207     * Only one item can be selected at a time.
14208     *
14209     * Items can have multiple states, or show menus when selected by the user.
14210     *
14211     * Smart callbacks one can listen to:
14212     * - "clicked" - when the user clicks on a toolbar item and becomes selected.
14213     * - "language,changed" - when the program language changes
14214     *
14215     * Available styles for it:
14216     * - @c "default"
14217     * - @c "transparent" - no background or shadow, just show the content
14218     *
14219     * List of examples:
14220     * @li @ref toolbar_example_01
14221     * @li @ref toolbar_example_02
14222     * @li @ref toolbar_example_03
14223     */
14224
14225    /**
14226     * @addtogroup Toolbar
14227     * @{
14228     */
14229
14230    /**
14231     * @enum _Elm_Toolbar_Shrink_Mode
14232     * @typedef Elm_Toolbar_Shrink_Mode
14233     *
14234     * Set toolbar's items display behavior, it can be scrollabel,
14235     * show a menu with exceeding items, or simply hide them.
14236     *
14237     * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14238     * from elm config.
14239     *
14240     * Values <b> don't </b> work as bitmask, only one can be choosen.
14241     *
14242     * @see elm_toolbar_mode_shrink_set()
14243     * @see elm_toolbar_mode_shrink_get()
14244     *
14245     * @ingroup Toolbar
14246     */
14247    typedef enum _Elm_Toolbar_Shrink_Mode
14248      {
14249         ELM_TOOLBAR_SHRINK_NONE,   /**< Set toolbar minimun size to fit all the items. */
14250         ELM_TOOLBAR_SHRINK_HIDE,   /**< Hide exceeding items. */
14251         ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14252         ELM_TOOLBAR_SHRINK_MENU    /**< Inserts a button to pop up a menu with exceeding items. */
14253      } Elm_Toolbar_Shrink_Mode;
14254
14255    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(). */
14256
14257    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(). */
14258
14259    /**
14260     * Add a new toolbar widget to the given parent Elementary
14261     * (container) object.
14262     *
14263     * @param parent The parent object.
14264     * @return a new toolbar widget handle or @c NULL, on errors.
14265     *
14266     * This function inserts a new toolbar widget on the canvas.
14267     *
14268     * @ingroup Toolbar
14269     */
14270    EAPI Evas_Object            *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14271
14272    /**
14273     * Set the icon size, in pixels, to be used by toolbar items.
14274     *
14275     * @param obj The toolbar object
14276     * @param icon_size The icon size in pixels
14277     *
14278     * @note Default value is @c 32. It reads value from elm config.
14279     *
14280     * @see elm_toolbar_icon_size_get()
14281     *
14282     * @ingroup Toolbar
14283     */
14284    EAPI void                    elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14285
14286    /**
14287     * Get the icon size, in pixels, to be used by toolbar items.
14288     *
14289     * @param obj The toolbar object.
14290     * @return The icon size in pixels.
14291     *
14292     * @see elm_toolbar_icon_size_set() for details.
14293     *
14294     * @ingroup Toolbar
14295     */
14296    EAPI int                     elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14297
14298    /**
14299     * Sets icon lookup order, for toolbar items' icons.
14300     *
14301     * @param obj The toolbar object.
14302     * @param order The icon lookup order.
14303     *
14304     * Icons added before calling this function will not be affected.
14305     * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14306     *
14307     * @see elm_toolbar_icon_order_lookup_get()
14308     *
14309     * @ingroup Toolbar
14310     */
14311    EAPI void                    elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14312
14313    /**
14314     * Gets the icon lookup order.
14315     *
14316     * @param obj The toolbar object.
14317     * @return The icon lookup order.
14318     *
14319     * @see elm_toolbar_icon_order_lookup_set() for details.
14320     *
14321     * @ingroup Toolbar
14322     */
14323    EAPI Elm_Icon_Lookup_Order   elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14324
14325    /**
14326     * Set whether the toolbar should always have an item selected.
14327     *
14328     * @param obj The toolbar object.
14329     * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
14330     * disable it.
14331     *
14332     * This will cause the toolbar to always have an item selected, and clicking
14333     * the selected item will not cause a selected event to be emitted. Enabling this mode
14334     * will immediately select the first toolbar item.
14335     *
14336     * Always-selected is disabled by default.
14337     *
14338     * @see elm_toolbar_always_select_mode_get().
14339     *
14340     * @ingroup Toolbar
14341     */
14342    EAPI void                    elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14343
14344    /**
14345     * Get whether the toolbar should always have an item selected.
14346     *
14347     * @param obj The toolbar object.
14348     * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
14349     * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
14350     *
14351     * @see elm_toolbar_always_select_mode_set() for details.
14352     *
14353     * @ingroup Toolbar
14354     */
14355    EAPI Eina_Bool               elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14356
14357    /**
14358     * Set whether the toolbar items' should be selected by the user or not.
14359     *
14360     * @param obj The toolbar object.
14361     * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14362     * enable it.
14363     *
14364     * This will turn off the ability to select items entirely and they will
14365     * neither appear selected nor emit selected signals. The clicked
14366     * callback function will still be called.
14367     *
14368     * Selection is enabled by default.
14369     *
14370     * @see elm_toolbar_no_select_mode_get().
14371     *
14372     * @ingroup Toolbar
14373     */
14374    EAPI void                    elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14375
14376    /**
14377     * Set whether the toolbar items' should be selected by the user or not.
14378     *
14379     * @param obj The toolbar object.
14380     * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14381     * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14382     *
14383     * @see elm_toolbar_no_select_mode_set() for details.
14384     *
14385     * @ingroup Toolbar
14386     */
14387    EAPI Eina_Bool               elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14388
14389    /**
14390     * Append item to the toolbar.
14391     *
14392     * @param obj The toolbar object.
14393     * @param icon A string with icon name or the absolute path of an image file.
14394     * @param label The label of the item.
14395     * @param func The function to call when the item is clicked.
14396     * @param data The data to associate with the item for related callbacks.
14397     * @return The created item or @c NULL upon failure.
14398     *
14399     * A new item will be created and appended to the toolbar, i.e., will
14400     * be set as @b last item.
14401     *
14402     * Items created with this method can be deleted with
14403     * elm_toolbar_item_del().
14404     *
14405     * Associated @p data can be properly freed when item is deleted if a
14406     * callback function is set with elm_toolbar_item_del_cb_set().
14407     *
14408     * If a function is passed as argument, it will be called everytime this item
14409     * is selected, i.e., the user clicks over an unselected item.
14410     * If such function isn't needed, just passing
14411     * @c NULL as @p func is enough. The same should be done for @p data.
14412     *
14413     * Toolbar will load icon image from fdo or current theme.
14414     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14415     * If an absolute path is provided it will load it direct from a file.
14416     *
14417     * @see elm_toolbar_item_icon_set()
14418     * @see elm_toolbar_item_del()
14419     * @see elm_toolbar_item_del_cb_set()
14420     *
14421     * @ingroup Toolbar
14422     */
14423    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);
14424
14425    /**
14426     * Prepend item to the toolbar.
14427     *
14428     * @param obj The toolbar object.
14429     * @param icon A string with icon name or the absolute path of an image file.
14430     * @param label The label of the item.
14431     * @param func The function to call when the item is clicked.
14432     * @param data The data to associate with the item for related callbacks.
14433     * @return The created item or @c NULL upon failure.
14434     *
14435     * A new item will be created and prepended to the toolbar, i.e., will
14436     * be set as @b first item.
14437     *
14438     * Items created with this method can be deleted with
14439     * elm_toolbar_item_del().
14440     *
14441     * Associated @p data can be properly freed when item is deleted if a
14442     * callback function is set with elm_toolbar_item_del_cb_set().
14443     *
14444     * If a function is passed as argument, it will be called everytime this item
14445     * is selected, i.e., the user clicks over an unselected item.
14446     * If such function isn't needed, just passing
14447     * @c NULL as @p func is enough. The same should be done for @p data.
14448     *
14449     * Toolbar will load icon image from fdo or current theme.
14450     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14451     * If an absolute path is provided it will load it direct from a file.
14452     *
14453     * @see elm_toolbar_item_icon_set()
14454     * @see elm_toolbar_item_del()
14455     * @see elm_toolbar_item_del_cb_set()
14456     *
14457     * @ingroup Toolbar
14458     */
14459    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);
14460
14461    /**
14462     * Insert a new item into the toolbar object before item @p before.
14463     *
14464     * @param obj The toolbar object.
14465     * @param before The toolbar item to insert before.
14466     * @param icon A string with icon name or the absolute path of an image file.
14467     * @param label The label of the item.
14468     * @param func The function to call when the item is clicked.
14469     * @param data The data to associate with the item for related callbacks.
14470     * @return The created item or @c NULL upon failure.
14471     *
14472     * A new item will be created and added to the toolbar. Its position in
14473     * this toolbar will be just before item @p before.
14474     *
14475     * Items created with this method can be deleted with
14476     * elm_toolbar_item_del().
14477     *
14478     * Associated @p data can be properly freed when item is deleted if a
14479     * callback function is set with elm_toolbar_item_del_cb_set().
14480     *
14481     * If a function is passed as argument, it will be called everytime this item
14482     * is selected, i.e., the user clicks over an unselected item.
14483     * If such function isn't needed, just passing
14484     * @c NULL as @p func is enough. The same should be done for @p data.
14485     *
14486     * Toolbar will load icon image from fdo or current theme.
14487     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14488     * If an absolute path is provided it will load it direct from a file.
14489     *
14490     * @see elm_toolbar_item_icon_set()
14491     * @see elm_toolbar_item_del()
14492     * @see elm_toolbar_item_del_cb_set()
14493     *
14494     * @ingroup Toolbar
14495     */
14496    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);
14497
14498    /**
14499     * Insert a new item into the toolbar object after item @p after.
14500     *
14501     * @param obj The toolbar object.
14502     * @param before The toolbar item to insert before.
14503     * @param icon A string with icon name or the absolute path of an image file.
14504     * @param label The label of the item.
14505     * @param func The function to call when the item is clicked.
14506     * @param data The data to associate with the item for related callbacks.
14507     * @return The created item or @c NULL upon failure.
14508     *
14509     * A new item will be created and added to the toolbar. Its position in
14510     * this toolbar will be just after item @p after.
14511     *
14512     * Items created with this method can be deleted with
14513     * elm_toolbar_item_del().
14514     *
14515     * Associated @p data can be properly freed when item is deleted if a
14516     * callback function is set with elm_toolbar_item_del_cb_set().
14517     *
14518     * If a function is passed as argument, it will be called everytime this item
14519     * is selected, i.e., the user clicks over an unselected item.
14520     * If such function isn't needed, just passing
14521     * @c NULL as @p func is enough. The same should be done for @p data.
14522     *
14523     * Toolbar will load icon image from fdo or current theme.
14524     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14525     * If an absolute path is provided it will load it direct from a file.
14526     *
14527     * @see elm_toolbar_item_icon_set()
14528     * @see elm_toolbar_item_del()
14529     * @see elm_toolbar_item_del_cb_set()
14530     *
14531     * @ingroup Toolbar
14532     */
14533    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);
14534
14535    /**
14536     * Get the first item in the given toolbar widget's list of
14537     * items.
14538     *
14539     * @param obj The toolbar object
14540     * @return The first item or @c NULL, if it has no items (and on
14541     * errors)
14542     *
14543     * @see elm_toolbar_item_append()
14544     * @see elm_toolbar_last_item_get()
14545     *
14546     * @ingroup Toolbar
14547     */
14548    EAPI Elm_Toolbar_Item       *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14549
14550    /**
14551     * Get the last item in the given toolbar widget's list of
14552     * items.
14553     *
14554     * @param obj The toolbar object
14555     * @return The last item or @c NULL, if it has no items (and on
14556     * errors)
14557     *
14558     * @see elm_toolbar_item_prepend()
14559     * @see elm_toolbar_first_item_get()
14560     *
14561     * @ingroup Toolbar
14562     */
14563    EAPI Elm_Toolbar_Item       *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14564
14565    /**
14566     * Get the item after @p item in toolbar.
14567     *
14568     * @param item The toolbar item.
14569     * @return The item after @p item, or @c NULL if none or on failure.
14570     *
14571     * @note If it is the last item, @c NULL will be returned.
14572     *
14573     * @see elm_toolbar_item_append()
14574     *
14575     * @ingroup Toolbar
14576     */
14577    EAPI Elm_Toolbar_Item       *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14578
14579    /**
14580     * Get the item before @p item in toolbar.
14581     *
14582     * @param item The toolbar item.
14583     * @return The item before @p item, or @c NULL if none or on failure.
14584     *
14585     * @note If it is the first item, @c NULL will be returned.
14586     *
14587     * @see elm_toolbar_item_prepend()
14588     *
14589     * @ingroup Toolbar
14590     */
14591    EAPI Elm_Toolbar_Item       *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14592
14593    /**
14594     * Get the toolbar object from an item.
14595     *
14596     * @param item The item.
14597     * @return The toolbar object.
14598     *
14599     * This returns the toolbar object itself that an item belongs to.
14600     *
14601     * @ingroup Toolbar
14602     */
14603    EAPI Evas_Object            *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14604
14605    /**
14606     * Set the priority of a toolbar item.
14607     *
14608     * @param item The toolbar item.
14609     * @param priority The item priority. The default is zero.
14610     *
14611     * This is used only when the toolbar shrink mode is set to
14612     * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
14613     * When space is less than required, items with low priority
14614     * will be removed from the toolbar and added to a dynamically-created menu,
14615     * while items with higher priority will remain on the toolbar,
14616     * with the same order they were added.
14617     *
14618     * @see elm_toolbar_item_priority_get()
14619     *
14620     * @ingroup Toolbar
14621     */
14622    EAPI void                    elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
14623
14624    /**
14625     * Get the priority of a toolbar item.
14626     *
14627     * @param item The toolbar item.
14628     * @return The @p item priority, or @c 0 on failure.
14629     *
14630     * @see elm_toolbar_item_priority_set() for details.
14631     *
14632     * @ingroup Toolbar
14633     */
14634    EAPI int                     elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14635
14636    /**
14637     * Get the label of item.
14638     *
14639     * @param item The item of toolbar.
14640     * @return The label of item.
14641     *
14642     * The return value is a pointer to the label associated to @p item when
14643     * it was created, with function elm_toolbar_item_append() or similar,
14644     * or later,
14645     * with function elm_toolbar_item_label_set. If no label
14646     * was passed as argument, it will return @c NULL.
14647     *
14648     * @see elm_toolbar_item_label_set() for more details.
14649     * @see elm_toolbar_item_append()
14650     *
14651     * @ingroup Toolbar
14652     */
14653    EAPI const char             *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14654
14655    /**
14656     * Set the label of item.
14657     *
14658     * @param item The item of toolbar.
14659     * @param text The label of item.
14660     *
14661     * The label to be displayed by the item.
14662     * Label will be placed at icons bottom (if set).
14663     *
14664     * If a label was passed as argument on item creation, with function
14665     * elm_toolbar_item_append() or similar, it will be already
14666     * displayed by the item.
14667     *
14668     * @see elm_toolbar_item_label_get()
14669     * @see elm_toolbar_item_append()
14670     *
14671     * @ingroup Toolbar
14672     */
14673    EAPI void                    elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
14674
14675    /**
14676     * Return the data associated with a given toolbar widget item.
14677     *
14678     * @param item The toolbar widget item handle.
14679     * @return The data associated with @p item.
14680     *
14681     * @see elm_toolbar_item_data_set()
14682     *
14683     * @ingroup Toolbar
14684     */
14685    EAPI void                   *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14686
14687    /**
14688     * Set the data associated with a given toolbar widget item.
14689     *
14690     * @param item The toolbar widget item handle.
14691     * @param data The new data pointer to set to @p item.
14692     *
14693     * This sets new item data on @p item.
14694     *
14695     * @warning The old data pointer won't be touched by this function, so
14696     * the user had better to free that old data himself/herself.
14697     *
14698     * @ingroup Toolbar
14699     */
14700    EAPI void                    elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
14701
14702    /**
14703     * Returns a pointer to a toolbar item by its label.
14704     *
14705     * @param obj The toolbar object.
14706     * @param label The label of the item to find.
14707     *
14708     * @return The pointer to the toolbar item matching @p label or @c NULL
14709     * on failure.
14710     *
14711     * @ingroup Toolbar
14712     */
14713    EAPI Elm_Toolbar_Item       *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14714
14715    /*
14716     * Get whether the @p item is selected or not.
14717     *
14718     * @param item The toolbar item.
14719     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
14720     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
14721     *
14722     * @see elm_toolbar_selected_item_set() for details.
14723     * @see elm_toolbar_item_selected_get()
14724     *
14725     * @ingroup Toolbar
14726     */
14727    EAPI Eina_Bool               elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14728
14729    /**
14730     * Set the selected state of an item.
14731     *
14732     * @param item The toolbar item
14733     * @param selected The selected state
14734     *
14735     * This sets the selected state of the given item @p it.
14736     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
14737     *
14738     * If a new item is selected the previosly selected will be unselected.
14739     * Previoulsy selected item can be get with function
14740     * elm_toolbar_selected_item_get().
14741     *
14742     * Selected items will be highlighted.
14743     *
14744     * @see elm_toolbar_item_selected_get()
14745     * @see elm_toolbar_selected_item_get()
14746     *
14747     * @ingroup Toolbar
14748     */
14749    EAPI void                    elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14750
14751    /**
14752     * Get the selected item.
14753     *
14754     * @param obj The toolbar object.
14755     * @return The selected toolbar item.
14756     *
14757     * The selected item can be unselected with function
14758     * elm_toolbar_item_selected_set().
14759     *
14760     * The selected item always will be highlighted on toolbar.
14761     *
14762     * @see elm_toolbar_selected_items_get()
14763     *
14764     * @ingroup Toolbar
14765     */
14766    EAPI Elm_Toolbar_Item       *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14767
14768    /**
14769     * Set the icon associated with @p item.
14770     *
14771     * @param obj The parent of this item.
14772     * @param item The toolbar item.
14773     * @param icon A string with icon name or the absolute path of an image file.
14774     *
14775     * Toolbar will load icon image from fdo or current theme.
14776     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14777     * If an absolute path is provided it will load it direct from a file.
14778     *
14779     * @see elm_toolbar_icon_order_lookup_set()
14780     * @see elm_toolbar_icon_order_lookup_get()
14781     *
14782     * @ingroup Toolbar
14783     */
14784    EAPI void                    elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
14785
14786    /**
14787     * Get the string used to set the icon of @p item.
14788     *
14789     * @param item The toolbar item.
14790     * @return The string associated with the icon object.
14791     *
14792     * @see elm_toolbar_item_icon_set() for details.
14793     *
14794     * @ingroup Toolbar
14795     */
14796    EAPI const char             *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14797
14798    /**
14799     * Get the object of @p item.
14800     *
14801     * @param item The toolbar item.
14802     * @return The object
14803     *
14804     * @ingroup Toolbar
14805     */
14806    EAPI Evas_Object            *elm_toolbar_item_object_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14807
14808    /**
14809     * Get the icon object of @p item.
14810     *
14811     * @param item The toolbar item.
14812     * @return The icon object
14813     *
14814     * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
14815     *
14816     * @ingroup Toolbar
14817     */
14818    EAPI Evas_Object            *elm_toolbar_item_icon_object_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14819
14820    /**
14821     * Set the icon associated with @p item to an image in a binary buffer.
14822     *
14823     * @param item The toolbar item.
14824     * @param img The binary data that will be used as an image
14825     * @param size The size of binary data @p img
14826     * @param format Optional format of @p img to pass to the image loader
14827     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
14828     *
14829     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
14830     *
14831     * @note The icon image set by this function can be changed by
14832     * elm_toolbar_item_icon_set().
14833     * 
14834     * @ingroup Toolbar
14835     */
14836    EAPI Eina_Bool elm_toolbar_item_icon_memfile_set(Elm_Toolbar_Item *item, const void *img, size_t size, const char *format, const char *key) EINA_ARG_NONNULL(1);
14837
14838    /**
14839     * Delete them item from the toolbar.
14840     *
14841     * @param item The item of toolbar to be deleted.
14842     *
14843     * @see elm_toolbar_item_append()
14844     * @see elm_toolbar_item_del_cb_set()
14845     *
14846     * @ingroup Toolbar
14847     */
14848    EAPI void                    elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14849
14850    /**
14851     * Set the function called when a toolbar item is freed.
14852     *
14853     * @param item The item to set the callback on.
14854     * @param func The function called.
14855     *
14856     * If there is a @p func, then it will be called prior item's memory release.
14857     * That will be called with the following arguments:
14858     * @li item's data;
14859     * @li item's Evas object;
14860     * @li item itself;
14861     *
14862     * This way, a data associated to a toolbar item could be properly freed.
14863     *
14864     * @ingroup Toolbar
14865     */
14866    EAPI void                    elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14867
14868    /**
14869     * Get a value whether toolbar item is disabled or not.
14870     *
14871     * @param item The item.
14872     * @return The disabled state.
14873     *
14874     * @see elm_toolbar_item_disabled_set() for more details.
14875     *
14876     * @ingroup Toolbar
14877     */
14878    EAPI Eina_Bool               elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14879
14880    /**
14881     * Sets the disabled/enabled state of a toolbar item.
14882     *
14883     * @param item The item.
14884     * @param disabled The disabled state.
14885     *
14886     * A disabled item cannot be selected or unselected. It will also
14887     * change its appearance (generally greyed out). This sets the
14888     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
14889     * enabled).
14890     *
14891     * @ingroup Toolbar
14892     */
14893    EAPI void                    elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14894
14895    /**
14896     * Set or unset item as a separator.
14897     *
14898     * @param item The toolbar item.
14899     * @param setting @c EINA_TRUE to set item @p item as separator or
14900     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
14901     *
14902     * Items aren't set as separator by default.
14903     *
14904     * If set as separator it will display separator theme, so won't display
14905     * icons or label.
14906     *
14907     * @see elm_toolbar_item_separator_get()
14908     *
14909     * @ingroup Toolbar
14910     */
14911    EAPI void                    elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
14912
14913    /**
14914     * Get a value whether item is a separator or not.
14915     *
14916     * @param item The toolbar item.
14917     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
14918     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
14919     *
14920     * @see elm_toolbar_item_separator_set() for details.
14921     *
14922     * @ingroup Toolbar
14923     */
14924    EAPI Eina_Bool               elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14925
14926    /**
14927     * Set the shrink state of toolbar @p obj.
14928     *
14929     * @param obj The toolbar object.
14930     * @param shrink_mode Toolbar's items display behavior.
14931     *
14932     * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
14933     * but will enforce a minimun size so all the items will fit, won't scroll
14934     * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
14935     * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
14936     * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
14937     *
14938     * @ingroup Toolbar
14939     */
14940    EAPI void                    elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
14941
14942    /**
14943     * Get the shrink mode of toolbar @p obj.
14944     *
14945     * @param obj The toolbar object.
14946     * @return Toolbar's items display behavior.
14947     *
14948     * @see elm_toolbar_mode_shrink_set() for details.
14949     *
14950     * @ingroup Toolbar
14951     */
14952    EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14953
14954    /**
14955     * Enable/disable homogenous mode.
14956     *
14957     * @param obj The toolbar object
14958     * @param homogeneous Assume the items within the toolbar are of the
14959     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
14960     *
14961     * This will enable the homogeneous mode where items are of the same size.
14962     * @see elm_toolbar_homogeneous_get()
14963     *
14964     * @ingroup Toolbar
14965     */
14966    EAPI void                    elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
14967
14968    /**
14969     * Get whether the homogenous mode is enabled.
14970     *
14971     * @param obj The toolbar object.
14972     * @return Assume the items within the toolbar are of the same height
14973     * and width (EINA_TRUE = on, EINA_FALSE = off).
14974     *
14975     * @see elm_toolbar_homogeneous_set()
14976     *
14977     * @ingroup Toolbar
14978     */
14979    EAPI Eina_Bool               elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14980
14981    /**
14982     * Enable/disable homogenous mode.
14983     *
14984     * @param obj The toolbar object
14985     * @param homogeneous Assume the items within the toolbar are of the
14986     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
14987     *
14988     * This will enable the homogeneous mode where items are of the same size.
14989     * @see elm_toolbar_homogeneous_get()
14990     *
14991     * @deprecated use elm_toolbar_homogeneous_set() instead.
14992     *
14993     * @ingroup Toolbar
14994     */
14995    EINA_DEPRECATED EAPI void    elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
14996
14997    /**
14998     * Get whether the homogenous mode is enabled.
14999     *
15000     * @param obj The toolbar object.
15001     * @return Assume the items within the toolbar are of the same height
15002     * and width (EINA_TRUE = on, EINA_FALSE = off).
15003     *
15004     * @see elm_toolbar_homogeneous_set()
15005     * @deprecated use elm_toolbar_homogeneous_get() instead.
15006     *
15007     * @ingroup Toolbar
15008     */
15009    EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15010
15011    /**
15012     * Set the parent object of the toolbar items' menus.
15013     *
15014     * @param obj The toolbar object.
15015     * @param parent The parent of the menu objects.
15016     *
15017     * Each item can be set as item menu, with elm_toolbar_item_menu_set().
15018     *
15019     * For more details about setting the parent for toolbar menus, see
15020     * elm_menu_parent_set().
15021     *
15022     * @see elm_menu_parent_set() for details.
15023     * @see elm_toolbar_item_menu_set() for details.
15024     *
15025     * @ingroup Toolbar
15026     */
15027    EAPI void                    elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15028
15029    /**
15030     * Get the parent object of the toolbar items' menus.
15031     *
15032     * @param obj The toolbar object.
15033     * @return The parent of the menu objects.
15034     *
15035     * @see elm_toolbar_menu_parent_set() for details.
15036     *
15037     * @ingroup Toolbar
15038     */
15039    EAPI Evas_Object            *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15040
15041    /**
15042     * Set the alignment of the items.
15043     *
15044     * @param obj The toolbar object.
15045     * @param align The new alignment, a float between <tt> 0.0 </tt>
15046     * and <tt> 1.0 </tt>.
15047     *
15048     * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
15049     * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
15050     * items.
15051     *
15052     * Centered items by default.
15053     *
15054     * @see elm_toolbar_align_get()
15055     *
15056     * @ingroup Toolbar
15057     */
15058    EAPI void                    elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
15059
15060    /**
15061     * Get the alignment of the items.
15062     *
15063     * @param obj The toolbar object.
15064     * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
15065     * <tt> 1.0 </tt>.
15066     *
15067     * @see elm_toolbar_align_set() for details.
15068     *
15069     * @ingroup Toolbar
15070     */
15071    EAPI double                  elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15072
15073    /**
15074     * Set whether the toolbar item opens a menu.
15075     *
15076     * @param item The toolbar item.
15077     * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
15078     *
15079     * A toolbar item can be set to be a menu, using this function.
15080     *
15081     * Once it is set to be a menu, it can be manipulated through the
15082     * menu-like function elm_toolbar_menu_parent_set() and the other
15083     * elm_menu functions, using the Evas_Object @c menu returned by
15084     * elm_toolbar_item_menu_get().
15085     *
15086     * So, items to be displayed in this item's menu should be added with
15087     * elm_menu_item_add().
15088     *
15089     * The following code exemplifies the most basic usage:
15090     * @code
15091     * tb = elm_toolbar_add(win)
15092     * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
15093     * elm_toolbar_item_menu_set(item, EINA_TRUE);
15094     * elm_toolbar_menu_parent_set(tb, win);
15095     * menu = elm_toolbar_item_menu_get(item);
15096     * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
15097     * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
15098     * NULL);
15099     * @endcode
15100     *
15101     * @see elm_toolbar_item_menu_get()
15102     *
15103     * @ingroup Toolbar
15104     */
15105    EAPI void                    elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
15106
15107    /**
15108     * Get toolbar item's menu.
15109     *
15110     * @param item The toolbar item.
15111     * @return Item's menu object or @c NULL on failure.
15112     *
15113     * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
15114     * this function will set it.
15115     *
15116     * @see elm_toolbar_item_menu_set() for details.
15117     *
15118     * @ingroup Toolbar
15119     */
15120    EAPI Evas_Object            *elm_toolbar_item_menu_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15121
15122    /**
15123     * Add a new state to @p item.
15124     *
15125     * @param item The item.
15126     * @param icon A string with icon name or the absolute path of an image file.
15127     * @param label The label of the new state.
15128     * @param func The function to call when the item is clicked when this
15129     * state is selected.
15130     * @param data The data to associate with the state.
15131     * @return The toolbar item state, or @c NULL upon failure.
15132     *
15133     * Toolbar will load icon image from fdo or current theme.
15134     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15135     * If an absolute path is provided it will load it direct from a file.
15136     *
15137     * States created with this function can be removed with
15138     * elm_toolbar_item_state_del().
15139     *
15140     * @see elm_toolbar_item_state_del()
15141     * @see elm_toolbar_item_state_sel()
15142     * @see elm_toolbar_item_state_get()
15143     *
15144     * @ingroup Toolbar
15145     */
15146    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);
15147
15148    /**
15149     * Delete a previoulsy added state to @p item.
15150     *
15151     * @param item The toolbar item.
15152     * @param state The state to be deleted.
15153     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15154     *
15155     * @see elm_toolbar_item_state_add()
15156     */
15157    EAPI Eina_Bool               elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15158
15159    /**
15160     * Set @p state as the current state of @p it.
15161     *
15162     * @param it The item.
15163     * @param state The state to use.
15164     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15165     *
15166     * If @p state is @c NULL, it won't select any state and the default item's
15167     * icon and label will be used. It's the same behaviour than
15168     * elm_toolbar_item_state_unser().
15169     *
15170     * @see elm_toolbar_item_state_unset()
15171     *
15172     * @ingroup Toolbar
15173     */
15174    EAPI Eina_Bool               elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15175
15176    /**
15177     * Unset the state of @p it.
15178     *
15179     * @param it The item.
15180     *
15181     * The default icon and label from this item will be displayed.
15182     *
15183     * @see elm_toolbar_item_state_set() for more details.
15184     *
15185     * @ingroup Toolbar
15186     */
15187    EAPI void                    elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15188
15189    /**
15190     * Get the current state of @p it.
15191     *
15192     * @param item The item.
15193     * @return The selected state or @c NULL if none is selected or on failure.
15194     *
15195     * @see elm_toolbar_item_state_set() for details.
15196     * @see elm_toolbar_item_state_unset()
15197     * @see elm_toolbar_item_state_add()
15198     *
15199     * @ingroup Toolbar
15200     */
15201    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15202
15203    /**
15204     * Get the state after selected state in toolbar's @p item.
15205     *
15206     * @param it The toolbar item to change state.
15207     * @return The state after current state, or @c NULL on failure.
15208     *
15209     * If last state is selected, this function will return first state.
15210     *
15211     * @see elm_toolbar_item_state_set()
15212     * @see elm_toolbar_item_state_add()
15213     *
15214     * @ingroup Toolbar
15215     */
15216    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15217
15218    /**
15219     * Get the state before selected state in toolbar's @p item.
15220     *
15221     * @param it The toolbar item to change state.
15222     * @return The state before current state, or @c NULL on failure.
15223     *
15224     * If first state is selected, this function will return last state.
15225     *
15226     * @see elm_toolbar_item_state_set()
15227     * @see elm_toolbar_item_state_add()
15228     *
15229     * @ingroup Toolbar
15230     */
15231    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15232
15233    /**
15234     * Set the text to be shown in a given toolbar item's tooltips.
15235     *
15236     * @param item Target item.
15237     * @param text The text to set in the content.
15238     *
15239     * Setup the text as tooltip to object. The item can have only one tooltip,
15240     * so any previous tooltip data - set with this function or
15241     * elm_toolbar_item_tooltip_content_cb_set() - is removed.
15242     *
15243     * @see elm_object_tooltip_text_set() for more details.
15244     *
15245     * @ingroup Toolbar
15246     */
15247    EAPI void             elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
15248
15249    /**
15250     * Set the content to be shown in the tooltip item.
15251     *
15252     * Setup the tooltip to item. The item can have only one tooltip,
15253     * so any previous tooltip data is removed. @p func(with @p data) will
15254     * be called every time that need show the tooltip and it should
15255     * return a valid Evas_Object. This object is then managed fully by
15256     * tooltip system and is deleted when the tooltip is gone.
15257     *
15258     * @param item the toolbar item being attached a tooltip.
15259     * @param func the function used to create the tooltip contents.
15260     * @param data what to provide to @a func as callback data/context.
15261     * @param del_cb called when data is not needed anymore, either when
15262     *        another callback replaces @a func, the tooltip is unset with
15263     *        elm_toolbar_item_tooltip_unset() or the owner @a item
15264     *        dies. This callback receives as the first parameter the
15265     *        given @a data, and @c event_info is the item.
15266     *
15267     * @see elm_object_tooltip_content_cb_set() for more details.
15268     *
15269     * @ingroup Toolbar
15270     */
15271    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);
15272
15273    /**
15274     * Unset tooltip from item.
15275     *
15276     * @param item toolbar item to remove previously set tooltip.
15277     *
15278     * Remove tooltip from item. The callback provided as del_cb to
15279     * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15280     * it is not used anymore.
15281     *
15282     * @see elm_object_tooltip_unset() for more details.
15283     * @see elm_toolbar_item_tooltip_content_cb_set()
15284     *
15285     * @ingroup Toolbar
15286     */
15287    EAPI void             elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15288
15289    /**
15290     * Sets a different style for this item tooltip.
15291     *
15292     * @note before you set a style you should define a tooltip with
15293     *       elm_toolbar_item_tooltip_content_cb_set() or
15294     *       elm_toolbar_item_tooltip_text_set()
15295     *
15296     * @param item toolbar item with tooltip already set.
15297     * @param style the theme style to use (default, transparent, ...)
15298     *
15299     * @see elm_object_tooltip_style_set() for more details.
15300     *
15301     * @ingroup Toolbar
15302     */
15303    EAPI void             elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15304
15305    /**
15306     * Get the style for this item tooltip.
15307     *
15308     * @param item toolbar item with tooltip already set.
15309     * @return style the theme style in use, defaults to "default". If the
15310     *         object does not have a tooltip set, then NULL is returned.
15311     *
15312     * @see elm_object_tooltip_style_get() for more details.
15313     * @see elm_toolbar_item_tooltip_style_set()
15314     *
15315     * @ingroup Toolbar
15316     */
15317    EAPI const char      *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15318
15319    /**
15320     * Set the type of mouse pointer/cursor decoration to be shown,
15321     * when the mouse pointer is over the given toolbar widget item
15322     *
15323     * @param item toolbar item to customize cursor on
15324     * @param cursor the cursor type's name
15325     *
15326     * This function works analogously as elm_object_cursor_set(), but
15327     * here the cursor's changing area is restricted to the item's
15328     * area, and not the whole widget's. Note that that item cursors
15329     * have precedence over widget cursors, so that a mouse over an
15330     * item with custom cursor set will always show @b that cursor.
15331     *
15332     * If this function is called twice for an object, a previously set
15333     * cursor will be unset on the second call.
15334     *
15335     * @see elm_object_cursor_set()
15336     * @see elm_toolbar_item_cursor_get()
15337     * @see elm_toolbar_item_cursor_unset()
15338     *
15339     * @ingroup Toolbar
15340     */
15341    EAPI void             elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15342
15343    /*
15344     * Get the type of mouse pointer/cursor decoration set to be shown,
15345     * when the mouse pointer is over the given toolbar widget item
15346     *
15347     * @param item toolbar item with custom cursor set
15348     * @return the cursor type's name or @c NULL, if no custom cursors
15349     * were set to @p item (and on errors)
15350     *
15351     * @see elm_object_cursor_get()
15352     * @see elm_toolbar_item_cursor_set()
15353     * @see elm_toolbar_item_cursor_unset()
15354     *
15355     * @ingroup Toolbar
15356     */
15357    EAPI const char      *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15358
15359    /**
15360     * Unset any custom mouse pointer/cursor decoration set to be
15361     * shown, when the mouse pointer is over the given toolbar widget
15362     * item, thus making it show the @b default cursor again.
15363     *
15364     * @param item a toolbar item
15365     *
15366     * Use this call to undo any custom settings on this item's cursor
15367     * decoration, bringing it back to defaults (no custom style set).
15368     *
15369     * @see elm_object_cursor_unset()
15370     * @see elm_toolbar_item_cursor_set()
15371     *
15372     * @ingroup Toolbar
15373     */
15374    EAPI void             elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15375
15376    /**
15377     * Set a different @b style for a given custom cursor set for a
15378     * toolbar item.
15379     *
15380     * @param item toolbar item with custom cursor set
15381     * @param style the <b>theme style</b> to use (e.g. @c "default",
15382     * @c "transparent", etc)
15383     *
15384     * This function only makes sense when one is using custom mouse
15385     * cursor decorations <b>defined in a theme file</b>, which can have,
15386     * given a cursor name/type, <b>alternate styles</b> on it. It
15387     * works analogously as elm_object_cursor_style_set(), but here
15388     * applyed only to toolbar item objects.
15389     *
15390     * @warning Before you set a cursor style you should have definen a
15391     *       custom cursor previously on the item, with
15392     *       elm_toolbar_item_cursor_set()
15393     *
15394     * @see elm_toolbar_item_cursor_engine_only_set()
15395     * @see elm_toolbar_item_cursor_style_get()
15396     *
15397     * @ingroup Toolbar
15398     */
15399    EAPI void             elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15400
15401    /**
15402     * Get the current @b style set for a given toolbar item's custom
15403     * cursor
15404     *
15405     * @param item toolbar item with custom cursor set.
15406     * @return style the cursor style in use. If the object does not
15407     *         have a cursor set, then @c NULL is returned.
15408     *
15409     * @see elm_toolbar_item_cursor_style_set() for more details
15410     *
15411     * @ingroup Toolbar
15412     */
15413    EAPI const char      *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15414
15415    /**
15416     * Set if the (custom)cursor for a given toolbar item should be
15417     * searched in its theme, also, or should only rely on the
15418     * rendering engine.
15419     *
15420     * @param item item with custom (custom) cursor already set on
15421     * @param engine_only Use @c EINA_TRUE to have cursors looked for
15422     * only on those provided by the rendering engine, @c EINA_FALSE to
15423     * have them searched on the widget's theme, as well.
15424     *
15425     * @note This call is of use only if you've set a custom cursor
15426     * for toolbar items, with elm_toolbar_item_cursor_set().
15427     *
15428     * @note By default, cursors will only be looked for between those
15429     * provided by the rendering engine.
15430     *
15431     * @ingroup Toolbar
15432     */
15433    EAPI void             elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15434
15435    /**
15436     * Get if the (custom) cursor for a given toolbar item is being
15437     * searched in its theme, also, or is only relying on the rendering
15438     * engine.
15439     *
15440     * @param item a toolbar item
15441     * @return @c EINA_TRUE, if cursors are being looked for only on
15442     * those provided by the rendering engine, @c EINA_FALSE if they
15443     * are being searched on the widget's theme, as well.
15444     *
15445     * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15446     *
15447     * @ingroup Toolbar
15448     */
15449    EAPI Eina_Bool        elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15450
15451    /**
15452     * Change a toolbar's orientation
15453     * @param obj The toolbar object
15454     * @param vertical If @c EINA_TRUE, the toolbar is vertical
15455     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15456     * @ingroup Toolbar
15457     */
15458    EAPI void             elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15459
15460    /**
15461     * Get a toolbar's orientation
15462     * @param obj The toolbar object
15463     * @return If @c EINA_TRUE, the toolbar is vertical
15464     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15465     * @ingroup Toolbar
15466     */
15467    EAPI Eina_Bool        elm_toolbar_orientation_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
15468
15469    /**
15470     * @}
15471     */
15472
15473    /**
15474     * @defgroup Tooltips Tooltips
15475     *
15476     * The Tooltip is an (internal, for now) smart object used to show a
15477     * content in a frame on mouse hover of objects(or widgets), with
15478     * tips/information about them.
15479     *
15480     * @{
15481     */
15482
15483    EAPI double       elm_tooltip_delay_get(void);
15484    EAPI Eina_Bool    elm_tooltip_delay_set(double delay);
15485    EAPI void         elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15486    EAPI void         elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15487    EAPI void         elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15488    EAPI void         elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
15489 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
15490    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);
15491    EAPI void         elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15492    EAPI void         elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15493    EAPI const char  *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15494    EAPI Eina_Bool    elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
15495    EAPI Eina_Bool    elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
15496
15497    /**
15498     * @}
15499     */
15500
15501    /**
15502     * @defgroup Cursors Cursors
15503     *
15504     * The Elementary cursor is an internal smart object used to
15505     * customize the mouse cursor displayed over objects (or
15506     * widgets). In the most common scenario, the cursor decoration
15507     * comes from the graphical @b engine Elementary is running
15508     * on. Those engines may provide different decorations for cursors,
15509     * and Elementary provides functions to choose them (think of X11
15510     * cursors, as an example).
15511     *
15512     * There's also the possibility of, besides using engine provided
15513     * cursors, also use ones coming from Edje theming files. Both
15514     * globally and per widget, Elementary makes it possible for one to
15515     * make the cursors lookup to be held on engines only or on
15516     * Elementary's theme file, too.
15517     *
15518     * @{
15519     */
15520
15521    /**
15522     * Set the cursor to be shown when mouse is over the object
15523     *
15524     * Set the cursor that will be displayed when mouse is over the
15525     * object. The object can have only one cursor set to it, so if
15526     * this function is called twice for an object, the previous set
15527     * will be unset.
15528     * If using X cursors, a definition of all the valid cursor names
15529     * is listed on Elementary_Cursors.h. If an invalid name is set
15530     * the default cursor will be used.
15531     *
15532     * @param obj the object being set a cursor.
15533     * @param cursor the cursor name to be used.
15534     *
15535     * @ingroup Cursors
15536     */
15537    EAPI void         elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15538
15539    /**
15540     * Get the cursor to be shown when mouse is over the object
15541     *
15542     * @param obj an object with cursor already set.
15543     * @return the cursor name.
15544     *
15545     * @ingroup Cursors
15546     */
15547    EAPI const char  *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15548
15549    /**
15550     * Unset cursor for object
15551     *
15552     * Unset cursor for object, and set the cursor to default if the mouse
15553     * was over this object.
15554     *
15555     * @param obj Target object
15556     * @see elm_object_cursor_set()
15557     *
15558     * @ingroup Cursors
15559     */
15560    EAPI void         elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15561
15562    /**
15563     * Sets a different style for this object cursor.
15564     *
15565     * @note before you set a style you should define a cursor with
15566     *       elm_object_cursor_set()
15567     *
15568     * @param obj an object with cursor already set.
15569     * @param style the theme style to use (default, transparent, ...)
15570     *
15571     * @ingroup Cursors
15572     */
15573    EAPI void         elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15574
15575    /**
15576     * Get the style for this object cursor.
15577     *
15578     * @param obj an object with cursor already set.
15579     * @return style the theme style in use, defaults to "default". If the
15580     *         object does not have a cursor set, then NULL is returned.
15581     *
15582     * @ingroup Cursors
15583     */
15584    EAPI const char  *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15585
15586    /**
15587     * Set if the cursor set should be searched on the theme or should use
15588     * the provided by the engine, only.
15589     *
15590     * @note before you set if should look on theme you should define a cursor
15591     * with elm_object_cursor_set(). By default it will only look for cursors
15592     * provided by the engine.
15593     *
15594     * @param obj an object with cursor already set.
15595     * @param engine_only boolean to define it cursors should be looked only
15596     * between the provided by the engine or searched on widget's theme as well.
15597     *
15598     * @ingroup Cursors
15599     */
15600    EAPI void         elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15601
15602    /**
15603     * Get the cursor engine only usage for this object cursor.
15604     *
15605     * @param obj an object with cursor already set.
15606     * @return engine_only boolean to define it cursors should be
15607     * looked only between the provided by the engine or searched on
15608     * widget's theme as well. If the object does not have a cursor
15609     * set, then EINA_FALSE is returned.
15610     *
15611     * @ingroup Cursors
15612     */
15613    EAPI Eina_Bool    elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15614
15615    /**
15616     * Get the configured cursor engine only usage
15617     *
15618     * This gets the globally configured exclusive usage of engine cursors.
15619     *
15620     * @return 1 if only engine cursors should be used
15621     * @ingroup Cursors
15622     */
15623    EAPI int          elm_cursor_engine_only_get(void);
15624
15625    /**
15626     * Set the configured cursor engine only usage
15627     *
15628     * This sets the globally configured exclusive usage of engine cursors.
15629     * It won't affect cursors set before changing this value.
15630     *
15631     * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15632     * look for them on theme before.
15633     * @return EINA_TRUE if value is valid and setted (0 or 1)
15634     * @ingroup Cursors
15635     */
15636    EAPI Eina_Bool    elm_cursor_engine_only_set(int engine_only);
15637
15638    /**
15639     * @}
15640     */
15641
15642    /**
15643     * @defgroup Menu Menu
15644     *
15645     * @image html img/widget/menu/preview-00.png
15646     * @image latex img/widget/menu/preview-00.eps
15647     *
15648     * A menu is a list of items displayed above its parent. When the menu is
15649     * showing its parent is darkened. Each item can have a sub-menu. The menu
15650     * object can be used to display a menu on a right click event, in a toolbar,
15651     * anywhere.
15652     *
15653     * Signals that you can add callbacks for are:
15654     * @li "clicked" - the user clicked the empty space in the menu to dismiss.
15655     *             event_info is NULL.
15656     *
15657     * @see @ref tutorial_menu
15658     * @{
15659     */
15660    typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
15661    /**
15662     * @brief Add a new menu to the parent
15663     *
15664     * @param parent The parent object.
15665     * @return The new object or NULL if it cannot be created.
15666     */
15667    EAPI Evas_Object       *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15668    /**
15669     * @brief Set the parent for the given menu widget
15670     *
15671     * @param obj The menu object.
15672     * @param parent The new parent.
15673     */
15674    EAPI void               elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15675    /**
15676     * @brief Get the parent for the given menu widget
15677     *
15678     * @param obj The menu object.
15679     * @return The parent.
15680     *
15681     * @see elm_menu_parent_set()
15682     */
15683    EAPI Evas_Object       *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15684    /**
15685     * @brief Move the menu to a new position
15686     *
15687     * @param obj The menu object.
15688     * @param x The new position.
15689     * @param y The new position.
15690     *
15691     * Sets the top-left position of the menu to (@p x,@p y).
15692     *
15693     * @note @p x and @p y coordinates are relative to parent.
15694     */
15695    EAPI void               elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
15696    /**
15697     * @brief Close a opened menu
15698     *
15699     * @param obj the menu object
15700     * @return void
15701     *
15702     * Hides the menu and all it's sub-menus.
15703     */
15704    EAPI void               elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
15705    /**
15706     * @brief Returns a list of @p item's items.
15707     *
15708     * @param obj The menu object
15709     * @return An Eina_List* of @p item's items
15710     */
15711    EAPI const Eina_List   *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15712    /**
15713     * @brief Get the Evas_Object of an Elm_Menu_Item
15714     *
15715     * @param item The menu item object.
15716     * @return The edje object containing the swallowed content
15717     *
15718     * @warning Don't manipulate this object!
15719     */
15720    EAPI Evas_Object       *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15721    /**
15722     * @brief Add an item at the end of the given menu widget
15723     *
15724     * @param obj The menu object.
15725     * @param parent The parent menu item (optional)
15726     * @param icon A icon display on the item. The icon will be destryed by the menu.
15727     * @param label The label of the item.
15728     * @param func Function called when the user select the item.
15729     * @param data Data sent by the callback.
15730     * @return Returns the new item.
15731     */
15732    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);
15733    /**
15734     * @brief Add an object swallowed in an item at the end of the given menu
15735     * widget
15736     *
15737     * @param obj The menu object.
15738     * @param parent The parent menu item (optional)
15739     * @param subobj The object to swallow
15740     * @param func Function called when the user select the item.
15741     * @param data Data sent by the callback.
15742     * @return Returns the new item.
15743     *
15744     * Add an evas object as an item to the menu.
15745     */
15746    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);
15747    /**
15748     * @brief Set the label of a menu item
15749     *
15750     * @param item The menu item object.
15751     * @param label The label to set for @p item
15752     *
15753     * @warning Don't use this funcion on items created with
15754     * elm_menu_item_add_object() or elm_menu_item_separator_add().
15755     */
15756    EAPI void               elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
15757    /**
15758     * @brief Get the label of a menu item
15759     *
15760     * @param item The menu item object.
15761     * @return The label of @p item
15762     */
15763    EAPI const char        *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15764    /**
15765     * @brief Set the icon of a menu item to the standard icon with name @p icon
15766     *
15767     * @param item The menu item object.
15768     * @param icon The icon object to set for the content of @p item
15769     *
15770     * Once this icon is set, any previously set icon will be deleted.
15771     */
15772    EAPI void               elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
15773    /**
15774     * @brief Get the string representation from the icon of a menu item
15775     *
15776     * @param item The menu item object.
15777     * @return The string representation of @p item's icon or NULL
15778     *
15779     * @see elm_menu_item_object_icon_name_set()
15780     */
15781    EAPI const char        *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15782    /**
15783     * @brief Set the content object of a menu item
15784     *
15785     * @param item The menu item object
15786     * @param The content object or NULL
15787     * @return EINA_TRUE on success, else EINA_FALSE
15788     *
15789     * Use this function to change the object swallowed by a menu item, deleting
15790     * any previously swallowed object.
15791     */
15792    EAPI Eina_Bool          elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
15793    /**
15794     * @brief Get the content object of a menu item
15795     *
15796     * @param item The menu item object
15797     * @return The content object or NULL
15798     * @note If @p item was added with elm_menu_item_add_object, this
15799     * function will return the object passed, else it will return the
15800     * icon object.
15801     *
15802     * @see elm_menu_item_object_content_set()
15803     */
15804    EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15805    /**
15806     * @brief Set the selected state of @p item.
15807     *
15808     * @param item The menu item object.
15809     * @param selected The selected/unselected state of the item
15810     */
15811    EAPI void               elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15812    /**
15813     * @brief Get the selected state of @p item.
15814     *
15815     * @param item The menu item object.
15816     * @return The selected/unselected state of the item
15817     *
15818     * @see elm_menu_item_selected_set()
15819     */
15820    EAPI Eina_Bool          elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15821    /**
15822     * @brief Set the disabled state of @p item.
15823     *
15824     * @param item The menu item object.
15825     * @param disabled The enabled/disabled state of the item
15826     */
15827    EAPI void               elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15828    /**
15829     * @brief Get the disabled state of @p item.
15830     *
15831     * @param item The menu item object.
15832     * @return The enabled/disabled state of the item
15833     *
15834     * @see elm_menu_item_disabled_set()
15835     */
15836    EAPI Eina_Bool          elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15837    /**
15838     * @brief Add a separator item to menu @p obj under @p parent.
15839     *
15840     * @param obj The menu object
15841     * @param parent The item to add the separator under
15842     * @return The created item or NULL on failure
15843     *
15844     * This is item is a @ref Separator.
15845     */
15846    EAPI Elm_Menu_Item     *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
15847    /**
15848     * @brief Returns whether @p item is a separator.
15849     *
15850     * @param item The item to check
15851     * @return If true, @p item is a separator
15852     *
15853     * @see elm_menu_item_separator_add()
15854     */
15855    EAPI Eina_Bool          elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15856    /**
15857     * @brief Deletes an item from the menu.
15858     *
15859     * @param item The item to delete.
15860     *
15861     * @see elm_menu_item_add()
15862     */
15863    EAPI void               elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15864    /**
15865     * @brief Set the function called when a menu item is deleted.
15866     *
15867     * @param item The item to set the callback on
15868     * @param func The function called
15869     *
15870     * @see elm_menu_item_add()
15871     * @see elm_menu_item_del()
15872     */
15873    EAPI void               elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15874    /**
15875     * @brief Returns the data associated with menu item @p item.
15876     *
15877     * @param item The item
15878     * @return The data associated with @p item or NULL if none was set.
15879     *
15880     * This is the data set with elm_menu_add() or elm_menu_item_data_set().
15881     */
15882    EAPI void              *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15883    /**
15884     * @brief Sets the data to be associated with menu item @p item.
15885     *
15886     * @param item The item
15887     * @param data The data to be associated with @p item
15888     */
15889    EAPI void               elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
15890    /**
15891     * @brief Returns a list of @p item's subitems.
15892     *
15893     * @param item The item
15894     * @return An Eina_List* of @p item's subitems
15895     *
15896     * @see elm_menu_add()
15897     */
15898    EAPI const Eina_List   *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15899    /**
15900     * @brief Get the position of a menu item
15901     *
15902     * @param item The menu item
15903     * @return The item's index
15904     *
15905     * This function returns the index position of a menu item in a menu.
15906     * For a sub-menu, this number is relative to the first item in the sub-menu.
15907     *
15908     * @note Index values begin with 0
15909     */
15910    EAPI unsigned int       elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
15911    /**
15912     * @brief @brief Return a menu item's owner menu
15913     *
15914     * @param item The menu item
15915     * @return The menu object owning @p item, or NULL on failure
15916     *
15917     * Use this function to get the menu object owning an item.
15918     */
15919    EAPI Evas_Object       *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
15920    /**
15921     * @brief Get the selected item in the menu
15922     *
15923     * @param obj The menu object
15924     * @return The selected item, or NULL if none
15925     *
15926     * @see elm_menu_item_selected_get()
15927     * @see elm_menu_item_selected_set()
15928     */
15929    EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
15930    /**
15931     * @brief Get the last item in the menu
15932     *
15933     * @param obj The menu object
15934     * @return The last item, or NULL if none
15935     */
15936    EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
15937    /**
15938     * @brief Get the first item in the menu
15939     *
15940     * @param obj The menu object
15941     * @return The first item, or NULL if none
15942     */
15943    EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
15944    /**
15945     * @brief Get the next item in the menu.
15946     *
15947     * @param item The menu item object.
15948     * @return The item after it, or NULL if none
15949     */
15950    EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15951    /**
15952     * @brief Get the previous item in the menu.
15953     *
15954     * @param item The menu item object.
15955     * @return The item before it, or NULL if none
15956     */
15957    EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15958    /**
15959     * @}
15960     */
15961
15962    /**
15963     * @defgroup List List
15964     * @ingroup Elementary
15965     *
15966     * @image html img/widget/list/preview-00.png
15967     * @image latex img/widget/list/preview-00.eps width=\textwidth
15968     *
15969     * @image html img/list.png
15970     * @image latex img/list.eps width=\textwidth
15971     *
15972     * A list widget is a container whose children are displayed vertically or
15973     * horizontally, in order, and can be selected.
15974     * The list can accept only one or multiple items selection. Also has many
15975     * modes of items displaying.
15976     *
15977     * A list is a very simple type of list widget.  For more robust
15978     * lists, @ref Genlist should probably be used.
15979     *
15980     * Smart callbacks one can listen to:
15981     * - @c "activated" - The user has double-clicked or pressed
15982     *   (enter|return|spacebar) on an item. The @c event_info parameter
15983     *   is the item that was activated.
15984     * - @c "clicked,double" - The user has double-clicked an item.
15985     *   The @c event_info parameter is the item that was double-clicked.
15986     * - "selected" - when the user selected an item
15987     * - "unselected" - when the user unselected an item
15988     * - "longpressed" - an item in the list is long-pressed
15989     * - "edge,top" - the list is scrolled until the top edge
15990     * - "edge,bottom" - the list is scrolled until the bottom edge
15991     * - "edge,left" - the list is scrolled until the left edge
15992     * - "edge,right" - the list is scrolled until the right edge
15993     * - "language,changed" - the program's language changed
15994     *
15995     * Available styles for it:
15996     * - @c "default"
15997     *
15998     * List of examples:
15999     * @li @ref list_example_01
16000     * @li @ref list_example_02
16001     * @li @ref list_example_03
16002     */
16003
16004    /**
16005     * @addtogroup List
16006     * @{
16007     */
16008
16009    /**
16010     * @enum _Elm_List_Mode
16011     * @typedef Elm_List_Mode
16012     *
16013     * Set list's resize behavior, transverse axis scroll and
16014     * items cropping. See each mode's description for more details.
16015     *
16016     * @note Default value is #ELM_LIST_SCROLL.
16017     *
16018     * Values <b> don't </b> work as bitmask, only one can be choosen.
16019     *
16020     * @see elm_list_mode_set()
16021     * @see elm_list_mode_get()
16022     *
16023     * @ingroup List
16024     */
16025    typedef enum _Elm_List_Mode
16026      {
16027         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. */
16028         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). */
16029         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. */
16030         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. */
16031         ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
16032      } Elm_List_Mode;
16033
16034    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().  */
16035
16036    /**
16037     * Add a new list widget to the given parent Elementary
16038     * (container) object.
16039     *
16040     * @param parent The parent object.
16041     * @return a new list widget handle or @c NULL, on errors.
16042     *
16043     * This function inserts a new list widget on the canvas.
16044     *
16045     * @ingroup List
16046     */
16047    EAPI Evas_Object     *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16048
16049    /**
16050     * Starts the list.
16051     *
16052     * @param obj The list object
16053     *
16054     * @note Call before running show() on the list object.
16055     * @warning If not called, it won't display the list properly.
16056     *
16057     * @code
16058     * li = elm_list_add(win);
16059     * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
16060     * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
16061     * elm_list_go(li);
16062     * evas_object_show(li);
16063     * @endcode
16064     *
16065     * @ingroup List
16066     */
16067    EAPI void             elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
16068
16069    /**
16070     * Enable or disable multiple items selection on the list object.
16071     *
16072     * @param obj The list object
16073     * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
16074     * disable it.
16075     *
16076     * Disabled by default. If disabled, the user can select a single item of
16077     * the list each time. Selected items are highlighted on list.
16078     * If enabled, many items can be selected.
16079     *
16080     * If a selected item is selected again, it will be unselected.
16081     *
16082     * @see elm_list_multi_select_get()
16083     *
16084     * @ingroup List
16085     */
16086    EAPI void             elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16087
16088    /**
16089     * Get a value whether multiple items selection is enabled or not.
16090     *
16091     * @see elm_list_multi_select_set() for details.
16092     *
16093     * @param obj The list object.
16094     * @return @c EINA_TRUE means multiple items selection is enabled.
16095     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16096     * @c EINA_FALSE is returned.
16097     *
16098     * @ingroup List
16099     */
16100    EAPI Eina_Bool        elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16101
16102    /**
16103     * Set which mode to use for the list object.
16104     *
16105     * @param obj The list object
16106     * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16107     * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
16108     *
16109     * Set list's resize behavior, transverse axis scroll and
16110     * items cropping. See each mode's description for more details.
16111     *
16112     * @note Default value is #ELM_LIST_SCROLL.
16113     *
16114     * Only one can be set, if a previous one was set, it will be changed
16115     * by the new mode set. Bitmask won't work as well.
16116     *
16117     * @see elm_list_mode_get()
16118     *
16119     * @ingroup List
16120     */
16121    EAPI void             elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16122
16123    /**
16124     * Get the mode the list is at.
16125     *
16126     * @param obj The list object
16127     * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16128     * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
16129     *
16130     * @note see elm_list_mode_set() for more information.
16131     *
16132     * @ingroup List
16133     */
16134    EAPI Elm_List_Mode    elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16135
16136    /**
16137     * Enable or disable horizontal mode on the list object.
16138     *
16139     * @param obj The list object.
16140     * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
16141     * disable it, i.e., to enable vertical mode.
16142     *
16143     * @note Vertical mode is set by default.
16144     *
16145     * On horizontal mode items are displayed on list from left to right,
16146     * instead of from top to bottom. Also, the list will scroll horizontally.
16147     * Each item will presents left icon on top and right icon, or end, at
16148     * the bottom.
16149     *
16150     * @see elm_list_horizontal_get()
16151     *
16152     * @ingroup List
16153     */
16154    EAPI void             elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16155
16156    /**
16157     * Get a value whether horizontal mode is enabled or not.
16158     *
16159     * @param obj The list object.
16160     * @return @c EINA_TRUE means horizontal mode selection is enabled.
16161     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16162     * @c EINA_FALSE is returned.
16163     *
16164     * @see elm_list_horizontal_set() for details.
16165     *
16166     * @ingroup List
16167     */
16168    EAPI Eina_Bool        elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16169
16170    /**
16171     * Enable or disable always select mode on the list object.
16172     *
16173     * @param obj The list object
16174     * @param always_select @c EINA_TRUE to enable always select mode or
16175     * @c EINA_FALSE to disable it.
16176     *
16177     * @note Always select mode is disabled by default.
16178     *
16179     * Default behavior of list items is to only call its callback function
16180     * the first time it's pressed, i.e., when it is selected. If a selected
16181     * item is pressed again, and multi-select is disabled, it won't call
16182     * this function (if multi-select is enabled it will unselect the item).
16183     *
16184     * If always select is enabled, it will call the callback function
16185     * everytime a item is pressed, so it will call when the item is selected,
16186     * and again when a selected item is pressed.
16187     *
16188     * @see elm_list_always_select_mode_get()
16189     * @see elm_list_multi_select_set()
16190     *
16191     * @ingroup List
16192     */
16193    EAPI void             elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16194
16195    /**
16196     * Get a value whether always select mode is enabled or not, meaning that
16197     * an item will always call its callback function, even if already selected.
16198     *
16199     * @param obj The list object
16200     * @return @c EINA_TRUE means horizontal mode selection is enabled.
16201     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16202     * @c EINA_FALSE is returned.
16203     *
16204     * @see elm_list_always_select_mode_set() for details.
16205     *
16206     * @ingroup List
16207     */
16208    EAPI Eina_Bool        elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16209
16210    /**
16211     * Set bouncing behaviour when the scrolled content reaches an edge.
16212     *
16213     * Tell the internal scroller object whether it should bounce or not
16214     * when it reaches the respective edges for each axis.
16215     *
16216     * @param obj The list object
16217     * @param h_bounce Whether to bounce or not in the horizontal axis.
16218     * @param v_bounce Whether to bounce or not in the vertical axis.
16219     *
16220     * @see elm_scroller_bounce_set()
16221     *
16222     * @ingroup List
16223     */
16224    EAPI void             elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16225
16226    /**
16227     * Get the bouncing behaviour of the internal scroller.
16228     *
16229     * Get whether the internal scroller should bounce when the edge of each
16230     * axis is reached scrolling.
16231     *
16232     * @param obj The list object.
16233     * @param h_bounce Pointer where to store the bounce state of the horizontal
16234     * axis.
16235     * @param v_bounce Pointer where to store the bounce state of the vertical
16236     * axis.
16237     *
16238     * @see elm_scroller_bounce_get()
16239     * @see elm_list_bounce_set()
16240     *
16241     * @ingroup List
16242     */
16243    EAPI void             elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16244
16245    /**
16246     * Set the scrollbar policy.
16247     *
16248     * @param obj The list object
16249     * @param policy_h Horizontal scrollbar policy.
16250     * @param policy_v Vertical scrollbar policy.
16251     *
16252     * This sets the scrollbar visibility policy for the given scroller.
16253     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
16254     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
16255     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
16256     * This applies respectively for the horizontal and vertical scrollbars.
16257     *
16258     * The both are disabled by default, i.e., are set to
16259     * #ELM_SCROLLER_POLICY_OFF.
16260     *
16261     * @ingroup List
16262     */
16263    EAPI void             elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
16264
16265    /**
16266     * Get the scrollbar policy.
16267     *
16268     * @see elm_list_scroller_policy_get() for details.
16269     *
16270     * @param obj The list object.
16271     * @param policy_h Pointer where to store horizontal scrollbar policy.
16272     * @param policy_v Pointer where to store vertical scrollbar policy.
16273     *
16274     * @ingroup List
16275     */
16276    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);
16277
16278    /**
16279     * Append a new item to the list object.
16280     *
16281     * @param obj The list object.
16282     * @param label The label of the list item.
16283     * @param icon The icon object to use for the left side of the item. An
16284     * icon can be any Evas object, but usually it is an icon created
16285     * with elm_icon_add().
16286     * @param end The icon object to use for the right side of the item. An
16287     * icon can be any Evas object.
16288     * @param func The function to call when the item is clicked.
16289     * @param data The data to associate with the item for related callbacks.
16290     *
16291     * @return The created item or @c NULL upon failure.
16292     *
16293     * A new item will be created and appended to the list, i.e., will
16294     * be set as @b last item.
16295     *
16296     * Items created with this method can be deleted with
16297     * elm_list_item_del().
16298     *
16299     * Associated @p data can be properly freed when item is deleted if a
16300     * callback function is set with elm_list_item_del_cb_set().
16301     *
16302     * If a function is passed as argument, it will be called everytime this item
16303     * is selected, i.e., the user clicks over an unselected item.
16304     * If always select is enabled it will call this function every time
16305     * user clicks over an item (already selected or not).
16306     * If such function isn't needed, just passing
16307     * @c NULL as @p func is enough. The same should be done for @p data.
16308     *
16309     * Simple example (with no function callback or data associated):
16310     * @code
16311     * li = elm_list_add(win);
16312     * ic = elm_icon_add(win);
16313     * elm_icon_file_set(ic, "path/to/image", NULL);
16314     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16315     * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16316     * elm_list_go(li);
16317     * evas_object_show(li);
16318     * @endcode
16319     *
16320     * @see elm_list_always_select_mode_set()
16321     * @see elm_list_item_del()
16322     * @see elm_list_item_del_cb_set()
16323     * @see elm_list_clear()
16324     * @see elm_icon_add()
16325     *
16326     * @ingroup List
16327     */
16328    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);
16329
16330    /**
16331     * Prepend a new item to the list object.
16332     *
16333     * @param obj The list object.
16334     * @param label The label of the list item.
16335     * @param icon The icon object to use for the left side of the item. An
16336     * icon can be any Evas object, but usually it is an icon created
16337     * with elm_icon_add().
16338     * @param end The icon object to use for the right side of the item. An
16339     * icon can be any Evas object.
16340     * @param func The function to call when the item is clicked.
16341     * @param data The data to associate with the item for related callbacks.
16342     *
16343     * @return The created item or @c NULL upon failure.
16344     *
16345     * A new item will be created and prepended to the list, i.e., will
16346     * be set as @b first item.
16347     *
16348     * Items created with this method can be deleted with
16349     * elm_list_item_del().
16350     *
16351     * Associated @p data can be properly freed when item is deleted if a
16352     * callback function is set with elm_list_item_del_cb_set().
16353     *
16354     * If a function is passed as argument, it will be called everytime this item
16355     * is selected, i.e., the user clicks over an unselected item.
16356     * If always select is enabled it will call this function every time
16357     * user clicks over an item (already selected or not).
16358     * If such function isn't needed, just passing
16359     * @c NULL as @p func is enough. The same should be done for @p data.
16360     *
16361     * @see elm_list_item_append() for a simple code example.
16362     * @see elm_list_always_select_mode_set()
16363     * @see elm_list_item_del()
16364     * @see elm_list_item_del_cb_set()
16365     * @see elm_list_clear()
16366     * @see elm_icon_add()
16367     *
16368     * @ingroup List
16369     */
16370    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);
16371
16372    /**
16373     * Insert a new item into the list object before item @p before.
16374     *
16375     * @param obj The list object.
16376     * @param before The list item to insert before.
16377     * @param label The label of the list item.
16378     * @param icon The icon object to use for the left side of the item. An
16379     * icon can be any Evas object, but usually it is an icon created
16380     * with elm_icon_add().
16381     * @param end The icon object to use for the right side of the item. An
16382     * icon can be any Evas object.
16383     * @param func The function to call when the item is clicked.
16384     * @param data The data to associate with the item for related callbacks.
16385     *
16386     * @return The created item or @c NULL upon failure.
16387     *
16388     * A new item will be created and added to the list. Its position in
16389     * this list will be just before item @p before.
16390     *
16391     * Items created with this method can be deleted with
16392     * elm_list_item_del().
16393     *
16394     * Associated @p data can be properly freed when item is deleted if a
16395     * callback function is set with elm_list_item_del_cb_set().
16396     *
16397     * If a function is passed as argument, it will be called everytime this item
16398     * is selected, i.e., the user clicks over an unselected item.
16399     * If always select is enabled it will call this function every time
16400     * user clicks over an item (already selected or not).
16401     * If such function isn't needed, just passing
16402     * @c NULL as @p func is enough. The same should be done for @p data.
16403     *
16404     * @see elm_list_item_append() for a simple code example.
16405     * @see elm_list_always_select_mode_set()
16406     * @see elm_list_item_del()
16407     * @see elm_list_item_del_cb_set()
16408     * @see elm_list_clear()
16409     * @see elm_icon_add()
16410     *
16411     * @ingroup List
16412     */
16413    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);
16414
16415    /**
16416     * Insert a new item into the list object after item @p after.
16417     *
16418     * @param obj The list object.
16419     * @param after The list item to insert after.
16420     * @param label The label of the list item.
16421     * @param icon The icon object to use for the left side of the item. An
16422     * icon can be any Evas object, but usually it is an icon created
16423     * with elm_icon_add().
16424     * @param end The icon object to use for the right side of the item. An
16425     * icon can be any Evas object.
16426     * @param func The function to call when the item is clicked.
16427     * @param data The data to associate with the item for related callbacks.
16428     *
16429     * @return The created item or @c NULL upon failure.
16430     *
16431     * A new item will be created and added to the list. Its position in
16432     * this list will be just after item @p after.
16433     *
16434     * Items created with this method can be deleted with
16435     * elm_list_item_del().
16436     *
16437     * Associated @p data can be properly freed when item is deleted if a
16438     * callback function is set with elm_list_item_del_cb_set().
16439     *
16440     * If a function is passed as argument, it will be called everytime this item
16441     * is selected, i.e., the user clicks over an unselected item.
16442     * If always select is enabled it will call this function every time
16443     * user clicks over an item (already selected or not).
16444     * If such function isn't needed, just passing
16445     * @c NULL as @p func is enough. The same should be done for @p data.
16446     *
16447     * @see elm_list_item_append() for a simple code example.
16448     * @see elm_list_always_select_mode_set()
16449     * @see elm_list_item_del()
16450     * @see elm_list_item_del_cb_set()
16451     * @see elm_list_clear()
16452     * @see elm_icon_add()
16453     *
16454     * @ingroup List
16455     */
16456    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);
16457
16458    /**
16459     * Insert a new item into the sorted list object.
16460     *
16461     * @param obj The list object.
16462     * @param label The label of the list item.
16463     * @param icon The icon object to use for the left side of the item. An
16464     * icon can be any Evas object, but usually it is an icon created
16465     * with elm_icon_add().
16466     * @param end The icon object to use for the right side of the item. An
16467     * icon can be any Evas object.
16468     * @param func The function to call when the item is clicked.
16469     * @param data The data to associate with the item for related callbacks.
16470     * @param cmp_func The comparing function to be used to sort list
16471     * items <b>by #Elm_List_Item item handles</b>. This function will
16472     * receive two items and compare them, returning a non-negative integer
16473     * if the second item should be place after the first, or negative value
16474     * if should be placed before.
16475     *
16476     * @return The created item or @c NULL upon failure.
16477     *
16478     * @note This function inserts values into a list object assuming it was
16479     * sorted and the result will be sorted.
16480     *
16481     * A new item will be created and added to the list. Its position in
16482     * this list will be found comparing the new item with previously inserted
16483     * items using function @p cmp_func.
16484     *
16485     * Items created with this method can be deleted with
16486     * elm_list_item_del().
16487     *
16488     * Associated @p data can be properly freed when item is deleted if a
16489     * callback function is set with elm_list_item_del_cb_set().
16490     *
16491     * If a function is passed as argument, it will be called everytime this item
16492     * is selected, i.e., the user clicks over an unselected item.
16493     * If always select is enabled it will call this function every time
16494     * user clicks over an item (already selected or not).
16495     * If such function isn't needed, just passing
16496     * @c NULL as @p func is enough. The same should be done for @p data.
16497     *
16498     * @see elm_list_item_append() for a simple code example.
16499     * @see elm_list_always_select_mode_set()
16500     * @see elm_list_item_del()
16501     * @see elm_list_item_del_cb_set()
16502     * @see elm_list_clear()
16503     * @see elm_icon_add()
16504     *
16505     * @ingroup List
16506     */
16507    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);
16508
16509    /**
16510     * Remove all list's items.
16511     *
16512     * @param obj The list object
16513     *
16514     * @see elm_list_item_del()
16515     * @see elm_list_item_append()
16516     *
16517     * @ingroup List
16518     */
16519    EAPI void             elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16520
16521    /**
16522     * Get a list of all the list items.
16523     *
16524     * @param obj The list object
16525     * @return An @c Eina_List of list items, #Elm_List_Item,
16526     * or @c NULL on failure.
16527     *
16528     * @see elm_list_item_append()
16529     * @see elm_list_item_del()
16530     * @see elm_list_clear()
16531     *
16532     * @ingroup List
16533     */
16534    EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16535
16536    /**
16537     * Get the selected item.
16538     *
16539     * @param obj The list object.
16540     * @return The selected list item.
16541     *
16542     * The selected item can be unselected with function
16543     * elm_list_item_selected_set().
16544     *
16545     * The selected item always will be highlighted on list.
16546     *
16547     * @see elm_list_selected_items_get()
16548     *
16549     * @ingroup List
16550     */
16551    EAPI Elm_List_Item   *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16552
16553    /**
16554     * Return a list of the currently selected list items.
16555     *
16556     * @param obj The list object.
16557     * @return An @c Eina_List of list items, #Elm_List_Item,
16558     * or @c NULL on failure.
16559     *
16560     * Multiple items can be selected if multi select is enabled. It can be
16561     * done with elm_list_multi_select_set().
16562     *
16563     * @see elm_list_selected_item_get()
16564     * @see elm_list_multi_select_set()
16565     *
16566     * @ingroup List
16567     */
16568    EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16569
16570    /**
16571     * Set the selected state of an item.
16572     *
16573     * @param item The list item
16574     * @param selected The selected state
16575     *
16576     * This sets the selected state of the given item @p it.
16577     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16578     *
16579     * If a new item is selected the previosly selected will be unselected,
16580     * unless multiple selection is enabled with elm_list_multi_select_set().
16581     * Previoulsy selected item can be get with function
16582     * elm_list_selected_item_get().
16583     *
16584     * Selected items will be highlighted.
16585     *
16586     * @see elm_list_item_selected_get()
16587     * @see elm_list_selected_item_get()
16588     * @see elm_list_multi_select_set()
16589     *
16590     * @ingroup List
16591     */
16592    EAPI void             elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16593
16594    /*
16595     * Get whether the @p item is selected or not.
16596     *
16597     * @param item The list item.
16598     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16599     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16600     *
16601     * @see elm_list_selected_item_set() for details.
16602     * @see elm_list_item_selected_get()
16603     *
16604     * @ingroup List
16605     */
16606    EAPI Eina_Bool        elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16607
16608    /**
16609     * Set or unset item as a separator.
16610     *
16611     * @param it The list item.
16612     * @param setting @c EINA_TRUE to set item @p it as separator or
16613     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16614     *
16615     * Items aren't set as separator by default.
16616     *
16617     * If set as separator it will display separator theme, so won't display
16618     * icons or label.
16619     *
16620     * @see elm_list_item_separator_get()
16621     *
16622     * @ingroup List
16623     */
16624    EAPI void             elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
16625
16626    /**
16627     * Get a value whether item is a separator or not.
16628     *
16629     * @see elm_list_item_separator_set() for details.
16630     *
16631     * @param it The list item.
16632     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16633     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16634     *
16635     * @ingroup List
16636     */
16637    EAPI Eina_Bool        elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16638
16639    /**
16640     * Show @p item in the list view.
16641     *
16642     * @param item The list item to be shown.
16643     *
16644     * It won't animate list until item is visible. If such behavior is wanted,
16645     * use elm_list_bring_in() intead.
16646     *
16647     * @ingroup List
16648     */
16649    EAPI void             elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16650
16651    /**
16652     * Bring in the given item to list view.
16653     *
16654     * @param item The item.
16655     *
16656     * This causes list to jump to the given item @p item and show it
16657     * (by scrolling), if it is not fully visible.
16658     *
16659     * This may use animation to do so and take a period of time.
16660     *
16661     * If animation isn't wanted, elm_list_item_show() can be used.
16662     *
16663     * @ingroup List
16664     */
16665    EAPI void             elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16666
16667    /**
16668     * Delete them item from the list.
16669     *
16670     * @param item The item of list to be deleted.
16671     *
16672     * If deleting all list items is required, elm_list_clear()
16673     * should be used instead of getting items list and deleting each one.
16674     *
16675     * @see elm_list_clear()
16676     * @see elm_list_item_append()
16677     * @see elm_list_item_del_cb_set()
16678     *
16679     * @ingroup List
16680     */
16681    EAPI void             elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16682
16683    /**
16684     * Set the function called when a list item is freed.
16685     *
16686     * @param item The item to set the callback on
16687     * @param func The function called
16688     *
16689     * If there is a @p func, then it will be called prior item's memory release.
16690     * That will be called with the following arguments:
16691     * @li item's data;
16692     * @li item's Evas object;
16693     * @li item itself;
16694     *
16695     * This way, a data associated to a list item could be properly freed.
16696     *
16697     * @ingroup List
16698     */
16699    EAPI void             elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16700
16701    /**
16702     * Get the data associated to the item.
16703     *
16704     * @param item The list item
16705     * @return The data associated to @p item
16706     *
16707     * The return value is a pointer to data associated to @p item when it was
16708     * created, with function elm_list_item_append() or similar. If no data
16709     * was passed as argument, it will return @c NULL.
16710     *
16711     * @see elm_list_item_append()
16712     *
16713     * @ingroup List
16714     */
16715    EAPI void            *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16716
16717    /**
16718     * Get the left side icon associated to the item.
16719     *
16720     * @param item The list item
16721     * @return The left side icon associated to @p item
16722     *
16723     * The return value is a pointer to the icon associated to @p item when
16724     * it was
16725     * created, with function elm_list_item_append() or similar, or later
16726     * with function elm_list_item_icon_set(). If no icon
16727     * was passed as argument, it will return @c NULL.
16728     *
16729     * @see elm_list_item_append()
16730     * @see elm_list_item_icon_set()
16731     *
16732     * @ingroup List
16733     */
16734    EAPI Evas_Object     *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16735
16736    /**
16737     * Set the left side icon associated to the item.
16738     *
16739     * @param item The list item
16740     * @param icon The left side icon object to associate with @p item
16741     *
16742     * The icon object to use at left side of the item. An
16743     * icon can be any Evas object, but usually it is an icon created
16744     * with elm_icon_add().
16745     *
16746     * Once the icon object is set, a previously set one will be deleted.
16747     * @warning Setting the same icon for two items will cause the icon to
16748     * dissapear from the first item.
16749     *
16750     * If an icon was passed as argument on item creation, with function
16751     * elm_list_item_append() or similar, it will be already
16752     * associated to the item.
16753     *
16754     * @see elm_list_item_append()
16755     * @see elm_list_item_icon_get()
16756     *
16757     * @ingroup List
16758     */
16759    EAPI void             elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
16760
16761    /**
16762     * Get the right side icon associated to the item.
16763     *
16764     * @param item The list item
16765     * @return The right side icon associated to @p item
16766     *
16767     * The return value is a pointer to the icon associated to @p item when
16768     * it was
16769     * created, with function elm_list_item_append() or similar, or later
16770     * with function elm_list_item_icon_set(). If no icon
16771     * was passed as argument, it will return @c NULL.
16772     *
16773     * @see elm_list_item_append()
16774     * @see elm_list_item_icon_set()
16775     *
16776     * @ingroup List
16777     */
16778    EAPI Evas_Object     *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16779
16780    /**
16781     * Set the right side icon associated to the item.
16782     *
16783     * @param item The list item
16784     * @param end The right side icon object to associate with @p item
16785     *
16786     * The icon object to use at right side of the item. An
16787     * icon can be any Evas object, but usually it is an icon created
16788     * with elm_icon_add().
16789     *
16790     * Once the icon object is set, a previously set one will be deleted.
16791     * @warning Setting the same icon for two items will cause the icon to
16792     * dissapear from the first item.
16793     *
16794     * If an icon was passed as argument on item creation, with function
16795     * elm_list_item_append() or similar, it will be already
16796     * associated to the item.
16797     *
16798     * @see elm_list_item_append()
16799     * @see elm_list_item_end_get()
16800     *
16801     * @ingroup List
16802     */
16803    EAPI void             elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
16804
16805    /**
16806     * Gets the base object of the item.
16807     *
16808     * @param item The list item
16809     * @return The base object associated with @p item
16810     *
16811     * Base object is the @c Evas_Object that represents that item.
16812     *
16813     * @ingroup List
16814     */
16815    EAPI Evas_Object     *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16816    EINA_DEPRECATED EAPI Evas_Object     *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16817
16818    /**
16819     * Get the label of item.
16820     *
16821     * @param item The item of list.
16822     * @return The label of item.
16823     *
16824     * The return value is a pointer to the label associated to @p item when
16825     * it was created, with function elm_list_item_append(), or later
16826     * with function elm_list_item_label_set. If no label
16827     * was passed as argument, it will return @c NULL.
16828     *
16829     * @see elm_list_item_label_set() for more details.
16830     * @see elm_list_item_append()
16831     *
16832     * @ingroup List
16833     */
16834    EAPI const char      *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16835
16836    /**
16837     * Set the label of item.
16838     *
16839     * @param item The item of list.
16840     * @param text The label of item.
16841     *
16842     * The label to be displayed by the item.
16843     * Label will be placed between left and right side icons (if set).
16844     *
16845     * If a label was passed as argument on item creation, with function
16846     * elm_list_item_append() or similar, it will be already
16847     * displayed by the item.
16848     *
16849     * @see elm_list_item_label_get()
16850     * @see elm_list_item_append()
16851     *
16852     * @ingroup List
16853     */
16854    EAPI void             elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
16855
16856
16857    /**
16858     * Get the item before @p it in list.
16859     *
16860     * @param it The list item.
16861     * @return The item before @p it, or @c NULL if none or on failure.
16862     *
16863     * @note If it is the first item, @c NULL will be returned.
16864     *
16865     * @see elm_list_item_append()
16866     * @see elm_list_items_get()
16867     *
16868     * @ingroup List
16869     */
16870    EAPI Elm_List_Item   *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16871
16872    /**
16873     * Get the item after @p it in list.
16874     *
16875     * @param it The list item.
16876     * @return The item after @p it, or @c NULL if none or on failure.
16877     *
16878     * @note If it is the last item, @c NULL will be returned.
16879     *
16880     * @see elm_list_item_append()
16881     * @see elm_list_items_get()
16882     *
16883     * @ingroup List
16884     */
16885    EAPI Elm_List_Item   *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16886
16887    /**
16888     * Sets the disabled/enabled state of a list item.
16889     *
16890     * @param it The item.
16891     * @param disabled The disabled state.
16892     *
16893     * A disabled item cannot be selected or unselected. It will also
16894     * change its appearance (generally greyed out). This sets the
16895     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
16896     * enabled).
16897     *
16898     * @ingroup List
16899     */
16900    EAPI void             elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16901
16902    /**
16903     * Get a value whether list item is disabled or not.
16904     *
16905     * @param it The item.
16906     * @return The disabled state.
16907     *
16908     * @see elm_list_item_disabled_set() for more details.
16909     *
16910     * @ingroup List
16911     */
16912    EAPI Eina_Bool        elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16913
16914    /**
16915     * Set the text to be shown in a given list item's tooltips.
16916     *
16917     * @param item Target item.
16918     * @param text The text to set in the content.
16919     *
16920     * Setup the text as tooltip to object. The item can have only one tooltip,
16921     * so any previous tooltip data - set with this function or
16922     * elm_list_item_tooltip_content_cb_set() - is removed.
16923     *
16924     * @see elm_object_tooltip_text_set() for more details.
16925     *
16926     * @ingroup List
16927     */
16928    EAPI void             elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
16929
16930
16931    /**
16932     * @brief Disable size restrictions on an object's tooltip
16933     * @param item The tooltip's anchor object
16934     * @param disable If EINA_TRUE, size restrictions are disabled
16935     * @return EINA_FALSE on failure, EINA_TRUE on success
16936     *
16937     * This function allows a tooltip to expand beyond its parant window's canvas.
16938     * It will instead be limited only by the size of the display.
16939     */
16940    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
16941    /**
16942     * @brief Retrieve size restriction state of an object's tooltip
16943     * @param obj The tooltip's anchor object
16944     * @return If EINA_TRUE, size restrictions are disabled
16945     *
16946     * This function returns whether a tooltip is allowed to expand beyond
16947     * its parant window's canvas.
16948     * It will instead be limited only by the size of the display.
16949     */
16950    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16951
16952    /**
16953     * Set the content to be shown in the tooltip item.
16954     *
16955     * Setup the tooltip to item. The item can have only one tooltip,
16956     * so any previous tooltip data is removed. @p func(with @p data) will
16957     * be called every time that need show the tooltip and it should
16958     * return a valid Evas_Object. This object is then managed fully by
16959     * tooltip system and is deleted when the tooltip is gone.
16960     *
16961     * @param item the list item being attached a tooltip.
16962     * @param func the function used to create the tooltip contents.
16963     * @param data what to provide to @a func as callback data/context.
16964     * @param del_cb called when data is not needed anymore, either when
16965     *        another callback replaces @a func, the tooltip is unset with
16966     *        elm_list_item_tooltip_unset() or the owner @a item
16967     *        dies. This callback receives as the first parameter the
16968     *        given @a data, and @c event_info is the item.
16969     *
16970     * @see elm_object_tooltip_content_cb_set() for more details.
16971     *
16972     * @ingroup List
16973     */
16974    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);
16975
16976    /**
16977     * Unset tooltip from item.
16978     *
16979     * @param item list item to remove previously set tooltip.
16980     *
16981     * Remove tooltip from item. The callback provided as del_cb to
16982     * elm_list_item_tooltip_content_cb_set() will be called to notify
16983     * it is not used anymore.
16984     *
16985     * @see elm_object_tooltip_unset() for more details.
16986     * @see elm_list_item_tooltip_content_cb_set()
16987     *
16988     * @ingroup List
16989     */
16990    EAPI void             elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16991
16992    /**
16993     * Sets a different style for this item tooltip.
16994     *
16995     * @note before you set a style you should define a tooltip with
16996     *       elm_list_item_tooltip_content_cb_set() or
16997     *       elm_list_item_tooltip_text_set()
16998     *
16999     * @param item list item with tooltip already set.
17000     * @param style the theme style to use (default, transparent, ...)
17001     *
17002     * @see elm_object_tooltip_style_set() for more details.
17003     *
17004     * @ingroup List
17005     */
17006    EAPI void             elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17007
17008    /**
17009     * Get the style for this item tooltip.
17010     *
17011     * @param item list item with tooltip already set.
17012     * @return style the theme style in use, defaults to "default". If the
17013     *         object does not have a tooltip set, then NULL is returned.
17014     *
17015     * @see elm_object_tooltip_style_get() for more details.
17016     * @see elm_list_item_tooltip_style_set()
17017     *
17018     * @ingroup List
17019     */
17020    EAPI const char      *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17021
17022    /**
17023     * Set the type of mouse pointer/cursor decoration to be shown,
17024     * when the mouse pointer is over the given list widget item
17025     *
17026     * @param item list item to customize cursor on
17027     * @param cursor the cursor type's name
17028     *
17029     * This function works analogously as elm_object_cursor_set(), but
17030     * here the cursor's changing area is restricted to the item's
17031     * area, and not the whole widget's. Note that that item cursors
17032     * have precedence over widget cursors, so that a mouse over an
17033     * item with custom cursor set will always show @b that cursor.
17034     *
17035     * If this function is called twice for an object, a previously set
17036     * cursor will be unset on the second call.
17037     *
17038     * @see elm_object_cursor_set()
17039     * @see elm_list_item_cursor_get()
17040     * @see elm_list_item_cursor_unset()
17041     *
17042     * @ingroup List
17043     */
17044    EAPI void             elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17045
17046    /*
17047     * Get the type of mouse pointer/cursor decoration set to be shown,
17048     * when the mouse pointer is over the given list widget item
17049     *
17050     * @param item list item with custom cursor set
17051     * @return the cursor type's name or @c NULL, if no custom cursors
17052     * were set to @p item (and on errors)
17053     *
17054     * @see elm_object_cursor_get()
17055     * @see elm_list_item_cursor_set()
17056     * @see elm_list_item_cursor_unset()
17057     *
17058     * @ingroup List
17059     */
17060    EAPI const char      *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17061
17062    /**
17063     * Unset any custom mouse pointer/cursor decoration set to be
17064     * shown, when the mouse pointer is over the given list widget
17065     * item, thus making it show the @b default cursor again.
17066     *
17067     * @param item a list item
17068     *
17069     * Use this call to undo any custom settings on this item's cursor
17070     * decoration, bringing it back to defaults (no custom style set).
17071     *
17072     * @see elm_object_cursor_unset()
17073     * @see elm_list_item_cursor_set()
17074     *
17075     * @ingroup List
17076     */
17077    EAPI void             elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17078
17079    /**
17080     * Set a different @b style for a given custom cursor set for a
17081     * list item.
17082     *
17083     * @param item list item with custom cursor set
17084     * @param style the <b>theme style</b> to use (e.g. @c "default",
17085     * @c "transparent", etc)
17086     *
17087     * This function only makes sense when one is using custom mouse
17088     * cursor decorations <b>defined in a theme file</b>, which can have,
17089     * given a cursor name/type, <b>alternate styles</b> on it. It
17090     * works analogously as elm_object_cursor_style_set(), but here
17091     * applyed only to list item objects.
17092     *
17093     * @warning Before you set a cursor style you should have definen a
17094     *       custom cursor previously on the item, with
17095     *       elm_list_item_cursor_set()
17096     *
17097     * @see elm_list_item_cursor_engine_only_set()
17098     * @see elm_list_item_cursor_style_get()
17099     *
17100     * @ingroup List
17101     */
17102    EAPI void             elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17103
17104    /**
17105     * Get the current @b style set for a given list item's custom
17106     * cursor
17107     *
17108     * @param item list item with custom cursor set.
17109     * @return style the cursor style in use. If the object does not
17110     *         have a cursor set, then @c NULL is returned.
17111     *
17112     * @see elm_list_item_cursor_style_set() for more details
17113     *
17114     * @ingroup List
17115     */
17116    EAPI const char      *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17117
17118    /**
17119     * Set if the (custom)cursor for a given list item should be
17120     * searched in its theme, also, or should only rely on the
17121     * rendering engine.
17122     *
17123     * @param item item with custom (custom) cursor already set on
17124     * @param engine_only Use @c EINA_TRUE to have cursors looked for
17125     * only on those provided by the rendering engine, @c EINA_FALSE to
17126     * have them searched on the widget's theme, as well.
17127     *
17128     * @note This call is of use only if you've set a custom cursor
17129     * for list items, with elm_list_item_cursor_set().
17130     *
17131     * @note By default, cursors will only be looked for between those
17132     * provided by the rendering engine.
17133     *
17134     * @ingroup List
17135     */
17136    EAPI void             elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17137
17138    /**
17139     * Get if the (custom) cursor for a given list item is being
17140     * searched in its theme, also, or is only relying on the rendering
17141     * engine.
17142     *
17143     * @param item a list item
17144     * @return @c EINA_TRUE, if cursors are being looked for only on
17145     * those provided by the rendering engine, @c EINA_FALSE if they
17146     * are being searched on the widget's theme, as well.
17147     *
17148     * @see elm_list_item_cursor_engine_only_set(), for more details
17149     *
17150     * @ingroup List
17151     */
17152    EAPI Eina_Bool        elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17153
17154    /**
17155     * @}
17156     */
17157
17158    /**
17159     * @defgroup Slider Slider
17160     * @ingroup Elementary
17161     *
17162     * @image html img/widget/slider/preview-00.png
17163     * @image latex img/widget/slider/preview-00.eps width=\textwidth
17164     *
17165     * The slider adds a dragable “slider” widget for selecting the value of
17166     * something within a range.
17167     *
17168     * A slider can be horizontal or vertical. It can contain an Icon and has a
17169     * primary label as well as a units label (that is formatted with floating
17170     * point values and thus accepts a printf-style format string, like
17171     * “%1.2f units”. There is also an indicator string that may be somewhere
17172     * else (like on the slider itself) that also accepts a format string like
17173     * units. Label, Icon Unit and Indicator strings/objects are optional.
17174     *
17175     * A slider may be inverted which means values invert, with high vales being
17176     * on the left or top and low values on the right or bottom (as opposed to
17177     * normally being low on the left or top and high on the bottom and right).
17178     *
17179     * The slider should have its minimum and maximum values set by the
17180     * application with  elm_slider_min_max_set() and value should also be set by
17181     * the application before use with  elm_slider_value_set(). The span of the
17182     * slider is its length (horizontally or vertically). This will be scaled by
17183     * the object or applications scaling factor. At any point code can query the
17184     * slider for its value with elm_slider_value_get().
17185     *
17186     * Smart callbacks one can listen to:
17187     * - "changed" - Whenever the slider value is changed by the user.
17188     * - "slider,drag,start" - dragging the slider indicator around has started.
17189     * - "slider,drag,stop" - dragging the slider indicator around has stopped.
17190     * - "delay,changed" - A short time after the value is changed by the user.
17191     * This will be called only when the user stops dragging for
17192     * a very short period or when they release their
17193     * finger/mouse, so it avoids possibly expensive reactions to
17194     * the value change.
17195     *
17196     * Available styles for it:
17197     * - @c "default"
17198     *
17199     * Here is an example on its usage:
17200     * @li @ref slider_example
17201     */
17202
17203    /**
17204     * @addtogroup Slider
17205     * @{
17206     */
17207
17208    /**
17209     * Add a new slider widget to the given parent Elementary
17210     * (container) object.
17211     *
17212     * @param parent The parent object.
17213     * @return a new slider widget handle or @c NULL, on errors.
17214     *
17215     * This function inserts a new slider widget on the canvas.
17216     *
17217     * @ingroup Slider
17218     */
17219    EAPI Evas_Object       *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17220
17221    /**
17222     * Set the label of a given slider widget
17223     *
17224     * @param obj The progress bar object
17225     * @param label The text label string, in UTF-8
17226     *
17227     * @ingroup Slider
17228     * @deprecated use elm_object_text_set() instead.
17229     */
17230    EINA_DEPRECATED EAPI void               elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17231
17232    /**
17233     * Get the label of a given slider widget
17234     *
17235     * @param obj The progressbar object
17236     * @return The text label string, in UTF-8
17237     *
17238     * @ingroup Slider
17239     * @deprecated use elm_object_text_get() instead.
17240     */
17241    EINA_DEPRECATED EAPI const char        *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17242
17243    /**
17244     * Set the icon object of the slider object.
17245     *
17246     * @param obj The slider object.
17247     * @param icon The icon object.
17248     *
17249     * On horizontal mode, icon is placed at left, and on vertical mode,
17250     * placed at top.
17251     *
17252     * @note Once the icon object is set, a previously set one will be deleted.
17253     * If you want to keep that old content object, use the
17254     * elm_slider_icon_unset() function.
17255     *
17256     * @warning If the object being set does not have minimum size hints set,
17257     * it won't get properly displayed.
17258     *
17259     * @ingroup Slider
17260     */
17261    EAPI void               elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17262
17263    /**
17264     * Unset an icon set on a given slider widget.
17265     *
17266     * @param obj The slider object.
17267     * @return The icon object that was being used, if any was set, or
17268     * @c NULL, otherwise (and on errors).
17269     *
17270     * On horizontal mode, icon is placed at left, and on vertical mode,
17271     * placed at top.
17272     *
17273     * This call will unparent and return the icon object which was set
17274     * for this widget, previously, on success.
17275     *
17276     * @see elm_slider_icon_set() for more details
17277     * @see elm_slider_icon_get()
17278     *
17279     * @ingroup Slider
17280     */
17281    EAPI Evas_Object       *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17282
17283    /**
17284     * Retrieve the icon object set for a given slider widget.
17285     *
17286     * @param obj The slider object.
17287     * @return The icon object's handle, if @p obj had one set, or @c NULL,
17288     * otherwise (and on errors).
17289     *
17290     * On horizontal mode, icon is placed at left, and on vertical mode,
17291     * placed at top.
17292     *
17293     * @see elm_slider_icon_set() for more details
17294     * @see elm_slider_icon_unset()
17295     *
17296     * @ingroup Slider
17297     */
17298    EAPI Evas_Object       *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17299
17300    /**
17301     * Set the end object of the slider object.
17302     *
17303     * @param obj The slider object.
17304     * @param end The end object.
17305     *
17306     * On horizontal mode, end is placed at left, and on vertical mode,
17307     * placed at bottom.
17308     *
17309     * @note Once the icon object is set, a previously set one will be deleted.
17310     * If you want to keep that old content object, use the
17311     * elm_slider_end_unset() function.
17312     *
17313     * @warning If the object being set does not have minimum size hints set,
17314     * it won't get properly displayed.
17315     *
17316     * @ingroup Slider
17317     */
17318    EAPI void               elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17319
17320    /**
17321     * Unset an end object set on a given slider widget.
17322     *
17323     * @param obj The slider object.
17324     * @return The end object that was being used, if any was set, or
17325     * @c NULL, otherwise (and on errors).
17326     *
17327     * On horizontal mode, end is placed at left, and on vertical mode,
17328     * placed at bottom.
17329     *
17330     * This call will unparent and return the icon object which was set
17331     * for this widget, previously, on success.
17332     *
17333     * @see elm_slider_end_set() for more details.
17334     * @see elm_slider_end_get()
17335     *
17336     * @ingroup Slider
17337     */
17338    EAPI Evas_Object       *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17339
17340    /**
17341     * Retrieve the end object set for a given slider widget.
17342     *
17343     * @param obj The slider object.
17344     * @return The end object's handle, if @p obj had one set, or @c NULL,
17345     * otherwise (and on errors).
17346     *
17347     * On horizontal mode, icon is placed at right, and on vertical mode,
17348     * placed at bottom.
17349     *
17350     * @see elm_slider_end_set() for more details.
17351     * @see elm_slider_end_unset()
17352     *
17353     * @ingroup Slider
17354     */
17355    EAPI Evas_Object       *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17356
17357    /**
17358     * Set the (exact) length of the bar region of a given slider widget.
17359     *
17360     * @param obj The slider object.
17361     * @param size The length of the slider's bar region.
17362     *
17363     * This sets the minimum width (when in horizontal mode) or height
17364     * (when in vertical mode) of the actual bar area of the slider
17365     * @p obj. This in turn affects the object's minimum size. Use
17366     * this when you're not setting other size hints expanding on the
17367     * given direction (like weight and alignment hints) and you would
17368     * like it to have a specific size.
17369     *
17370     * @note Icon, end, label, indicator and unit text around @p obj
17371     * will require their
17372     * own space, which will make @p obj to require more the @p size,
17373     * actually.
17374     *
17375     * @see elm_slider_span_size_get()
17376     *
17377     * @ingroup Slider
17378     */
17379    EAPI void               elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17380
17381    /**
17382     * Get the length set for the bar region of a given slider widget
17383     *
17384     * @param obj The slider object.
17385     * @return The length of the slider's bar region.
17386     *
17387     * If that size was not set previously, with
17388     * elm_slider_span_size_set(), this call will return @c 0.
17389     *
17390     * @ingroup Slider
17391     */
17392    EAPI Evas_Coord         elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17393
17394    /**
17395     * Set the format string for the unit label.
17396     *
17397     * @param obj The slider object.
17398     * @param format The format string for the unit display.
17399     *
17400     * Unit label is displayed all the time, if set, after slider's bar.
17401     * In horizontal mode, at right and in vertical mode, at bottom.
17402     *
17403     * If @c NULL, unit label won't be visible. If not it sets the format
17404     * string for the label text. To the label text is provided a floating point
17405     * value, so the label text can display up to 1 floating point value.
17406     * Note that this is optional.
17407     *
17408     * Use a format string such as "%1.2f meters" for example, and it will
17409     * display values like: "3.14 meters" for a value equal to 3.14159.
17410     *
17411     * Default is unit label disabled.
17412     *
17413     * @see elm_slider_indicator_format_get()
17414     *
17415     * @ingroup Slider
17416     */
17417    EAPI void               elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17418
17419    /**
17420     * Get the unit label format of the slider.
17421     *
17422     * @param obj The slider object.
17423     * @return The unit label format string in UTF-8.
17424     *
17425     * Unit label is displayed all the time, if set, after slider's bar.
17426     * In horizontal mode, at right and in vertical mode, at bottom.
17427     *
17428     * @see elm_slider_unit_format_set() for more
17429     * information on how this works.
17430     *
17431     * @ingroup Slider
17432     */
17433    EAPI const char        *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17434
17435    /**
17436     * Set the format string for the indicator label.
17437     *
17438     * @param obj The slider object.
17439     * @param indicator The format string for the indicator display.
17440     *
17441     * The slider may display its value somewhere else then unit label,
17442     * for example, above the slider knob that is dragged around. This function
17443     * sets the format string used for this.
17444     *
17445     * If @c NULL, indicator label won't be visible. If not it sets the format
17446     * string for the label text. To the label text is provided a floating point
17447     * value, so the label text can display up to 1 floating point value.
17448     * Note that this is optional.
17449     *
17450     * Use a format string such as "%1.2f meters" for example, and it will
17451     * display values like: "3.14 meters" for a value equal to 3.14159.
17452     *
17453     * Default is indicator label disabled.
17454     *
17455     * @see elm_slider_indicator_format_get()
17456     *
17457     * @ingroup Slider
17458     */
17459    EAPI void               elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17460
17461    /**
17462     * Get the indicator label format of the slider.
17463     *
17464     * @param obj The slider object.
17465     * @return The indicator label format string in UTF-8.
17466     *
17467     * The slider may display its value somewhere else then unit label,
17468     * for example, above the slider knob that is dragged around. This function
17469     * gets the format string used for this.
17470     *
17471     * @see elm_slider_indicator_format_set() for more
17472     * information on how this works.
17473     *
17474     * @ingroup Slider
17475     */
17476    EAPI const char        *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17477
17478    /**
17479     * Set the format function pointer for the indicator label
17480     *
17481     * @param obj The slider object.
17482     * @param func The indicator format function.
17483     * @param free_func The freeing function for the format string.
17484     *
17485     * Set the callback function to format the indicator string.
17486     *
17487     * @see elm_slider_indicator_format_set() for more info on how this works.
17488     *
17489     * @ingroup Slider
17490     */
17491   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);
17492
17493   /**
17494    * Set the format function pointer for the units label
17495    *
17496    * @param obj The slider object.
17497    * @param func The units format function.
17498    * @param free_func The freeing function for the format string.
17499    *
17500    * Set the callback function to format the indicator string.
17501    *
17502    * @see elm_slider_units_format_set() for more info on how this works.
17503    *
17504    * @ingroup Slider
17505    */
17506   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);
17507
17508   /**
17509    * Set the orientation of a given slider widget.
17510    *
17511    * @param obj The slider object.
17512    * @param horizontal Use @c EINA_TRUE to make @p obj to be
17513    * @b horizontal, @c EINA_FALSE to make it @b vertical.
17514    *
17515    * Use this function to change how your slider is to be
17516    * disposed: vertically or horizontally.
17517    *
17518    * By default it's displayed horizontally.
17519    *
17520    * @see elm_slider_horizontal_get()
17521    *
17522    * @ingroup Slider
17523    */
17524    EAPI void               elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17525
17526    /**
17527     * Retrieve the orientation of a given slider widget
17528     *
17529     * @param obj The slider object.
17530     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17531     * @c EINA_FALSE if it's @b vertical (and on errors).
17532     *
17533     * @see elm_slider_horizontal_set() for more details.
17534     *
17535     * @ingroup Slider
17536     */
17537    EAPI Eina_Bool          elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17538
17539    /**
17540     * Set the minimum and maximum values for the slider.
17541     *
17542     * @param obj The slider object.
17543     * @param min The minimum value.
17544     * @param max The maximum value.
17545     *
17546     * Define the allowed range of values to be selected by the user.
17547     *
17548     * If actual value is less than @p min, it will be updated to @p min. If it
17549     * is bigger then @p max, will be updated to @p max. Actual value can be
17550     * get with elm_slider_value_get().
17551     *
17552     * By default, min is equal to 0.0, and max is equal to 1.0.
17553     *
17554     * @warning Maximum must be greater than minimum, otherwise behavior
17555     * is undefined.
17556     *
17557     * @see elm_slider_min_max_get()
17558     *
17559     * @ingroup Slider
17560     */
17561    EAPI void               elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17562
17563    /**
17564     * Get the minimum and maximum values of the slider.
17565     *
17566     * @param obj The slider object.
17567     * @param min Pointer where to store the minimum value.
17568     * @param max Pointer where to store the maximum value.
17569     *
17570     * @note If only one value is needed, the other pointer can be passed
17571     * as @c NULL.
17572     *
17573     * @see elm_slider_min_max_set() for details.
17574     *
17575     * @ingroup Slider
17576     */
17577    EAPI void               elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17578
17579    /**
17580     * Set the value the slider displays.
17581     *
17582     * @param obj The slider object.
17583     * @param val The value to be displayed.
17584     *
17585     * Value will be presented on the unit label following format specified with
17586     * elm_slider_unit_format_set() and on indicator with
17587     * elm_slider_indicator_format_set().
17588     *
17589     * @warning The value must to be between min and max values. This values
17590     * are set by elm_slider_min_max_set().
17591     *
17592     * @see elm_slider_value_get()
17593     * @see elm_slider_unit_format_set()
17594     * @see elm_slider_indicator_format_set()
17595     * @see elm_slider_min_max_set()
17596     *
17597     * @ingroup Slider
17598     */
17599    EAPI void               elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17600
17601    /**
17602     * Get the value displayed by the spinner.
17603     *
17604     * @param obj The spinner object.
17605     * @return The value displayed.
17606     *
17607     * @see elm_spinner_value_set() for details.
17608     *
17609     * @ingroup Slider
17610     */
17611    EAPI double             elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17612
17613    /**
17614     * Invert a given slider widget's displaying values order
17615     *
17616     * @param obj The slider object.
17617     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17618     * @c EINA_FALSE to bring it back to default, non-inverted values.
17619     *
17620     * A slider may be @b inverted, in which state it gets its
17621     * values inverted, with high vales being on the left or top and
17622     * low values on the right or bottom, as opposed to normally have
17623     * the low values on the former and high values on the latter,
17624     * respectively, for horizontal and vertical modes.
17625     *
17626     * @see elm_slider_inverted_get()
17627     *
17628     * @ingroup Slider
17629     */
17630    EAPI void               elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17631
17632    /**
17633     * Get whether a given slider widget's displaying values are
17634     * inverted or not.
17635     *
17636     * @param obj The slider object.
17637     * @return @c EINA_TRUE, if @p obj has inverted values,
17638     * @c EINA_FALSE otherwise (and on errors).
17639     *
17640     * @see elm_slider_inverted_set() for more details.
17641     *
17642     * @ingroup Slider
17643     */
17644    EAPI Eina_Bool          elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17645
17646    /**
17647     * Set whether to enlarge slider indicator (augmented knob) or not.
17648     *
17649     * @param obj The slider object.
17650     * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
17651     * let the knob always at default size.
17652     *
17653     * By default, indicator will be bigger while dragged by the user.
17654     *
17655     * @warning It won't display values set with
17656     * elm_slider_indicator_format_set() if you disable indicator.
17657     *
17658     * @ingroup Slider
17659     */
17660    EAPI void               elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
17661
17662    /**
17663     * Get whether a given slider widget's enlarging indicator or not.
17664     *
17665     * @param obj The slider object.
17666     * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
17667     * @c EINA_FALSE otherwise (and on errors).
17668     *
17669     * @see elm_slider_indicator_show_set() for details.
17670     *
17671     * @ingroup Slider
17672     */
17673    EAPI Eina_Bool          elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17674
17675    /**
17676     * @}
17677     */
17678
17679    /**
17680     * @addtogroup Actionslider Actionslider
17681     *
17682     * @image html img/widget/actionslider/preview-00.png
17683     * @image latex img/widget/actionslider/preview-00.eps
17684     *
17685     * An actionslider is a switcher for 2 or 3 labels with customizable magnet
17686     * properties. The user drags and releases the indicator, to choose a label.
17687     *
17688     * Labels occupy the following positions.
17689     * a. Left
17690     * b. Right
17691     * c. Center
17692     *
17693     * Positions can be enabled or disabled.
17694     *
17695     * Magnets can be set on the above positions.
17696     *
17697     * When the indicator is released, it will move to its nearest "enabled and magnetized" position.
17698     *
17699     * @note By default all positions are set as enabled.
17700     *
17701     * Signals that you can add callbacks for are:
17702     *
17703     * "selected" - when user selects an enabled position (the label is passed
17704     *              as event info)".
17705     * @n
17706     * "pos_changed" - when the indicator reaches any of the positions("left",
17707     *                 "right" or "center").
17708     *
17709     * See an example of actionslider usage @ref actionslider_example_page "here"
17710     * @{
17711     */
17712    typedef enum _Elm_Actionslider_Pos
17713      {
17714         ELM_ACTIONSLIDER_NONE = 0,
17715         ELM_ACTIONSLIDER_LEFT = 1 << 0,
17716         ELM_ACTIONSLIDER_CENTER = 1 << 1,
17717         ELM_ACTIONSLIDER_RIGHT = 1 << 2,
17718         ELM_ACTIONSLIDER_ALL = (1 << 3) -1
17719      } Elm_Actionslider_Pos;
17720
17721    /**
17722     * Add a new actionslider to the parent.
17723     *
17724     * @param parent The parent object
17725     * @return The new actionslider object or NULL if it cannot be created
17726     */
17727    EAPI Evas_Object          *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17728    /**
17729     * Set actionslider labels.
17730     *
17731     * @param obj The actionslider object
17732     * @param left_label The label to be set on the left.
17733     * @param center_label The label to be set on the center.
17734     * @param right_label The label to be set on the right.
17735     * @deprecated use elm_object_text_set() instead.
17736     */
17737    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);
17738    /**
17739     * Get actionslider labels.
17740     *
17741     * @param obj The actionslider object
17742     * @param left_label A char** to place the left_label of @p obj into.
17743     * @param center_label A char** to place the center_label of @p obj into.
17744     * @param right_label A char** to place the right_label of @p obj into.
17745     * @deprecated use elm_object_text_set() instead.
17746     */
17747    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);
17748    /**
17749     * Get actionslider selected label.
17750     *
17751     * @param obj The actionslider object
17752     * @return The selected label
17753     */
17754    EAPI const char           *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17755    /**
17756     * Set actionslider indicator position.
17757     *
17758     * @param obj The actionslider object.
17759     * @param pos The position of the indicator.
17760     */
17761    EAPI void                  elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17762    /**
17763     * Get actionslider indicator position.
17764     *
17765     * @param obj The actionslider object.
17766     * @return The position of the indicator.
17767     */
17768    EAPI Elm_Actionslider_Pos  elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17769    /**
17770     * Set actionslider magnet position. To make multiple positions magnets @c or
17771     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
17772     *
17773     * @param obj The actionslider object.
17774     * @param pos Bit mask indicating the magnet positions.
17775     */
17776    EAPI void                  elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17777    /**
17778     * Get actionslider magnet position.
17779     *
17780     * @param obj The actionslider object.
17781     * @return The positions with magnet property.
17782     */
17783    EAPI Elm_Actionslider_Pos  elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17784    /**
17785     * Set actionslider enabled position. To set multiple positions as enabled @c or
17786     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
17787     *
17788     * @note All the positions are enabled by default.
17789     *
17790     * @param obj The actionslider object.
17791     * @param pos Bit mask indicating the enabled positions.
17792     */
17793    EAPI void                  elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17794    /**
17795     * Get actionslider enabled position.
17796     *
17797     * @param obj The actionslider object.
17798     * @return The enabled positions.
17799     */
17800    EAPI Elm_Actionslider_Pos  elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17801    /**
17802     * Set the label used on the indicator.
17803     *
17804     * @param obj The actionslider object
17805     * @param label The label to be set on the indicator.
17806     * @deprecated use elm_object_text_set() instead.
17807     */
17808    EINA_DEPRECATED EAPI void                  elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17809    /**
17810     * Get the label used on the indicator object.
17811     *
17812     * @param obj The actionslider object
17813     * @return The indicator label
17814     * @deprecated use elm_object_text_get() instead.
17815     */
17816    EINA_DEPRECATED EAPI const char           *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
17817    /**
17818     * @}
17819     */
17820
17821    /**
17822     * @defgroup Genlist Genlist
17823     *
17824     * @image html img/widget/genlist/preview-00.png
17825     * @image latex img/widget/genlist/preview-00.eps
17826     * @image html img/genlist.png
17827     * @image latex img/genlist.eps
17828     *
17829     * This widget aims to have more expansive list than the simple list in
17830     * Elementary that could have more flexible items and allow many more entries
17831     * while still being fast and low on memory usage. At the same time it was
17832     * also made to be able to do tree structures. But the price to pay is more
17833     * complexity when it comes to usage. If all you want is a simple list with
17834     * icons and a single label, use the normal @ref List object.
17835     *
17836     * Genlist has a fairly large API, mostly because it's relatively complex,
17837     * trying to be both expansive, powerful and efficient. First we will begin
17838     * an overview on the theory behind genlist.
17839     *
17840     * @section Genlist_Item_Class Genlist item classes - creating items
17841     *
17842     * In order to have the ability to add and delete items on the fly, genlist
17843     * implements a class (callback) system where the application provides a
17844     * structure with information about that type of item (genlist may contain
17845     * multiple different items with different classes, states and styles).
17846     * Genlist will call the functions in this struct (methods) when an item is
17847     * "realized" (i.e., created dynamically, while the user is scrolling the
17848     * grid). All objects will simply be deleted when no longer needed with
17849     * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
17850     * following members:
17851     * - @c item_style - This is a constant string and simply defines the name
17852     *   of the item style. It @b must be specified and the default should be @c
17853     *   "default".
17854     *
17855     * - @c func - A struct with pointers to functions that will be called when
17856     *   an item is going to be actually created. All of them receive a @c data
17857     *   parameter that will point to the same data passed to
17858     *   elm_genlist_item_append() and related item creation functions, and a @c
17859     *   obj parameter that points to the genlist object itself.
17860     *
17861     * The function pointers inside @c func are @c label_get, @c icon_get, @c
17862     * state_get and @c del. The 3 first functions also receive a @c part
17863     * parameter described below. A brief description of these functions follows:
17864     *
17865     * - @c label_get - The @c part parameter is the name string of one of the
17866     *   existing text parts in the Edje group implementing the item's theme.
17867     *   This function @b must return a strdup'()ed string, as the caller will
17868     *   free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
17869     * - @c icon_get - The @c part parameter is the name string of one of the
17870     *   existing (icon) swallow parts in the Edje group implementing the item's
17871     *   theme. It must return @c NULL, when no icon is desired, or a valid
17872     *   object handle, otherwise.  The object will be deleted by the genlist on
17873     *   its deletion or when the item is "unrealized".  See
17874     *   #Elm_Genlist_Item_Icon_Get_Cb.
17875     * - @c func.state_get - The @c part parameter is the name string of one of
17876     *   the state parts in the Edje group implementing the item's theme. Return
17877     *   @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
17878     *   emit a signal to its theming Edje object with @c "elm,state,XXX,active"
17879     *   and @c "elm" as "emission" and "source" arguments, respectively, when
17880     *   the state is true (the default is false), where @c XXX is the name of
17881     *   the (state) part.  See #Elm_Genlist_Item_State_Get_Cb.
17882     * - @c func.del - This is intended for use when genlist items are deleted,
17883     *   so any data attached to the item (e.g. its data parameter on creation)
17884     *   can be deleted. See #Elm_Genlist_Item_Del_Cb.
17885     *
17886     * available item styles:
17887     * - default
17888     * - default_style - The text part is a textblock
17889     *
17890     * @image html img/widget/genlist/preview-04.png
17891     * @image latex img/widget/genlist/preview-04.eps
17892     *
17893     * - double_label
17894     *
17895     * @image html img/widget/genlist/preview-01.png
17896     * @image latex img/widget/genlist/preview-01.eps
17897     *
17898     * - icon_top_text_bottom
17899     *
17900     * @image html img/widget/genlist/preview-02.png
17901     * @image latex img/widget/genlist/preview-02.eps
17902     *
17903     * - group_index
17904     *
17905     * @image html img/widget/genlist/preview-03.png
17906     * @image latex img/widget/genlist/preview-03.eps
17907     *
17908     * @section Genlist_Items Structure of items
17909     *
17910     * An item in a genlist can have 0 or more text labels (they can be regular
17911     * text or textblock Evas objects - that's up to the style to determine), 0
17912     * or more icons (which are simply objects swallowed into the genlist item's
17913     * theming Edje object) and 0 or more <b>boolean states</b>, which have the
17914     * behavior left to the user to define. The Edje part names for each of
17915     * these properties will be looked up, in the theme file for the genlist,
17916     * under the Edje (string) data items named @c "labels", @c "icons" and @c
17917     * "states", respectively. For each of those properties, if more than one
17918     * part is provided, they must have names listed separated by spaces in the
17919     * data fields. For the default genlist item theme, we have @b one label
17920     * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
17921     * "elm.swallow.end") and @b no state parts.
17922     *
17923     * A genlist item may be at one of several styles. Elementary provides one
17924     * by default - "default", but this can be extended by system or application
17925     * custom themes/overlays/extensions (see @ref Theme "themes" for more
17926     * details).
17927     *
17928     * @section Genlist_Manipulation Editing and Navigating
17929     *
17930     * Items can be added by several calls. All of them return a @ref
17931     * Elm_Genlist_Item handle that is an internal member inside the genlist.
17932     * They all take a data parameter that is meant to be used for a handle to
17933     * the applications internal data (eg the struct with the original item
17934     * data). The parent parameter is the parent genlist item this belongs to if
17935     * it is a tree or an indexed group, and NULL if there is no parent. The
17936     * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
17937     * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
17938     * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
17939     * that is able to expand and have child items.  If ELM_GENLIST_ITEM_GROUP
17940     * is set then this item is group index item that is displayed at the top
17941     * until the next group comes. The func parameter is a convenience callback
17942     * that is called when the item is selected and the data parameter will be
17943     * the func_data parameter, obj be the genlist object and event_info will be
17944     * the genlist item.
17945     *
17946     * elm_genlist_item_append() adds an item to the end of the list, or if
17947     * there is a parent, to the end of all the child items of the parent.
17948     * elm_genlist_item_prepend() is the same but adds to the beginning of
17949     * the list or children list. elm_genlist_item_insert_before() inserts at
17950     * item before another item and elm_genlist_item_insert_after() inserts after
17951     * the indicated item.
17952     *
17953     * The application can clear the list with elm_genlist_clear() which deletes
17954     * all the items in the list and elm_genlist_item_del() will delete a specific
17955     * item. elm_genlist_item_subitems_clear() will clear all items that are
17956     * children of the indicated parent item.
17957     *
17958     * To help inspect list items you can jump to the item at the top of the list
17959     * with elm_genlist_first_item_get() which will return the item pointer, and
17960     * similarly elm_genlist_last_item_get() gets the item at the end of the list.
17961     * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
17962     * and previous items respectively relative to the indicated item. Using
17963     * these calls you can walk the entire item list/tree. Note that as a tree
17964     * the items are flattened in the list, so elm_genlist_item_parent_get() will
17965     * let you know which item is the parent (and thus know how to skip them if
17966     * wanted).
17967     *
17968     * @section Genlist_Muti_Selection Multi-selection
17969     *
17970     * If the application wants multiple items to be able to be selected,
17971     * elm_genlist_multi_select_set() can enable this. If the list is
17972     * single-selection only (the default), then elm_genlist_selected_item_get()
17973     * will return the selected item, if any, or NULL I none is selected. If the
17974     * list is multi-select then elm_genlist_selected_items_get() will return a
17975     * list (that is only valid as long as no items are modified (added, deleted,
17976     * selected or unselected)).
17977     *
17978     * @section Genlist_Usage_Hints Usage hints
17979     *
17980     * There are also convenience functions. elm_genlist_item_genlist_get() will
17981     * return the genlist object the item belongs to. elm_genlist_item_show()
17982     * will make the scroller scroll to show that specific item so its visible.
17983     * elm_genlist_item_data_get() returns the data pointer set by the item
17984     * creation functions.
17985     *
17986     * If an item changes (state of boolean changes, label or icons change),
17987     * then use elm_genlist_item_update() to have genlist update the item with
17988     * the new state. Genlist will re-realize the item thus call the functions
17989     * in the _Elm_Genlist_Item_Class for that item.
17990     *
17991     * To programmatically (un)select an item use elm_genlist_item_selected_set().
17992     * To get its selected state use elm_genlist_item_selected_get(). Similarly
17993     * to expand/contract an item and get its expanded state, use
17994     * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
17995     * again to make an item disabled (unable to be selected and appear
17996     * differently) use elm_genlist_item_disabled_set() to set this and
17997     * elm_genlist_item_disabled_get() to get the disabled state.
17998     *
17999     * In general to indicate how the genlist should expand items horizontally to
18000     * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
18001     * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
18002     * mode means that if items are too wide to fit, the scroller will scroll
18003     * horizontally. Otherwise items are expanded to fill the width of the
18004     * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
18005     * to the viewport width and limited to that size. This can be combined with
18006     * a different style that uses edjes' ellipsis feature (cutting text off like
18007     * this: "tex...").
18008     *
18009     * Items will only call their selection func and callback when first becoming
18010     * selected. Any further clicks will do nothing, unless you enable always
18011     * select with elm_genlist_always_select_mode_set(). This means even if
18012     * selected, every click will make the selected callbacks be called.
18013     * elm_genlist_no_select_mode_set() will turn off the ability to select
18014     * items entirely and they will neither appear selected nor call selected
18015     * callback functions.
18016     *
18017     * Remember that you can create new styles and add your own theme augmentation
18018     * per application with elm_theme_extension_add(). If you absolutely must
18019     * have a specific style that overrides any theme the user or system sets up
18020     * you can use elm_theme_overlay_add() to add such a file.
18021     *
18022     * @section Genlist_Implementation Implementation
18023     *
18024     * Evas tracks every object you create. Every time it processes an event
18025     * (mouse move, down, up etc.) it needs to walk through objects and find out
18026     * what event that affects. Even worse every time it renders display updates,
18027     * in order to just calculate what to re-draw, it needs to walk through many
18028     * many many objects. Thus, the more objects you keep active, the more
18029     * overhead Evas has in just doing its work. It is advisable to keep your
18030     * active objects to the minimum working set you need. Also remember that
18031     * object creation and deletion carries an overhead, so there is a
18032     * middle-ground, which is not easily determined. But don't keep massive lists
18033     * of objects you can't see or use. Genlist does this with list objects. It
18034     * creates and destroys them dynamically as you scroll around. It groups them
18035     * into blocks so it can determine the visibility etc. of a whole block at
18036     * once as opposed to having to walk the whole list. This 2-level list allows
18037     * for very large numbers of items to be in the list (tests have used up to
18038     * 2,000,000 items). Also genlist employs a queue for adding items. As items
18039     * may be different sizes, every item added needs to be calculated as to its
18040     * size and thus this presents a lot of overhead on populating the list, this
18041     * genlist employs a queue. Any item added is queued and spooled off over
18042     * time, actually appearing some time later, so if your list has many members
18043     * you may find it takes a while for them to all appear, with your process
18044     * consuming a lot of CPU while it is busy spooling.
18045     *
18046     * Genlist also implements a tree structure, but it does so with callbacks to
18047     * the application, with the application filling in tree structures when
18048     * requested (allowing for efficient building of a very deep tree that could
18049     * even be used for file-management). See the above smart signal callbacks for
18050     * details.
18051     *
18052     * @section Genlist_Smart_Events Genlist smart events
18053     *
18054     * Signals that you can add callbacks for are:
18055     * - @c "activated" - The user has double-clicked or pressed
18056     *   (enter|return|spacebar) on an item. The @c event_info parameter is the
18057     *   item that was activated.
18058     * - @c "clicked,double" - The user has double-clicked an item.  The @c
18059     *   event_info parameter is the item that was double-clicked.
18060     * - @c "selected" - This is called when a user has made an item selected.
18061     *   The event_info parameter is the genlist item that was selected.
18062     * - @c "unselected" - This is called when a user has made an item
18063     *   unselected. The event_info parameter is the genlist item that was
18064     *   unselected.
18065     * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
18066     *   called and the item is now meant to be expanded. The event_info
18067     *   parameter is the genlist item that was indicated to expand.  It is the
18068     *   job of this callback to then fill in the child items.
18069     * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
18070     *   called and the item is now meant to be contracted. The event_info
18071     *   parameter is the genlist item that was indicated to contract. It is the
18072     *   job of this callback to then delete the child items.
18073     * - @c "expand,request" - This is called when a user has indicated they want
18074     *   to expand a tree branch item. The callback should decide if the item can
18075     *   expand (has any children) and then call elm_genlist_item_expanded_set()
18076     *   appropriately to set the state. The event_info parameter is the genlist
18077     *   item that was indicated to expand.
18078     * - @c "contract,request" - This is called when a user has indicated they
18079     *   want to contract a tree branch item. The callback should decide if the
18080     *   item can contract (has any children) and then call
18081     *   elm_genlist_item_expanded_set() appropriately to set the state. The
18082     *   event_info parameter is the genlist item that was indicated to contract.
18083     * - @c "realized" - This is called when the item in the list is created as a
18084     *   real evas object. event_info parameter is the genlist item that was
18085     *   created. The object may be deleted at any time, so it is up to the
18086     *   caller to not use the object pointer from elm_genlist_item_object_get()
18087     *   in a way where it may point to freed objects.
18088     * - @c "unrealized" - This is called just before an item is unrealized.
18089     *   After this call icon objects provided will be deleted and the item
18090     *   object itself delete or be put into a floating cache.
18091     * - @c "drag,start,up" - This is called when the item in the list has been
18092     *   dragged (not scrolled) up.
18093     * - @c "drag,start,down" - This is called when the item in the list has been
18094     *   dragged (not scrolled) down.
18095     * - @c "drag,start,left" - This is called when the item in the list has been
18096     *   dragged (not scrolled) left.
18097     * - @c "drag,start,right" - This is called when the item in the list has
18098     *   been dragged (not scrolled) right.
18099     * - @c "drag,stop" - This is called when the item in the list has stopped
18100     *   being dragged.
18101     * - @c "drag" - This is called when the item in the list is being dragged.
18102     * - @c "longpressed" - This is called when the item is pressed for a certain
18103     *   amount of time. By default it's 1 second.
18104     * - @c "scroll,anim,start" - This is called when scrolling animation has
18105     *   started.
18106     * - @c "scroll,anim,stop" - This is called when scrolling animation has
18107     *   stopped.
18108     * - @c "scroll,drag,start" - This is called when dragging the content has
18109     *   started.
18110     * - @c "scroll,drag,stop" - This is called when dragging the content has
18111     *   stopped.
18112     * - @c "edge,top" - This is called when the genlist is scrolled until
18113     *   the top edge.
18114     * - @c "edge,bottom" - This is called when the genlist is scrolled
18115     *   until the bottom edge.
18116     * - @c "edge,left" - This is called when the genlist is scrolled
18117     *   until the left edge.
18118     * - @c "edge,right" - This is called when the genlist is scrolled
18119     *   until the right edge.
18120     * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
18121     *   swiped left.
18122     * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
18123     *   swiped right.
18124     * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
18125     *   swiped up.
18126     * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
18127     *   swiped down.
18128     * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
18129     *   pinched out.  "- @c multi,pinch,in" - This is called when the genlist is
18130     *   multi-touch pinched in.
18131     * - @c "swipe" - This is called when the genlist is swiped.
18132     * - @c "moved" - This is called when a genlist item is moved.
18133     * - @c "language,changed" - This is called when the program's language is
18134     *   changed.
18135     *
18136     * @section Genlist_Examples Examples
18137     *
18138     * Here is a list of examples that use the genlist, trying to show some of
18139     * its capabilities:
18140     * - @ref genlist_example_01
18141     * - @ref genlist_example_02
18142     * - @ref genlist_example_03
18143     * - @ref genlist_example_04
18144     * - @ref genlist_example_05
18145     */
18146
18147    /**
18148     * @addtogroup Genlist
18149     * @{
18150     */
18151
18152    /**
18153     * @enum _Elm_Genlist_Item_Flags
18154     * @typedef Elm_Genlist_Item_Flags
18155     *
18156     * Defines if the item is of any special type (has subitems or it's the
18157     * index of a group), or is just a simple item.
18158     *
18159     * @ingroup Genlist
18160     */
18161    typedef enum _Elm_Genlist_Item_Flags
18162      {
18163         ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
18164         ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
18165         ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
18166      } Elm_Genlist_Item_Flags;
18167    typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;  /**< Genlist item class definition structs */
18168    #define Elm_Genlist_Item_Class Elm_Gen_Item_Class
18169    typedef struct _Elm_Genlist_Item       Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18170    #define Elm_Genlist_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18171    typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
18172    typedef char        *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
18173    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. */
18174    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. */
18175    typedef void         (*Elm_Genlist_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
18176
18177    /**
18178     * @struct _Elm_Genlist_Item_Class
18179     *
18180     * Genlist item class definition structs.
18181     *
18182     * This struct contains the style and fetching functions that will define the
18183     * contents of each item.
18184     *
18185     * @see @ref Genlist_Item_Class
18186     */
18187    struct _Elm_Genlist_Item_Class
18188      {
18189         const char                *item_style; /**< style of this class. */
18190         struct Elm_Genlist_Item_Class_Func
18191           {
18192              Elm_Genlist_Item_Label_Get_Cb  label_get; /**< Label fetching class function for genlist item classes.*/
18193              Elm_Genlist_Item_Icon_Get_Cb   icon_get; /**< Icon fetching class function for genlist item classes. */
18194              Elm_Genlist_Item_State_Get_Cb  state_get; /**< State fetching class function for genlist item classes. */
18195              Elm_Genlist_Item_Del_Cb        del; /**< Deletion class function for genlist item classes. */
18196           } func;
18197      };
18198    #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
18199    /**
18200     * Add a new genlist widget to the given parent Elementary
18201     * (container) object
18202     *
18203     * @param parent The parent object
18204     * @return a new genlist widget handle or @c NULL, on errors
18205     *
18206     * This function inserts a new genlist widget on the canvas.
18207     *
18208     * @see elm_genlist_item_append()
18209     * @see elm_genlist_item_del()
18210     * @see elm_genlist_clear()
18211     *
18212     * @ingroup Genlist
18213     */
18214    EAPI Evas_Object      *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18215    /**
18216     * Remove all items from a given genlist widget.
18217     *
18218     * @param obj The genlist object
18219     *
18220     * This removes (and deletes) all items in @p obj, leaving it empty.
18221     *
18222     * @see elm_genlist_item_del(), to remove just one item.
18223     *
18224     * @ingroup Genlist
18225     */
18226    EINA_DEPRECATED EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18227    /**
18228     * Enable or disable multi-selection in the genlist
18229     *
18230     * @param obj The genlist object
18231     * @param multi Multi-select enable/disable. Default is disabled.
18232     *
18233     * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
18234     * the list. This allows more than 1 item to be selected. To retrieve the list
18235     * of selected items, use elm_genlist_selected_items_get().
18236     *
18237     * @see elm_genlist_selected_items_get()
18238     * @see elm_genlist_multi_select_get()
18239     *
18240     * @ingroup Genlist
18241     */
18242    EAPI void              elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
18243    /**
18244     * Gets if multi-selection in genlist is enabled or disabled.
18245     *
18246     * @param obj The genlist object
18247     * @return Multi-select enabled/disabled
18248     * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
18249     *
18250     * @see elm_genlist_multi_select_set()
18251     *
18252     * @ingroup Genlist
18253     */
18254    EAPI Eina_Bool         elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18255    /**
18256     * This sets the horizontal stretching mode.
18257     *
18258     * @param obj The genlist object
18259     * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
18260     *
18261     * This sets the mode used for sizing items horizontally. Valid modes
18262     * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
18263     * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
18264     * the scroller will scroll horizontally. Otherwise items are expanded
18265     * to fill the width of the viewport of the scroller. If it is
18266     * ELM_LIST_LIMIT, items will be expanded to the viewport width and
18267     * limited to that size.
18268     *
18269     * @see elm_genlist_horizontal_get()
18270     *
18271     * @ingroup Genlist
18272     */
18273    EAPI void              elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18274    EINA_DEPRECATED EAPI void              elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18275    /**
18276     * Gets the horizontal stretching mode.
18277     *
18278     * @param obj The genlist object
18279     * @return The mode to use
18280     * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
18281     *
18282     * @see elm_genlist_horizontal_set()
18283     *
18284     * @ingroup Genlist
18285     */
18286    EAPI Elm_List_Mode     elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18287    EINA_DEPRECATED EAPI Elm_List_Mode     elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18288    /**
18289     * Set the always select mode.
18290     *
18291     * @param obj The genlist object
18292     * @param always_select The always select mode (@c EINA_TRUE = on, @c
18293     * EINA_FALSE = off). Default is @c EINA_FALSE.
18294     *
18295     * Items will only call their selection func and callback when first
18296     * becoming selected. Any further clicks will do nothing, unless you
18297     * enable always select with elm_genlist_always_select_mode_set().
18298     * This means that, even if selected, every click will make the selected
18299     * callbacks be called.
18300     *
18301     * @see elm_genlist_always_select_mode_get()
18302     *
18303     * @ingroup Genlist
18304     */
18305    EINA_DEPRECATED EAPI void              elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18306    /**
18307     * Get the always select mode.
18308     *
18309     * @param obj The genlist object
18310     * @return The always select mode
18311     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18312     *
18313     * @see elm_genlist_always_select_mode_set()
18314     *
18315     * @ingroup Genlist
18316     */
18317    EINA_DEPRECATED EAPI Eina_Bool         elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18318    /**
18319     * Enable/disable the no select mode.
18320     *
18321     * @param obj The genlist object
18322     * @param no_select The no select mode
18323     * (EINA_TRUE = on, EINA_FALSE = off)
18324     *
18325     * This will turn off the ability to select items entirely and they
18326     * will neither appear selected nor call selected callback functions.
18327     *
18328     * @see elm_genlist_no_select_mode_get()
18329     *
18330     * @ingroup Genlist
18331     */
18332    EINA_DEPRECATED EAPI void              elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18333    /**
18334     * Gets whether the no select mode is enabled.
18335     *
18336     * @param obj The genlist object
18337     * @return The no select mode
18338     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18339     *
18340     * @see elm_genlist_no_select_mode_set()
18341     *
18342     * @ingroup Genlist
18343     */
18344    EINA_DEPRECATED EAPI Eina_Bool         elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18345    /**
18346     * Enable/disable compress mode.
18347     *
18348     * @param obj The genlist object
18349     * @param compress The compress mode
18350     * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18351     *
18352     * This will enable the compress mode where items are "compressed"
18353     * horizontally to fit the genlist scrollable viewport width. This is
18354     * special for genlist.  Do not rely on
18355     * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18356     * work as genlist needs to handle it specially.
18357     *
18358     * @see elm_genlist_compress_mode_get()
18359     *
18360     * @ingroup Genlist
18361     */
18362    EAPI void              elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18363    /**
18364     * Get whether the compress mode is enabled.
18365     *
18366     * @param obj The genlist object
18367     * @return The compress mode
18368     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18369     *
18370     * @see elm_genlist_compress_mode_set()
18371     *
18372     * @ingroup Genlist
18373     */
18374    EAPI Eina_Bool         elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18375    /**
18376     * Enable/disable height-for-width mode.
18377     *
18378     * @param obj The genlist object
18379     * @param setting The height-for-width mode (@c EINA_TRUE = on,
18380     * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18381     *
18382     * With height-for-width mode the item width will be fixed (restricted
18383     * to a minimum of) to the list width when calculating its size in
18384     * order to allow the height to be calculated based on it. This allows,
18385     * for instance, text block to wrap lines if the Edje part is
18386     * configured with "text.min: 0 1".
18387     *
18388     * @note This mode will make list resize slower as it will have to
18389     *       recalculate every item height again whenever the list width
18390     *       changes!
18391     *
18392     * @note When height-for-width mode is enabled, it also enables
18393     *       compress mode (see elm_genlist_compress_mode_set()) and
18394     *       disables homogeneous (see elm_genlist_homogeneous_set()).
18395     *
18396     * @ingroup Genlist
18397     */
18398    EAPI void              elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18399    /**
18400     * Get whether the height-for-width mode is enabled.
18401     *
18402     * @param obj The genlist object
18403     * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18404     * off)
18405     *
18406     * @ingroup Genlist
18407     */
18408    EAPI Eina_Bool         elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18409    /**
18410     * Enable/disable horizontal and vertical bouncing effect.
18411     *
18412     * @param obj The genlist object
18413     * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18414     * EINA_FALSE = off). Default is @c EINA_FALSE.
18415     * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18416     * EINA_FALSE = off). Default is @c EINA_TRUE.
18417     *
18418     * This will enable or disable the scroller bouncing effect for the
18419     * genlist. See elm_scroller_bounce_set() for details.
18420     *
18421     * @see elm_scroller_bounce_set()
18422     * @see elm_genlist_bounce_get()
18423     *
18424     * @ingroup Genlist
18425     */
18426    EINA_DEPRECATED EAPI void              elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18427    /**
18428     * Get whether the horizontal and vertical bouncing effect is enabled.
18429     *
18430     * @param obj The genlist object
18431     * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18432     * option is set.
18433     * @param v_bounce Pointer to a bool to receive if the bounce vertically
18434     * option is set.
18435     *
18436     * @see elm_genlist_bounce_set()
18437     *
18438     * @ingroup Genlist
18439     */
18440    EINA_DEPRECATED EAPI void              elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18441    /**
18442     * Enable/disable homogenous mode.
18443     *
18444     * @param obj The genlist object
18445     * @param homogeneous Assume the items within the genlist are of the
18446     * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18447     * EINA_FALSE.
18448     *
18449     * This will enable the homogeneous mode where items are of the same
18450     * height and width so that genlist may do the lazy-loading at its
18451     * maximum (which increases the performance for scrolling the list). This
18452     * implies 'compressed' mode.
18453     *
18454     * @see elm_genlist_compress_mode_set()
18455     * @see elm_genlist_homogeneous_get()
18456     *
18457     * @ingroup Genlist
18458     */
18459    EAPI void              elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18460    /**
18461     * Get whether the homogenous mode is enabled.
18462     *
18463     * @param obj The genlist object
18464     * @return Assume the items within the genlist are of the same height
18465     * and width (EINA_TRUE = on, EINA_FALSE = off)
18466     *
18467     * @see elm_genlist_homogeneous_set()
18468     *
18469     * @ingroup Genlist
18470     */
18471    EAPI Eina_Bool         elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18472    /**
18473     * Set the maximum number of items within an item block
18474     *
18475     * @param obj The genlist object
18476     * @param n   Maximum number of items within an item block. Default is 32.
18477     *
18478     * This will configure the block count to tune to the target with
18479     * particular performance matrix.
18480     *
18481     * A block of objects will be used to reduce the number of operations due to
18482     * many objects in the screen. It can determine the visibility, or if the
18483     * object has changed, it theme needs to be updated, etc. doing this kind of
18484     * calculation to the entire block, instead of per object.
18485     *
18486     * The default value for the block count is enough for most lists, so unless
18487     * you know you will have a lot of objects visible in the screen at the same
18488     * time, don't try to change this.
18489     *
18490     * @see elm_genlist_block_count_get()
18491     * @see @ref Genlist_Implementation
18492     *
18493     * @ingroup Genlist
18494     */
18495    EAPI void              elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18496    /**
18497     * Get the maximum number of items within an item block
18498     *
18499     * @param obj The genlist object
18500     * @return Maximum number of items within an item block
18501     *
18502     * @see elm_genlist_block_count_set()
18503     *
18504     * @ingroup Genlist
18505     */
18506    EAPI int               elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18507    /**
18508     * Set the timeout in seconds for the longpress event.
18509     *
18510     * @param obj The genlist object
18511     * @param timeout timeout in seconds. Default is 1.
18512     *
18513     * This option will change how long it takes to send an event "longpressed"
18514     * after the mouse down signal is sent to the list. If this event occurs, no
18515     * "clicked" event will be sent.
18516     *
18517     * @see elm_genlist_longpress_timeout_set()
18518     *
18519     * @ingroup Genlist
18520     */
18521    EAPI void              elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18522    /**
18523     * Get the timeout in seconds for the longpress event.
18524     *
18525     * @param obj The genlist object
18526     * @return timeout in seconds
18527     *
18528     * @see elm_genlist_longpress_timeout_get()
18529     *
18530     * @ingroup Genlist
18531     */
18532    EAPI double            elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18533    /**
18534     * Append a new item in a given genlist widget.
18535     *
18536     * @param obj The genlist object
18537     * @param itc The item class for the item
18538     * @param data The item data
18539     * @param parent The parent item, or NULL if none
18540     * @param flags Item flags
18541     * @param func Convenience function called when the item is selected
18542     * @param func_data Data passed to @p func above.
18543     * @return A handle to the item added or @c NULL if not possible
18544     *
18545     * This adds the given item to the end of the list or the end of
18546     * the children list if the @p parent is given.
18547     *
18548     * @see elm_genlist_item_prepend()
18549     * @see elm_genlist_item_insert_before()
18550     * @see elm_genlist_item_insert_after()
18551     * @see elm_genlist_item_del()
18552     *
18553     * @ingroup Genlist
18554     */
18555    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);
18556    /**
18557     * Prepend a new item in a given genlist widget.
18558     *
18559     * @param obj The genlist object
18560     * @param itc The item class for the item
18561     * @param data The item data
18562     * @param parent The parent item, or NULL if none
18563     * @param flags Item flags
18564     * @param func Convenience function called when the item is selected
18565     * @param func_data Data passed to @p func above.
18566     * @return A handle to the item added or NULL if not possible
18567     *
18568     * This adds an item to the beginning of the list or beginning of the
18569     * children of the parent if given.
18570     *
18571     * @see elm_genlist_item_append()
18572     * @see elm_genlist_item_insert_before()
18573     * @see elm_genlist_item_insert_after()
18574     * @see elm_genlist_item_del()
18575     *
18576     * @ingroup Genlist
18577     */
18578    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);
18579    /**
18580     * Insert an item before another in a genlist widget
18581     *
18582     * @param obj The genlist object
18583     * @param itc The item class for the item
18584     * @param data The item data
18585     * @param before The item to place this new one before.
18586     * @param flags Item flags
18587     * @param func Convenience function called when the item is selected
18588     * @param func_data Data passed to @p func above.
18589     * @return A handle to the item added or @c NULL if not possible
18590     *
18591     * This inserts an item before another in the list. It will be in the
18592     * same tree level or group as the item it is inserted before.
18593     *
18594     * @see elm_genlist_item_append()
18595     * @see elm_genlist_item_prepend()
18596     * @see elm_genlist_item_insert_after()
18597     * @see elm_genlist_item_del()
18598     *
18599     * @ingroup Genlist
18600     */
18601    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);
18602    /**
18603     * Insert an item after another in a genlist widget
18604     *
18605     * @param obj The genlist object
18606     * @param itc The item class for the item
18607     * @param data The item data
18608     * @param after The item to place this new one after.
18609     * @param flags Item flags
18610     * @param func Convenience function called when the item is selected
18611     * @param func_data Data passed to @p func above.
18612     * @return A handle to the item added or @c NULL if not possible
18613     *
18614     * This inserts an item after another in the list. It will be in the
18615     * same tree level or group as the item it is inserted after.
18616     *
18617     * @see elm_genlist_item_append()
18618     * @see elm_genlist_item_prepend()
18619     * @see elm_genlist_item_insert_before()
18620     * @see elm_genlist_item_del()
18621     *
18622     * @ingroup Genlist
18623     */
18624    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);
18625    /**
18626     * Insert a new item into the sorted genlist object
18627     *
18628     * @param obj The genlist object
18629     * @param itc The item class for the item
18630     * @param data The item data
18631     * @param parent The parent item, or NULL if none
18632     * @param flags Item flags
18633     * @param comp The function called for the sort
18634     * @param func Convenience function called when item selected
18635     * @param func_data Data passed to @p func above.
18636     * @return A handle to the item added or NULL if not possible
18637     *
18638     * @ingroup Genlist
18639     */
18640    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);
18641    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);
18642    /* operations to retrieve existing items */
18643    /**
18644     * Get the selectd item in the genlist.
18645     *
18646     * @param obj The genlist object
18647     * @return The selected item, or NULL if none is selected.
18648     *
18649     * This gets the selected item in the list (if multi-selection is enabled, only
18650     * the item that was first selected in the list is returned - which is not very
18651     * useful, so see elm_genlist_selected_items_get() for when multi-selection is
18652     * used).
18653     *
18654     * If no item is selected, NULL is returned.
18655     *
18656     * @see elm_genlist_selected_items_get()
18657     *
18658     * @ingroup Genlist
18659     */
18660    EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18661    /**
18662     * Get a list of selected items in the genlist.
18663     *
18664     * @param obj The genlist object
18665     * @return The list of selected items, or NULL if none are selected.
18666     *
18667     * It returns a list of the selected items. This list pointer is only valid so
18668     * long as the selection doesn't change (no items are selected or unselected, or
18669     * unselected implicitly by deletion). The list contains Elm_Genlist_Item
18670     * pointers. The order of the items in this list is the order which they were
18671     * selected, i.e. the first item in this list is the first item that was
18672     * selected, and so on.
18673     *
18674     * @note If not in multi-select mode, consider using function
18675     * elm_genlist_selected_item_get() instead.
18676     *
18677     * @see elm_genlist_multi_select_set()
18678     * @see elm_genlist_selected_item_get()
18679     *
18680     * @ingroup Genlist
18681     */
18682    EAPI const Eina_List  *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18683    /**
18684     * Get the mode item style of items in the genlist
18685     * @param obj The genlist object
18686     * @return The mode item style string, or NULL if none is specified
18687     * 
18688     * This is a constant string and simply defines the name of the
18689     * style that will be used for mode animations. It can be
18690     * @c NULL if you don't plan to use Genlist mode. See
18691     * elm_genlist_item_mode_set() for more info.
18692     * 
18693     * @ingroup Genlist
18694     */
18695    EAPI const char       *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18696    /**
18697     * Set the mode item style of items in the genlist
18698     * @param obj The genlist object
18699     * @param style The mode item style string, or NULL if none is desired
18700     * 
18701     * This is a constant string and simply defines the name of the
18702     * style that will be used for mode animations. It can be
18703     * @c NULL if you don't plan to use Genlist mode. See
18704     * elm_genlist_item_mode_set() for more info.
18705     * 
18706     * @ingroup Genlist
18707     */
18708    EAPI void              elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
18709    /**
18710     * Get a list of realized items in genlist
18711     *
18712     * @param obj The genlist object
18713     * @return The list of realized items, nor NULL if none are realized.
18714     *
18715     * This returns a list of the realized items in the genlist. The list
18716     * contains Elm_Genlist_Item pointers. The list must be freed by the
18717     * caller when done with eina_list_free(). The item pointers in the
18718     * list are only valid so long as those items are not deleted or the
18719     * genlist is not deleted.
18720     *
18721     * @see elm_genlist_realized_items_update()
18722     *
18723     * @ingroup Genlist
18724     */
18725    EAPI Eina_List        *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18726    /**
18727     * Get the item that is at the x, y canvas coords.
18728     *
18729     * @param obj The gelinst object.
18730     * @param x The input x coordinate
18731     * @param y The input y coordinate
18732     * @param posret The position relative to the item returned here
18733     * @return The item at the coordinates or NULL if none
18734     *
18735     * This returns the item at the given coordinates (which are canvas
18736     * relative, not object-relative). If an item is at that coordinate,
18737     * that item handle is returned, and if @p posret is not NULL, the
18738     * integer pointed to is set to a value of -1, 0 or 1, depending if
18739     * the coordinate is on the upper portion of that item (-1), on the
18740     * middle section (0) or on the lower part (1). If NULL is returned as
18741     * an item (no item found there), then posret may indicate -1 or 1
18742     * based if the coordinate is above or below all items respectively in
18743     * the genlist.
18744     *
18745     * @ingroup Genlist
18746     */
18747    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);
18748    /**
18749     * Get the first item in the genlist
18750     *
18751     * This returns the first item in the list.
18752     *
18753     * @param obj The genlist object
18754     * @return The first item, or NULL if none
18755     *
18756     * @ingroup Genlist
18757     */
18758    EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18759    /**
18760     * Get the last item in the genlist
18761     *
18762     * This returns the last item in the list.
18763     *
18764     * @return The last item, or NULL if none
18765     *
18766     * @ingroup Genlist
18767     */
18768    EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18769    /**
18770     * Set the scrollbar policy
18771     *
18772     * @param obj The genlist object
18773     * @param policy_h Horizontal scrollbar policy.
18774     * @param policy_v Vertical scrollbar policy.
18775     *
18776     * This sets the scrollbar visibility policy for the given genlist
18777     * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
18778     * made visible if it is needed, and otherwise kept hidden.
18779     * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
18780     * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
18781     * respectively for the horizontal and vertical scrollbars. Default is
18782     * #ELM_SMART_SCROLLER_POLICY_AUTO
18783     *
18784     * @see elm_genlist_scroller_policy_get()
18785     *
18786     * @ingroup Genlist
18787     */
18788    EAPI void              elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
18789    /**
18790     * Get the scrollbar policy
18791     *
18792     * @param obj The genlist object
18793     * @param policy_h Pointer to store the horizontal scrollbar policy.
18794     * @param policy_v Pointer to store the vertical scrollbar policy.
18795     *
18796     * @see elm_genlist_scroller_policy_set()
18797     *
18798     * @ingroup Genlist
18799     */
18800    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);
18801    /**
18802     * Get the @b next item in a genlist widget's internal list of items,
18803     * given a handle to one of those items.
18804     *
18805     * @param item The genlist item to fetch next from
18806     * @return The item after @p item, or @c NULL if there's none (and
18807     * on errors)
18808     *
18809     * This returns the item placed after the @p item, on the container
18810     * genlist.
18811     *
18812     * @see elm_genlist_item_prev_get()
18813     *
18814     * @ingroup Genlist
18815     */
18816    EINA_DEPRECATED EAPI Elm_Genlist_Item  *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18817    /**
18818     * Get the @b previous item in a genlist widget's internal list of items,
18819     * given a handle to one of those items.
18820     *
18821     * @param item The genlist item to fetch previous from
18822     * @return The item before @p item, or @c NULL if there's none (and
18823     * on errors)
18824     *
18825     * This returns the item placed before the @p item, on the container
18826     * genlist.
18827     *
18828     * @see elm_genlist_item_next_get()
18829     *
18830     * @ingroup Genlist
18831     */
18832    EINA_DEPRECATED EAPI Elm_Genlist_Item  *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18833    /**
18834     * Get the genlist object's handle which contains a given genlist
18835     * item
18836     *
18837     * @param item The item to fetch the container from
18838     * @return The genlist (parent) object
18839     *
18840     * This returns the genlist object itself that an item belongs to.
18841     *
18842     * @ingroup Genlist
18843     */
18844    EINA_DEPRECATED EAPI Evas_Object       *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18845    /**
18846     * Get the parent item of the given item
18847     *
18848     * @param it The item
18849     * @return The parent of the item or @c NULL if it has no parent.
18850     *
18851     * This returns the item that was specified as parent of the item @p it on
18852     * elm_genlist_item_append() and insertion related functions.
18853     *
18854     * @ingroup Genlist
18855     */
18856    EAPI Elm_Genlist_Item  *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18857    /**
18858     * Remove all sub-items (children) of the given item
18859     *
18860     * @param it The item
18861     *
18862     * This removes all items that are children (and their descendants) of the
18863     * given item @p it.
18864     *
18865     * @see elm_genlist_clear()
18866     * @see elm_genlist_item_del()
18867     *
18868     * @ingroup Genlist
18869     */
18870    EAPI void               elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18871    /**
18872     * Set whether a given genlist item is selected or not
18873     *
18874     * @param it The item
18875     * @param selected Use @c EINA_TRUE, to make it selected, @c
18876     * EINA_FALSE to make it unselected
18877     *
18878     * This sets the selected state of an item. If multi selection is
18879     * not enabled on the containing genlist and @p selected is @c
18880     * EINA_TRUE, any other previously selected items will get
18881     * unselected in favor of this new one.
18882     *
18883     * @see elm_genlist_item_selected_get()
18884     *
18885     * @ingroup Genlist
18886     */
18887    EINA_DEPRECATED EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
18888    /**
18889     * Get whether a given genlist item is selected or not
18890     *
18891     * @param it The item
18892     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
18893     *
18894     * @see elm_genlist_item_selected_set() for more details
18895     *
18896     * @ingroup Genlist
18897     */
18898    EINA_DEPRECATED EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18899    /**
18900     * Sets the expanded state of an item.
18901     *
18902     * @param it The item
18903     * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
18904     *
18905     * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
18906     * expanded or not.
18907     *
18908     * The theme will respond to this change visually, and a signal "expanded" or
18909     * "contracted" will be sent from the genlist with a pointer to the item that
18910     * has been expanded/contracted.
18911     *
18912     * Calling this function won't show or hide any child of this item (if it is
18913     * a parent). You must manually delete and create them on the callbacks fo
18914     * the "expanded" or "contracted" signals.
18915     *
18916     * @see elm_genlist_item_expanded_get()
18917     *
18918     * @ingroup Genlist
18919     */
18920    EAPI void               elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
18921    /**
18922     * Get the expanded state of an item
18923     *
18924     * @param it The item
18925     * @return The expanded state
18926     *
18927     * This gets the expanded state of an item.
18928     *
18929     * @see elm_genlist_item_expanded_set()
18930     *
18931     * @ingroup Genlist
18932     */
18933    EAPI Eina_Bool          elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18934    /**
18935     * Get the depth of expanded item
18936     *
18937     * @param it The genlist item object
18938     * @return The depth of expanded item
18939     *
18940     * @ingroup Genlist
18941     */
18942    EAPI int                elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18943    /**
18944     * Set whether a given genlist item is disabled or not.
18945     *
18946     * @param it The item
18947     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
18948     * to enable it back.
18949     *
18950     * A disabled item cannot be selected or unselected. It will also
18951     * change its appearance, to signal the user it's disabled.
18952     *
18953     * @see elm_genlist_item_disabled_get()
18954     *
18955     * @ingroup Genlist
18956     */
18957    EAPI void               elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
18958    /**
18959     * Get whether a given genlist item is disabled or not.
18960     *
18961     * @param it The item
18962     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
18963     * (and on errors).
18964     *
18965     * @see elm_genlist_item_disabled_set() for more details
18966     *
18967     * @ingroup Genlist
18968     */
18969    EAPI Eina_Bool          elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18970    /**
18971     * Sets the display only state of an item.
18972     *
18973     * @param it The item
18974     * @param display_only @c EINA_TRUE if the item is display only, @c
18975     * EINA_FALSE otherwise.
18976     *
18977     * A display only item cannot be selected or unselected. It is for
18978     * display only and not selecting or otherwise clicking, dragging
18979     * etc. by the user, thus finger size rules will not be applied to
18980     * this item.
18981     *
18982     * It's good to set group index items to display only state.
18983     *
18984     * @see elm_genlist_item_display_only_get()
18985     *
18986     * @ingroup Genlist
18987     */
18988    EAPI void               elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
18989    /**
18990     * Get the display only state of an item
18991     *
18992     * @param it The item
18993     * @return @c EINA_TRUE if the item is display only, @c
18994     * EINA_FALSE otherwise.
18995     *
18996     * @see elm_genlist_item_display_only_set()
18997     *
18998     * @ingroup Genlist
18999     */
19000    EAPI Eina_Bool          elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19001    /**
19002     * Show the portion of a genlist's internal list containing a given
19003     * item, immediately.
19004     *
19005     * @param it The item to display
19006     *
19007     * This causes genlist to jump to the given item @p it and show it (by
19008     * immediately scrolling to that position), if it is not fully visible.
19009     *
19010     * @see elm_genlist_item_bring_in()
19011     * @see elm_genlist_item_top_show()
19012     * @see elm_genlist_item_middle_show()
19013     *
19014     * @ingroup Genlist
19015     */
19016    EAPI void               elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19017    /**
19018     * Animatedly bring in, to the visible are of a genlist, a given
19019     * item on it.
19020     *
19021     * @param it The item to display
19022     *
19023     * This causes genlist to jump to the given item @p it and show it (by
19024     * animatedly scrolling), if it is not fully visible. This may use animation
19025     * to do so and take a period of time
19026     *
19027     * @see elm_genlist_item_show()
19028     * @see elm_genlist_item_top_bring_in()
19029     * @see elm_genlist_item_middle_bring_in()
19030     *
19031     * @ingroup Genlist
19032     */
19033    EAPI void               elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19034    /**
19035     * Show the portion of a genlist's internal list containing a given
19036     * item, immediately.
19037     *
19038     * @param it The item to display
19039     *
19040     * This causes genlist to jump to the given item @p it and show it (by
19041     * immediately scrolling to that position), if it is not fully visible.
19042     *
19043     * The item will be positioned at the top of the genlist viewport.
19044     *
19045     * @see elm_genlist_item_show()
19046     * @see elm_genlist_item_top_bring_in()
19047     *
19048     * @ingroup Genlist
19049     */
19050    EAPI void               elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19051    /**
19052     * Animatedly bring in, to the visible are of a genlist, a given
19053     * item on it.
19054     *
19055     * @param it The item
19056     *
19057     * This causes genlist to jump to the given item @p it and show it (by
19058     * animatedly scrolling), if it is not fully visible. This may use animation
19059     * to do so and take a period of time
19060     *
19061     * The item will be positioned at the top of the genlist viewport.
19062     *
19063     * @see elm_genlist_item_bring_in()
19064     * @see elm_genlist_item_top_show()
19065     *
19066     * @ingroup Genlist
19067     */
19068    EAPI void               elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19069    /**
19070     * Show the portion of a genlist's internal list containing a given
19071     * item, immediately.
19072     *
19073     * @param it The item to display
19074     *
19075     * This causes genlist to jump to the given item @p it and show it (by
19076     * immediately scrolling to that position), if it is not fully visible.
19077     *
19078     * The item will be positioned at the middle of the genlist viewport.
19079     *
19080     * @see elm_genlist_item_show()
19081     * @see elm_genlist_item_middle_bring_in()
19082     *
19083     * @ingroup Genlist
19084     */
19085    EAPI void               elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19086    /**
19087     * Animatedly bring in, to the visible are of a genlist, a given
19088     * item on it.
19089     *
19090     * @param it The item
19091     *
19092     * This causes genlist to jump to the given item @p it and show it (by
19093     * animatedly scrolling), if it is not fully visible. This may use animation
19094     * to do so and take a period of time
19095     *
19096     * The item will be positioned at the middle of the genlist viewport.
19097     *
19098     * @see elm_genlist_item_bring_in()
19099     * @see elm_genlist_item_middle_show()
19100     *
19101     * @ingroup Genlist
19102     */
19103    EAPI void               elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19104    /**
19105     * Remove a genlist item from the its parent, deleting it.
19106     *
19107     * @param item The item to be removed.
19108     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
19109     *
19110     * @see elm_genlist_clear(), to remove all items in a genlist at
19111     * once.
19112     *
19113     * @ingroup Genlist
19114     */
19115    EAPI void               elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19116    /**
19117     * Return the data associated to a given genlist item
19118     *
19119     * @param item The genlist item.
19120     * @return the data associated to this item.
19121     *
19122     * This returns the @c data value passed on the
19123     * elm_genlist_item_append() and related item addition calls.
19124     *
19125     * @see elm_genlist_item_append()
19126     * @see elm_genlist_item_data_set()
19127     *
19128     * @ingroup Genlist
19129     */
19130    EAPI void              *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19131    /**
19132     * Set the data associated to a given genlist item
19133     *
19134     * @param item The genlist item
19135     * @param data The new data pointer to set on it
19136     *
19137     * This @b overrides the @c data value passed on the
19138     * elm_genlist_item_append() and related item addition calls. This
19139     * function @b won't call elm_genlist_item_update() automatically,
19140     * so you'd issue it afterwards if you want to hove the item
19141     * updated to reflect the that new data.
19142     *
19143     * @see elm_genlist_item_data_get()
19144     *
19145     * @ingroup Genlist
19146     */
19147    EAPI void               elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
19148    /**
19149     * Tells genlist to "orphan" icons fetchs by the item class
19150     *
19151     * @param it The item
19152     *
19153     * This instructs genlist to release references to icons in the item,
19154     * meaning that they will no longer be managed by genlist and are
19155     * floating "orphans" that can be re-used elsewhere if the user wants
19156     * to.
19157     *
19158     * @ingroup Genlist
19159     */
19160    EAPI void               elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19161    /**
19162     * Get the real Evas object created to implement the view of a
19163     * given genlist item
19164     *
19165     * @param item The genlist item.
19166     * @return the Evas object implementing this item's view.
19167     *
19168     * This returns the actual Evas object used to implement the
19169     * specified genlist item's view. This may be @c NULL, as it may
19170     * not have been created or may have been deleted, at any time, by
19171     * the genlist. <b>Do not modify this object</b> (move, resize,
19172     * show, hide, etc.), as the genlist is controlling it. This
19173     * function is for querying, emitting custom signals or hooking
19174     * lower level callbacks for events on that object. Do not delete
19175     * this object under any circumstances.
19176     *
19177     * @see elm_genlist_item_data_get()
19178     *
19179     * @ingroup Genlist
19180     */
19181    EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19182    /**
19183     * Update the contents of an item
19184     *
19185     * @param it The item
19186     *
19187     * This updates an item by calling all the item class functions again
19188     * to get the icons, labels and states. Use this when the original
19189     * item data has changed and the changes are desired to be reflected.
19190     *
19191     * Use elm_genlist_realized_items_update() to update all already realized
19192     * items.
19193     *
19194     * @see elm_genlist_realized_items_update()
19195     *
19196     * @ingroup Genlist
19197     */
19198    EAPI void               elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19199    /**
19200     * Update the item class of an item
19201     *
19202     * @param it The item
19203     * @param itc The item class for the item
19204     *
19205     * This sets another class fo the item, changing the way that it is
19206     * displayed. After changing the item class, elm_genlist_item_update() is
19207     * called on the item @p it.
19208     *
19209     * @ingroup Genlist
19210     */
19211    EAPI void               elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
19212    EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19213    /**
19214     * Set the text to be shown in a given genlist item's tooltips.
19215     *
19216     * @param item The genlist item
19217     * @param text The text to set in the content
19218     *
19219     * This call will setup the text to be used as tooltip to that item
19220     * (analogous to elm_object_tooltip_text_set(), but being item
19221     * tooltips with higher precedence than object tooltips). It can
19222     * have only one tooltip at a time, so any previous tooltip data
19223     * will get removed.
19224     *
19225     * In order to set an icon or something else as a tooltip, look at
19226     * elm_genlist_item_tooltip_content_cb_set().
19227     *
19228     * @ingroup Genlist
19229     */
19230    EAPI void               elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
19231    /**
19232     * Set the content to be shown in a given genlist item's tooltips
19233     *
19234     * @param item The genlist item.
19235     * @param func The function returning the tooltip contents.
19236     * @param data What to provide to @a func as callback data/context.
19237     * @param del_cb Called when data is not needed anymore, either when
19238     *        another callback replaces @p func, the tooltip is unset with
19239     *        elm_genlist_item_tooltip_unset() or the owner @p item
19240     *        dies. This callback receives as its first parameter the
19241     *        given @p data, being @c event_info the item handle.
19242     *
19243     * This call will setup the tooltip's contents to @p item
19244     * (analogous to elm_object_tooltip_content_cb_set(), but being
19245     * item tooltips with higher precedence than object tooltips). It
19246     * can have only one tooltip at a time, so any previous tooltip
19247     * content will get removed. @p func (with @p data) will be called
19248     * every time Elementary needs to show the tooltip and it should
19249     * return a valid Evas object, which will be fully managed by the
19250     * tooltip system, getting deleted when the tooltip is gone.
19251     *
19252     * In order to set just a text as a tooltip, look at
19253     * elm_genlist_item_tooltip_text_set().
19254     *
19255     * @ingroup Genlist
19256     */
19257    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);
19258    /**
19259     * Unset a tooltip from a given genlist item
19260     *
19261     * @param item genlist item to remove a previously set tooltip from.
19262     *
19263     * This call removes any tooltip set on @p item. The callback
19264     * provided as @c del_cb to
19265     * elm_genlist_item_tooltip_content_cb_set() will be called to
19266     * notify it is not used anymore (and have resources cleaned, if
19267     * need be).
19268     *
19269     * @see elm_genlist_item_tooltip_content_cb_set()
19270     *
19271     * @ingroup Genlist
19272     */
19273    EAPI void               elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19274    /**
19275     * Set a different @b style for a given genlist item's tooltip.
19276     *
19277     * @param item genlist item with tooltip set
19278     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
19279     * "default", @c "transparent", etc)
19280     *
19281     * Tooltips can have <b>alternate styles</b> to be displayed on,
19282     * which are defined by the theme set on Elementary. This function
19283     * works analogously as elm_object_tooltip_style_set(), but here
19284     * applied only to genlist item objects. The default style for
19285     * tooltips is @c "default".
19286     *
19287     * @note before you set a style you should define a tooltip with
19288     *       elm_genlist_item_tooltip_content_cb_set() or
19289     *       elm_genlist_item_tooltip_text_set()
19290     *
19291     * @see elm_genlist_item_tooltip_style_get()
19292     *
19293     * @ingroup Genlist
19294     */
19295    EAPI void               elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19296    /**
19297     * Get the style set a given genlist item's tooltip.
19298     *
19299     * @param item genlist item with tooltip already set on.
19300     * @return style the theme style in use, which defaults to
19301     *         "default". If the object does not have a tooltip set,
19302     *         then @c NULL is returned.
19303     *
19304     * @see elm_genlist_item_tooltip_style_set() for more details
19305     *
19306     * @ingroup Genlist
19307     */
19308    EAPI const char        *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19309    /**
19310     * @brief Disable size restrictions on an object's tooltip
19311     * @param item The tooltip's anchor object
19312     * @param disable If EINA_TRUE, size restrictions are disabled
19313     * @return EINA_FALSE on failure, EINA_TRUE on success
19314     *
19315     * This function allows a tooltip to expand beyond its parant window's canvas.
19316     * It will instead be limited only by the size of the display.
19317     */
19318    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
19319    /**
19320     * @brief Retrieve size restriction state of an object's tooltip
19321     * @param item The tooltip's anchor object
19322     * @return If EINA_TRUE, size restrictions are disabled
19323     *
19324     * This function returns whether a tooltip is allowed to expand beyond
19325     * its parant window's canvas.
19326     * It will instead be limited only by the size of the display.
19327     */
19328    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
19329    /**
19330     * Set the type of mouse pointer/cursor decoration to be shown,
19331     * when the mouse pointer is over the given genlist widget item
19332     *
19333     * @param item genlist item to customize cursor on
19334     * @param cursor the cursor type's name
19335     *
19336     * This function works analogously as elm_object_cursor_set(), but
19337     * here the cursor's changing area is restricted to the item's
19338     * area, and not the whole widget's. Note that that item cursors
19339     * have precedence over widget cursors, so that a mouse over @p
19340     * item will always show cursor @p type.
19341     *
19342     * If this function is called twice for an object, a previously set
19343     * cursor will be unset on the second call.
19344     *
19345     * @see elm_object_cursor_set()
19346     * @see elm_genlist_item_cursor_get()
19347     * @see elm_genlist_item_cursor_unset()
19348     *
19349     * @ingroup Genlist
19350     */
19351    EAPI void               elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19352    /**
19353     * Get the type of mouse pointer/cursor decoration set to be shown,
19354     * when the mouse pointer is over the given genlist widget item
19355     *
19356     * @param item genlist item with custom cursor set
19357     * @return the cursor type's name or @c NULL, if no custom cursors
19358     * were set to @p item (and on errors)
19359     *
19360     * @see elm_object_cursor_get()
19361     * @see elm_genlist_item_cursor_set() for more details
19362     * @see elm_genlist_item_cursor_unset()
19363     *
19364     * @ingroup Genlist
19365     */
19366    EAPI const char        *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19367    /**
19368     * Unset any custom mouse pointer/cursor decoration set to be
19369     * shown, when the mouse pointer is over the given genlist widget
19370     * item, thus making it show the @b default cursor again.
19371     *
19372     * @param item a genlist item
19373     *
19374     * Use this call to undo any custom settings on this item's cursor
19375     * decoration, bringing it back to defaults (no custom style set).
19376     *
19377     * @see elm_object_cursor_unset()
19378     * @see elm_genlist_item_cursor_set() for more details
19379     *
19380     * @ingroup Genlist
19381     */
19382    EAPI void               elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19383    /**
19384     * Set a different @b style for a given custom cursor set for a
19385     * genlist item.
19386     *
19387     * @param item genlist item with custom cursor set
19388     * @param style the <b>theme style</b> to use (e.g. @c "default",
19389     * @c "transparent", etc)
19390     *
19391     * This function only makes sense when one is using custom mouse
19392     * cursor decorations <b>defined in a theme file</b> , which can
19393     * have, given a cursor name/type, <b>alternate styles</b> on
19394     * it. It works analogously as elm_object_cursor_style_set(), but
19395     * here applied only to genlist item objects.
19396     *
19397     * @warning Before you set a cursor style you should have defined a
19398     *       custom cursor previously on the item, with
19399     *       elm_genlist_item_cursor_set()
19400     *
19401     * @see elm_genlist_item_cursor_engine_only_set()
19402     * @see elm_genlist_item_cursor_style_get()
19403     *
19404     * @ingroup Genlist
19405     */
19406    EAPI void               elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19407    /**
19408     * Get the current @b style set for a given genlist item's custom
19409     * cursor
19410     *
19411     * @param item genlist item with custom cursor set.
19412     * @return style the cursor style in use. If the object does not
19413     *         have a cursor set, then @c NULL is returned.
19414     *
19415     * @see elm_genlist_item_cursor_style_set() for more details
19416     *
19417     * @ingroup Genlist
19418     */
19419    EAPI const char        *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19420    /**
19421     * Set if the (custom) cursor for a given genlist item should be
19422     * searched in its theme, also, or should only rely on the
19423     * rendering engine.
19424     *
19425     * @param item item with custom (custom) cursor already set on
19426     * @param engine_only Use @c EINA_TRUE to have cursors looked for
19427     * only on those provided by the rendering engine, @c EINA_FALSE to
19428     * have them searched on the widget's theme, as well.
19429     *
19430     * @note This call is of use only if you've set a custom cursor
19431     * for genlist items, with elm_genlist_item_cursor_set().
19432     *
19433     * @note By default, cursors will only be looked for between those
19434     * provided by the rendering engine.
19435     *
19436     * @ingroup Genlist
19437     */
19438    EAPI void               elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19439    /**
19440     * Get if the (custom) cursor for a given genlist item is being
19441     * searched in its theme, also, or is only relying on the rendering
19442     * engine.
19443     *
19444     * @param item a genlist item
19445     * @return @c EINA_TRUE, if cursors are being looked for only on
19446     * those provided by the rendering engine, @c EINA_FALSE if they
19447     * are being searched on the widget's theme, as well.
19448     *
19449     * @see elm_genlist_item_cursor_engine_only_set(), for more details
19450     *
19451     * @ingroup Genlist
19452     */
19453    EAPI Eina_Bool          elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19454    /**
19455     * Update the contents of all realized items.
19456     *
19457     * @param obj The genlist object.
19458     *
19459     * This updates all realized items by calling all the item class functions again
19460     * to get the icons, labels and states. Use this when the original
19461     * item data has changed and the changes are desired to be reflected.
19462     *
19463     * To update just one item, use elm_genlist_item_update().
19464     *
19465     * @see elm_genlist_realized_items_get()
19466     * @see elm_genlist_item_update()
19467     *
19468     * @ingroup Genlist
19469     */
19470    EAPI void               elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19471    /**
19472     * Activate a genlist mode on an item
19473     *
19474     * @param item The genlist item
19475     * @param mode Mode name
19476     * @param mode_set Boolean to define set or unset mode.
19477     *
19478     * A genlist mode is a different way of selecting an item. Once a mode is
19479     * activated on an item, any other selected item is immediately unselected.
19480     * This feature provides an easy way of implementing a new kind of animation
19481     * for selecting an item, without having to entirely rewrite the item style
19482     * theme. However, the elm_genlist_selected_* API can't be used to get what
19483     * item is activate for a mode.
19484     *
19485     * The current item style will still be used, but applying a genlist mode to
19486     * an item will select it using a different kind of animation.
19487     *
19488     * The current active item for a mode can be found by
19489     * elm_genlist_mode_item_get().
19490     *
19491     * The characteristics of genlist mode are:
19492     * - Only one mode can be active at any time, and for only one item.
19493     * - Genlist handles deactivating other items when one item is activated.
19494     * - A mode is defined in the genlist theme (edc), and more modes can easily
19495     *   be added.
19496     * - A mode style and the genlist item style are different things. They
19497     *   can be combined to provide a default style to the item, with some kind
19498     *   of animation for that item when the mode is activated.
19499     *
19500     * When a mode is activated on an item, a new view for that item is created.
19501     * The theme of this mode defines the animation that will be used to transit
19502     * the item from the old view to the new view. This second (new) view will be
19503     * active for that item while the mode is active on the item, and will be
19504     * destroyed after the mode is totally deactivated from that item.
19505     *
19506     * @see elm_genlist_mode_get()
19507     * @see elm_genlist_mode_item_get()
19508     *
19509     * @ingroup Genlist
19510     */
19511    EAPI void               elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19512    /**
19513     * Get the last (or current) genlist mode used.
19514     *
19515     * @param obj The genlist object
19516     *
19517     * This function just returns the name of the last used genlist mode. It will
19518     * be the current mode if it's still active.
19519     *
19520     * @see elm_genlist_item_mode_set()
19521     * @see elm_genlist_mode_item_get()
19522     *
19523     * @ingroup Genlist
19524     */
19525    EAPI const char        *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19526    /**
19527     * Get active genlist mode item
19528     *
19529     * @param obj The genlist object
19530     * @return The active item for that current mode. Or @c NULL if no item is
19531     * activated with any mode.
19532     *
19533     * This function returns the item that was activated with a mode, by the
19534     * function elm_genlist_item_mode_set().
19535     *
19536     * @see elm_genlist_item_mode_set()
19537     * @see elm_genlist_mode_get()
19538     *
19539     * @ingroup Genlist
19540     */
19541    EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19542
19543    /**
19544     * Set reorder mode
19545     *
19546     * @param obj The genlist object
19547     * @param reorder_mode The reorder mode
19548     * (EINA_TRUE = on, EINA_FALSE = off)
19549     *
19550     * @ingroup Genlist
19551     */
19552    EAPI void               elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
19553
19554    /**
19555     * Get the reorder mode
19556     *
19557     * @param obj The genlist object
19558     * @return The reorder mode
19559     * (EINA_TRUE = on, EINA_FALSE = off)
19560     *
19561     * @ingroup Genlist
19562     */
19563    EAPI Eina_Bool          elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19564
19565    /**
19566     * @}
19567     */
19568
19569    /**
19570     * @defgroup Check Check
19571     *
19572     * @image html img/widget/check/preview-00.png
19573     * @image latex img/widget/check/preview-00.eps
19574     * @image html img/widget/check/preview-01.png
19575     * @image latex img/widget/check/preview-01.eps
19576     * @image html img/widget/check/preview-02.png
19577     * @image latex img/widget/check/preview-02.eps
19578     *
19579     * @brief The check widget allows for toggling a value between true and
19580     * false.
19581     *
19582     * Check objects are a lot like radio objects in layout and functionality
19583     * except they do not work as a group, but independently and only toggle the
19584     * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
19585     * the boolean state (1 for true, 0 for false), and elm_check_state_get()
19586     * returns the current state. For convenience, like the radio objects, you
19587     * can set a pointer to a boolean directly with elm_check_state_pointer_set()
19588     * for it to modify.
19589     *
19590     * Signals that you can add callbacks for are:
19591     * "changed" - This is called whenever the user changes the state of one of
19592     *             the check object(event_info is NULL).
19593     *
19594     * @ref tutorial_check should give you a firm grasp of how to use this widget.
19595     * @{
19596     */
19597    /**
19598     * @brief Add a new Check object
19599     *
19600     * @param parent The parent object
19601     * @return The new object or NULL if it cannot be created
19602     */
19603    EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19604    /**
19605     * @brief Set the text label of the check object
19606     *
19607     * @param obj The check object
19608     * @param label The text label string in UTF-8
19609     *
19610     * @deprecated use elm_object_text_set() instead.
19611     */
19612    EINA_DEPRECATED EAPI void         elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19613    /**
19614     * @brief Get the text label of the check object
19615     *
19616     * @param obj The check object
19617     * @return The text label string in UTF-8
19618     *
19619     * @deprecated use elm_object_text_get() instead.
19620     */
19621    EINA_DEPRECATED EAPI const char  *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19622    /**
19623     * @brief Set the icon object of the check object
19624     *
19625     * @param obj The check object
19626     * @param icon The icon object
19627     *
19628     * Once the icon object is set, a previously set one will be deleted.
19629     * If you want to keep that old content object, use the
19630     * elm_check_icon_unset() function.
19631     */
19632    EAPI void         elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19633    /**
19634     * @brief Get the icon object of the check object
19635     *
19636     * @param obj The check object
19637     * @return The icon object
19638     */
19639    EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19640    /**
19641     * @brief Unset the icon used for the check object
19642     *
19643     * @param obj The check object
19644     * @return The icon object that was being used
19645     *
19646     * Unparent and return the icon object which was set for this widget.
19647     */
19648    EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19649    /**
19650     * @brief Set the on/off state of the check object
19651     *
19652     * @param obj The check object
19653     * @param state The state to use (1 == on, 0 == off)
19654     *
19655     * This sets the state of the check. If set
19656     * with elm_check_state_pointer_set() the state of that variable is also
19657     * changed. Calling this @b doesn't cause the "changed" signal to be emited.
19658     */
19659    EAPI void         elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19660    /**
19661     * @brief Get the state of the check object
19662     *
19663     * @param obj The check object
19664     * @return The boolean state
19665     */
19666    EAPI Eina_Bool    elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19667    /**
19668     * @brief Set a convenience pointer to a boolean to change
19669     *
19670     * @param obj The check object
19671     * @param statep Pointer to the boolean to modify
19672     *
19673     * This sets a pointer to a boolean, that, in addition to the check objects
19674     * state will also be modified directly. To stop setting the object pointed
19675     * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
19676     * then when this is called, the check objects state will also be modified to
19677     * reflect the value of the boolean @p statep points to, just like calling
19678     * elm_check_state_set().
19679     */
19680    EAPI void         elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
19681    EINA_DEPRECATED EAPI void         elm_check_states_labels_set(Evas_Object *obj, const char *ontext, const char *offtext) EINA_ARG_NONNULL(1,2,3);
19682    EINA_DEPRECATED EAPI void         elm_check_states_labels_get(const Evas_Object *obj, const char **ontext, const char **offtext) EINA_ARG_NONNULL(1,2,3);
19683
19684    /**
19685     * @}
19686     */
19687
19688    /**
19689     * @defgroup Radio Radio
19690     *
19691     * @image html img/widget/radio/preview-00.png
19692     * @image latex img/widget/radio/preview-00.eps
19693     *
19694     * @brief Radio is a widget that allows for 1 or more options to be displayed
19695     * and have the user choose only 1 of them.
19696     *
19697     * A radio object contains an indicator, an optional Label and an optional
19698     * icon object. While it's possible to have a group of only one radio they,
19699     * are normally used in groups of 2 or more. To add a radio to a group use
19700     * elm_radio_group_add(). The radio object(s) will select from one of a set
19701     * of integer values, so any value they are configuring needs to be mapped to
19702     * a set of integers. To configure what value that radio object represents,
19703     * use  elm_radio_state_value_set() to set the integer it represents. To set
19704     * the value the whole group(which one is currently selected) is to indicate
19705     * use elm_radio_value_set() on any group member, and to get the groups value
19706     * use elm_radio_value_get(). For convenience the radio objects are also able
19707     * to directly set an integer(int) to the value that is selected. To specify
19708     * the pointer to this integer to modify, use elm_radio_value_pointer_set().
19709     * The radio objects will modify this directly. That implies the pointer must
19710     * point to valid memory for as long as the radio objects exist.
19711     *
19712     * Signals that you can add callbacks for are:
19713     * @li changed - This is called whenever the user changes the state of one of
19714     * the radio objects within the group of radio objects that work together.
19715     *
19716     * @ref tutorial_radio show most of this API in action.
19717     * @{
19718     */
19719    /**
19720     * @brief Add a new radio to the parent
19721     *
19722     * @param parent The parent object
19723     * @return The new object or NULL if it cannot be created
19724     */
19725    EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19726    /**
19727     * @brief Set the text label of the radio object
19728     *
19729     * @param obj The radio object
19730     * @param label The text label string in UTF-8
19731     *
19732     * @deprecated use elm_object_text_set() instead.
19733     */
19734    EINA_DEPRECATED EAPI void         elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19735    /**
19736     * @brief Get the text label of the radio object
19737     *
19738     * @param obj The radio object
19739     * @return The text label string in UTF-8
19740     *
19741     * @deprecated use elm_object_text_set() instead.
19742     */
19743    EINA_DEPRECATED EAPI const char  *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19744    /**
19745     * @brief Set the icon object of the radio object
19746     *
19747     * @param obj The radio object
19748     * @param icon The icon object
19749     *
19750     * Once the icon object is set, a previously set one will be deleted. If you
19751     * want to keep that old content object, use the elm_radio_icon_unset()
19752     * function.
19753     */
19754    EAPI void         elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19755    /**
19756     * @brief Get the icon object of the radio object
19757     *
19758     * @param obj The radio object
19759     * @return The icon object
19760     *
19761     * @see elm_radio_icon_set()
19762     */
19763    EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19764    /**
19765     * @brief Unset the icon used for the radio object
19766     *
19767     * @param obj The radio object
19768     * @return The icon object that was being used
19769     *
19770     * Unparent and return the icon object which was set for this widget.
19771     *
19772     * @see elm_radio_icon_set()
19773     */
19774    EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19775    /**
19776     * @brief Add this radio to a group of other radio objects
19777     *
19778     * @param obj The radio object
19779     * @param group Any object whose group the @p obj is to join.
19780     *
19781     * Radio objects work in groups. Each member should have a different integer
19782     * value assigned. In order to have them work as a group, they need to know
19783     * about each other. This adds the given radio object to the group of which
19784     * the group object indicated is a member.
19785     */
19786    EAPI void         elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
19787    /**
19788     * @brief Set the integer value that this radio object represents
19789     *
19790     * @param obj The radio object
19791     * @param value The value to use if this radio object is selected
19792     *
19793     * This sets the value of the radio.
19794     */
19795    EAPI void         elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
19796    /**
19797     * @brief Get the integer value that this radio object represents
19798     *
19799     * @param obj The radio object
19800     * @return The value used if this radio object is selected
19801     *
19802     * This gets the value of the radio.
19803     *
19804     * @see elm_radio_value_set()
19805     */
19806    EAPI int          elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19807    /**
19808     * @brief Set the value of the radio.
19809     *
19810     * @param obj The radio object
19811     * @param value The value to use for the group
19812     *
19813     * This sets the value of the radio group and will also set the value if
19814     * pointed to, to the value supplied, but will not call any callbacks.
19815     */
19816    EAPI void         elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
19817    /**
19818     * @brief Get the state of the radio object
19819     *
19820     * @param obj The radio object
19821     * @return The integer state
19822     */
19823    EAPI int          elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19824    /**
19825     * @brief Set a convenience pointer to a integer to change
19826     *
19827     * @param obj The radio object
19828     * @param valuep Pointer to the integer to modify
19829     *
19830     * This sets a pointer to a integer, that, in addition to the radio objects
19831     * state will also be modified directly. To stop setting the object pointed
19832     * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
19833     * when this is called, the radio objects state will also be modified to
19834     * reflect the value of the integer valuep points to, just like calling
19835     * elm_radio_value_set().
19836     */
19837    EAPI void         elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
19838    /**
19839     * @}
19840     */
19841
19842    /**
19843     * @defgroup Pager Pager
19844     *
19845     * @image html img/widget/pager/preview-00.png
19846     * @image latex img/widget/pager/preview-00.eps
19847     *
19848     * @brief Widget that allows flipping between 1 or more “pages” of objects.
19849     *
19850     * The flipping between “pages” of objects is animated. All content in pager
19851     * is kept in a stack, the last content to be added will be on the top of the
19852     * stack(be visible).
19853     *
19854     * Objects can be pushed or popped from the stack or deleted as normal.
19855     * Pushes and pops will animate (and a pop will delete the object once the
19856     * animation is finished). Any object already in the pager can be promoted to
19857     * the top(from its current stacking position) through the use of
19858     * elm_pager_content_promote(). Objects are pushed to the top with
19859     * elm_pager_content_push() and when the top item is no longer wanted, simply
19860     * pop it with elm_pager_content_pop() and it will also be deleted. If an
19861     * object is no longer needed and is not the top item, just delete it as
19862     * normal. You can query which objects are the top and bottom with
19863     * elm_pager_content_bottom_get() and elm_pager_content_top_get().
19864     *
19865     * Signals that you can add callbacks for are:
19866     * "hide,finished" - when the previous page is hided
19867     *
19868     * This widget has the following styles available:
19869     * @li default
19870     * @li fade
19871     * @li fade_translucide
19872     * @li fade_invisible
19873     * @note This styles affect only the flipping animations, the appearance when
19874     * not animating is unaffected by styles.
19875     *
19876     * @ref tutorial_pager gives a good overview of the usage of the API.
19877     * @{
19878     */
19879    /**
19880     * Add a new pager to the parent
19881     *
19882     * @param parent The parent object
19883     * @return The new object or NULL if it cannot be created
19884     *
19885     * @ingroup Pager
19886     */
19887    EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19888    /**
19889     * @brief Push an object to the top of the pager stack (and show it).
19890     *
19891     * @param obj The pager object
19892     * @param content The object to push
19893     *
19894     * The object pushed becomes a child of the pager, it will be controlled and
19895     * deleted when the pager is deleted.
19896     *
19897     * @note If the content is already in the stack use
19898     * elm_pager_content_promote().
19899     * @warning Using this function on @p content already in the stack results in
19900     * undefined behavior.
19901     */
19902    EAPI void         elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19903    /**
19904     * @brief Pop the object that is on top of the stack
19905     *
19906     * @param obj The pager object
19907     *
19908     * This pops the object that is on the top(visible) of the pager, makes it
19909     * disappear, then deletes the object. The object that was underneath it on
19910     * the stack will become visible.
19911     */
19912    EAPI void         elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
19913    /**
19914     * @brief Moves an object already in the pager stack to the top of the stack.
19915     *
19916     * @param obj The pager object
19917     * @param content The object to promote
19918     *
19919     * This will take the @p content and move it to the top of the stack as
19920     * if it had been pushed there.
19921     *
19922     * @note If the content isn't already in the stack use
19923     * elm_pager_content_push().
19924     * @warning Using this function on @p content not already in the stack
19925     * results in undefined behavior.
19926     */
19927    EAPI void         elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19928    /**
19929     * @brief Return the object at the bottom of the pager stack
19930     *
19931     * @param obj The pager object
19932     * @return The bottom object or NULL if none
19933     */
19934    EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19935    /**
19936     * @brief  Return the object at the top of the pager stack
19937     *
19938     * @param obj The pager object
19939     * @return The top object or NULL if none
19940     */
19941    EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19942
19943    /**
19944     * @}
19945     */
19946
19947    /**
19948     * @defgroup Slideshow Slideshow
19949     *
19950     * @image html img/widget/slideshow/preview-00.png
19951     * @image latex img/widget/slideshow/preview-00.eps
19952     *
19953     * This widget, as the name indicates, is a pre-made image
19954     * slideshow panel, with API functions acting on (child) image
19955     * items presentation. Between those actions, are:
19956     * - advance to next/previous image
19957     * - select the style of image transition animation
19958     * - set the exhibition time for each image
19959     * - start/stop the slideshow
19960     *
19961     * The transition animations are defined in the widget's theme,
19962     * consequently new animations can be added without having to
19963     * update the widget's code.
19964     *
19965     * @section Slideshow_Items Slideshow items
19966     *
19967     * For slideshow items, just like for @ref Genlist "genlist" ones,
19968     * the user defines a @b classes, specifying functions that will be
19969     * called on the item's creation and deletion times.
19970     *
19971     * The #Elm_Slideshow_Item_Class structure contains the following
19972     * members:
19973     *
19974     * - @c func.get - When an item is displayed, this function is
19975     *   called, and it's where one should create the item object, de
19976     *   facto. For example, the object can be a pure Evas image object
19977     *   or an Elementary @ref Photocam "photocam" widget. See
19978     *   #SlideshowItemGetFunc.
19979     * - @c func.del - When an item is no more displayed, this function
19980     *   is called, where the user must delete any data associated to
19981     *   the item. See #SlideshowItemDelFunc.
19982     *
19983     * @section Slideshow_Caching Slideshow caching
19984     *
19985     * The slideshow provides facilities to have items adjacent to the
19986     * one being displayed <b>already "realized"</b> (i.e. loaded) for
19987     * you, so that the system does not have to decode image data
19988     * anymore at the time it has to actually switch images on its
19989     * viewport. The user is able to set the numbers of items to be
19990     * cached @b before and @b after the current item, in the widget's
19991     * item list.
19992     *
19993     * Smart events one can add callbacks for are:
19994     *
19995     * - @c "changed" - when the slideshow switches its view to a new
19996     *   item
19997     *
19998     * List of examples for the slideshow widget:
19999     * @li @ref slideshow_example
20000     */
20001
20002    /**
20003     * @addtogroup Slideshow
20004     * @{
20005     */
20006
20007    typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
20008    typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
20009    typedef struct _Elm_Slideshow_Item       Elm_Slideshow_Item; /**< Slideshow item handle */
20010    typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
20011    typedef void         (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
20012
20013    /**
20014     * @struct _Elm_Slideshow_Item_Class
20015     *
20016     * Slideshow item class definition. See @ref Slideshow_Items for
20017     * field details.
20018     */
20019    struct _Elm_Slideshow_Item_Class
20020      {
20021         struct _Elm_Slideshow_Item_Class_Func
20022           {
20023              SlideshowItemGetFunc get;
20024              SlideshowItemDelFunc del;
20025           } func;
20026      }; /**< #Elm_Slideshow_Item_Class member definitions */
20027
20028    /**
20029     * Add a new slideshow widget to the given parent Elementary
20030     * (container) object
20031     *
20032     * @param parent The parent object
20033     * @return A new slideshow widget handle or @c NULL, on errors
20034     *
20035     * This function inserts a new slideshow widget on the canvas.
20036     *
20037     * @ingroup Slideshow
20038     */
20039    EAPI Evas_Object        *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20040
20041    /**
20042     * Add (append) a new item in a given slideshow widget.
20043     *
20044     * @param obj The slideshow object
20045     * @param itc The item class for the item
20046     * @param data The item's data
20047     * @return A handle to the item added or @c NULL, on errors
20048     *
20049     * Add a new item to @p obj's internal list of items, appending it.
20050     * The item's class must contain the function really fetching the
20051     * image object to show for this item, which could be an Evas image
20052     * object or an Elementary photo, for example. The @p data
20053     * parameter is going to be passed to both class functions of the
20054     * item.
20055     *
20056     * @see #Elm_Slideshow_Item_Class
20057     * @see elm_slideshow_item_sorted_insert()
20058     *
20059     * @ingroup Slideshow
20060     */
20061    EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
20062
20063    /**
20064     * Insert a new item into the given slideshow widget, using the @p func
20065     * function to sort items (by item handles).
20066     *
20067     * @param obj The slideshow object
20068     * @param itc The item class for the item
20069     * @param data The item's data
20070     * @param func The comparing function to be used to sort slideshow
20071     * items <b>by #Elm_Slideshow_Item item handles</b>
20072     * @return Returns The slideshow item handle, on success, or
20073     * @c NULL, on errors
20074     *
20075     * Add a new item to @p obj's internal list of items, in a position
20076     * determined by the @p func comparing function. The item's class
20077     * must contain the function really fetching the image object to
20078     * show for this item, which could be an Evas image object or an
20079     * Elementary photo, for example. The @p data parameter is going to
20080     * be passed to both class functions of the item.
20081     *
20082     * @see #Elm_Slideshow_Item_Class
20083     * @see elm_slideshow_item_add()
20084     *
20085     * @ingroup Slideshow
20086     */
20087    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);
20088
20089    /**
20090     * Display a given slideshow widget's item, programmatically.
20091     *
20092     * @param obj The slideshow object
20093     * @param item The item to display on @p obj's viewport
20094     *
20095     * The change between the current item and @p item will use the
20096     * transition @p obj is set to use (@see
20097     * elm_slideshow_transition_set()).
20098     *
20099     * @ingroup Slideshow
20100     */
20101    EAPI void                elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20102
20103    /**
20104     * Slide to the @b next item, in a given slideshow widget
20105     *
20106     * @param obj The slideshow object
20107     *
20108     * The sliding animation @p obj is set to use will be the
20109     * transition effect used, after this call is issued.
20110     *
20111     * @note If the end of the slideshow's internal list of items is
20112     * reached, it'll wrap around to the list's beginning, again.
20113     *
20114     * @ingroup Slideshow
20115     */
20116    EAPI void                elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20117
20118    /**
20119     * Slide to the @b previous item, in a given slideshow widget
20120     *
20121     * @param obj The slideshow object
20122     *
20123     * The sliding animation @p obj is set to use will be the
20124     * transition effect used, after this call is issued.
20125     *
20126     * @note If the beginning of the slideshow's internal list of items
20127     * is reached, it'll wrap around to the list's end, again.
20128     *
20129     * @ingroup Slideshow
20130     */
20131    EAPI void                elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
20132
20133    /**
20134     * Returns the list of sliding transition/effect names available, for a
20135     * given slideshow widget.
20136     *
20137     * @param obj The slideshow object
20138     * @return The list of transitions (list of @b stringshared strings
20139     * as data)
20140     *
20141     * The transitions, which come from @p obj's theme, must be an EDC
20142     * data item named @c "transitions" on the theme file, with (prefix)
20143     * names of EDC programs actually implementing them.
20144     *
20145     * The available transitions for slideshows on the default theme are:
20146     * - @c "fade" - the current item fades out, while the new one
20147     *   fades in to the slideshow's viewport.
20148     * - @c "black_fade" - the current item fades to black, and just
20149     *   then, the new item will fade in.
20150     * - @c "horizontal" - the current item slides horizontally, until
20151     *   it gets out of the slideshow's viewport, while the new item
20152     *   comes from the left to take its place.
20153     * - @c "vertical" - the current item slides vertically, until it
20154     *   gets out of the slideshow's viewport, while the new item comes
20155     *   from the bottom to take its place.
20156     * - @c "square" - the new item starts to appear from the middle of
20157     *   the current one, but with a tiny size, growing until its
20158     *   target (full) size and covering the old one.
20159     *
20160     * @warning The stringshared strings get no new references
20161     * exclusive to the user grabbing the list, here, so if you'd like
20162     * to use them out of this call's context, you'd better @c
20163     * eina_stringshare_ref() them.
20164     *
20165     * @see elm_slideshow_transition_set()
20166     *
20167     * @ingroup Slideshow
20168     */
20169    EAPI const Eina_List    *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20170
20171    /**
20172     * Set the current slide transition/effect in use for a given
20173     * slideshow widget
20174     *
20175     * @param obj The slideshow object
20176     * @param transition The new transition's name string
20177     *
20178     * If @p transition is implemented in @p obj's theme (i.e., is
20179     * contained in the list returned by
20180     * elm_slideshow_transitions_get()), this new sliding effect will
20181     * be used on the widget.
20182     *
20183     * @see elm_slideshow_transitions_get() for more details
20184     *
20185     * @ingroup Slideshow
20186     */
20187    EAPI void                elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
20188
20189    /**
20190     * Get the current slide transition/effect in use for a given
20191     * slideshow widget
20192     *
20193     * @param obj The slideshow object
20194     * @return The current transition's name
20195     *
20196     * @see elm_slideshow_transition_set() for more details
20197     *
20198     * @ingroup Slideshow
20199     */
20200    EAPI const char         *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20201
20202    /**
20203     * Set the interval between each image transition on a given
20204     * slideshow widget, <b>and start the slideshow, itself</b>
20205     *
20206     * @param obj The slideshow object
20207     * @param timeout The new displaying timeout for images
20208     *
20209     * After this call, the slideshow widget will start cycling its
20210     * view, sequentially and automatically, with the images of the
20211     * items it has. The time between each new image displayed is going
20212     * to be @p timeout, in @b seconds. If a different timeout was set
20213     * previously and an slideshow was in progress, it will continue
20214     * with the new time between transitions, after this call.
20215     *
20216     * @note A value less than or equal to 0 on @p timeout will disable
20217     * the widget's internal timer, thus halting any slideshow which
20218     * could be happening on @p obj.
20219     *
20220     * @see elm_slideshow_timeout_get()
20221     *
20222     * @ingroup Slideshow
20223     */
20224    EAPI void                elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
20225
20226    /**
20227     * Get the interval set for image transitions on a given slideshow
20228     * widget.
20229     *
20230     * @param obj The slideshow object
20231     * @return Returns the timeout set on it
20232     *
20233     * @see elm_slideshow_timeout_set() for more details
20234     *
20235     * @ingroup Slideshow
20236     */
20237    EAPI double              elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20238
20239    /**
20240     * Set if, after a slideshow is started, for a given slideshow
20241     * widget, its items should be displayed cyclically or not.
20242     *
20243     * @param obj The slideshow object
20244     * @param loop Use @c EINA_TRUE to make it cycle through items or
20245     * @c EINA_FALSE for it to stop at the end of @p obj's internal
20246     * list of items
20247     *
20248     * @note elm_slideshow_next() and elm_slideshow_previous() will @b
20249     * ignore what is set by this functions, i.e., they'll @b always
20250     * cycle through items. This affects only the "automatic"
20251     * slideshow, as set by elm_slideshow_timeout_set().
20252     *
20253     * @see elm_slideshow_loop_get()
20254     *
20255     * @ingroup Slideshow
20256     */
20257    EAPI void                elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
20258
20259    /**
20260     * Get if, after a slideshow is started, for a given slideshow
20261     * widget, its items are to be displayed cyclically or not.
20262     *
20263     * @param obj The slideshow object
20264     * @return @c EINA_TRUE, if the items in @p obj will be cycled
20265     * through or @c EINA_FALSE, otherwise
20266     *
20267     * @see elm_slideshow_loop_set() for more details
20268     *
20269     * @ingroup Slideshow
20270     */
20271    EAPI Eina_Bool           elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20272
20273    /**
20274     * Remove all items from a given slideshow widget
20275     *
20276     * @param obj The slideshow object
20277     *
20278     * This removes (and deletes) all items in @p obj, leaving it
20279     * empty.
20280     *
20281     * @see elm_slideshow_item_del(), to remove just one item.
20282     *
20283     * @ingroup Slideshow
20284     */
20285    EAPI void                elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20286
20287    /**
20288     * Get the internal list of items in a given slideshow widget.
20289     *
20290     * @param obj The slideshow object
20291     * @return The list of items (#Elm_Slideshow_Item as data) or
20292     * @c NULL on errors.
20293     *
20294     * This list is @b not to be modified in any way and must not be
20295     * freed. Use the list members with functions like
20296     * elm_slideshow_item_del(), elm_slideshow_item_data_get().
20297     *
20298     * @warning This list is only valid until @p obj object's internal
20299     * items list is changed. It should be fetched again with another
20300     * call to this function when changes happen.
20301     *
20302     * @ingroup Slideshow
20303     */
20304    EAPI const Eina_List    *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20305
20306    /**
20307     * Delete a given item from a slideshow widget.
20308     *
20309     * @param item The slideshow item
20310     *
20311     * @ingroup Slideshow
20312     */
20313    EAPI void                elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20314
20315    /**
20316     * Return the data associated with a given slideshow item
20317     *
20318     * @param item The slideshow item
20319     * @return Returns the data associated to this item
20320     *
20321     * @ingroup Slideshow
20322     */
20323    EAPI void               *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20324
20325    /**
20326     * Returns the currently displayed item, in a given slideshow widget
20327     *
20328     * @param obj The slideshow object
20329     * @return A handle to the item being displayed in @p obj or
20330     * @c NULL, if none is (and on errors)
20331     *
20332     * @ingroup Slideshow
20333     */
20334    EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20335
20336    /**
20337     * Get the real Evas object created to implement the view of a
20338     * given slideshow item
20339     *
20340     * @param item The slideshow item.
20341     * @return the Evas object implementing this item's view.
20342     *
20343     * This returns the actual Evas object used to implement the
20344     * specified slideshow item's view. This may be @c NULL, as it may
20345     * not have been created or may have been deleted, at any time, by
20346     * the slideshow. <b>Do not modify this object</b> (move, resize,
20347     * show, hide, etc.), as the slideshow is controlling it. This
20348     * function is for querying, emitting custom signals or hooking
20349     * lower level callbacks for events on that object. Do not delete
20350     * this object under any circumstances.
20351     *
20352     * @see elm_slideshow_item_data_get()
20353     *
20354     * @ingroup Slideshow
20355     */
20356    EAPI Evas_Object*        elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20357
20358    /**
20359     * Get the the item, in a given slideshow widget, placed at
20360     * position @p nth, in its internal items list
20361     *
20362     * @param obj The slideshow object
20363     * @param nth The number of the item to grab a handle to (0 being
20364     * the first)
20365     * @return The item stored in @p obj at position @p nth or @c NULL,
20366     * if there's no item with that index (and on errors)
20367     *
20368     * @ingroup Slideshow
20369     */
20370    EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20371
20372    /**
20373     * Set the current slide layout in use for a given slideshow widget
20374     *
20375     * @param obj The slideshow object
20376     * @param layout The new layout's name string
20377     *
20378     * If @p layout is implemented in @p obj's theme (i.e., is contained
20379     * in the list returned by elm_slideshow_layouts_get()), this new
20380     * images layout will be used on the widget.
20381     *
20382     * @see elm_slideshow_layouts_get() for more details
20383     *
20384     * @ingroup Slideshow
20385     */
20386    EAPI void                elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20387
20388    /**
20389     * Get the current slide layout in use for a given slideshow widget
20390     *
20391     * @param obj The slideshow object
20392     * @return The current layout's name
20393     *
20394     * @see elm_slideshow_layout_set() for more details
20395     *
20396     * @ingroup Slideshow
20397     */
20398    EAPI const char         *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20399
20400    /**
20401     * Returns the list of @b layout names available, for a given
20402     * slideshow widget.
20403     *
20404     * @param obj The slideshow object
20405     * @return The list of layouts (list of @b stringshared strings
20406     * as data)
20407     *
20408     * Slideshow layouts will change how the widget is to dispose each
20409     * image item in its viewport, with regard to cropping, scaling,
20410     * etc.
20411     *
20412     * The layouts, which come from @p obj's theme, must be an EDC
20413     * data item name @c "layouts" on the theme file, with (prefix)
20414     * names of EDC programs actually implementing them.
20415     *
20416     * The available layouts for slideshows on the default theme are:
20417     * - @c "fullscreen" - item images with original aspect, scaled to
20418     *   touch top and down slideshow borders or, if the image's heigh
20419     *   is not enough, left and right slideshow borders.
20420     * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20421     *   one, but always leaving 10% of the slideshow's dimensions of
20422     *   distance between the item image's borders and the slideshow
20423     *   borders, for each axis.
20424     *
20425     * @warning The stringshared strings get no new references
20426     * exclusive to the user grabbing the list, here, so if you'd like
20427     * to use them out of this call's context, you'd better @c
20428     * eina_stringshare_ref() them.
20429     *
20430     * @see elm_slideshow_layout_set()
20431     *
20432     * @ingroup Slideshow
20433     */
20434    EAPI const Eina_List    *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20435
20436    /**
20437     * Set the number of items to cache, on a given slideshow widget,
20438     * <b>before the current item</b>
20439     *
20440     * @param obj The slideshow object
20441     * @param count Number of items to cache before the current one
20442     *
20443     * The default value for this property is @c 2. See
20444     * @ref Slideshow_Caching "slideshow caching" for more details.
20445     *
20446     * @see elm_slideshow_cache_before_get()
20447     *
20448     * @ingroup Slideshow
20449     */
20450    EAPI void                elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20451
20452    /**
20453     * Retrieve the number of items to cache, on a given slideshow widget,
20454     * <b>before the current item</b>
20455     *
20456     * @param obj The slideshow object
20457     * @return The number of items set to be cached before the current one
20458     *
20459     * @see elm_slideshow_cache_before_set() for more details
20460     *
20461     * @ingroup Slideshow
20462     */
20463    EAPI int                 elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20464
20465    /**
20466     * Set the number of items to cache, on a given slideshow widget,
20467     * <b>after the current item</b>
20468     *
20469     * @param obj The slideshow object
20470     * @param count Number of items to cache after the current one
20471     *
20472     * The default value for this property is @c 2. See
20473     * @ref Slideshow_Caching "slideshow caching" for more details.
20474     *
20475     * @see elm_slideshow_cache_after_get()
20476     *
20477     * @ingroup Slideshow
20478     */
20479    EAPI void                elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20480
20481    /**
20482     * Retrieve the number of items to cache, on a given slideshow widget,
20483     * <b>after the current item</b>
20484     *
20485     * @param obj The slideshow object
20486     * @return The number of items set to be cached after the current one
20487     *
20488     * @see elm_slideshow_cache_after_set() for more details
20489     *
20490     * @ingroup Slideshow
20491     */
20492    EAPI int                 elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20493
20494    /**
20495     * Get the number of items stored in a given slideshow widget
20496     *
20497     * @param obj The slideshow object
20498     * @return The number of items on @p obj, at the moment of this call
20499     *
20500     * @ingroup Slideshow
20501     */
20502    EAPI unsigned int        elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20503
20504    /**
20505     * @}
20506     */
20507
20508    /**
20509     * @defgroup Fileselector File Selector
20510     *
20511     * @image html img/widget/fileselector/preview-00.png
20512     * @image latex img/widget/fileselector/preview-00.eps
20513     *
20514     * A file selector is a widget that allows a user to navigate
20515     * through a file system, reporting file selections back via its
20516     * API.
20517     *
20518     * It contains shortcut buttons for home directory (@c ~) and to
20519     * jump one directory upwards (..), as well as cancel/ok buttons to
20520     * confirm/cancel a given selection. After either one of those two
20521     * former actions, the file selector will issue its @c "done" smart
20522     * callback.
20523     *
20524     * There's a text entry on it, too, showing the name of the current
20525     * selection. There's the possibility of making it editable, so it
20526     * is useful on file saving dialogs on applications, where one
20527     * gives a file name to save contents to, in a given directory in
20528     * the system. This custom file name will be reported on the @c
20529     * "done" smart callback (explained in sequence).
20530     *
20531     * Finally, it has a view to display file system items into in two
20532     * possible forms:
20533     * - list
20534     * - grid
20535     *
20536     * If Elementary is built with support of the Ethumb thumbnailing
20537     * library, the second form of view will display preview thumbnails
20538     * of files which it supports.
20539     *
20540     * Smart callbacks one can register to:
20541     *
20542     * - @c "selected" - the user has clicked on a file (when not in
20543     *      folders-only mode) or directory (when in folders-only mode)
20544     * - @c "directory,open" - the list has been populated with new
20545     *      content (@c event_info is a pointer to the directory's
20546     *      path, a @b stringshared string)
20547     * - @c "done" - the user has clicked on the "ok" or "cancel"
20548     *      buttons (@c event_info is a pointer to the selection's
20549     *      path, a @b stringshared string)
20550     *
20551     * Here is an example on its usage:
20552     * @li @ref fileselector_example
20553     */
20554
20555    /**
20556     * @addtogroup Fileselector
20557     * @{
20558     */
20559
20560    /**
20561     * Defines how a file selector widget is to layout its contents
20562     * (file system entries).
20563     */
20564    typedef enum _Elm_Fileselector_Mode
20565      {
20566         ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
20567         ELM_FILESELECTOR_GRID, /**< layout as a grid */
20568         ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
20569      } Elm_Fileselector_Mode;
20570
20571    /**
20572     * Add a new file selector widget to the given parent Elementary
20573     * (container) object
20574     *
20575     * @param parent The parent object
20576     * @return a new file selector widget handle or @c NULL, on errors
20577     *
20578     * This function inserts a new file selector widget on the canvas.
20579     *
20580     * @ingroup Fileselector
20581     */
20582    EAPI Evas_Object          *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20583
20584    /**
20585     * Enable/disable the file name entry box where the user can type
20586     * in a name for a file, in a given file selector widget
20587     *
20588     * @param obj The file selector object
20589     * @param is_save @c EINA_TRUE to make the file selector a "saving
20590     * dialog", @c EINA_FALSE otherwise
20591     *
20592     * Having the entry editable is useful on file saving dialogs on
20593     * applications, where one gives a file name to save contents to,
20594     * in a given directory in the system. This custom file name will
20595     * be reported on the @c "done" smart callback.
20596     *
20597     * @see elm_fileselector_is_save_get()
20598     *
20599     * @ingroup Fileselector
20600     */
20601    EAPI void                  elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
20602
20603    /**
20604     * Get whether the given file selector is in "saving dialog" mode
20605     *
20606     * @param obj The file selector object
20607     * @return @c EINA_TRUE, if the file selector is in "saving dialog"
20608     * mode, @c EINA_FALSE otherwise (and on errors)
20609     *
20610     * @see elm_fileselector_is_save_set() for more details
20611     *
20612     * @ingroup Fileselector
20613     */
20614    EAPI Eina_Bool             elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20615
20616    /**
20617     * Enable/disable folder-only view for a given file selector widget
20618     *
20619     * @param obj The file selector object
20620     * @param only @c EINA_TRUE to make @p obj only display
20621     * directories, @c EINA_FALSE to make files to be displayed in it
20622     * too
20623     *
20624     * If enabled, the widget's view will only display folder items,
20625     * naturally.
20626     *
20627     * @see elm_fileselector_folder_only_get()
20628     *
20629     * @ingroup Fileselector
20630     */
20631    EAPI void                  elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
20632
20633    /**
20634     * Get whether folder-only view is set for a given file selector
20635     * widget
20636     *
20637     * @param obj The file selector object
20638     * @return only @c EINA_TRUE if @p obj is only displaying
20639     * directories, @c EINA_FALSE if files are being displayed in it
20640     * too (and on errors)
20641     *
20642     * @see elm_fileselector_folder_only_get()
20643     *
20644     * @ingroup Fileselector
20645     */
20646    EAPI Eina_Bool             elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20647
20648    /**
20649     * Enable/disable the "ok" and "cancel" buttons on a given file
20650     * selector widget
20651     *
20652     * @param obj The file selector object
20653     * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
20654     *
20655     * @note A file selector without those buttons will never emit the
20656     * @c "done" smart event, and is only usable if one is just hooking
20657     * to the other two events.
20658     *
20659     * @see elm_fileselector_buttons_ok_cancel_get()
20660     *
20661     * @ingroup Fileselector
20662     */
20663    EAPI void                  elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
20664
20665    /**
20666     * Get whether the "ok" and "cancel" buttons on a given file
20667     * selector widget are being shown.
20668     *
20669     * @param obj The file selector object
20670     * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
20671     * otherwise (and on errors)
20672     *
20673     * @see elm_fileselector_buttons_ok_cancel_set() for more details
20674     *
20675     * @ingroup Fileselector
20676     */
20677    EAPI Eina_Bool             elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20678
20679    /**
20680     * Enable/disable a tree view in the given file selector widget,
20681     * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
20682     *
20683     * @param obj The file selector object
20684     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
20685     * disable
20686     *
20687     * In a tree view, arrows are created on the sides of directories,
20688     * allowing them to expand in place.
20689     *
20690     * @note If it's in other mode, the changes made by this function
20691     * will only be visible when one switches back to "list" mode.
20692     *
20693     * @see elm_fileselector_expandable_get()
20694     *
20695     * @ingroup Fileselector
20696     */
20697    EAPI void                  elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
20698
20699    /**
20700     * Get whether tree view is enabled for the given file selector
20701     * widget
20702     *
20703     * @param obj The file selector object
20704     * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
20705     * otherwise (and or errors)
20706     *
20707     * @see elm_fileselector_expandable_set() for more details
20708     *
20709     * @ingroup Fileselector
20710     */
20711    EAPI Eina_Bool             elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20712
20713    /**
20714     * Set, programmatically, the @b directory that a given file
20715     * selector widget will display contents from
20716     *
20717     * @param obj The file selector object
20718     * @param path The path to display in @p obj
20719     *
20720     * This will change the @b directory that @p obj is displaying. It
20721     * will also clear the text entry area on the @p obj object, which
20722     * displays select files' names.
20723     *
20724     * @see elm_fileselector_path_get()
20725     *
20726     * @ingroup Fileselector
20727     */
20728    EAPI void                  elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20729
20730    /**
20731     * Get the parent directory's path that a given file selector
20732     * widget is displaying
20733     *
20734     * @param obj The file selector object
20735     * @return The (full) path of the directory the file selector is
20736     * displaying, a @b stringshared string
20737     *
20738     * @see elm_fileselector_path_set()
20739     *
20740     * @ingroup Fileselector
20741     */
20742    EAPI const char           *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20743
20744    /**
20745     * Set, programmatically, the currently selected file/directory in
20746     * the given file selector widget
20747     *
20748     * @param obj The file selector object
20749     * @param path The (full) path to a file or directory
20750     * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
20751     * latter case occurs if the directory or file pointed to do not
20752     * exist.
20753     *
20754     * @see elm_fileselector_selected_get()
20755     *
20756     * @ingroup Fileselector
20757     */
20758    EAPI Eina_Bool             elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20759
20760    /**
20761     * Get the currently selected item's (full) path, in the given file
20762     * selector widget
20763     *
20764     * @param obj The file selector object
20765     * @return The absolute path of the selected item, a @b
20766     * stringshared string
20767     *
20768     * @note Custom editions on @p obj object's text entry, if made,
20769     * will appear on the return string of this function, naturally.
20770     *
20771     * @see elm_fileselector_selected_set() for more details
20772     *
20773     * @ingroup Fileselector
20774     */
20775    EAPI const char           *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20776
20777    /**
20778     * Set the mode in which a given file selector widget will display
20779     * (layout) file system entries in its view
20780     *
20781     * @param obj The file selector object
20782     * @param mode The mode of the fileselector, being it one of
20783     * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
20784     * first one, naturally, will display the files in a list. The
20785     * latter will make the widget to display its entries in a grid
20786     * form.
20787     *
20788     * @note By using elm_fileselector_expandable_set(), the user may
20789     * trigger a tree view for that list.
20790     *
20791     * @note If Elementary is built with support of the Ethumb
20792     * thumbnailing library, the second form of view will display
20793     * preview thumbnails of files which it supports. You must have
20794     * elm_need_ethumb() called in your Elementary for thumbnailing to
20795     * work, though.
20796     *
20797     * @see elm_fileselector_expandable_set().
20798     * @see elm_fileselector_mode_get().
20799     *
20800     * @ingroup Fileselector
20801     */
20802    EAPI void                  elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
20803
20804    /**
20805     * Get the mode in which a given file selector widget is displaying
20806     * (layouting) file system entries in its view
20807     *
20808     * @param obj The fileselector object
20809     * @return The mode in which the fileselector is at
20810     *
20811     * @see elm_fileselector_mode_set() for more details
20812     *
20813     * @ingroup Fileselector
20814     */
20815    EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20816
20817    /**
20818     * @}
20819     */
20820
20821    /**
20822     * @defgroup Progressbar Progress bar
20823     *
20824     * The progress bar is a widget for visually representing the
20825     * progress status of a given job/task.
20826     *
20827     * A progress bar may be horizontal or vertical. It may display an
20828     * icon besides it, as well as primary and @b units labels. The
20829     * former is meant to label the widget as a whole, while the
20830     * latter, which is formatted with floating point values (and thus
20831     * accepts a <c>printf</c>-style format string, like <c>"%1.2f
20832     * units"</c>), is meant to label the widget's <b>progress
20833     * value</b>. Label, icon and unit strings/objects are @b optional
20834     * for progress bars.
20835     *
20836     * A progress bar may be @b inverted, in which state it gets its
20837     * values inverted, with high values being on the left or top and
20838     * low values on the right or bottom, as opposed to normally have
20839     * the low values on the former and high values on the latter,
20840     * respectively, for horizontal and vertical modes.
20841     *
20842     * The @b span of the progress, as set by
20843     * elm_progressbar_span_size_set(), is its length (horizontally or
20844     * vertically), unless one puts size hints on the widget to expand
20845     * on desired directions, by any container. That length will be
20846     * scaled by the object or applications scaling factor. At any
20847     * point code can query the progress bar for its value with
20848     * elm_progressbar_value_get().
20849     *
20850     * Available widget styles for progress bars:
20851     * - @c "default"
20852     * - @c "wheel" (simple style, no text, no progression, only
20853     *      "pulse" effect is available)
20854     *
20855     * Here is an example on its usage:
20856     * @li @ref progressbar_example
20857     */
20858
20859    /**
20860     * Add a new progress bar widget to the given parent Elementary
20861     * (container) object
20862     *
20863     * @param parent The parent object
20864     * @return a new progress bar widget handle or @c NULL, on errors
20865     *
20866     * This function inserts a new progress bar widget on the canvas.
20867     *
20868     * @ingroup Progressbar
20869     */
20870    EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20871
20872    /**
20873     * Set whether a given progress bar widget is at "pulsing mode" or
20874     * not.
20875     *
20876     * @param obj The progress bar object
20877     * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
20878     * @c EINA_FALSE to put it back to its default one
20879     *
20880     * By default, progress bars will display values from the low to
20881     * high value boundaries. There are, though, contexts in which the
20882     * state of progression of a given task is @b unknown.  For those,
20883     * one can set a progress bar widget to a "pulsing state", to give
20884     * the user an idea that some computation is being held, but
20885     * without exact progress values. In the default theme it will
20886     * animate its bar with the contents filling in constantly and back
20887     * to non-filled, in a loop. To start and stop this pulsing
20888     * animation, one has to explicitly call elm_progressbar_pulse().
20889     *
20890     * @see elm_progressbar_pulse_get()
20891     * @see elm_progressbar_pulse()
20892     *
20893     * @ingroup Progressbar
20894     */
20895    EAPI void         elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
20896
20897    /**
20898     * Get whether a given progress bar widget is at "pulsing mode" or
20899     * not.
20900     *
20901     * @param obj The progress bar object
20902     * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
20903     * if it's in the default one (and on errors)
20904     *
20905     * @ingroup Progressbar
20906     */
20907    EAPI Eina_Bool    elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20908
20909    /**
20910     * Start/stop a given progress bar "pulsing" animation, if its
20911     * under that mode
20912     *
20913     * @param obj The progress bar object
20914     * @param state @c EINA_TRUE, to @b start the pulsing animation,
20915     * @c EINA_FALSE to @b stop it
20916     *
20917     * @note This call won't do anything if @p obj is not under "pulsing mode".
20918     *
20919     * @see elm_progressbar_pulse_set() for more details.
20920     *
20921     * @ingroup Progressbar
20922     */
20923    EAPI void         elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
20924
20925    /**
20926     * Set the progress value (in percentage) on a given progress bar
20927     * widget
20928     *
20929     * @param obj The progress bar object
20930     * @param val The progress value (@b must be between @c 0.0 and @c
20931     * 1.0)
20932     *
20933     * Use this call to set progress bar levels.
20934     *
20935     * @note If you passes a value out of the specified range for @p
20936     * val, it will be interpreted as the @b closest of the @b boundary
20937     * values in the range.
20938     *
20939     * @ingroup Progressbar
20940     */
20941    EAPI void         elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
20942
20943    /**
20944     * Get the progress value (in percentage) on a given progress bar
20945     * widget
20946     *
20947     * @param obj The progress bar object
20948     * @return The value of the progressbar
20949     *
20950     * @see elm_progressbar_value_set() for more details
20951     *
20952     * @ingroup Progressbar
20953     */
20954    EAPI double       elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20955
20956    /**
20957     * Set the label of a given progress bar widget
20958     *
20959     * @param obj The progress bar object
20960     * @param label The text label string, in UTF-8
20961     *
20962     * @ingroup Progressbar
20963     * @deprecated use elm_object_text_set() instead.
20964     */
20965    EINA_DEPRECATED EAPI void         elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
20966
20967    /**
20968     * Get the label of a given progress bar widget
20969     *
20970     * @param obj The progressbar object
20971     * @return The text label string, in UTF-8
20972     *
20973     * @ingroup Progressbar
20974     * @deprecated use elm_object_text_set() instead.
20975     */
20976    EINA_DEPRECATED EAPI const char  *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20977
20978    /**
20979     * Set the icon object of a given progress bar widget
20980     *
20981     * @param obj The progress bar object
20982     * @param icon The icon object
20983     *
20984     * Use this call to decorate @p obj with an icon next to it.
20985     *
20986     * @note Once the icon object is set, a previously set one will be
20987     * deleted. If you want to keep that old content object, use the
20988     * elm_progressbar_icon_unset() function.
20989     *
20990     * @see elm_progressbar_icon_get()
20991     *
20992     * @ingroup Progressbar
20993     */
20994    EAPI void         elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20995
20996    /**
20997     * Retrieve the icon object set for a given progress bar widget
20998     *
20999     * @param obj The progress bar object
21000     * @return The icon object's handle, if @p obj had one set, or @c NULL,
21001     * otherwise (and on errors)
21002     *
21003     * @see elm_progressbar_icon_set() for more details
21004     *
21005     * @ingroup Progressbar
21006     */
21007    EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21008
21009    /**
21010     * Unset an icon set on a given progress bar widget
21011     *
21012     * @param obj The progress bar object
21013     * @return The icon object that was being used, if any was set, or
21014     * @c NULL, otherwise (and on errors)
21015     *
21016     * This call will unparent and return the icon object which was set
21017     * for this widget, previously, on success.
21018     *
21019     * @see elm_progressbar_icon_set() for more details
21020     *
21021     * @ingroup Progressbar
21022     */
21023    EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21024
21025    /**
21026     * Set the (exact) length of the bar region of a given progress bar
21027     * widget
21028     *
21029     * @param obj The progress bar object
21030     * @param size The length of the progress bar's bar region
21031     *
21032     * This sets the minimum width (when in horizontal mode) or height
21033     * (when in vertical mode) of the actual bar area of the progress
21034     * bar @p obj. This in turn affects the object's minimum size. Use
21035     * this when you're not setting other size hints expanding on the
21036     * given direction (like weight and alignment hints) and you would
21037     * like it to have a specific size.
21038     *
21039     * @note Icon, label and unit text around @p obj will require their
21040     * own space, which will make @p obj to require more the @p size,
21041     * actually.
21042     *
21043     * @see elm_progressbar_span_size_get()
21044     *
21045     * @ingroup Progressbar
21046     */
21047    EAPI void         elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
21048
21049    /**
21050     * Get the length set for the bar region of a given progress bar
21051     * widget
21052     *
21053     * @param obj The progress bar object
21054     * @return The length of the progress bar's bar region
21055     *
21056     * If that size was not set previously, with
21057     * elm_progressbar_span_size_set(), this call will return @c 0.
21058     *
21059     * @ingroup Progressbar
21060     */
21061    EAPI Evas_Coord   elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21062
21063    /**
21064     * Set the format string for a given progress bar widget's units
21065     * label
21066     *
21067     * @param obj The progress bar object
21068     * @param format The format string for @p obj's units label
21069     *
21070     * If @c NULL is passed on @p format, it will make @p obj's units
21071     * area to be hidden completely. If not, it'll set the <b>format
21072     * string</b> for the units label's @b text. The units label is
21073     * provided a floating point value, so the units text is up display
21074     * at most one floating point falue. Note that the units label is
21075     * optional. Use a format string such as "%1.2f meters" for
21076     * example.
21077     *
21078     * @note The default format string for a progress bar is an integer
21079     * percentage, as in @c "%.0f %%".
21080     *
21081     * @see elm_progressbar_unit_format_get()
21082     *
21083     * @ingroup Progressbar
21084     */
21085    EAPI void         elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
21086
21087    /**
21088     * Retrieve the format string set for a given progress bar widget's
21089     * units label
21090     *
21091     * @param obj The progress bar object
21092     * @return The format set string for @p obj's units label or
21093     * @c NULL, if none was set (and on errors)
21094     *
21095     * @see elm_progressbar_unit_format_set() for more details
21096     *
21097     * @ingroup Progressbar
21098     */
21099    EAPI const char  *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21100
21101    /**
21102     * Set the orientation of a given progress bar widget
21103     *
21104     * @param obj The progress bar object
21105     * @param horizontal Use @c EINA_TRUE to make @p obj to be
21106     * @b horizontal, @c EINA_FALSE to make it @b vertical
21107     *
21108     * Use this function to change how your progress bar is to be
21109     * disposed: vertically or horizontally.
21110     *
21111     * @see elm_progressbar_horizontal_get()
21112     *
21113     * @ingroup Progressbar
21114     */
21115    EAPI void         elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21116
21117    /**
21118     * Retrieve the orientation of a given progress bar widget
21119     *
21120     * @param obj The progress bar object
21121     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
21122     * @c EINA_FALSE if it's @b vertical (and on errors)
21123     *
21124     * @see elm_progressbar_horizontal_set() for more details
21125     *
21126     * @ingroup Progressbar
21127     */
21128    EAPI Eina_Bool    elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21129
21130    /**
21131     * Invert a given progress bar widget's displaying values order
21132     *
21133     * @param obj The progress bar object
21134     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
21135     * @c EINA_FALSE to bring it back to default, non-inverted values.
21136     *
21137     * A progress bar may be @b inverted, in which state it gets its
21138     * values inverted, with high values being on the left or top and
21139     * low values on the right or bottom, as opposed to normally have
21140     * the low values on the former and high values on the latter,
21141     * respectively, for horizontal and vertical modes.
21142     *
21143     * @see elm_progressbar_inverted_get()
21144     *
21145     * @ingroup Progressbar
21146     */
21147    EAPI void         elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
21148
21149    /**
21150     * Get whether a given progress bar widget's displaying values are
21151     * inverted or not
21152     *
21153     * @param obj The progress bar object
21154     * @return @c EINA_TRUE, if @p obj has inverted values,
21155     * @c EINA_FALSE otherwise (and on errors)
21156     *
21157     * @see elm_progressbar_inverted_set() for more details
21158     *
21159     * @ingroup Progressbar
21160     */
21161    EAPI Eina_Bool    elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21162
21163    /**
21164     * @defgroup Separator Separator
21165     *
21166     * @brief Separator is a very thin object used to separate other objects.
21167     *
21168     * A separator can be vertical or horizontal.
21169     *
21170     * @ref tutorial_separator is a good example of how to use a separator.
21171     * @{
21172     */
21173    /**
21174     * @brief Add a separator object to @p parent
21175     *
21176     * @param parent The parent object
21177     *
21178     * @return The separator object, or NULL upon failure
21179     */
21180    EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21181    /**
21182     * @brief Set the horizontal mode of a separator object
21183     *
21184     * @param obj The separator object
21185     * @param horizontal If true, the separator is horizontal
21186     */
21187    EAPI void         elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21188    /**
21189     * @brief Get the horizontal mode of a separator object
21190     *
21191     * @param obj The separator object
21192     * @return If true, the separator is horizontal
21193     *
21194     * @see elm_separator_horizontal_set()
21195     */
21196    EAPI Eina_Bool    elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21197    /**
21198     * @}
21199     */
21200
21201    /**
21202     * @defgroup Spinner Spinner
21203     * @ingroup Elementary
21204     *
21205     * @image html img/widget/spinner/preview-00.png
21206     * @image latex img/widget/spinner/preview-00.eps
21207     *
21208     * A spinner is a widget which allows the user to increase or decrease
21209     * numeric values using arrow buttons, or edit values directly, clicking
21210     * over it and typing the new value.
21211     *
21212     * By default the spinner will not wrap and has a label
21213     * of "%.0f" (just showing the integer value of the double).
21214     *
21215     * A spinner has a label that is formatted with floating
21216     * point values and thus accepts a printf-style format string, like
21217     * “%1.2f units”.
21218     *
21219     * It also allows specific values to be replaced by pre-defined labels.
21220     *
21221     * Smart callbacks one can register to:
21222     *
21223     * - "changed" - Whenever the spinner value is changed.
21224     * - "delay,changed" - A short time after the value is changed by the user.
21225     *    This will be called only when the user stops dragging for a very short
21226     *    period or when they release their finger/mouse, so it avoids possibly
21227     *    expensive reactions to the value change.
21228     *
21229     * Available styles for it:
21230     * - @c "default";
21231     * - @c "vertical": up/down buttons at the right side and text left aligned.
21232     *
21233     * Here is an example on its usage:
21234     * @ref spinner_example
21235     */
21236
21237    /**
21238     * @addtogroup Spinner
21239     * @{
21240     */
21241
21242    /**
21243     * Add a new spinner widget to the given parent Elementary
21244     * (container) object.
21245     *
21246     * @param parent The parent object.
21247     * @return a new spinner widget handle or @c NULL, on errors.
21248     *
21249     * This function inserts a new spinner widget on the canvas.
21250     *
21251     * @ingroup Spinner
21252     *
21253     */
21254    EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21255
21256    /**
21257     * Set the format string of the displayed label.
21258     *
21259     * @param obj The spinner object.
21260     * @param fmt The format string for the label display.
21261     *
21262     * If @c NULL, this sets the format to "%.0f". If not it sets the format
21263     * string for the label text. The label text is provided a floating point
21264     * value, so the label text can display up to 1 floating point value.
21265     * Note that this is optional.
21266     *
21267     * Use a format string such as "%1.2f meters" for example, and it will
21268     * display values like: "3.14 meters" for a value equal to 3.14159.
21269     *
21270     * Default is "%0.f".
21271     *
21272     * @see elm_spinner_label_format_get()
21273     *
21274     * @ingroup Spinner
21275     */
21276    EAPI void         elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
21277
21278    /**
21279     * Get the label format of the spinner.
21280     *
21281     * @param obj The spinner object.
21282     * @return The text label format string in UTF-8.
21283     *
21284     * @see elm_spinner_label_format_set() for details.
21285     *
21286     * @ingroup Spinner
21287     */
21288    EAPI const char  *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21289
21290    /**
21291     * Set the minimum and maximum values for the spinner.
21292     *
21293     * @param obj The spinner object.
21294     * @param min The minimum value.
21295     * @param max The maximum value.
21296     *
21297     * Define the allowed range of values to be selected by the user.
21298     *
21299     * If actual value is less than @p min, it will be updated to @p min. If it
21300     * is bigger then @p max, will be updated to @p max. Actual value can be
21301     * get with elm_spinner_value_get().
21302     *
21303     * By default, min is equal to 0, and max is equal to 100.
21304     *
21305     * @warning Maximum must be greater than minimum.
21306     *
21307     * @see elm_spinner_min_max_get()
21308     *
21309     * @ingroup Spinner
21310     */
21311    EAPI void         elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
21312
21313    /**
21314     * Get the minimum and maximum values of the spinner.
21315     *
21316     * @param obj The spinner object.
21317     * @param min Pointer where to store the minimum value.
21318     * @param max Pointer where to store the maximum value.
21319     *
21320     * @note If only one value is needed, the other pointer can be passed
21321     * as @c NULL.
21322     *
21323     * @see elm_spinner_min_max_set() for details.
21324     *
21325     * @ingroup Spinner
21326     */
21327    EAPI void         elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
21328
21329    /**
21330     * Set the step used to increment or decrement the spinner value.
21331     *
21332     * @param obj The spinner object.
21333     * @param step The step value.
21334     *
21335     * This value will be incremented or decremented to the displayed value.
21336     * It will be incremented while the user keep right or top arrow pressed,
21337     * and will be decremented while the user keep left or bottom arrow pressed.
21338     *
21339     * The interval to increment / decrement can be set with
21340     * elm_spinner_interval_set().
21341     *
21342     * By default step value is equal to 1.
21343     *
21344     * @see elm_spinner_step_get()
21345     *
21346     * @ingroup Spinner
21347     */
21348    EAPI void         elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21349
21350    /**
21351     * Get the step used to increment or decrement the spinner value.
21352     *
21353     * @param obj The spinner object.
21354     * @return The step value.
21355     *
21356     * @see elm_spinner_step_get() for more details.
21357     *
21358     * @ingroup Spinner
21359     */
21360    EAPI double       elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21361
21362    /**
21363     * Set the value the spinner displays.
21364     *
21365     * @param obj The spinner object.
21366     * @param val The value to be displayed.
21367     *
21368     * Value will be presented on the label following format specified with
21369     * elm_spinner_format_set().
21370     *
21371     * @warning The value must to be between min and max values. This values
21372     * are set by elm_spinner_min_max_set().
21373     *
21374     * @see elm_spinner_value_get().
21375     * @see elm_spinner_format_set().
21376     * @see elm_spinner_min_max_set().
21377     *
21378     * @ingroup Spinner
21379     */
21380    EAPI void         elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21381
21382    /**
21383     * Get the value displayed by the spinner.
21384     *
21385     * @param obj The spinner object.
21386     * @return The value displayed.
21387     *
21388     * @see elm_spinner_value_set() for details.
21389     *
21390     * @ingroup Spinner
21391     */
21392    EAPI double       elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21393
21394    /**
21395     * Set whether the spinner should wrap when it reaches its
21396     * minimum or maximum value.
21397     *
21398     * @param obj The spinner object.
21399     * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21400     * disable it.
21401     *
21402     * Disabled by default. If disabled, when the user tries to increment the
21403     * value,
21404     * but displayed value plus step value is bigger than maximum value,
21405     * the spinner
21406     * won't allow it. The same happens when the user tries to decrement it,
21407     * but the value less step is less than minimum value.
21408     *
21409     * When wrap is enabled, in such situations it will allow these changes,
21410     * but will get the value that would be less than minimum and subtracts
21411     * from maximum. Or add the value that would be more than maximum to
21412     * the minimum.
21413     *
21414     * E.g.:
21415     * @li min value = 10
21416     * @li max value = 50
21417     * @li step value = 20
21418     * @li displayed value = 20
21419     *
21420     * When the user decrement value (using left or bottom arrow), it will
21421     * displays @c 40, because max - (min - (displayed - step)) is
21422     * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21423     *
21424     * @see elm_spinner_wrap_get().
21425     *
21426     * @ingroup Spinner
21427     */
21428    EAPI void         elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21429
21430    /**
21431     * Get whether the spinner should wrap when it reaches its
21432     * minimum or maximum value.
21433     *
21434     * @param obj The spinner object
21435     * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21436     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21437     *
21438     * @see elm_spinner_wrap_set() for details.
21439     *
21440     * @ingroup Spinner
21441     */
21442    EAPI Eina_Bool    elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21443
21444    /**
21445     * Set whether the spinner can be directly edited by the user or not.
21446     *
21447     * @param obj The spinner object.
21448     * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21449     * don't allow users to edit it directly.
21450     *
21451     * Spinner objects can have edition @b disabled, in which state they will
21452     * be changed only by arrows.
21453     * Useful for contexts
21454     * where you don't want your users to interact with it writting the value.
21455     * Specially
21456     * when using special values, the user can see real value instead
21457     * of special label on edition.
21458     *
21459     * It's enabled by default.
21460     *
21461     * @see elm_spinner_editable_get()
21462     *
21463     * @ingroup Spinner
21464     */
21465    EAPI void         elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
21466
21467    /**
21468     * Get whether the spinner can be directly edited by the user or not.
21469     *
21470     * @param obj The spinner object.
21471     * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
21472     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21473     *
21474     * @see elm_spinner_editable_set() for details.
21475     *
21476     * @ingroup Spinner
21477     */
21478    EAPI Eina_Bool    elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21479
21480    /**
21481     * Set a special string to display in the place of the numerical value.
21482     *
21483     * @param obj The spinner object.
21484     * @param value The value to be replaced.
21485     * @param label The label to be used.
21486     *
21487     * It's useful for cases when a user should select an item that is
21488     * better indicated by a label than a value. For example, weekdays or months.
21489     *
21490     * E.g.:
21491     * @code
21492     * sp = elm_spinner_add(win);
21493     * elm_spinner_min_max_set(sp, 1, 3);
21494     * elm_spinner_special_value_add(sp, 1, "January");
21495     * elm_spinner_special_value_add(sp, 2, "February");
21496     * elm_spinner_special_value_add(sp, 3, "March");
21497     * evas_object_show(sp);
21498     * @endcode
21499     *
21500     * @ingroup Spinner
21501     */
21502    EAPI void         elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
21503
21504    /**
21505     * Set the interval on time updates for an user mouse button hold
21506     * on spinner widgets' arrows.
21507     *
21508     * @param obj The spinner object.
21509     * @param interval The (first) interval value in seconds.
21510     *
21511     * This interval value is @b decreased while the user holds the
21512     * mouse pointer either incrementing or decrementing spinner's value.
21513     *
21514     * This helps the user to get to a given value distant from the
21515     * current one easier/faster, as it will start to change quicker and
21516     * quicker on mouse button holds.
21517     *
21518     * The calculation for the next change interval value, starting from
21519     * the one set with this call, is the previous interval divided by
21520     * @c 1.05, so it decreases a little bit.
21521     *
21522     * The default starting interval value for automatic changes is
21523     * @c 0.85 seconds.
21524     *
21525     * @see elm_spinner_interval_get()
21526     *
21527     * @ingroup Spinner
21528     */
21529    EAPI void         elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21530
21531    /**
21532     * Get the interval on time updates for an user mouse button hold
21533     * on spinner widgets' arrows.
21534     *
21535     * @param obj The spinner object.
21536     * @return The (first) interval value, in seconds, set on it.
21537     *
21538     * @see elm_spinner_interval_set() for more details.
21539     *
21540     * @ingroup Spinner
21541     */
21542    EAPI double       elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21543
21544    /**
21545     * @}
21546     */
21547
21548    /**
21549     * @defgroup Index Index
21550     *
21551     * @image html img/widget/index/preview-00.png
21552     * @image latex img/widget/index/preview-00.eps
21553     *
21554     * An index widget gives you an index for fast access to whichever
21555     * group of other UI items one might have. It's a list of text
21556     * items (usually letters, for alphabetically ordered access).
21557     *
21558     * Index widgets are by default hidden and just appear when the
21559     * user clicks over it's reserved area in the canvas. In its
21560     * default theme, it's an area one @ref Fingers "finger" wide on
21561     * the right side of the index widget's container.
21562     *
21563     * When items on the index are selected, smart callbacks get
21564     * called, so that its user can make other container objects to
21565     * show a given area or child object depending on the index item
21566     * selected. You'd probably be using an index together with @ref
21567     * List "lists", @ref Genlist "generic lists" or @ref Gengrid
21568     * "general grids".
21569     *
21570     * Smart events one  can add callbacks for are:
21571     * - @c "changed" - When the selected index item changes. @c
21572     *      event_info is the selected item's data pointer.
21573     * - @c "delay,changed" - When the selected index item changes, but
21574     *      after a small idling period. @c event_info is the selected
21575     *      item's data pointer.
21576     * - @c "selected" - When the user releases a mouse button and
21577     *      selects an item. @c event_info is the selected item's data
21578     *      pointer.
21579     * - @c "level,up" - when the user moves a finger from the first
21580     *      level to the second level
21581     * - @c "level,down" - when the user moves a finger from the second
21582     *      level to the first level
21583     *
21584     * The @c "delay,changed" event is so that it'll wait a small time
21585     * before actually reporting those events and, moreover, just the
21586     * last event happening on those time frames will actually be
21587     * reported.
21588     *
21589     * Here are some examples on its usage:
21590     * @li @ref index_example_01
21591     * @li @ref index_example_02
21592     */
21593
21594    /**
21595     * @addtogroup Index
21596     * @{
21597     */
21598
21599    typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
21600
21601    /**
21602     * Add a new index widget to the given parent Elementary
21603     * (container) object
21604     *
21605     * @param parent The parent object
21606     * @return a new index widget handle or @c NULL, on errors
21607     *
21608     * This function inserts a new index widget on the canvas.
21609     *
21610     * @ingroup Index
21611     */
21612    EAPI Evas_Object    *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21613
21614    /**
21615     * Set whether a given index widget is or not visible,
21616     * programatically.
21617     *
21618     * @param obj The index object
21619     * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
21620     *
21621     * Not to be confused with visible as in @c evas_object_show() --
21622     * visible with regard to the widget's auto hiding feature.
21623     *
21624     * @see elm_index_active_get()
21625     *
21626     * @ingroup Index
21627     */
21628    EAPI void            elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
21629
21630    /**
21631     * Get whether a given index widget is currently visible or not.
21632     *
21633     * @param obj The index object
21634     * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
21635     *
21636     * @see elm_index_active_set() for more details
21637     *
21638     * @ingroup Index
21639     */
21640    EAPI Eina_Bool       elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21641
21642    /**
21643     * Set the items level for a given index widget.
21644     *
21645     * @param obj The index object.
21646     * @param level @c 0 or @c 1, the currently implemented levels.
21647     *
21648     * @see elm_index_item_level_get()
21649     *
21650     * @ingroup Index
21651     */
21652    EAPI void            elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21653
21654    /**
21655     * Get the items level set for a given index widget.
21656     *
21657     * @param obj The index object.
21658     * @return @c 0 or @c 1, which are the levels @p obj might be at.
21659     *
21660     * @see elm_index_item_level_set() for more information
21661     *
21662     * @ingroup Index
21663     */
21664    EAPI int             elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21665
21666    /**
21667     * Returns the last selected item's data, for a given index widget.
21668     *
21669     * @param obj The index object.
21670     * @return The item @b data associated to the last selected item on
21671     * @p obj (or @c NULL, on errors).
21672     *
21673     * @warning The returned value is @b not an #Elm_Index_Item item
21674     * handle, but the data associated to it (see the @c item parameter
21675     * in elm_index_item_append(), as an example).
21676     *
21677     * @ingroup Index
21678     */
21679    EAPI void           *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21680
21681    /**
21682     * Append a new item on a given index widget.
21683     *
21684     * @param obj The index object.
21685     * @param letter Letter under which the item should be indexed
21686     * @param item The item data to set for the index's item
21687     *
21688     * Despite the most common usage of the @p letter argument is for
21689     * single char strings, one could use arbitrary strings as index
21690     * entries.
21691     *
21692     * @c item will be the pointer returned back on @c "changed", @c
21693     * "delay,changed" and @c "selected" smart events.
21694     *
21695     * @ingroup Index
21696     */
21697    EAPI void            elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21698
21699    /**
21700     * Prepend a new item on a given index widget.
21701     *
21702     * @param obj The index object.
21703     * @param letter Letter under which the item should be indexed
21704     * @param item The item data to set for the index's item
21705     *
21706     * Despite the most common usage of the @p letter argument is for
21707     * single char strings, one could use arbitrary strings as index
21708     * entries.
21709     *
21710     * @c item will be the pointer returned back on @c "changed", @c
21711     * "delay,changed" and @c "selected" smart events.
21712     *
21713     * @ingroup Index
21714     */
21715    EAPI void            elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21716
21717    /**
21718     * Append a new item, on a given index widget, <b>after the item
21719     * having @p relative as data</b>.
21720     *
21721     * @param obj The index object.
21722     * @param letter Letter under which the item should be indexed
21723     * @param item The item data to set for the index's item
21724     * @param relative The item data of the index item to be the
21725     * predecessor of this new one
21726     *
21727     * Despite the most common usage of the @p letter argument is for
21728     * single char strings, one could use arbitrary strings as index
21729     * entries.
21730     *
21731     * @c item will be the pointer returned back on @c "changed", @c
21732     * "delay,changed" and @c "selected" smart events.
21733     *
21734     * @note If @p relative is @c NULL or if it's not found to be data
21735     * set on any previous item on @p obj, this function will behave as
21736     * elm_index_item_append().
21737     *
21738     * @ingroup Index
21739     */
21740    EAPI void            elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21741
21742    /**
21743     * Prepend a new item, on a given index widget, <b>after the item
21744     * having @p relative as data</b>.
21745     *
21746     * @param obj The index object.
21747     * @param letter Letter under which the item should be indexed
21748     * @param item The item data to set for the index's item
21749     * @param relative The item data of the index item to be the
21750     * successor of this new one
21751     *
21752     * Despite the most common usage of the @p letter argument is for
21753     * single char strings, one could use arbitrary strings as index
21754     * entries.
21755     *
21756     * @c item will be the pointer returned back on @c "changed", @c
21757     * "delay,changed" and @c "selected" smart events.
21758     *
21759     * @note If @p relative is @c NULL or if it's not found to be data
21760     * set on any previous item on @p obj, this function will behave as
21761     * elm_index_item_prepend().
21762     *
21763     * @ingroup Index
21764     */
21765    EAPI void            elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21766
21767    /**
21768     * Insert a new item into the given index widget, using @p cmp_func
21769     * function to sort items (by item handles).
21770     *
21771     * @param obj The index object.
21772     * @param letter Letter under which the item should be indexed
21773     * @param item The item data to set for the index's item
21774     * @param cmp_func The comparing function to be used to sort index
21775     * items <b>by #Elm_Index_Item item handles</b>
21776     * @param cmp_data_func A @b fallback function to be called for the
21777     * sorting of index items <b>by item data</b>). It will be used
21778     * when @p cmp_func returns @c 0 (equality), which means an index
21779     * item with provided item data already exists. To decide which
21780     * data item should be pointed to by the index item in question, @p
21781     * cmp_data_func will be used. If @p cmp_data_func returns a
21782     * non-negative value, the previous index item data will be
21783     * replaced by the given @p item pointer. If the previous data need
21784     * to be freed, it should be done by the @p cmp_data_func function,
21785     * because all references to it will be lost. If this function is
21786     * not provided (@c NULL is given), index items will be @b
21787     * duplicated, if @p cmp_func returns @c 0.
21788     *
21789     * Despite the most common usage of the @p letter argument is for
21790     * single char strings, one could use arbitrary strings as index
21791     * entries.
21792     *
21793     * @c item will be the pointer returned back on @c "changed", @c
21794     * "delay,changed" and @c "selected" smart events.
21795     *
21796     * @ingroup Index
21797     */
21798    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);
21799
21800    /**
21801     * Remove an item from a given index widget, <b>to be referenced by
21802     * it's data value</b>.
21803     *
21804     * @param obj The index object
21805     * @param item The item's data pointer for the item to be removed
21806     * from @p obj
21807     *
21808     * If a deletion callback is set, via elm_index_item_del_cb_set(),
21809     * that callback function will be called by this one.
21810     *
21811     * @warning The item to be removed from @p obj will be found via
21812     * its item data pointer, and not by an #Elm_Index_Item handle.
21813     *
21814     * @ingroup Index
21815     */
21816    EAPI void            elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
21817
21818    /**
21819     * Find a given index widget's item, <b>using item data</b>.
21820     *
21821     * @param obj The index object
21822     * @param item The item data pointed to by the desired index item
21823     * @return The index item handle, if found, or @c NULL otherwise
21824     *
21825     * @ingroup Index
21826     */
21827    EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
21828
21829    /**
21830     * Removes @b all items from a given index widget.
21831     *
21832     * @param obj The index object.
21833     *
21834     * If deletion callbacks are set, via elm_index_item_del_cb_set(),
21835     * that callback function will be called for each item in @p obj.
21836     *
21837     * @ingroup Index
21838     */
21839    EAPI void            elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
21840
21841    /**
21842     * Go to a given items level on a index widget
21843     *
21844     * @param obj The index object
21845     * @param level The index level (one of @c 0 or @c 1)
21846     *
21847     * @ingroup Index
21848     */
21849    EAPI void            elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21850
21851    /**
21852     * Return the data associated with a given index widget item
21853     *
21854     * @param it The index widget item handle
21855     * @return The data associated with @p it
21856     *
21857     * @see elm_index_item_data_set()
21858     *
21859     * @ingroup Index
21860     */
21861    EAPI void           *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
21862
21863    /**
21864     * Set the data associated with a given index widget item
21865     *
21866     * @param it The index widget item handle
21867     * @param data The new data pointer to set to @p it
21868     *
21869     * This sets new item data on @p it.
21870     *
21871     * @warning The old data pointer won't be touched by this function, so
21872     * the user had better to free that old data himself/herself.
21873     *
21874     * @ingroup Index
21875     */
21876    EAPI void            elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
21877
21878    /**
21879     * Set the function to be called when a given index widget item is freed.
21880     *
21881     * @param it The item to set the callback on
21882     * @param func The function to call on the item's deletion
21883     *
21884     * When called, @p func will have both @c data and @c event_info
21885     * arguments with the @p it item's data value and, naturally, the
21886     * @c obj argument with a handle to the parent index widget.
21887     *
21888     * @ingroup Index
21889     */
21890    EAPI void            elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
21891
21892    /**
21893     * Get the letter (string) set on a given index widget item.
21894     *
21895     * @param it The index item handle
21896     * @return The letter string set on @p it
21897     *
21898     * @ingroup Index
21899     */
21900    EAPI const char     *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
21901
21902    /**
21903     * @}
21904     */
21905
21906    /**
21907     * @defgroup Photocam Photocam
21908     *
21909     * @image html img/widget/photocam/preview-00.png
21910     * @image latex img/widget/photocam/preview-00.eps
21911     *
21912     * This is a widget specifically for displaying high-resolution digital
21913     * camera photos giving speedy feedback (fast load), low memory footprint
21914     * and zooming and panning as well as fitting logic. It is entirely focused
21915     * on jpeg images, and takes advantage of properties of the jpeg format (via
21916     * evas loader features in the jpeg loader).
21917     *
21918     * Signals that you can add callbacks for are:
21919     * @li "clicked" - This is called when a user has clicked the photo without
21920     *                 dragging around.
21921     * @li "press" - This is called when a user has pressed down on the photo.
21922     * @li "longpressed" - This is called when a user has pressed down on the
21923     *                     photo for a long time without dragging around.
21924     * @li "clicked,double" - This is called when a user has double-clicked the
21925     *                        photo.
21926     * @li "load" - Photo load begins.
21927     * @li "loaded" - This is called when the image file load is complete for the
21928     *                first view (low resolution blurry version).
21929     * @li "load,detail" - Photo detailed data load begins.
21930     * @li "loaded,detail" - This is called when the image file load is complete
21931     *                      for the detailed image data (full resolution needed).
21932     * @li "zoom,start" - Zoom animation started.
21933     * @li "zoom,stop" - Zoom animation stopped.
21934     * @li "zoom,change" - Zoom changed when using an auto zoom mode.
21935     * @li "scroll" - the content has been scrolled (moved)
21936     * @li "scroll,anim,start" - scrolling animation has started
21937     * @li "scroll,anim,stop" - scrolling animation has stopped
21938     * @li "scroll,drag,start" - dragging the contents around has started
21939     * @li "scroll,drag,stop" - dragging the contents around has stopped
21940     *
21941     * @ref tutorial_photocam shows the API in action.
21942     * @{
21943     */
21944    /**
21945     * @brief Types of zoom available.
21946     */
21947    typedef enum _Elm_Photocam_Zoom_Mode
21948      {
21949         ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
21950         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
21951         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
21952         ELM_PHOTOCAM_ZOOM_MODE_LAST
21953      } Elm_Photocam_Zoom_Mode;
21954    /**
21955     * @brief Add a new Photocam object
21956     *
21957     * @param parent The parent object
21958     * @return The new object or NULL if it cannot be created
21959     */
21960    EAPI Evas_Object           *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21961    /**
21962     * @brief Set the photo file to be shown
21963     *
21964     * @param obj The photocam object
21965     * @param file The photo file
21966     * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
21967     *
21968     * This sets (and shows) the specified file (with a relative or absolute
21969     * path) and will return a load error (same error that
21970     * evas_object_image_load_error_get() will return). The image will change and
21971     * adjust its size at this point and begin a background load process for this
21972     * photo that at some time in the future will be displayed at the full
21973     * quality needed.
21974     */
21975    EAPI Evas_Load_Error        elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
21976    /**
21977     * @brief Returns the path of the current image file
21978     *
21979     * @param obj The photocam object
21980     * @return Returns the path
21981     *
21982     * @see elm_photocam_file_set()
21983     */
21984    EAPI const char            *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21985    /**
21986     * @brief Set the zoom level of the photo
21987     *
21988     * @param obj The photocam object
21989     * @param zoom The zoom level to set
21990     *
21991     * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
21992     * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
21993     * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
21994     * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
21995     * 16, 32, etc.).
21996     */
21997    EAPI void                   elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
21998    /**
21999     * @brief Get the zoom level of the photo
22000     *
22001     * @param obj The photocam object
22002     * @return The current zoom level
22003     *
22004     * This returns the current zoom level of the photocam object. Note that if
22005     * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
22006     * (which is the default), the zoom level may be changed at any time by the
22007     * photocam object itself to account for photo size and photocam viewpoer
22008     * size.
22009     *
22010     * @see elm_photocam_zoom_set()
22011     * @see elm_photocam_zoom_mode_set()
22012     */
22013    EAPI double                 elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22014    /**
22015     * @brief Set the zoom mode
22016     *
22017     * @param obj The photocam object
22018     * @param mode The desired mode
22019     *
22020     * This sets the zoom mode to manual or one of several automatic levels.
22021     * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
22022     * elm_photocam_zoom_set() and will stay at that level until changed by code
22023     * or until zoom mode is changed. This is the default mode. The Automatic
22024     * modes will allow the photocam object to automatically adjust zoom mode
22025     * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
22026     * the photo fits EXACTLY inside the scroll frame with no pixels outside this
22027     * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
22028     * pixels within the frame are left unfilled.
22029     */
22030    EAPI void                   elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22031    /**
22032     * @brief Get the zoom mode
22033     *
22034     * @param obj The photocam object
22035     * @return The current zoom mode
22036     *
22037     * This gets the current zoom mode of the photocam object.
22038     *
22039     * @see elm_photocam_zoom_mode_set()
22040     */
22041    EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22042    /**
22043     * @brief Get the current image pixel width and height
22044     *
22045     * @param obj The photocam object
22046     * @param w A pointer to the width return
22047     * @param h A pointer to the height return
22048     *
22049     * This gets the current photo pixel width and height (for the original).
22050     * The size will be returned in the integers @p w and @p h that are pointed
22051     * to.
22052     */
22053    EAPI void                   elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
22054    /**
22055     * @brief Get the area of the image that is currently shown
22056     *
22057     * @param obj
22058     * @param x A pointer to the X-coordinate of region
22059     * @param y A pointer to the Y-coordinate of region
22060     * @param w A pointer to the width
22061     * @param h A pointer to the height
22062     *
22063     * @see elm_photocam_image_region_show()
22064     * @see elm_photocam_image_region_bring_in()
22065     */
22066    EAPI void                   elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
22067    /**
22068     * @brief Set the viewed portion of the image
22069     *
22070     * @param obj The photocam object
22071     * @param x X-coordinate of region in image original pixels
22072     * @param y Y-coordinate of region in image original pixels
22073     * @param w Width of region in image original pixels
22074     * @param h Height of region in image original pixels
22075     *
22076     * This shows the region of the image without using animation.
22077     */
22078    EAPI void                   elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22079    /**
22080     * @brief Bring in the viewed portion of the image
22081     *
22082     * @param obj The photocam object
22083     * @param x X-coordinate of region in image original pixels
22084     * @param y Y-coordinate of region in image original pixels
22085     * @param w Width of region in image original pixels
22086     * @param h Height of region in image original pixels
22087     *
22088     * This shows the region of the image using animation.
22089     */
22090    EAPI void                   elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22091    /**
22092     * @brief Set the paused state for photocam
22093     *
22094     * @param obj The photocam object
22095     * @param paused The pause state to set
22096     *
22097     * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
22098     * photocam. The default is off. This will stop zooming using animation on
22099     * zoom levels changes and change instantly. This will stop any existing
22100     * animations that are running.
22101     */
22102    EAPI void                   elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22103    /**
22104     * @brief Get the paused state for photocam
22105     *
22106     * @param obj The photocam object
22107     * @return The current paused state
22108     *
22109     * This gets the current paused state for the photocam object.
22110     *
22111     * @see elm_photocam_paused_set()
22112     */
22113    EAPI Eina_Bool              elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22114    /**
22115     * @brief Get the internal low-res image used for photocam
22116     *
22117     * @param obj The photocam object
22118     * @return The internal image object handle, or NULL if none exists
22119     *
22120     * This gets the internal image object inside photocam. Do not modify it. It
22121     * is for inspection only, and hooking callbacks to. Nothing else. It may be
22122     * deleted at any time as well.
22123     */
22124    EAPI Evas_Object           *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22125    /**
22126     * @brief Set the photocam scrolling bouncing.
22127     *
22128     * @param obj The photocam object
22129     * @param h_bounce bouncing for horizontal
22130     * @param v_bounce bouncing for vertical
22131     */
22132    EAPI void                   elm_photocam_bounce_set(Evas_Object *obj,  Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22133    /**
22134     * @brief Get the photocam scrolling bouncing.
22135     *
22136     * @param obj The photocam object
22137     * @param h_bounce bouncing for horizontal
22138     * @param v_bounce bouncing for vertical
22139     *
22140     * @see elm_photocam_bounce_set()
22141     */
22142    EAPI void                   elm_photocam_bounce_get(const Evas_Object *obj,  Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22143    /**
22144     * @}
22145     */
22146
22147    /**
22148     * @defgroup Map Map
22149     * @ingroup Elementary
22150     *
22151     * @image html img/widget/map/preview-00.png
22152     * @image latex img/widget/map/preview-00.eps
22153     *
22154     * This is a widget specifically for displaying a map. It uses basically
22155     * OpenStreetMap provider http://www.openstreetmap.org/,
22156     * but custom providers can be added.
22157     *
22158     * It supports some basic but yet nice features:
22159     * @li zoom and scroll
22160     * @li markers with content to be displayed when user clicks over it
22161     * @li group of markers
22162     * @li routes
22163     *
22164     * Smart callbacks one can listen to:
22165     *
22166     * - "clicked" - This is called when a user has clicked the map without
22167     *   dragging around.
22168     * - "press" - This is called when a user has pressed down on the map.
22169     * - "longpressed" - This is called when a user has pressed down on the map
22170     *   for a long time without dragging around.
22171     * - "clicked,double" - This is called when a user has double-clicked
22172     *   the map.
22173     * - "load,detail" - Map detailed data load begins.
22174     * - "loaded,detail" - This is called when all currently visible parts of
22175     *   the map are loaded.
22176     * - "zoom,start" - Zoom animation started.
22177     * - "zoom,stop" - Zoom animation stopped.
22178     * - "zoom,change" - Zoom changed when using an auto zoom mode.
22179     * - "scroll" - the content has been scrolled (moved).
22180     * - "scroll,anim,start" - scrolling animation has started.
22181     * - "scroll,anim,stop" - scrolling animation has stopped.
22182     * - "scroll,drag,start" - dragging the contents around has started.
22183     * - "scroll,drag,stop" - dragging the contents around has stopped.
22184     * - "downloaded" - This is called when all currently required map images
22185     *   are downloaded.
22186     * - "route,load" - This is called when route request begins.
22187     * - "route,loaded" - This is called when route request ends.
22188     * - "name,load" - This is called when name request begins.
22189     * - "name,loaded- This is called when name request ends.
22190     *
22191     * Available style for map widget:
22192     * - @c "default"
22193     *
22194     * Available style for markers:
22195     * - @c "radio"
22196     * - @c "radio2"
22197     * - @c "empty"
22198     *
22199     * Available style for marker bubble:
22200     * - @c "default"
22201     *
22202     * List of examples:
22203     * @li @ref map_example_01
22204     * @li @ref map_example_02
22205     * @li @ref map_example_03
22206     */
22207
22208    /**
22209     * @addtogroup Map
22210     * @{
22211     */
22212
22213    /**
22214     * @enum _Elm_Map_Zoom_Mode
22215     * @typedef Elm_Map_Zoom_Mode
22216     *
22217     * Set map's zoom behavior. It can be set to manual or automatic.
22218     *
22219     * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
22220     *
22221     * Values <b> don't </b> work as bitmask, only one can be choosen.
22222     *
22223     * @note Valid sizes are 2^zoom, consequently the map may be smaller
22224     * than the scroller view.
22225     *
22226     * @see elm_map_zoom_mode_set()
22227     * @see elm_map_zoom_mode_get()
22228     *
22229     * @ingroup Map
22230     */
22231    typedef enum _Elm_Map_Zoom_Mode
22232      {
22233         ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
22234         ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
22235         ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
22236         ELM_MAP_ZOOM_MODE_LAST
22237      } Elm_Map_Zoom_Mode;
22238
22239    /**
22240     * @enum _Elm_Map_Route_Sources
22241     * @typedef Elm_Map_Route_Sources
22242     *
22243     * Set route service to be used. By default used source is
22244     * #ELM_MAP_ROUTE_SOURCE_YOURS.
22245     *
22246     * @see elm_map_route_source_set()
22247     * @see elm_map_route_source_get()
22248     *
22249     * @ingroup Map
22250     */
22251    typedef enum _Elm_Map_Route_Sources
22252      {
22253         ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
22254         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. */
22255         ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
22256         ELM_MAP_ROUTE_SOURCE_LAST
22257      } Elm_Map_Route_Sources;
22258
22259    typedef enum _Elm_Map_Name_Sources
22260      {
22261         ELM_MAP_NAME_SOURCE_NOMINATIM,
22262         ELM_MAP_NAME_SOURCE_LAST
22263      } Elm_Map_Name_Sources;
22264
22265    /**
22266     * @enum _Elm_Map_Route_Type
22267     * @typedef Elm_Map_Route_Type
22268     *
22269     * Set type of transport used on route.
22270     *
22271     * @see elm_map_route_add()
22272     *
22273     * @ingroup Map
22274     */
22275    typedef enum _Elm_Map_Route_Type
22276      {
22277         ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
22278         ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
22279         ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
22280         ELM_MAP_ROUTE_TYPE_LAST
22281      } Elm_Map_Route_Type;
22282
22283    /**
22284     * @enum _Elm_Map_Route_Method
22285     * @typedef Elm_Map_Route_Method
22286     *
22287     * Set the routing method, what should be priorized, time or distance.
22288     *
22289     * @see elm_map_route_add()
22290     *
22291     * @ingroup Map
22292     */
22293    typedef enum _Elm_Map_Route_Method
22294      {
22295         ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
22296         ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
22297         ELM_MAP_ROUTE_METHOD_LAST
22298      } Elm_Map_Route_Method;
22299
22300    typedef enum _Elm_Map_Name_Method
22301      {
22302         ELM_MAP_NAME_METHOD_SEARCH,
22303         ELM_MAP_NAME_METHOD_REVERSE,
22304         ELM_MAP_NAME_METHOD_LAST
22305      } Elm_Map_Name_Method;
22306
22307    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(). */
22308    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(). */
22309    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(). */
22310    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(). */
22311    typedef struct _Elm_Map_Name            Elm_Map_Name; /**< A handle for specific coordinates. */
22312    typedef struct _Elm_Map_Track           Elm_Map_Track;
22313
22314    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. */
22315    typedef void         (*ElmMapMarkerDelFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
22316    typedef Evas_Object *(*ElmMapMarkerIconGetFunc)  (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
22317    typedef Evas_Object *(*ElmMapGroupIconGetFunc)   (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
22318
22319    typedef char        *(*ElmMapModuleSourceFunc) (void);
22320    typedef int          (*ElmMapModuleZoomMinFunc) (void);
22321    typedef int          (*ElmMapModuleZoomMaxFunc) (void);
22322    typedef char        *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
22323    typedef int          (*ElmMapModuleRouteSourceFunc) (void);
22324    typedef char        *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
22325    typedef char        *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
22326    typedef Eina_Bool    (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
22327    typedef Eina_Bool    (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
22328
22329    /**
22330     * Add a new map widget to the given parent Elementary (container) object.
22331     *
22332     * @param parent The parent object.
22333     * @return a new map widget handle or @c NULL, on errors.
22334     *
22335     * This function inserts a new map widget on the canvas.
22336     *
22337     * @ingroup Map
22338     */
22339    EAPI Evas_Object          *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22340
22341    /**
22342     * Set the zoom level of the map.
22343     *
22344     * @param obj The map object.
22345     * @param zoom The zoom level to set.
22346     *
22347     * This sets the zoom level.
22348     *
22349     * It will respect limits defined by elm_map_source_zoom_min_set() and
22350     * elm_map_source_zoom_max_set().
22351     *
22352     * By default these values are 0 (world map) and 18 (maximum zoom).
22353     *
22354     * This function should be used when zoom mode is set to
22355     * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22356     * with elm_map_zoom_mode_set().
22357     *
22358     * @see elm_map_zoom_mode_set().
22359     * @see elm_map_zoom_get().
22360     *
22361     * @ingroup Map
22362     */
22363    EAPI void                  elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22364
22365    /**
22366     * Get the zoom level of the map.
22367     *
22368     * @param obj The map object.
22369     * @return The current zoom level.
22370     *
22371     * This returns the current zoom level of the map object.
22372     *
22373     * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22374     * (which is the default), the zoom level may be changed at any time by the
22375     * map object itself to account for map size and map viewport size.
22376     *
22377     * @see elm_map_zoom_set() for details.
22378     *
22379     * @ingroup Map
22380     */
22381    EAPI int                   elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22382
22383    /**
22384     * Set the zoom mode used by the map object.
22385     *
22386     * @param obj The map object.
22387     * @param mode The zoom mode of the map, being it one of
22388     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22389     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22390     *
22391     * This sets the zoom mode to manual or one of the automatic levels.
22392     * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22393     * elm_map_zoom_set() and will stay at that level until changed by code
22394     * or until zoom mode is changed. This is the default mode.
22395     *
22396     * The Automatic modes will allow the map object to automatically
22397     * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22398     * adjust zoom so the map fits inside the scroll frame with no pixels
22399     * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22400     * ensure no pixels within the frame are left unfilled. Do not forget that
22401     * the valid sizes are 2^zoom, consequently the map may be smaller than
22402     * the scroller view.
22403     *
22404     * @see elm_map_zoom_set()
22405     *
22406     * @ingroup Map
22407     */
22408    EAPI void                  elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22409
22410    /**
22411     * Get the zoom mode used by the map object.
22412     *
22413     * @param obj The map object.
22414     * @return The zoom mode of the map, being it one of
22415     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22416     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22417     *
22418     * This function returns the current zoom mode used by the map object.
22419     *
22420     * @see elm_map_zoom_mode_set() for more details.
22421     *
22422     * @ingroup Map
22423     */
22424    EAPI Elm_Map_Zoom_Mode     elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22425
22426    /**
22427     * Get the current coordinates of the map.
22428     *
22429     * @param obj The map object.
22430     * @param lon Pointer where to store longitude.
22431     * @param lat Pointer where to store latitude.
22432     *
22433     * This gets the current center coordinates of the map object. It can be
22434     * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22435     *
22436     * @see elm_map_geo_region_bring_in()
22437     * @see elm_map_geo_region_show()
22438     *
22439     * @ingroup Map
22440     */
22441    EAPI void                  elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22442
22443    /**
22444     * Animatedly bring in given coordinates to the center of the map.
22445     *
22446     * @param obj The map object.
22447     * @param lon Longitude to center at.
22448     * @param lat Latitude to center at.
22449     *
22450     * This causes map to jump to the given @p lat and @p lon coordinates
22451     * and show it (by scrolling) in the center of the viewport, if it is not
22452     * already centered. This will use animation to do so and take a period
22453     * of time to complete.
22454     *
22455     * @see elm_map_geo_region_show() for a function to avoid animation.
22456     * @see elm_map_geo_region_get()
22457     *
22458     * @ingroup Map
22459     */
22460    EAPI void                  elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22461
22462    /**
22463     * Show the given coordinates at the center of the map, @b immediately.
22464     *
22465     * @param obj The map object.
22466     * @param lon Longitude to center at.
22467     * @param lat Latitude to center at.
22468     *
22469     * This causes map to @b redraw its viewport's contents to the
22470     * region contining the given @p lat and @p lon, that will be moved to the
22471     * center of the map.
22472     *
22473     * @see elm_map_geo_region_bring_in() for a function to move with animation.
22474     * @see elm_map_geo_region_get()
22475     *
22476     * @ingroup Map
22477     */
22478    EAPI void                  elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22479
22480    /**
22481     * Pause or unpause the map.
22482     *
22483     * @param obj The map object.
22484     * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
22485     * to unpause it.
22486     *
22487     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22488     * for map.
22489     *
22490     * The default is off.
22491     *
22492     * This will stop zooming using animation, changing zoom levels will
22493     * change instantly. This will stop any existing animations that are running.
22494     *
22495     * @see elm_map_paused_get()
22496     *
22497     * @ingroup Map
22498     */
22499    EAPI void                  elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22500
22501    /**
22502     * Get a value whether map is paused or not.
22503     *
22504     * @param obj The map object.
22505     * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
22506     * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22507     *
22508     * This gets the current paused state for the map object.
22509     *
22510     * @see elm_map_paused_set() for details.
22511     *
22512     * @ingroup Map
22513     */
22514    EAPI Eina_Bool             elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22515
22516    /**
22517     * Set to show markers during zoom level changes or not.
22518     *
22519     * @param obj The map object.
22520     * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
22521     * to show them.
22522     *
22523     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22524     * for map.
22525     *
22526     * The default is off.
22527     *
22528     * This will stop zooming using animation, changing zoom levels will
22529     * change instantly. This will stop any existing animations that are running.
22530     *
22531     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22532     * for the markers.
22533     *
22534     * The default  is off.
22535     *
22536     * Enabling it will force the map to stop displaying the markers during
22537     * zoom level changes. Set to on if you have a large number of markers.
22538     *
22539     * @see elm_map_paused_markers_get()
22540     *
22541     * @ingroup Map
22542     */
22543    EAPI void                  elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22544
22545    /**
22546     * Get a value whether markers will be displayed on zoom level changes or not
22547     *
22548     * @param obj The map object.
22549     * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
22550     * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
22551     *
22552     * This gets the current markers paused state for the map object.
22553     *
22554     * @see elm_map_paused_markers_set() for details.
22555     *
22556     * @ingroup Map
22557     */
22558    EAPI Eina_Bool             elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22559
22560    /**
22561     * Get the information of downloading status.
22562     *
22563     * @param obj The map object.
22564     * @param try_num Pointer where to store number of tiles being downloaded.
22565     * @param finish_num Pointer where to store number of tiles successfully
22566     * downloaded.
22567     *
22568     * This gets the current downloading status for the map object, the number
22569     * of tiles being downloaded and the number of tiles already downloaded.
22570     *
22571     * @ingroup Map
22572     */
22573    EAPI void                  elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
22574
22575    /**
22576     * Convert a pixel coordinate (x,y) into a geographic coordinate
22577     * (longitude, latitude).
22578     *
22579     * @param obj The map object.
22580     * @param x the coordinate.
22581     * @param y the coordinate.
22582     * @param size the size in pixels of the map.
22583     * The map is a square and generally his size is : pow(2.0, zoom)*256.
22584     * @param lon Pointer where to store the longitude that correspond to x.
22585     * @param lat Pointer where to store the latitude that correspond to y.
22586     *
22587     * @note Origin pixel point is the top left corner of the viewport.
22588     * Map zoom and size are taken on account.
22589     *
22590     * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
22591     *
22592     * @ingroup Map
22593     */
22594    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);
22595
22596    /**
22597     * Convert a geographic coordinate (longitude, latitude) into a pixel
22598     * coordinate (x, y).
22599     *
22600     * @param obj The map object.
22601     * @param lon the longitude.
22602     * @param lat the latitude.
22603     * @param size the size in pixels of the map. The map is a square
22604     * and generally his size is : pow(2.0, zoom)*256.
22605     * @param x Pointer where to store the horizontal pixel coordinate that
22606     * correspond to the longitude.
22607     * @param y Pointer where to store the vertical pixel coordinate that
22608     * correspond to the latitude.
22609     *
22610     * @note Origin pixel point is the top left corner of the viewport.
22611     * Map zoom and size are taken on account.
22612     *
22613     * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
22614     *
22615     * @ingroup Map
22616     */
22617    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);
22618
22619    /**
22620     * Convert a geographic coordinate (longitude, latitude) into a name
22621     * (address).
22622     *
22623     * @param obj The map object.
22624     * @param lon the longitude.
22625     * @param lat the latitude.
22626     * @return name A #Elm_Map_Name handle for this coordinate.
22627     *
22628     * To get the string for this address, elm_map_name_address_get()
22629     * should be used.
22630     *
22631     * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
22632     *
22633     * @ingroup Map
22634     */
22635    EAPI Elm_Map_Name         *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22636
22637    /**
22638     * Convert a name (address) into a geographic coordinate
22639     * (longitude, latitude).
22640     *
22641     * @param obj The map object.
22642     * @param name The address.
22643     * @return name A #Elm_Map_Name handle for this address.
22644     *
22645     * To get the longitude and latitude, elm_map_name_region_get()
22646     * should be used.
22647     *
22648     * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
22649     *
22650     * @ingroup Map
22651     */
22652    EAPI Elm_Map_Name         *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
22653
22654    /**
22655     * Convert a pixel coordinate into a rotated pixel coordinate.
22656     *
22657     * @param obj The map object.
22658     * @param x horizontal coordinate of the point to rotate.
22659     * @param y vertical coordinate of the point to rotate.
22660     * @param cx rotation's center horizontal position.
22661     * @param cy rotation's center vertical position.
22662     * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
22663     * @param xx Pointer where to store rotated x.
22664     * @param yy Pointer where to store rotated y.
22665     *
22666     * @ingroup Map
22667     */
22668    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);
22669
22670    /**
22671     * Add a new marker to the map object.
22672     *
22673     * @param obj The map object.
22674     * @param lon The longitude of the marker.
22675     * @param lat The latitude of the marker.
22676     * @param clas The class, to use when marker @b isn't grouped to others.
22677     * @param clas_group The class group, to use when marker is grouped to others
22678     * @param data The data passed to the callbacks.
22679     *
22680     * @return The created marker or @c NULL upon failure.
22681     *
22682     * A marker will be created and shown in a specific point of the map, defined
22683     * by @p lon and @p lat.
22684     *
22685     * It will be displayed using style defined by @p class when this marker
22686     * is displayed alone (not grouped). A new class can be created with
22687     * elm_map_marker_class_new().
22688     *
22689     * If the marker is grouped to other markers, it will be displayed with
22690     * style defined by @p class_group. Markers with the same group are grouped
22691     * if they are close. A new group class can be created with
22692     * elm_map_marker_group_class_new().
22693     *
22694     * Markers created with this method can be deleted with
22695     * elm_map_marker_remove().
22696     *
22697     * A marker can have associated content to be displayed by a bubble,
22698     * when a user click over it, as well as an icon. These objects will
22699     * be fetch using class' callback functions.
22700     *
22701     * @see elm_map_marker_class_new()
22702     * @see elm_map_marker_group_class_new()
22703     * @see elm_map_marker_remove()
22704     *
22705     * @ingroup Map
22706     */
22707    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);
22708
22709    /**
22710     * Set the maximum numbers of markers' content to be displayed in a group.
22711     *
22712     * @param obj The map object.
22713     * @param max The maximum numbers of items displayed in a bubble.
22714     *
22715     * A bubble will be displayed when the user clicks over the group,
22716     * and will place the content of markers that belong to this group
22717     * inside it.
22718     *
22719     * A group can have a long list of markers, consequently the creation
22720     * of the content of the bubble can be very slow.
22721     *
22722     * In order to avoid this, a maximum number of items is displayed
22723     * in a bubble.
22724     *
22725     * By default this number is 30.
22726     *
22727     * Marker with the same group class are grouped if they are close.
22728     *
22729     * @see elm_map_marker_add()
22730     *
22731     * @ingroup Map
22732     */
22733    EAPI void                  elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
22734
22735    /**
22736     * Remove a marker from the map.
22737     *
22738     * @param marker The marker to remove.
22739     *
22740     * @see elm_map_marker_add()
22741     *
22742     * @ingroup Map
22743     */
22744    EAPI void                  elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22745
22746    /**
22747     * Get the current coordinates of the marker.
22748     *
22749     * @param marker marker.
22750     * @param lat Pointer where to store the marker's latitude.
22751     * @param lon Pointer where to store the marker's longitude.
22752     *
22753     * These values are set when adding markers, with function
22754     * elm_map_marker_add().
22755     *
22756     * @see elm_map_marker_add()
22757     *
22758     * @ingroup Map
22759     */
22760    EAPI void                  elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
22761
22762    /**
22763     * Animatedly bring in given marker to the center of the map.
22764     *
22765     * @param marker The marker to center at.
22766     *
22767     * This causes map to jump to the given @p marker's coordinates
22768     * and show it (by scrolling) in the center of the viewport, if it is not
22769     * already centered. This will use animation to do so and take a period
22770     * of time to complete.
22771     *
22772     * @see elm_map_marker_show() for a function to avoid animation.
22773     * @see elm_map_marker_region_get()
22774     *
22775     * @ingroup Map
22776     */
22777    EAPI void                  elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22778
22779    /**
22780     * Show the given marker at the center of the map, @b immediately.
22781     *
22782     * @param marker The marker to center at.
22783     *
22784     * This causes map to @b redraw its viewport's contents to the
22785     * region contining the given @p marker's coordinates, that will be
22786     * moved to the center of the map.
22787     *
22788     * @see elm_map_marker_bring_in() for a function to move with animation.
22789     * @see elm_map_markers_list_show() if more than one marker need to be
22790     * displayed.
22791     * @see elm_map_marker_region_get()
22792     *
22793     * @ingroup Map
22794     */
22795    EAPI void                  elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22796
22797    /**
22798     * Move and zoom the map to display a list of markers.
22799     *
22800     * @param markers A list of #Elm_Map_Marker handles.
22801     *
22802     * The map will be centered on the center point of the markers in the list.
22803     * Then the map will be zoomed in order to fit the markers using the maximum
22804     * zoom which allows display of all the markers.
22805     *
22806     * @warning All the markers should belong to the same map object.
22807     *
22808     * @see elm_map_marker_show() to show a single marker.
22809     * @see elm_map_marker_bring_in()
22810     *
22811     * @ingroup Map
22812     */
22813    EAPI void                  elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
22814
22815    /**
22816     * Get the Evas object returned by the ElmMapMarkerGetFunc callback
22817     *
22818     * @param marker The marker wich content should be returned.
22819     * @return Return the evas object if it exists, else @c NULL.
22820     *
22821     * To set callback function #ElmMapMarkerGetFunc for the marker class,
22822     * elm_map_marker_class_get_cb_set() should be used.
22823     *
22824     * This content is what will be inside the bubble that will be displayed
22825     * when an user clicks over the marker.
22826     *
22827     * This returns the actual Evas object used to be placed inside
22828     * the bubble. This may be @c NULL, as it may
22829     * not have been created or may have been deleted, at any time, by
22830     * the map. <b>Do not modify this object</b> (move, resize,
22831     * show, hide, etc.), as the map is controlling it. This
22832     * function is for querying, emitting custom signals or hooking
22833     * lower level callbacks for events on that object. Do not delete
22834     * this object under any circumstances.
22835     *
22836     * @ingroup Map
22837     */
22838    EAPI Evas_Object          *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22839
22840    /**
22841     * Update the marker
22842     *
22843     * @param marker The marker to be updated.
22844     *
22845     * If a content is set to this marker, it will call function to delete it,
22846     * #ElmMapMarkerDelFunc, and then will fetch the content again with
22847     * #ElmMapMarkerGetFunc.
22848     *
22849     * These functions are set for the marker class with
22850     * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
22851     *
22852     * @ingroup Map
22853     */
22854    EAPI void                  elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22855
22856    /**
22857     * Close all the bubbles opened by the user.
22858     *
22859     * @param obj The map object.
22860     *
22861     * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
22862     * when the user clicks on a marker.
22863     *
22864     * This functions is set for the marker class with
22865     * elm_map_marker_class_get_cb_set().
22866     *
22867     * @ingroup Map
22868     */
22869    EAPI void                  elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
22870
22871    /**
22872     * Create a new group class.
22873     *
22874     * @param obj The map object.
22875     * @return Returns the new group class.
22876     *
22877     * Each marker must be associated to a group class. Markers in the same
22878     * group are grouped if they are close.
22879     *
22880     * The group class defines the style of the marker when a marker is grouped
22881     * to others markers. When it is alone, another class will be used.
22882     *
22883     * A group class will need to be provided when creating a marker with
22884     * elm_map_marker_add().
22885     *
22886     * Some properties and functions can be set by class, as:
22887     * - style, with elm_map_group_class_style_set()
22888     * - data - to be associated to the group class. It can be set using
22889     *   elm_map_group_class_data_set().
22890     * - min zoom to display markers, set with
22891     *   elm_map_group_class_zoom_displayed_set().
22892     * - max zoom to group markers, set using
22893     *   elm_map_group_class_zoom_grouped_set().
22894     * - visibility - set if markers will be visible or not, set with
22895     *   elm_map_group_class_hide_set().
22896     * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
22897     *   It can be set using elm_map_group_class_icon_cb_set().
22898     *
22899     * @see elm_map_marker_add()
22900     * @see elm_map_group_class_style_set()
22901     * @see elm_map_group_class_data_set()
22902     * @see elm_map_group_class_zoom_displayed_set()
22903     * @see elm_map_group_class_zoom_grouped_set()
22904     * @see elm_map_group_class_hide_set()
22905     * @see elm_map_group_class_icon_cb_set()
22906     *
22907     * @ingroup Map
22908     */
22909    EAPI Elm_Map_Group_Class  *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
22910
22911    /**
22912     * Set the marker's style of a group class.
22913     *
22914     * @param clas The group class.
22915     * @param style The style to be used by markers.
22916     *
22917     * Each marker must be associated to a group class, and will use the style
22918     * defined by such class when grouped to other markers.
22919     *
22920     * The following styles are provided by default theme:
22921     * @li @c radio - blue circle
22922     * @li @c radio2 - green circle
22923     * @li @c empty
22924     *
22925     * @see elm_map_group_class_new() for more details.
22926     * @see elm_map_marker_add()
22927     *
22928     * @ingroup Map
22929     */
22930    EAPI void                  elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
22931
22932    /**
22933     * Set the icon callback function of a group class.
22934     *
22935     * @param clas The group class.
22936     * @param icon_get The callback function that will return the icon.
22937     *
22938     * Each marker must be associated to a group class, and it can display a
22939     * custom icon. The function @p icon_get must return this icon.
22940     *
22941     * @see elm_map_group_class_new() for more details.
22942     * @see elm_map_marker_add()
22943     *
22944     * @ingroup Map
22945     */
22946    EAPI void                  elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
22947
22948    /**
22949     * Set the data associated to the group class.
22950     *
22951     * @param clas The group class.
22952     * @param data The new user data.
22953     *
22954     * This data will be passed for callback functions, like icon get callback,
22955     * that can be set with elm_map_group_class_icon_cb_set().
22956     *
22957     * If a data was previously set, the object will lose the pointer for it,
22958     * so if needs to be freed, you must do it yourself.
22959     *
22960     * @see elm_map_group_class_new() for more details.
22961     * @see elm_map_group_class_icon_cb_set()
22962     * @see elm_map_marker_add()
22963     *
22964     * @ingroup Map
22965     */
22966    EAPI void                  elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
22967
22968    /**
22969     * Set the minimum zoom from where the markers are displayed.
22970     *
22971     * @param clas The group class.
22972     * @param zoom The minimum zoom.
22973     *
22974     * Markers only will be displayed when the map is displayed at @p zoom
22975     * or bigger.
22976     *
22977     * @see elm_map_group_class_new() for more details.
22978     * @see elm_map_marker_add()
22979     *
22980     * @ingroup Map
22981     */
22982    EAPI void                  elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
22983
22984    /**
22985     * Set the zoom from where the markers are no more grouped.
22986     *
22987     * @param clas The group class.
22988     * @param zoom The maximum zoom.
22989     *
22990     * Markers only will be grouped when the map is displayed at
22991     * less than @p zoom.
22992     *
22993     * @see elm_map_group_class_new() for more details.
22994     * @see elm_map_marker_add()
22995     *
22996     * @ingroup Map
22997     */
22998    EAPI void                  elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
22999
23000    /**
23001     * Set if the markers associated to the group class @clas are hidden or not.
23002     *
23003     * @param clas The group class.
23004     * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
23005     * to show them.
23006     *
23007     * If @p hide is @c EINA_TRUE the markers will be hidden, but default
23008     * is to show them.
23009     *
23010     * @ingroup Map
23011     */
23012    EAPI void                  elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
23013
23014    /**
23015     * Create a new marker class.
23016     *
23017     * @param obj The map object.
23018     * @return Returns the new group class.
23019     *
23020     * Each marker must be associated to a class.
23021     *
23022     * The marker class defines the style of the marker when a marker is
23023     * displayed alone, i.e., not grouped to to others markers. When grouped
23024     * it will use group class style.
23025     *
23026     * A marker class will need to be provided when creating a marker with
23027     * elm_map_marker_add().
23028     *
23029     * Some properties and functions can be set by class, as:
23030     * - style, with elm_map_marker_class_style_set()
23031     * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
23032     *   It can be set using elm_map_marker_class_icon_cb_set().
23033     * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
23034     *   Set using elm_map_marker_class_get_cb_set().
23035     * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
23036     *   Set using elm_map_marker_class_del_cb_set().
23037     *
23038     * @see elm_map_marker_add()
23039     * @see elm_map_marker_class_style_set()
23040     * @see elm_map_marker_class_icon_cb_set()
23041     * @see elm_map_marker_class_get_cb_set()
23042     * @see elm_map_marker_class_del_cb_set()
23043     *
23044     * @ingroup Map
23045     */
23046    EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23047
23048    /**
23049     * Set the marker's style of a marker class.
23050     *
23051     * @param clas The marker class.
23052     * @param style The style to be used by markers.
23053     *
23054     * Each marker must be associated to a marker class, and will use the style
23055     * defined by such class when alone, i.e., @b not grouped to other markers.
23056     *
23057     * The following styles are provided by default theme:
23058     * @li @c radio
23059     * @li @c radio2
23060     * @li @c empty
23061     *
23062     * @see elm_map_marker_class_new() for more details.
23063     * @see elm_map_marker_add()
23064     *
23065     * @ingroup Map
23066     */
23067    EAPI void                  elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23068
23069    /**
23070     * Set the icon callback function of a marker class.
23071     *
23072     * @param clas The marker class.
23073     * @param icon_get The callback function that will return the icon.
23074     *
23075     * Each marker must be associated to a marker class, and it can display a
23076     * custom icon. The function @p icon_get must return this icon.
23077     *
23078     * @see elm_map_marker_class_new() for more details.
23079     * @see elm_map_marker_add()
23080     *
23081     * @ingroup Map
23082     */
23083    EAPI void                  elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23084
23085    /**
23086     * Set the bubble content callback function of a marker class.
23087     *
23088     * @param clas The marker class.
23089     * @param get The callback function that will return the content.
23090     *
23091     * Each marker must be associated to a marker class, and it can display a
23092     * a content on a bubble that opens when the user click over the marker.
23093     * The function @p get must return this content object.
23094     *
23095     * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
23096     * can be used.
23097     *
23098     * @see elm_map_marker_class_new() for more details.
23099     * @see elm_map_marker_class_del_cb_set()
23100     * @see elm_map_marker_add()
23101     *
23102     * @ingroup Map
23103     */
23104    EAPI void                  elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
23105
23106    /**
23107     * Set the callback function used to delete bubble content of a marker class.
23108     *
23109     * @param clas The marker class.
23110     * @param del The callback function that will delete the content.
23111     *
23112     * Each marker must be associated to a marker class, and it can display a
23113     * a content on a bubble that opens when the user click over the marker.
23114     * The function to return such content can be set with
23115     * elm_map_marker_class_get_cb_set().
23116     *
23117     * If this content must be freed, a callback function need to be
23118     * set for that task with this function.
23119     *
23120     * If this callback is defined it will have to delete (or not) the
23121     * object inside, but if the callback is not defined the object will be
23122     * destroyed with evas_object_del().
23123     *
23124     * @see elm_map_marker_class_new() for more details.
23125     * @see elm_map_marker_class_get_cb_set()
23126     * @see elm_map_marker_add()
23127     *
23128     * @ingroup Map
23129     */
23130    EAPI void                  elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
23131
23132    /**
23133     * Get the list of available sources.
23134     *
23135     * @param obj The map object.
23136     * @return The source names list.
23137     *
23138     * It will provide a list with all available sources, that can be set as
23139     * current source with elm_map_source_name_set(), or get with
23140     * elm_map_source_name_get().
23141     *
23142     * Available sources:
23143     * @li "Mapnik"
23144     * @li "Osmarender"
23145     * @li "CycleMap"
23146     * @li "Maplint"
23147     *
23148     * @see elm_map_source_name_set() for more details.
23149     * @see elm_map_source_name_get()
23150     *
23151     * @ingroup Map
23152     */
23153    EAPI const char          **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23154
23155    /**
23156     * Set the source of the map.
23157     *
23158     * @param obj The map object.
23159     * @param source The source to be used.
23160     *
23161     * Map widget retrieves images that composes the map from a web service.
23162     * This web service can be set with this method.
23163     *
23164     * A different service can return a different maps with different
23165     * information and it can use different zoom values.
23166     *
23167     * The @p source_name need to match one of the names provided by
23168     * elm_map_source_names_get().
23169     *
23170     * The current source can be get using elm_map_source_name_get().
23171     *
23172     * @see elm_map_source_names_get()
23173     * @see elm_map_source_name_get()
23174     *
23175     *
23176     * @ingroup Map
23177     */
23178    EAPI void                  elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
23179
23180    /**
23181     * Get the name of currently used source.
23182     *
23183     * @param obj The map object.
23184     * @return Returns the name of the source in use.
23185     *
23186     * @see elm_map_source_name_set() for more details.
23187     *
23188     * @ingroup Map
23189     */
23190    EAPI const char           *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23191
23192    /**
23193     * Set the source of the route service to be used by the map.
23194     *
23195     * @param obj The map object.
23196     * @param source The route service to be used, being it one of
23197     * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
23198     * and #ELM_MAP_ROUTE_SOURCE_ORS.
23199     *
23200     * Each one has its own algorithm, so the route retrieved may
23201     * differ depending on the source route. Now, only the default is working.
23202     *
23203     * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
23204     * http://www.yournavigation.org/.
23205     *
23206     * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
23207     * assumptions. Its routing core is based on Contraction Hierarchies.
23208     *
23209     * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
23210     *
23211     * @see elm_map_route_source_get().
23212     *
23213     * @ingroup Map
23214     */
23215    EAPI void                  elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
23216
23217    /**
23218     * Get the current route source.
23219     *
23220     * @param obj The map object.
23221     * @return The source of the route service used by the map.
23222     *
23223     * @see elm_map_route_source_set() for details.
23224     *
23225     * @ingroup Map
23226     */
23227    EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23228
23229    /**
23230     * Set the minimum zoom of the source.
23231     *
23232     * @param obj The map object.
23233     * @param zoom New minimum zoom value to be used.
23234     *
23235     * By default, it's 0.
23236     *
23237     * @ingroup Map
23238     */
23239    EAPI void                  elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23240
23241    /**
23242     * Get the minimum zoom of the source.
23243     *
23244     * @param obj The map object.
23245     * @return Returns the minimum zoom of the source.
23246     *
23247     * @see elm_map_source_zoom_min_set() for details.
23248     *
23249     * @ingroup Map
23250     */
23251    EAPI int                   elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23252
23253    /**
23254     * Set the maximum zoom of the source.
23255     *
23256     * @param obj The map object.
23257     * @param zoom New maximum zoom value to be used.
23258     *
23259     * By default, it's 18.
23260     *
23261     * @ingroup Map
23262     */
23263    EAPI void                  elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23264
23265    /**
23266     * Get the maximum zoom of the source.
23267     *
23268     * @param obj The map object.
23269     * @return Returns the maximum zoom of the source.
23270     *
23271     * @see elm_map_source_zoom_min_set() for details.
23272     *
23273     * @ingroup Map
23274     */
23275    EAPI int                   elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23276
23277    /**
23278     * Set the user agent used by the map object to access routing services.
23279     *
23280     * @param obj The map object.
23281     * @param user_agent The user agent to be used by the map.
23282     *
23283     * User agent is a client application implementing a network protocol used
23284     * in communications within a client–server distributed computing system
23285     *
23286     * The @p user_agent identification string will transmitted in a header
23287     * field @c User-Agent.
23288     *
23289     * @see elm_map_user_agent_get()
23290     *
23291     * @ingroup Map
23292     */
23293    EAPI void                  elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
23294
23295    /**
23296     * Get the user agent used by the map object.
23297     *
23298     * @param obj The map object.
23299     * @return The user agent identification string used by the map.
23300     *
23301     * @see elm_map_user_agent_set() for details.
23302     *
23303     * @ingroup Map
23304     */
23305    EAPI const char           *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23306
23307    /**
23308     * Add a new route to the map object.
23309     *
23310     * @param obj The map object.
23311     * @param type The type of transport to be considered when tracing a route.
23312     * @param method The routing method, what should be priorized.
23313     * @param flon The start longitude.
23314     * @param flat The start latitude.
23315     * @param tlon The destination longitude.
23316     * @param tlat The destination latitude.
23317     *
23318     * @return The created route or @c NULL upon failure.
23319     *
23320     * A route will be traced by point on coordinates (@p flat, @p flon)
23321     * to point on coordinates (@p tlat, @p tlon), using the route service
23322     * set with elm_map_route_source_set().
23323     *
23324     * It will take @p type on consideration to define the route,
23325     * depending if the user will be walking or driving, the route may vary.
23326     * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
23327     * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
23328     *
23329     * Another parameter is what the route should priorize, the minor distance
23330     * or the less time to be spend on the route. So @p method should be one
23331     * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
23332     *
23333     * Routes created with this method can be deleted with
23334     * elm_map_route_remove(), colored with elm_map_route_color_set(),
23335     * and distance can be get with elm_map_route_distance_get().
23336     *
23337     * @see elm_map_route_remove()
23338     * @see elm_map_route_color_set()
23339     * @see elm_map_route_distance_get()
23340     * @see elm_map_route_source_set()
23341     *
23342     * @ingroup Map
23343     */
23344    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);
23345
23346    /**
23347     * Remove a route from the map.
23348     *
23349     * @param route The route to remove.
23350     *
23351     * @see elm_map_route_add()
23352     *
23353     * @ingroup Map
23354     */
23355    EAPI void                  elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23356
23357    /**
23358     * Set the route color.
23359     *
23360     * @param route The route object.
23361     * @param r Red channel value, from 0 to 255.
23362     * @param g Green channel value, from 0 to 255.
23363     * @param b Blue channel value, from 0 to 255.
23364     * @param a Alpha channel value, from 0 to 255.
23365     *
23366     * It uses an additive color model, so each color channel represents
23367     * how much of each primary colors must to be used. 0 represents
23368     * ausence of this color, so if all of the three are set to 0,
23369     * the color will be black.
23370     *
23371     * These component values should be integers in the range 0 to 255,
23372     * (single 8-bit byte).
23373     *
23374     * This sets the color used for the route. By default, it is set to
23375     * solid red (r = 255, g = 0, b = 0, a = 255).
23376     *
23377     * For alpha channel, 0 represents completely transparent, and 255, opaque.
23378     *
23379     * @see elm_map_route_color_get()
23380     *
23381     * @ingroup Map
23382     */
23383    EAPI void                  elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23384
23385    /**
23386     * Get the route color.
23387     *
23388     * @param route The route object.
23389     * @param r Pointer where to store the red channel value.
23390     * @param g Pointer where to store the green channel value.
23391     * @param b Pointer where to store the blue channel value.
23392     * @param a Pointer where to store the alpha channel value.
23393     *
23394     * @see elm_map_route_color_set() for details.
23395     *
23396     * @ingroup Map
23397     */
23398    EAPI void                  elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23399
23400    /**
23401     * Get the route distance in kilometers.
23402     *
23403     * @param route The route object.
23404     * @return The distance of route (unit : km).
23405     *
23406     * @ingroup Map
23407     */
23408    EAPI double                elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23409
23410    /**
23411     * Get the information of route nodes.
23412     *
23413     * @param route The route object.
23414     * @return Returns a string with the nodes of route.
23415     *
23416     * @ingroup Map
23417     */
23418    EAPI const char           *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23419
23420    /**
23421     * Get the information of route waypoint.
23422     *
23423     * @param route the route object.
23424     * @return Returns a string with information about waypoint of route.
23425     *
23426     * @ingroup Map
23427     */
23428    EAPI const char           *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23429
23430    /**
23431     * Get the address of the name.
23432     *
23433     * @param name The name handle.
23434     * @return Returns the address string of @p name.
23435     *
23436     * This gets the coordinates of the @p name, created with one of the
23437     * conversion functions.
23438     *
23439     * @see elm_map_utils_convert_name_into_coord()
23440     * @see elm_map_utils_convert_coord_into_name()
23441     *
23442     * @ingroup Map
23443     */
23444    EAPI const char           *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23445
23446    /**
23447     * Get the current coordinates of the name.
23448     *
23449     * @param name The name handle.
23450     * @param lat Pointer where to store the latitude.
23451     * @param lon Pointer where to store The longitude.
23452     *
23453     * This gets the coordinates of the @p name, created with one of the
23454     * conversion functions.
23455     *
23456     * @see elm_map_utils_convert_name_into_coord()
23457     * @see elm_map_utils_convert_coord_into_name()
23458     *
23459     * @ingroup Map
23460     */
23461    EAPI void                  elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
23462
23463    /**
23464     * Remove a name from the map.
23465     *
23466     * @param name The name to remove.
23467     *
23468     * Basically the struct handled by @p name will be freed, so convertions
23469     * between address and coordinates will be lost.
23470     *
23471     * @see elm_map_utils_convert_name_into_coord()
23472     * @see elm_map_utils_convert_coord_into_name()
23473     *
23474     * @ingroup Map
23475     */
23476    EAPI void                  elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23477
23478    /**
23479     * Rotate the map.
23480     *
23481     * @param obj The map object.
23482     * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
23483     * @param cx Rotation's center horizontal position.
23484     * @param cy Rotation's center vertical position.
23485     *
23486     * @see elm_map_rotate_get()
23487     *
23488     * @ingroup Map
23489     */
23490    EAPI void                  elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
23491
23492    /**
23493     * Get the rotate degree of the map
23494     *
23495     * @param obj The map object
23496     * @param degree Pointer where to store degrees from 0.0 to 360.0
23497     * to rotate arount Z axis.
23498     * @param cx Pointer where to store rotation's center horizontal position.
23499     * @param cy Pointer where to store rotation's center vertical position.
23500     *
23501     * @see elm_map_rotate_set() to set map rotation.
23502     *
23503     * @ingroup Map
23504     */
23505    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);
23506
23507    /**
23508     * Enable or disable mouse wheel to be used to zoom in / out the map.
23509     *
23510     * @param obj The map object.
23511     * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
23512     * to enable it.
23513     *
23514     * Mouse wheel can be used for the user to zoom in or zoom out the map.
23515     *
23516     * It's disabled by default.
23517     *
23518     * @see elm_map_wheel_disabled_get()
23519     *
23520     * @ingroup Map
23521     */
23522    EAPI void                  elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23523
23524    /**
23525     * Get a value whether mouse wheel is enabled or not.
23526     *
23527     * @param obj The map object.
23528     * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
23529     * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23530     *
23531     * Mouse wheel can be used for the user to zoom in or zoom out the map.
23532     *
23533     * @see elm_map_wheel_disabled_set() for details.
23534     *
23535     * @ingroup Map
23536     */
23537    EAPI Eina_Bool             elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23538
23539 #ifdef ELM_EMAP
23540    /**
23541     * Add a track on the map
23542     *
23543     * @param obj The map object.
23544     * @param emap The emap route object.
23545     * @return The route object. This is an elm object of type Route.
23546     *
23547     * @see elm_route_add() for details.
23548     *
23549     * @ingroup Map
23550     */
23551    EAPI Evas_Object          *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
23552 #endif
23553
23554    /**
23555     * Remove a track from the map
23556     *
23557     * @param obj The map object.
23558     * @param route The track to remove.
23559     *
23560     * @ingroup Map
23561     */
23562    EAPI void                  elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
23563
23564    /**
23565     * @}
23566     */
23567
23568    /* Route */
23569    EAPI Evas_Object *elm_route_add(Evas_Object *parent);
23570 #ifdef ELM_EMAP
23571    EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
23572 #endif
23573    EAPI double elm_route_lon_min_get(Evas_Object *obj);
23574    EAPI double elm_route_lat_min_get(Evas_Object *obj);
23575    EAPI double elm_route_lon_max_get(Evas_Object *obj);
23576    EAPI double elm_route_lat_max_get(Evas_Object *obj);
23577
23578
23579    /**
23580     * @defgroup Panel Panel
23581     *
23582     * @image html img/widget/panel/preview-00.png
23583     * @image latex img/widget/panel/preview-00.eps
23584     *
23585     * @brief A panel is a type of animated container that contains subobjects.
23586     * It can be expanded or contracted by clicking the button on it's edge.
23587     *
23588     * Orientations are as follows:
23589     * @li ELM_PANEL_ORIENT_TOP
23590     * @li ELM_PANEL_ORIENT_LEFT
23591     * @li ELM_PANEL_ORIENT_RIGHT
23592     *
23593     * @ref tutorial_panel shows one way to use this widget.
23594     * @{
23595     */
23596    typedef enum _Elm_Panel_Orient
23597      {
23598         ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
23599         ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
23600         ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
23601         ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
23602      } Elm_Panel_Orient;
23603    /**
23604     * @brief Adds a panel object
23605     *
23606     * @param parent The parent object
23607     *
23608     * @return The panel object, or NULL on failure
23609     */
23610    EAPI Evas_Object          *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23611    /**
23612     * @brief Sets the orientation of the panel
23613     *
23614     * @param parent The parent object
23615     * @param orient The panel orientation. Can be one of the following:
23616     * @li ELM_PANEL_ORIENT_TOP
23617     * @li ELM_PANEL_ORIENT_LEFT
23618     * @li ELM_PANEL_ORIENT_RIGHT
23619     *
23620     * Sets from where the panel will (dis)appear.
23621     */
23622    EAPI void                  elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
23623    /**
23624     * @brief Get the orientation of the panel.
23625     *
23626     * @param obj The panel object
23627     * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
23628     */
23629    EAPI Elm_Panel_Orient      elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23630    /**
23631     * @brief Set the content of the panel.
23632     *
23633     * @param obj The panel object
23634     * @param content The panel content
23635     *
23636     * Once the content object is set, a previously set one will be deleted.
23637     * If you want to keep that old content object, use the
23638     * elm_panel_content_unset() function.
23639     */
23640    EAPI void                  elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23641    /**
23642     * @brief Get the content of the panel.
23643     *
23644     * @param obj The panel object
23645     * @return The content that is being used
23646     *
23647     * Return the content object which is set for this widget.
23648     *
23649     * @see elm_panel_content_set()
23650     */
23651    EAPI Evas_Object          *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23652    /**
23653     * @brief Unset the content of the panel.
23654     *
23655     * @param obj The panel object
23656     * @return The content that was being used
23657     *
23658     * Unparent and return the content object which was set for this widget.
23659     *
23660     * @see elm_panel_content_set()
23661     */
23662    EAPI Evas_Object          *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23663    /**
23664     * @brief Set the state of the panel.
23665     *
23666     * @param obj The panel object
23667     * @param hidden If true, the panel will run the animation to contract
23668     */
23669    EAPI void                  elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
23670    /**
23671     * @brief Get the state of the panel.
23672     *
23673     * @param obj The panel object
23674     * @param hidden If true, the panel is in the "hide" state
23675     */
23676    EAPI Eina_Bool             elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23677    /**
23678     * @brief Toggle the hidden state of the panel from code
23679     *
23680     * @param obj The panel object
23681     */
23682    EAPI void                  elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
23683    /**
23684     * @}
23685     */
23686
23687    /**
23688     * @defgroup Panes Panes
23689     * @ingroup Elementary
23690     *
23691     * @image html img/widget/panes/preview-00.png
23692     * @image latex img/widget/panes/preview-00.eps width=\textwidth
23693     *
23694     * @image html img/panes.png
23695     * @image latex img/panes.eps width=\textwidth
23696     *
23697     * The panes adds a dragable bar between two contents. When dragged
23698     * this bar will resize contents size.
23699     *
23700     * Panes can be displayed vertically or horizontally, and contents
23701     * size proportion can be customized (homogeneous by default).
23702     *
23703     * Smart callbacks one can listen to:
23704     * - "press" - The panes has been pressed (button wasn't released yet).
23705     * - "unpressed" - The panes was released after being pressed.
23706     * - "clicked" - The panes has been clicked>
23707     * - "clicked,double" - The panes has been double clicked
23708     *
23709     * Available styles for it:
23710     * - @c "default"
23711     *
23712     * Here is an example on its usage:
23713     * @li @ref panes_example
23714     */
23715
23716    /**
23717     * @addtogroup Panes
23718     * @{
23719     */
23720
23721    /**
23722     * Add a new panes widget to the given parent Elementary
23723     * (container) object.
23724     *
23725     * @param parent The parent object.
23726     * @return a new panes widget handle or @c NULL, on errors.
23727     *
23728     * This function inserts a new panes widget on the canvas.
23729     *
23730     * @ingroup Panes
23731     */
23732    EAPI Evas_Object          *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23733
23734    /**
23735     * Set the left content of the panes widget.
23736     *
23737     * @param obj The panes object.
23738     * @param content The new left content object.
23739     *
23740     * Once the content object is set, a previously set one will be deleted.
23741     * If you want to keep that old content object, use the
23742     * elm_panes_content_left_unset() function.
23743     *
23744     * If panes is displayed vertically, left content will be displayed at
23745     * top.
23746     *
23747     * @see elm_panes_content_left_get()
23748     * @see elm_panes_content_right_set() to set content on the other side.
23749     *
23750     * @ingroup Panes
23751     */
23752    EAPI void                  elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23753
23754    /**
23755     * Set the right content of the panes widget.
23756     *
23757     * @param obj The panes object.
23758     * @param content The new right content object.
23759     *
23760     * Once the content object is set, a previously set one will be deleted.
23761     * If you want to keep that old content object, use the
23762     * elm_panes_content_right_unset() function.
23763     *
23764     * If panes is displayed vertically, left content will be displayed at
23765     * bottom.
23766     *
23767     * @see elm_panes_content_right_get()
23768     * @see elm_panes_content_left_set() to set content on the other side.
23769     *
23770     * @ingroup Panes
23771     */
23772    EAPI void                  elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23773
23774    /**
23775     * Get the left content of the panes.
23776     *
23777     * @param obj The panes object.
23778     * @return The left content object that is being used.
23779     *
23780     * Return the left content object which is set for this widget.
23781     *
23782     * @see elm_panes_content_left_set() for details.
23783     *
23784     * @ingroup Panes
23785     */
23786    EAPI Evas_Object          *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23787
23788    /**
23789     * Get the right content of the panes.
23790     *
23791     * @param obj The panes object
23792     * @return The right content object that is being used
23793     *
23794     * Return the right content object which is set for this widget.
23795     *
23796     * @see elm_panes_content_right_set() for details.
23797     *
23798     * @ingroup Panes
23799     */
23800    EAPI Evas_Object          *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23801
23802    /**
23803     * Unset the left content used for the panes.
23804     *
23805     * @param obj The panes object.
23806     * @return The left content object that was being used.
23807     *
23808     * Unparent and return the left content object which was set for this widget.
23809     *
23810     * @see elm_panes_content_left_set() for details.
23811     * @see elm_panes_content_left_get().
23812     *
23813     * @ingroup Panes
23814     */
23815    EAPI Evas_Object          *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23816
23817    /**
23818     * Unset the right content used for the panes.
23819     *
23820     * @param obj The panes object.
23821     * @return The right content object that was being used.
23822     *
23823     * Unparent and return the right content object which was set for this
23824     * widget.
23825     *
23826     * @see elm_panes_content_right_set() for details.
23827     * @see elm_panes_content_right_get().
23828     *
23829     * @ingroup Panes
23830     */
23831    EAPI Evas_Object          *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23832
23833    /**
23834     * Get the size proportion of panes widget's left side.
23835     *
23836     * @param obj The panes object.
23837     * @return float value between 0.0 and 1.0 representing size proportion
23838     * of left side.
23839     *
23840     * @see elm_panes_content_left_size_set() for more details.
23841     *
23842     * @ingroup Panes
23843     */
23844    EAPI double                elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23845
23846    /**
23847     * Set the size proportion of panes widget's left side.
23848     *
23849     * @param obj The panes object.
23850     * @param size Value between 0.0 and 1.0 representing size proportion
23851     * of left side.
23852     *
23853     * By default it's homogeneous, i.e., both sides have the same size.
23854     *
23855     * If something different is required, it can be set with this function.
23856     * For example, if the left content should be displayed over
23857     * 75% of the panes size, @p size should be passed as @c 0.75.
23858     * This way, right content will be resized to 25% of panes size.
23859     *
23860     * If displayed vertically, left content is displayed at top, and
23861     * right content at bottom.
23862     *
23863     * @note This proportion will change when user drags the panes bar.
23864     *
23865     * @see elm_panes_content_left_size_get()
23866     *
23867     * @ingroup Panes
23868     */
23869    EAPI void                  elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
23870
23871   /**
23872    * Set the orientation of a given panes widget.
23873    *
23874    * @param obj The panes object.
23875    * @param horizontal Use @c EINA_TRUE to make @p obj to be
23876    * @b horizontal, @c EINA_FALSE to make it @b vertical.
23877    *
23878    * Use this function to change how your panes is to be
23879    * disposed: vertically or horizontally.
23880    *
23881    * By default it's displayed horizontally.
23882    *
23883    * @see elm_panes_horizontal_get()
23884    *
23885    * @ingroup Panes
23886    */
23887    EAPI void                  elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
23888
23889    /**
23890     * Retrieve the orientation of a given panes widget.
23891     *
23892     * @param obj The panes object.
23893     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
23894     * @c EINA_FALSE if it's @b vertical (and on errors).
23895     *
23896     * @see elm_panes_horizontal_set() for more details.
23897     *
23898     * @ingroup Panes
23899     */
23900    EAPI Eina_Bool             elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23901    EAPI void                  elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
23902    EAPI Eina_Bool             elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23903
23904    /**
23905     * @}
23906     */
23907
23908    /**
23909     * @defgroup Flip Flip
23910     *
23911     * @image html img/widget/flip/preview-00.png
23912     * @image latex img/widget/flip/preview-00.eps
23913     *
23914     * This widget holds 2 content objects(Evas_Object): one on the front and one
23915     * on the back. It allows you to flip from front to back and vice-versa using
23916     * various animations.
23917     *
23918     * If either the front or back contents are not set the flip will treat that
23919     * as transparent. So if you wore to set the front content but not the back,
23920     * and then call elm_flip_go() you would see whatever is below the flip.
23921     *
23922     * For a list of supported animations see elm_flip_go().
23923     *
23924     * Signals that you can add callbacks for are:
23925     * "animate,begin" - when a flip animation was started
23926     * "animate,done" - when a flip animation is finished
23927     *
23928     * @ref tutorial_flip show how to use most of the API.
23929     *
23930     * @{
23931     */
23932    typedef enum _Elm_Flip_Mode
23933      {
23934         ELM_FLIP_ROTATE_Y_CENTER_AXIS,
23935         ELM_FLIP_ROTATE_X_CENTER_AXIS,
23936         ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
23937         ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
23938         ELM_FLIP_CUBE_LEFT,
23939         ELM_FLIP_CUBE_RIGHT,
23940         ELM_FLIP_CUBE_UP,
23941         ELM_FLIP_CUBE_DOWN,
23942         ELM_FLIP_PAGE_LEFT,
23943         ELM_FLIP_PAGE_RIGHT,
23944         ELM_FLIP_PAGE_UP,
23945         ELM_FLIP_PAGE_DOWN
23946      } Elm_Flip_Mode;
23947    typedef enum _Elm_Flip_Interaction
23948      {
23949         ELM_FLIP_INTERACTION_NONE,
23950         ELM_FLIP_INTERACTION_ROTATE,
23951         ELM_FLIP_INTERACTION_CUBE,
23952         ELM_FLIP_INTERACTION_PAGE
23953      } Elm_Flip_Interaction;
23954    typedef enum _Elm_Flip_Direction
23955      {
23956         ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
23957         ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
23958         ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
23959         ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
23960      } Elm_Flip_Direction;
23961    /**
23962     * @brief Add a new flip to the parent
23963     *
23964     * @param parent The parent object
23965     * @return The new object or NULL if it cannot be created
23966     */
23967    EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23968    /**
23969     * @brief Set the front content of the flip widget.
23970     *
23971     * @param obj The flip object
23972     * @param content The new front content object
23973     *
23974     * Once the content object is set, a previously set one will be deleted.
23975     * If you want to keep that old content object, use the
23976     * elm_flip_content_front_unset() function.
23977     */
23978    EAPI void         elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23979    /**
23980     * @brief Set the back content of the flip widget.
23981     *
23982     * @param obj The flip object
23983     * @param content The new back content object
23984     *
23985     * Once the content object is set, a previously set one will be deleted.
23986     * If you want to keep that old content object, use the
23987     * elm_flip_content_back_unset() function.
23988     */
23989    EAPI void         elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23990    /**
23991     * @brief Get the front content used for the flip
23992     *
23993     * @param obj The flip object
23994     * @return The front content object that is being used
23995     *
23996     * Return the front content object which is set for this widget.
23997     */
23998    EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23999    /**
24000     * @brief Get the back content used for the flip
24001     *
24002     * @param obj The flip object
24003     * @return The back content object that is being used
24004     *
24005     * Return the back content object which is set for this widget.
24006     */
24007    EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24008    /**
24009     * @brief Unset the front content used for the flip
24010     *
24011     * @param obj The flip object
24012     * @return The front content object that was being used
24013     *
24014     * Unparent and return the front content object which was set for this widget.
24015     */
24016    EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24017    /**
24018     * @brief Unset the back content used for the flip
24019     *
24020     * @param obj The flip object
24021     * @return The back content object that was being used
24022     *
24023     * Unparent and return the back content object which was set for this widget.
24024     */
24025    EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24026    /**
24027     * @brief Get flip front visibility state
24028     *
24029     * @param obj The flip objct
24030     * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
24031     * showing.
24032     */
24033    EAPI Eina_Bool    elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24034    /**
24035     * @brief Set flip perspective
24036     *
24037     * @param obj The flip object
24038     * @param foc The coordinate to set the focus on
24039     * @param x The X coordinate
24040     * @param y The Y coordinate
24041     *
24042     * @warning This function currently does nothing.
24043     */
24044    EAPI void         elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
24045    /**
24046     * @brief Runs the flip animation
24047     *
24048     * @param obj The flip object
24049     * @param mode The mode type
24050     *
24051     * Flips the front and back contents using the @p mode animation. This
24052     * efectively hides the currently visible content and shows the hidden one.
24053     *
24054     * There a number of possible animations to use for the flipping:
24055     * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
24056     * around a horizontal axis in the middle of its height, the other content
24057     * is shown as the other side of the flip.
24058     * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
24059     * around a vertical axis in the middle of its width, the other content is
24060     * shown as the other side of the flip.
24061     * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
24062     * around a diagonal axis in the middle of its width, the other content is
24063     * shown as the other side of the flip.
24064     * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
24065     * around a diagonal axis in the middle of its height, the other content is
24066     * shown as the other side of the flip.
24067     * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
24068     * as if the flip was a cube, the other content is show as the right face of
24069     * the cube.
24070     * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
24071     * right as if the flip was a cube, the other content is show as the left
24072     * face of the cube.
24073     * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
24074     * flip was a cube, the other content is show as the bottom face of the cube.
24075     * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
24076     * the flip was a cube, the other content is show as the upper face of the
24077     * cube.
24078     * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
24079     * if the flip was a book, the other content is shown as the page below that.
24080     * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
24081     * as if the flip was a book, the other content is shown as the page below
24082     * that.
24083     * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
24084     * flip was a book, the other content is shown as the page below that.
24085     * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
24086     * flip was a book, the other content is shown as the page below that.
24087     *
24088     * @image html elm_flip.png
24089     * @image latex elm_flip.eps width=\textwidth
24090     */
24091    EAPI void         elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
24092    /**
24093     * @brief Set the interactive flip mode
24094     *
24095     * @param obj The flip object
24096     * @param mode The interactive flip mode to use
24097     *
24098     * This sets if the flip should be interactive (allow user to click and
24099     * drag a side of the flip to reveal the back page and cause it to flip).
24100     * By default a flip is not interactive. You may also need to set which
24101     * sides of the flip are "active" for flipping and how much space they use
24102     * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
24103     * and elm_flip_interacton_direction_hitsize_set()
24104     *
24105     * The four avilable mode of interaction are:
24106     * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
24107     * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
24108     * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
24109     * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
24110     *
24111     * @note ELM_FLIP_INTERACTION_ROTATE won't cause
24112     * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
24113     * happen, those can only be acheived with elm_flip_go();
24114     */
24115    EAPI void         elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
24116    /**
24117     * @brief Get the interactive flip mode
24118     *
24119     * @param obj The flip object
24120     * @return The interactive flip mode
24121     *
24122     * Returns the interactive flip mode set by elm_flip_interaction_set()
24123     */
24124    EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
24125    /**
24126     * @brief Set which directions of the flip respond to interactive flip
24127     *
24128     * @param obj The flip object
24129     * @param dir The direction to change
24130     * @param enabled If that direction is enabled or not
24131     *
24132     * By default all directions are disabled, so you may want to enable the
24133     * desired directions for flipping if you need interactive flipping. You must
24134     * call this function once for each direction that should be enabled.
24135     *
24136     * @see elm_flip_interaction_set()
24137     */
24138    EAPI void         elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
24139    /**
24140     * @brief Get the enabled state of that flip direction
24141     *
24142     * @param obj The flip object
24143     * @param dir The direction to check
24144     * @return If that direction is enabled or not
24145     *
24146     * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
24147     *
24148     * @see elm_flip_interaction_set()
24149     */
24150    EAPI Eina_Bool    elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
24151    /**
24152     * @brief Set the amount of the flip that is sensitive to interactive flip
24153     *
24154     * @param obj The flip object
24155     * @param dir The direction to modify
24156     * @param hitsize The amount of that dimension (0.0 to 1.0) to use
24157     *
24158     * Set the amount of the flip that is sensitive to interactive flip, with 0
24159     * representing no area in the flip and 1 representing the entire flip. There
24160     * is however a consideration to be made in that the area will never be
24161     * smaller than the finger size set(as set in your Elementary configuration).
24162     *
24163     * @see elm_flip_interaction_set()
24164     */
24165    EAPI void         elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
24166    /**
24167     * @brief Get the amount of the flip that is sensitive to interactive flip
24168     *
24169     * @param obj The flip object
24170     * @param dir The direction to check
24171     * @return The size set for that direction
24172     *
24173     * Returns the amount os sensitive area set by
24174     * elm_flip_interacton_direction_hitsize_set().
24175     */
24176    EAPI double       elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
24177    /**
24178     * @}
24179     */
24180
24181    /* scrolledentry */
24182    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24183    EINA_DEPRECATED EAPI void         elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
24184    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24185    EINA_DEPRECATED EAPI void         elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
24186    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24187    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24188    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24189    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24190    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24191    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24192    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24193    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
24194    EINA_DEPRECATED EAPI void         elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
24195    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24196    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
24197    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
24198    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24199    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24200    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
24201    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
24202    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24203    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24204    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24205    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24206    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
24207    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
24208    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24209    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24210    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24211    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24212    EINA_DEPRECATED EAPI int          elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24213    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
24214    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
24215    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
24216    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24217    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);
24218    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24219    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24220    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);
24221    EINA_DEPRECATED EAPI void         elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24222    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);
24223    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
24224    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24225    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24226    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24227    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
24228    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24229    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24230    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24231    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);
24232    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);
24233    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);
24234    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);
24235    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);
24236    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);
24237    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
24238    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
24239    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
24240    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
24241    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24242    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
24243    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
24244
24245    /**
24246     * @defgroup Conformant Conformant
24247     * @ingroup Elementary
24248     *
24249     * @image html img/widget/conformant/preview-00.png
24250     * @image latex img/widget/conformant/preview-00.eps width=\textwidth
24251     *
24252     * @image html img/conformant.png
24253     * @image latex img/conformant.eps width=\textwidth
24254     *
24255     * The aim is to provide a widget that can be used in elementary apps to
24256     * account for space taken up by the indicator, virtual keypad & softkey
24257     * windows when running the illume2 module of E17.
24258     *
24259     * So conformant content will be sized and positioned considering the
24260     * space required for such stuff, and when they popup, as a keyboard
24261     * shows when an entry is selected, conformant content won't change.
24262     *
24263     * Available styles for it:
24264     * - @c "default"
24265     *
24266     * See how to use this widget in this example:
24267     * @ref conformant_example
24268     */
24269
24270    /**
24271     * @addtogroup Conformant
24272     * @{
24273     */
24274
24275    /**
24276     * Add a new conformant widget to the given parent Elementary
24277     * (container) object.
24278     *
24279     * @param parent The parent object.
24280     * @return A new conformant widget handle or @c NULL, on errors.
24281     *
24282     * This function inserts a new conformant widget on the canvas.
24283     *
24284     * @ingroup Conformant
24285     */
24286    EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24287
24288    /**
24289     * Set the content of the conformant widget.
24290     *
24291     * @param obj The conformant object.
24292     * @param content The content to be displayed by the conformant.
24293     *
24294     * Content will be sized and positioned considering the space required
24295     * to display a virtual keyboard. So it won't fill all the conformant
24296     * size. This way is possible to be sure that content won't resize
24297     * or be re-positioned after the keyboard is displayed.
24298     *
24299     * Once the content object is set, a previously set one will be deleted.
24300     * If you want to keep that old content object, use the
24301     * elm_conformat_content_unset() function.
24302     *
24303     * @see elm_conformant_content_unset()
24304     * @see elm_conformant_content_get()
24305     *
24306     * @ingroup Conformant
24307     */
24308    EAPI void         elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24309
24310    /**
24311     * Get the content of the conformant widget.
24312     *
24313     * @param obj The conformant object.
24314     * @return The content that is being used.
24315     *
24316     * Return the content object which is set for this widget.
24317     * It won't be unparent from conformant. For that, use
24318     * elm_conformant_content_unset().
24319     *
24320     * @see elm_conformant_content_set() for more details.
24321     * @see elm_conformant_content_unset()
24322     *
24323     * @ingroup Conformant
24324     */
24325    EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24326
24327    /**
24328     * Unset the content of the conformant widget.
24329     *
24330     * @param obj The conformant object.
24331     * @return The content that was being used.
24332     *
24333     * Unparent and return the content object which was set for this widget.
24334     *
24335     * @see elm_conformant_content_set() for more details.
24336     *
24337     * @ingroup Conformant
24338     */
24339    EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24340
24341    /**
24342     * Returns the Evas_Object that represents the content area.
24343     *
24344     * @param obj The conformant object.
24345     * @return The content area of the widget.
24346     *
24347     * @ingroup Conformant
24348     */
24349    EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24350
24351    /**
24352     * @}
24353     */
24354
24355    /**
24356     * @defgroup Mapbuf Mapbuf
24357     * @ingroup Elementary
24358     *
24359     * @image html img/widget/mapbuf/preview-00.png
24360     * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24361     *
24362     * This holds one content object and uses an Evas Map of transformation
24363     * points to be later used with this content. So the content will be
24364     * moved, resized, etc as a single image. So it will improve performance
24365     * when you have a complex interafce, with a lot of elements, and will
24366     * need to resize or move it frequently (the content object and its
24367     * children).
24368     *
24369     * See how to use this widget in this example:
24370     * @ref mapbuf_example
24371     */
24372
24373    /**
24374     * @addtogroup Mapbuf
24375     * @{
24376     */
24377
24378    /**
24379     * Add a new mapbuf widget to the given parent Elementary
24380     * (container) object.
24381     *
24382     * @param parent The parent object.
24383     * @return A new mapbuf widget handle or @c NULL, on errors.
24384     *
24385     * This function inserts a new mapbuf widget on the canvas.
24386     *
24387     * @ingroup Mapbuf
24388     */
24389    EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24390
24391    /**
24392     * Set the content of the mapbuf.
24393     *
24394     * @param obj The mapbuf object.
24395     * @param content The content that will be filled in this mapbuf object.
24396     *
24397     * Once the content object is set, a previously set one will be deleted.
24398     * If you want to keep that old content object, use the
24399     * elm_mapbuf_content_unset() function.
24400     *
24401     * To enable map, elm_mapbuf_enabled_set() should be used.
24402     *
24403     * @ingroup Mapbuf
24404     */
24405    EAPI void         elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24406
24407    /**
24408     * Get the content of the mapbuf.
24409     *
24410     * @param obj The mapbuf object.
24411     * @return The content that is being used.
24412     *
24413     * Return the content object which is set for this widget.
24414     *
24415     * @see elm_mapbuf_content_set() for details.
24416     *
24417     * @ingroup Mapbuf
24418     */
24419    EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24420
24421    /**
24422     * Unset the content of the mapbuf.
24423     *
24424     * @param obj The mapbuf object.
24425     * @return The content that was being used.
24426     *
24427     * Unparent and return the content object which was set for this widget.
24428     *
24429     * @see elm_mapbuf_content_set() for details.
24430     *
24431     * @ingroup Mapbuf
24432     */
24433    EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24434
24435    /**
24436     * Enable or disable the map.
24437     *
24438     * @param obj The mapbuf object.
24439     * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
24440     *
24441     * This enables the map that is set or disables it. On enable, the object
24442     * geometry will be saved, and the new geometry will change (position and
24443     * size) to reflect the map geometry set.
24444     *
24445     * Also, when enabled, alpha and smooth states will be used, so if the
24446     * content isn't solid, alpha should be enabled, for example, otherwise
24447     * a black retangle will fill the content.
24448     *
24449     * When disabled, the stored map will be freed and geometry prior to
24450     * enabling the map will be restored.
24451     *
24452     * It's disabled by default.
24453     *
24454     * @see elm_mapbuf_alpha_set()
24455     * @see elm_mapbuf_smooth_set()
24456     *
24457     * @ingroup Mapbuf
24458     */
24459    EAPI void         elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24460
24461    /**
24462     * Get a value whether map is enabled or not.
24463     *
24464     * @param obj The mapbuf object.
24465     * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
24466     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24467     *
24468     * @see elm_mapbuf_enabled_set() for details.
24469     *
24470     * @ingroup Mapbuf
24471     */
24472    EAPI Eina_Bool    elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24473
24474    /**
24475     * Enable or disable smooth map rendering.
24476     *
24477     * @param obj The mapbuf object.
24478     * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
24479     * to disable it.
24480     *
24481     * This sets smoothing for map rendering. If the object is a type that has
24482     * its own smoothing settings, then both the smooth settings for this object
24483     * and the map must be turned off.
24484     *
24485     * By default smooth maps are enabled.
24486     *
24487     * @ingroup Mapbuf
24488     */
24489    EAPI void         elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
24490
24491    /**
24492     * Get a value whether smooth map rendering is enabled or not.
24493     *
24494     * @param obj The mapbuf object.
24495     * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
24496     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24497     *
24498     * @see elm_mapbuf_smooth_set() for details.
24499     *
24500     * @ingroup Mapbuf
24501     */
24502    EAPI Eina_Bool    elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24503
24504    /**
24505     * Set or unset alpha flag for map rendering.
24506     *
24507     * @param obj The mapbuf object.
24508     * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
24509     * to disable it.
24510     *
24511     * This sets alpha flag for map rendering. If the object is a type that has
24512     * its own alpha settings, then this will take precedence. Only image objects
24513     * have this currently. It stops alpha blending of the map area, and is
24514     * useful if you know the object and/or all sub-objects is 100% solid.
24515     *
24516     * Alpha is enabled by default.
24517     *
24518     * @ingroup Mapbuf
24519     */
24520    EAPI void         elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
24521
24522    /**
24523     * Get a value whether alpha blending is enabled or not.
24524     *
24525     * @param obj The mapbuf object.
24526     * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
24527     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24528     *
24529     * @see elm_mapbuf_alpha_set() for details.
24530     *
24531     * @ingroup Mapbuf
24532     */
24533    EAPI Eina_Bool    elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24534
24535    /**
24536     * @}
24537     */
24538
24539    /**
24540     * @defgroup Flipselector Flip Selector
24541     *
24542     * @image html img/widget/flipselector/preview-00.png
24543     * @image latex img/widget/flipselector/preview-00.eps
24544     *
24545     * A flip selector is a widget to show a set of @b text items, one
24546     * at a time, with the same sheet switching style as the @ref Clock
24547     * "clock" widget, when one changes the current displaying sheet
24548     * (thus, the "flip" in the name).
24549     *
24550     * User clicks to flip sheets which are @b held for some time will
24551     * make the flip selector to flip continuosly and automatically for
24552     * the user. The interval between flips will keep growing in time,
24553     * so that it helps the user to reach an item which is distant from
24554     * the current selection.
24555     *
24556     * Smart callbacks one can register to:
24557     * - @c "selected" - when the widget's selected text item is changed
24558     * - @c "overflowed" - when the widget's current selection is changed
24559     *   from the first item in its list to the last
24560     * - @c "underflowed" - when the widget's current selection is changed
24561     *   from the last item in its list to the first
24562     *
24563     * Available styles for it:
24564     * - @c "default"
24565     *
24566     * Here is an example on its usage:
24567     * @li @ref flipselector_example
24568     */
24569
24570    /**
24571     * @addtogroup Flipselector
24572     * @{
24573     */
24574
24575    typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
24576
24577    /**
24578     * Add a new flip selector widget to the given parent Elementary
24579     * (container) widget
24580     *
24581     * @param parent The parent object
24582     * @return a new flip selector widget handle or @c NULL, on errors
24583     *
24584     * This function inserts a new flip selector widget on the canvas.
24585     *
24586     * @ingroup Flipselector
24587     */
24588    EAPI Evas_Object               *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24589
24590    /**
24591     * Programmatically select the next item of a flip selector widget
24592     *
24593     * @param obj The flipselector object
24594     *
24595     * @note The selection will be animated. Also, if it reaches the
24596     * end of its list of member items, it will continue with the first
24597     * one onwards.
24598     *
24599     * @ingroup Flipselector
24600     */
24601    EAPI void                       elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24602
24603    /**
24604     * Programmatically select the previous item of a flip selector
24605     * widget
24606     *
24607     * @param obj The flipselector object
24608     *
24609     * @note The selection will be animated.  Also, if it reaches the
24610     * beginning of its list of member items, it will continue with the
24611     * last one backwards.
24612     *
24613     * @ingroup Flipselector
24614     */
24615    EAPI void                       elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24616
24617    /**
24618     * Append a (text) item to a flip selector widget
24619     *
24620     * @param obj The flipselector object
24621     * @param label The (text) label of the new item
24622     * @param func Convenience callback function to take place when
24623     * item is selected
24624     * @param data Data passed to @p func, above
24625     * @return A handle to the item added or @c NULL, on errors
24626     *
24627     * The widget's list of labels to show will be appended with the
24628     * given value. If the user wishes so, a callback function pointer
24629     * can be passed, which will get called when this same item is
24630     * selected.
24631     *
24632     * @note The current selection @b won't be modified by appending an
24633     * element to the list.
24634     *
24635     * @note The maximum length of the text label is going to be
24636     * determined <b>by the widget's theme</b>. Strings larger than
24637     * that value are going to be @b truncated.
24638     *
24639     * @ingroup Flipselector
24640     */
24641    EAPI Elm_Flipselector_Item     *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24642
24643    /**
24644     * Prepend a (text) item to a flip selector widget
24645     *
24646     * @param obj The flipselector object
24647     * @param label The (text) label of the new item
24648     * @param func Convenience callback function to take place when
24649     * item is selected
24650     * @param data Data passed to @p func, above
24651     * @return A handle to the item added or @c NULL, on errors
24652     *
24653     * The widget's list of labels to show will be prepended with the
24654     * given value. If the user wishes so, a callback function pointer
24655     * can be passed, which will get called when this same item is
24656     * selected.
24657     *
24658     * @note The current selection @b won't be modified by prepending
24659     * an element to the list.
24660     *
24661     * @note The maximum length of the text label is going to be
24662     * determined <b>by the widget's theme</b>. Strings larger than
24663     * that value are going to be @b truncated.
24664     *
24665     * @ingroup Flipselector
24666     */
24667    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24668
24669    /**
24670     * Get the internal list of items in a given flip selector widget.
24671     *
24672     * @param obj The flipselector object
24673     * @return The list of items (#Elm_Flipselector_Item as data) or
24674     * @c NULL on errors.
24675     *
24676     * This list is @b not to be modified in any way and must not be
24677     * freed. Use the list members with functions like
24678     * elm_flipselector_item_label_set(),
24679     * elm_flipselector_item_label_get(),
24680     * elm_flipselector_item_del(),
24681     * elm_flipselector_item_selected_get(),
24682     * elm_flipselector_item_selected_set().
24683     *
24684     * @warning This list is only valid until @p obj object's internal
24685     * items list is changed. It should be fetched again with another
24686     * call to this function when changes happen.
24687     *
24688     * @ingroup Flipselector
24689     */
24690    EAPI const Eina_List           *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24691
24692    /**
24693     * Get the first item in the given flip selector widget's list of
24694     * items.
24695     *
24696     * @param obj The flipselector object
24697     * @return The first item or @c NULL, if it has no items (and on
24698     * errors)
24699     *
24700     * @see elm_flipselector_item_append()
24701     * @see elm_flipselector_last_item_get()
24702     *
24703     * @ingroup Flipselector
24704     */
24705    EAPI Elm_Flipselector_Item     *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24706
24707    /**
24708     * Get the last item in the given flip selector widget's list of
24709     * items.
24710     *
24711     * @param obj The flipselector object
24712     * @return The last item or @c NULL, if it has no items (and on
24713     * errors)
24714     *
24715     * @see elm_flipselector_item_prepend()
24716     * @see elm_flipselector_first_item_get()
24717     *
24718     * @ingroup Flipselector
24719     */
24720    EAPI Elm_Flipselector_Item     *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24721
24722    /**
24723     * Get the currently selected item in a flip selector widget.
24724     *
24725     * @param obj The flipselector object
24726     * @return The selected item or @c NULL, if the widget has no items
24727     * (and on erros)
24728     *
24729     * @ingroup Flipselector
24730     */
24731    EAPI Elm_Flipselector_Item     *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24732
24733    /**
24734     * Set whether a given flip selector widget's item should be the
24735     * currently selected one.
24736     *
24737     * @param item The flip selector item
24738     * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
24739     *
24740     * This sets whether @p item is or not the selected (thus, under
24741     * display) one. If @p item is different than one under display,
24742     * the latter will be unselected. If the @p item is set to be
24743     * unselected, on the other hand, the @b first item in the widget's
24744     * internal members list will be the new selected one.
24745     *
24746     * @see elm_flipselector_item_selected_get()
24747     *
24748     * @ingroup Flipselector
24749     */
24750    EAPI void                       elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
24751
24752    /**
24753     * Get whether a given flip selector widget's item is the currently
24754     * selected one.
24755     *
24756     * @param item The flip selector item
24757     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
24758     * (or on errors).
24759     *
24760     * @see elm_flipselector_item_selected_set()
24761     *
24762     * @ingroup Flipselector
24763     */
24764    EAPI Eina_Bool                  elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24765
24766    /**
24767     * Delete a given item from a flip selector widget.
24768     *
24769     * @param item The item to delete
24770     *
24771     * @ingroup Flipselector
24772     */
24773    EAPI void                       elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24774
24775    /**
24776     * Get the label of a given flip selector widget's item.
24777     *
24778     * @param item The item to get label from
24779     * @return The text label of @p item or @c NULL, on errors
24780     *
24781     * @see elm_flipselector_item_label_set()
24782     *
24783     * @ingroup Flipselector
24784     */
24785    EAPI const char                *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24786
24787    /**
24788     * Set the label of a given flip selector widget's item.
24789     *
24790     * @param item The item to set label on
24791     * @param label The text label string, in UTF-8 encoding
24792     *
24793     * @see elm_flipselector_item_label_get()
24794     *
24795     * @ingroup Flipselector
24796     */
24797    EAPI void                       elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
24798
24799    /**
24800     * Gets the item before @p item in a flip selector widget's
24801     * internal list of items.
24802     *
24803     * @param item The item to fetch previous from
24804     * @return The item before the @p item, in its parent's list. If
24805     *         there is no previous item for @p item or there's an
24806     *         error, @c NULL is returned.
24807     *
24808     * @see elm_flipselector_item_next_get()
24809     *
24810     * @ingroup Flipselector
24811     */
24812    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24813
24814    /**
24815     * Gets the item after @p item in a flip selector widget's
24816     * internal list of items.
24817     *
24818     * @param item The item to fetch next from
24819     * @return The item after the @p item, in its parent's list. If
24820     *         there is no next item for @p item or there's an
24821     *         error, @c NULL is returned.
24822     *
24823     * @see elm_flipselector_item_next_get()
24824     *
24825     * @ingroup Flipselector
24826     */
24827    EAPI Elm_Flipselector_Item     *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24828
24829    /**
24830     * Set the interval on time updates for an user mouse button hold
24831     * on a flip selector widget.
24832     *
24833     * @param obj The flip selector object
24834     * @param interval The (first) interval value in seconds
24835     *
24836     * This interval value is @b decreased while the user holds the
24837     * mouse pointer either flipping up or flipping doww a given flip
24838     * selector.
24839     *
24840     * This helps the user to get to a given item distant from the
24841     * current one easier/faster, as it will start to flip quicker and
24842     * quicker on mouse button holds.
24843     *
24844     * The calculation for the next flip interval value, starting from
24845     * the one set with this call, is the previous interval divided by
24846     * 1.05, so it decreases a little bit.
24847     *
24848     * The default starting interval value for automatic flips is
24849     * @b 0.85 seconds.
24850     *
24851     * @see elm_flipselector_interval_get()
24852     *
24853     * @ingroup Flipselector
24854     */
24855    EAPI void                       elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
24856
24857    /**
24858     * Get the interval on time updates for an user mouse button hold
24859     * on a flip selector widget.
24860     *
24861     * @param obj The flip selector object
24862     * @return The (first) interval value, in seconds, set on it
24863     *
24864     * @see elm_flipselector_interval_set() for more details
24865     *
24866     * @ingroup Flipselector
24867     */
24868    EAPI double                     elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24869    /**
24870     * @}
24871     */
24872
24873    /**
24874     * @addtogroup Calendar
24875     * @{
24876     */
24877
24878    /**
24879     * @enum _Elm_Calendar_Mark_Repeat
24880     * @typedef Elm_Calendar_Mark_Repeat
24881     *
24882     * Event periodicity, used to define if a mark should be repeated
24883     * @b beyond event's day. It's set when a mark is added.
24884     *
24885     * So, for a mark added to 13th May with periodicity set to WEEKLY,
24886     * there will be marks every week after this date. Marks will be displayed
24887     * at 13th, 20th, 27th, 3rd June ...
24888     *
24889     * Values don't work as bitmask, only one can be choosen.
24890     *
24891     * @see elm_calendar_mark_add()
24892     *
24893     * @ingroup Calendar
24894     */
24895    typedef enum _Elm_Calendar_Mark_Repeat
24896      {
24897         ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
24898         ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
24899         ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
24900         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*/
24901         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. */
24902      } Elm_Calendar_Mark_Repeat;
24903
24904    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(). */
24905
24906    /**
24907     * Add a new calendar widget to the given parent Elementary
24908     * (container) object.
24909     *
24910     * @param parent The parent object.
24911     * @return a new calendar widget handle or @c NULL, on errors.
24912     *
24913     * This function inserts a new calendar widget on the canvas.
24914     *
24915     * @ref calendar_example_01
24916     *
24917     * @ingroup Calendar
24918     */
24919    EAPI Evas_Object       *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24920
24921    /**
24922     * Get weekdays names displayed by the calendar.
24923     *
24924     * @param obj The calendar object.
24925     * @return Array of seven strings to be used as weekday names.
24926     *
24927     * By default, weekdays abbreviations get from system are displayed:
24928     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
24929     * The first string is related to Sunday, the second to Monday...
24930     *
24931     * @see elm_calendar_weekdays_name_set()
24932     *
24933     * @ref calendar_example_05
24934     *
24935     * @ingroup Calendar
24936     */
24937    EAPI const char       **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24938
24939    /**
24940     * Set weekdays names to be displayed by the calendar.
24941     *
24942     * @param obj The calendar object.
24943     * @param weekdays Array of seven strings to be used as weekday names.
24944     * @warning It must have 7 elements, or it will access invalid memory.
24945     * @warning The strings must be NULL terminated ('@\0').
24946     *
24947     * By default, weekdays abbreviations get from system are displayed:
24948     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
24949     *
24950     * The first string should be related to Sunday, the second to Monday...
24951     *
24952     * The usage should be like this:
24953     * @code
24954     *   const char *weekdays[] =
24955     *   {
24956     *      "Sunday", "Monday", "Tuesday", "Wednesday",
24957     *      "Thursday", "Friday", "Saturday"
24958     *   };
24959     *   elm_calendar_weekdays_names_set(calendar, weekdays);
24960     * @endcode
24961     *
24962     * @see elm_calendar_weekdays_name_get()
24963     *
24964     * @ref calendar_example_02
24965     *
24966     * @ingroup Calendar
24967     */
24968    EAPI void               elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
24969
24970    /**
24971     * Set the minimum and maximum values for the year
24972     *
24973     * @param obj The calendar object
24974     * @param min The minimum year, greater than 1901;
24975     * @param max The maximum year;
24976     *
24977     * Maximum must be greater than minimum, except if you don't wan't to set
24978     * maximum year.
24979     * Default values are 1902 and -1.
24980     *
24981     * If the maximum year is a negative value, it will be limited depending
24982     * on the platform architecture (year 2037 for 32 bits);
24983     *
24984     * @see elm_calendar_min_max_year_get()
24985     *
24986     * @ref calendar_example_03
24987     *
24988     * @ingroup Calendar
24989     */
24990    EAPI void               elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
24991
24992    /**
24993     * Get the minimum and maximum values for the year
24994     *
24995     * @param obj The calendar object.
24996     * @param min The minimum year.
24997     * @param max The maximum year.
24998     *
24999     * Default values are 1902 and -1.
25000     *
25001     * @see elm_calendar_min_max_year_get() for more details.
25002     *
25003     * @ref calendar_example_05
25004     *
25005     * @ingroup Calendar
25006     */
25007    EAPI void               elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
25008
25009    /**
25010     * Enable or disable day selection
25011     *
25012     * @param obj The calendar object.
25013     * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
25014     * disable it.
25015     *
25016     * Enabled by default. If disabled, the user still can select months,
25017     * but not days. Selected days are highlighted on calendar.
25018     * It should be used if you won't need such selection for the widget usage.
25019     *
25020     * When a day is selected, or month is changed, smart callbacks for
25021     * signal "changed" will be called.
25022     *
25023     * @see elm_calendar_day_selection_enable_get()
25024     *
25025     * @ref calendar_example_04
25026     *
25027     * @ingroup Calendar
25028     */
25029    EAPI void               elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25030
25031    /**
25032     * Get a value whether day selection is enabled or not.
25033     *
25034     * @see elm_calendar_day_selection_enable_set() for details.
25035     *
25036     * @param obj The calendar object.
25037     * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
25038     * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
25039     *
25040     * @ref calendar_example_05
25041     *
25042     * @ingroup Calendar
25043     */
25044    EAPI Eina_Bool          elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25045
25046
25047    /**
25048     * Set selected date to be highlighted on calendar.
25049     *
25050     * @param obj The calendar object.
25051     * @param selected_time A @b tm struct to represent the selected date.
25052     *
25053     * Set the selected date, changing the displayed month if needed.
25054     * Selected date changes when the user goes to next/previous month or
25055     * select a day pressing over it on calendar.
25056     *
25057     * @see elm_calendar_selected_time_get()
25058     *
25059     * @ref calendar_example_04
25060     *
25061     * @ingroup Calendar
25062     */
25063    EAPI void               elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
25064
25065    /**
25066     * Get selected date.
25067     *
25068     * @param obj The calendar object
25069     * @param selected_time A @b tm struct to point to selected date
25070     * @return EINA_FALSE means an error ocurred and returned time shouldn't
25071     * be considered.
25072     *
25073     * Get date selected by the user or set by function
25074     * elm_calendar_selected_time_set().
25075     * Selected date changes when the user goes to next/previous month or
25076     * select a day pressing over it on calendar.
25077     *
25078     * @see elm_calendar_selected_time_get()
25079     *
25080     * @ref calendar_example_05
25081     *
25082     * @ingroup Calendar
25083     */
25084    EAPI Eina_Bool          elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
25085
25086    /**
25087     * Set a function to format the string that will be used to display
25088     * month and year;
25089     *
25090     * @param obj The calendar object
25091     * @param format_function Function to set the month-year string given
25092     * the selected date
25093     *
25094     * By default it uses strftime with "%B %Y" format string.
25095     * It should allocate the memory that will be used by the string,
25096     * that will be freed by the widget after usage.
25097     * A pointer to the string and a pointer to the time struct will be provided.
25098     *
25099     * Example:
25100     * @code
25101     * static char *
25102     * _format_month_year(struct tm *selected_time)
25103     * {
25104     *    char buf[32];
25105     *    if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
25106     *    return strdup(buf);
25107     * }
25108     *
25109     * elm_calendar_format_function_set(calendar, _format_month_year);
25110     * @endcode
25111     *
25112     * @ref calendar_example_02
25113     *
25114     * @ingroup Calendar
25115     */
25116    EAPI void               elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
25117
25118    /**
25119     * Add a new mark to the calendar
25120     *
25121     * @param obj The calendar object
25122     * @param mark_type A string used to define the type of mark. It will be
25123     * emitted to the theme, that should display a related modification on these
25124     * days representation.
25125     * @param mark_time A time struct to represent the date of inclusion of the
25126     * mark. For marks that repeats it will just be displayed after the inclusion
25127     * date in the calendar.
25128     * @param repeat Repeat the event following this periodicity. Can be a unique
25129     * mark (that don't repeat), daily, weekly, monthly or annually.
25130     * @return The created mark or @p NULL upon failure.
25131     *
25132     * Add a mark that will be drawn in the calendar respecting the insertion
25133     * time and periodicity. It will emit the type as signal to the widget theme.
25134     * Default theme supports "holiday" and "checked", but it can be extended.
25135     *
25136     * It won't immediately update the calendar, drawing the marks.
25137     * For this, call elm_calendar_marks_draw(). However, when user selects
25138     * next or previous month calendar forces marks drawn.
25139     *
25140     * Marks created with this method can be deleted with
25141     * elm_calendar_mark_del().
25142     *
25143     * Example
25144     * @code
25145     * struct tm selected_time;
25146     * time_t current_time;
25147     *
25148     * current_time = time(NULL) + 5 * 84600;
25149     * localtime_r(&current_time, &selected_time);
25150     * elm_calendar_mark_add(cal, "holiday", selected_time,
25151     *     ELM_CALENDAR_ANNUALLY);
25152     *
25153     * current_time = time(NULL) + 1 * 84600;
25154     * localtime_r(&current_time, &selected_time);
25155     * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
25156     *
25157     * elm_calendar_marks_draw(cal);
25158     * @endcode
25159     *
25160     * @see elm_calendar_marks_draw()
25161     * @see elm_calendar_mark_del()
25162     *
25163     * @ref calendar_example_06
25164     *
25165     * @ingroup Calendar
25166     */
25167    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);
25168
25169    /**
25170     * Delete mark from the calendar.
25171     *
25172     * @param mark The mark to be deleted.
25173     *
25174     * If deleting all calendar marks is required, elm_calendar_marks_clear()
25175     * should be used instead of getting marks list and deleting each one.
25176     *
25177     * @see elm_calendar_mark_add()
25178     *
25179     * @ref calendar_example_06
25180     *
25181     * @ingroup Calendar
25182     */
25183    EAPI void               elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
25184
25185    /**
25186     * Remove all calendar's marks
25187     *
25188     * @param obj The calendar object.
25189     *
25190     * @see elm_calendar_mark_add()
25191     * @see elm_calendar_mark_del()
25192     *
25193     * @ingroup Calendar
25194     */
25195    EAPI void               elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25196
25197
25198    /**
25199     * Get a list of all the calendar marks.
25200     *
25201     * @param obj The calendar object.
25202     * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
25203     *
25204     * @see elm_calendar_mark_add()
25205     * @see elm_calendar_mark_del()
25206     * @see elm_calendar_marks_clear()
25207     *
25208     * @ingroup Calendar
25209     */
25210    EAPI const Eina_List   *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25211
25212    /**
25213     * Draw calendar marks.
25214     *
25215     * @param obj The calendar object.
25216     *
25217     * Should be used after adding, removing or clearing marks.
25218     * It will go through the entire marks list updating the calendar.
25219     * If lots of marks will be added, add all the marks and then call
25220     * this function.
25221     *
25222     * When the month is changed, i.e. user selects next or previous month,
25223     * marks will be drawed.
25224     *
25225     * @see elm_calendar_mark_add()
25226     * @see elm_calendar_mark_del()
25227     * @see elm_calendar_marks_clear()
25228     *
25229     * @ref calendar_example_06
25230     *
25231     * @ingroup Calendar
25232     */
25233    EAPI void               elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
25234
25235    /**
25236     * Set a day text color to the same that represents Saturdays.
25237     *
25238     * @param obj The calendar object.
25239     * @param pos The text position. Position is the cell counter, from left
25240     * to right, up to down. It starts on 0 and ends on 41.
25241     *
25242     * @deprecated use elm_calendar_mark_add() instead like:
25243     *
25244     * @code
25245     * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
25246     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25247     * @endcode
25248     *
25249     * @see elm_calendar_mark_add()
25250     *
25251     * @ingroup Calendar
25252     */
25253    EINA_DEPRECATED EAPI void               elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25254
25255    /**
25256     * Set a day text color to the same that represents Sundays.
25257     *
25258     * @param obj The calendar object.
25259     * @param pos The text position. Position is the cell counter, from left
25260     * to right, up to down. It starts on 0 and ends on 41.
25261
25262     * @deprecated use elm_calendar_mark_add() instead like:
25263     *
25264     * @code
25265     * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
25266     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25267     * @endcode
25268     *
25269     * @see elm_calendar_mark_add()
25270     *
25271     * @ingroup Calendar
25272     */
25273    EINA_DEPRECATED EAPI void               elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25274
25275    /**
25276     * Set a day text color to the same that represents Weekdays.
25277     *
25278     * @param obj The calendar object
25279     * @param pos The text position. Position is the cell counter, from left
25280     * to right, up to down. It starts on 0 and ends on 41.
25281     *
25282     * @deprecated use elm_calendar_mark_add() instead like:
25283     *
25284     * @code
25285     * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
25286     *
25287     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
25288     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25289     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
25290     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25291     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
25292     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25293     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
25294     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25295     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
25296     * @endcode
25297     *
25298     * @see elm_calendar_mark_add()
25299     *
25300     * @ingroup Calendar
25301     */
25302    EINA_DEPRECATED EAPI void               elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25303
25304    /**
25305     * Set the interval on time updates for an user mouse button hold
25306     * on calendar widgets' month selection.
25307     *
25308     * @param obj The calendar object
25309     * @param interval The (first) interval value in seconds
25310     *
25311     * This interval value is @b decreased while the user holds the
25312     * mouse pointer either selecting next or previous month.
25313     *
25314     * This helps the user to get to a given month distant from the
25315     * current one easier/faster, as it will start to change quicker and
25316     * quicker on mouse button holds.
25317     *
25318     * The calculation for the next change interval value, starting from
25319     * the one set with this call, is the previous interval divided by
25320     * 1.05, so it decreases a little bit.
25321     *
25322     * The default starting interval value for automatic changes is
25323     * @b 0.85 seconds.
25324     *
25325     * @see elm_calendar_interval_get()
25326     *
25327     * @ingroup Calendar
25328     */
25329    EAPI void               elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25330
25331    /**
25332     * Get the interval on time updates for an user mouse button hold
25333     * on calendar widgets' month selection.
25334     *
25335     * @param obj The calendar object
25336     * @return The (first) interval value, in seconds, set on it
25337     *
25338     * @see elm_calendar_interval_set() for more details
25339     *
25340     * @ingroup Calendar
25341     */
25342    EAPI double             elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25343
25344    /**
25345     * @}
25346     */
25347
25348    /**
25349     * @defgroup Diskselector Diskselector
25350     * @ingroup Elementary
25351     *
25352     * @image html img/widget/diskselector/preview-00.png
25353     * @image latex img/widget/diskselector/preview-00.eps
25354     *
25355     * A diskselector is a kind of list widget. It scrolls horizontally,
25356     * and can contain label and icon objects. Three items are displayed
25357     * with the selected one in the middle.
25358     *
25359     * It can act like a circular list with round mode and labels can be
25360     * reduced for a defined length for side items.
25361     *
25362     * Smart callbacks one can listen to:
25363     * - "selected" - when item is selected, i.e. scroller stops.
25364     *
25365     * Available styles for it:
25366     * - @c "default"
25367     *
25368     * List of examples:
25369     * @li @ref diskselector_example_01
25370     * @li @ref diskselector_example_02
25371     */
25372
25373    /**
25374     * @addtogroup Diskselector
25375     * @{
25376     */
25377
25378    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(). */
25379
25380    /**
25381     * Add a new diskselector widget to the given parent Elementary
25382     * (container) object.
25383     *
25384     * @param parent The parent object.
25385     * @return a new diskselector widget handle or @c NULL, on errors.
25386     *
25387     * This function inserts a new diskselector widget on the canvas.
25388     *
25389     * @ingroup Diskselector
25390     */
25391    EAPI Evas_Object           *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25392
25393    /**
25394     * Enable or disable round mode.
25395     *
25396     * @param obj The diskselector object.
25397     * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
25398     * disable it.
25399     *
25400     * Disabled by default. If round mode is enabled the items list will
25401     * work like a circle list, so when the user reaches the last item,
25402     * the first one will popup.
25403     *
25404     * @see elm_diskselector_round_get()
25405     *
25406     * @ingroup Diskselector
25407     */
25408    EAPI void                   elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
25409
25410    /**
25411     * Get a value whether round mode is enabled or not.
25412     *
25413     * @see elm_diskselector_round_set() for details.
25414     *
25415     * @param obj The diskselector object.
25416     * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
25417     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25418     *
25419     * @ingroup Diskselector
25420     */
25421    EAPI Eina_Bool              elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25422
25423    /**
25424     * Get the side labels max length.
25425     *
25426     * @deprecated use elm_diskselector_side_label_length_get() instead:
25427     *
25428     * @param obj The diskselector object.
25429     * @return The max length defined for side labels, or 0 if not a valid
25430     * diskselector.
25431     *
25432     * @ingroup Diskselector
25433     */
25434    EINA_DEPRECATED EAPI int    elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25435
25436    /**
25437     * Set the side labels max length.
25438     *
25439     * @deprecated use elm_diskselector_side_label_length_set() instead:
25440     *
25441     * @param obj The diskselector object.
25442     * @param len The max length defined for side labels.
25443     *
25444     * @ingroup Diskselector
25445     */
25446    EINA_DEPRECATED EAPI void   elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25447
25448    /**
25449     * Get the side labels max length.
25450     *
25451     * @see elm_diskselector_side_label_length_set() for details.
25452     *
25453     * @param obj The diskselector object.
25454     * @return The max length defined for side labels, or 0 if not a valid
25455     * diskselector.
25456     *
25457     * @ingroup Diskselector
25458     */
25459    EAPI int                    elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25460
25461    /**
25462     * Set the side labels max length.
25463     *
25464     * @param obj The diskselector object.
25465     * @param len The max length defined for side labels.
25466     *
25467     * Length is the number of characters of items' label that will be
25468     * visible when it's set on side positions. It will just crop
25469     * the string after defined size. E.g.:
25470     *
25471     * An item with label "January" would be displayed on side position as
25472     * "Jan" if max length is set to 3, or "Janu", if this property
25473     * is set to 4.
25474     *
25475     * When it's selected, the entire label will be displayed, except for
25476     * width restrictions. In this case label will be cropped and "..."
25477     * will be concatenated.
25478     *
25479     * Default side label max length is 3.
25480     *
25481     * This property will be applyed over all items, included before or
25482     * later this function call.
25483     *
25484     * @ingroup Diskselector
25485     */
25486    EAPI void                   elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25487
25488    /**
25489     * Set the number of items to be displayed.
25490     *
25491     * @param obj The diskselector object.
25492     * @param num The number of items the diskselector will display.
25493     *
25494     * Default value is 3, and also it's the minimun. If @p num is less
25495     * than 3, it will be set to 3.
25496     *
25497     * Also, it can be set on theme, using data item @c display_item_num
25498     * on group "elm/diskselector/item/X", where X is style set.
25499     * E.g.:
25500     *
25501     * group { name: "elm/diskselector/item/X";
25502     * data {
25503     *     item: "display_item_num" "5";
25504     *     }
25505     *
25506     * @ingroup Diskselector
25507     */
25508    EAPI void                   elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
25509
25510    /**
25511     * Get the number of items in the diskselector object.
25512     *
25513     * @param obj The diskselector object.
25514     *
25515     * @ingroup Diskselector
25516     */
25517    EAPI int                   elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25518
25519    /**
25520     * Set bouncing behaviour when the scrolled content reaches an edge.
25521     *
25522     * Tell the internal scroller object whether it should bounce or not
25523     * when it reaches the respective edges for each axis.
25524     *
25525     * @param obj The diskselector object.
25526     * @param h_bounce Whether to bounce or not in the horizontal axis.
25527     * @param v_bounce Whether to bounce or not in the vertical axis.
25528     *
25529     * @see elm_scroller_bounce_set()
25530     *
25531     * @ingroup Diskselector
25532     */
25533    EAPI void                   elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
25534
25535    /**
25536     * Get the bouncing behaviour of the internal scroller.
25537     *
25538     * Get whether the internal scroller should bounce when the edge of each
25539     * axis is reached scrolling.
25540     *
25541     * @param obj The diskselector object.
25542     * @param h_bounce Pointer where to store the bounce state of the horizontal
25543     * axis.
25544     * @param v_bounce Pointer where to store the bounce state of the vertical
25545     * axis.
25546     *
25547     * @see elm_scroller_bounce_get()
25548     * @see elm_diskselector_bounce_set()
25549     *
25550     * @ingroup Diskselector
25551     */
25552    EAPI void                   elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
25553
25554    /**
25555     * Get the scrollbar policy.
25556     *
25557     * @see elm_diskselector_scroller_policy_get() for details.
25558     *
25559     * @param obj The diskselector object.
25560     * @param policy_h Pointer where to store horizontal scrollbar policy.
25561     * @param policy_v Pointer where to store vertical scrollbar policy.
25562     *
25563     * @ingroup Diskselector
25564     */
25565    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);
25566
25567    /**
25568     * Set the scrollbar policy.
25569     *
25570     * @param obj The diskselector object.
25571     * @param policy_h Horizontal scrollbar policy.
25572     * @param policy_v Vertical scrollbar policy.
25573     *
25574     * This sets the scrollbar visibility policy for the given scroller.
25575     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
25576     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
25577     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
25578     * This applies respectively for the horizontal and vertical scrollbars.
25579     *
25580     * The both are disabled by default, i.e., are set to
25581     * #ELM_SCROLLER_POLICY_OFF.
25582     *
25583     * @ingroup Diskselector
25584     */
25585    EAPI void                   elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
25586
25587    /**
25588     * Remove all diskselector's items.
25589     *
25590     * @param obj The diskselector object.
25591     *
25592     * @see elm_diskselector_item_del()
25593     * @see elm_diskselector_item_append()
25594     *
25595     * @ingroup Diskselector
25596     */
25597    EAPI void                   elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25598
25599    /**
25600     * Get a list of all the diskselector items.
25601     *
25602     * @param obj The diskselector object.
25603     * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
25604     * or @c NULL on failure.
25605     *
25606     * @see elm_diskselector_item_append()
25607     * @see elm_diskselector_item_del()
25608     * @see elm_diskselector_clear()
25609     *
25610     * @ingroup Diskselector
25611     */
25612    EAPI const Eina_List       *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25613
25614    /**
25615     * Appends a new item to the diskselector object.
25616     *
25617     * @param obj The diskselector object.
25618     * @param label The label of the diskselector item.
25619     * @param icon The icon object to use at left side of the item. An
25620     * icon can be any Evas object, but usually it is an icon created
25621     * with elm_icon_add().
25622     * @param func The function to call when the item is selected.
25623     * @param data The data to associate with the item for related callbacks.
25624     *
25625     * @return The created item or @c NULL upon failure.
25626     *
25627     * A new item will be created and appended to the diskselector, i.e., will
25628     * be set as last item. Also, if there is no selected item, it will
25629     * be selected. This will always happens for the first appended item.
25630     *
25631     * If no icon is set, label will be centered on item position, otherwise
25632     * the icon will be placed at left of the label, that will be shifted
25633     * to the right.
25634     *
25635     * Items created with this method can be deleted with
25636     * elm_diskselector_item_del().
25637     *
25638     * Associated @p data can be properly freed when item is deleted if a
25639     * callback function is set with elm_diskselector_item_del_cb_set().
25640     *
25641     * If a function is passed as argument, it will be called everytime this item
25642     * is selected, i.e., the user stops the diskselector with this
25643     * item on center position. If such function isn't needed, just passing
25644     * @c NULL as @p func is enough. The same should be done for @p data.
25645     *
25646     * Simple example (with no function callback or data associated):
25647     * @code
25648     * disk = elm_diskselector_add(win);
25649     * ic = elm_icon_add(win);
25650     * elm_icon_file_set(ic, "path/to/image", NULL);
25651     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
25652     * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
25653     * @endcode
25654     *
25655     * @see elm_diskselector_item_del()
25656     * @see elm_diskselector_item_del_cb_set()
25657     * @see elm_diskselector_clear()
25658     * @see elm_icon_add()
25659     *
25660     * @ingroup Diskselector
25661     */
25662    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);
25663
25664
25665    /**
25666     * Delete them item from the diskselector.
25667     *
25668     * @param it The item of diskselector to be deleted.
25669     *
25670     * If deleting all diskselector items is required, elm_diskselector_clear()
25671     * should be used instead of getting items list and deleting each one.
25672     *
25673     * @see elm_diskselector_clear()
25674     * @see elm_diskselector_item_append()
25675     * @see elm_diskselector_item_del_cb_set()
25676     *
25677     * @ingroup Diskselector
25678     */
25679    EAPI void                   elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25680
25681    /**
25682     * Set the function called when a diskselector item is freed.
25683     *
25684     * @param it The item to set the callback on
25685     * @param func The function called
25686     *
25687     * If there is a @p func, then it will be called prior item's memory release.
25688     * That will be called with the following arguments:
25689     * @li item's data;
25690     * @li item's Evas object;
25691     * @li item itself;
25692     *
25693     * This way, a data associated to a diskselector item could be properly
25694     * freed.
25695     *
25696     * @ingroup Diskselector
25697     */
25698    EAPI void                   elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
25699
25700    /**
25701     * Get the data associated to the item.
25702     *
25703     * @param it The diskselector item
25704     * @return The data associated to @p it
25705     *
25706     * The return value is a pointer to data associated to @p item when it was
25707     * created, with function elm_diskselector_item_append(). If no data
25708     * was passed as argument, it will return @c NULL.
25709     *
25710     * @see elm_diskselector_item_append()
25711     *
25712     * @ingroup Diskselector
25713     */
25714    EAPI void                  *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25715
25716    /**
25717     * Set the icon associated to the item.
25718     *
25719     * @param it The diskselector item
25720     * @param icon The icon object to associate with @p it
25721     *
25722     * The icon object to use at left side of the item. An
25723     * icon can be any Evas object, but usually it is an icon created
25724     * with elm_icon_add().
25725     *
25726     * Once the icon object is set, a previously set one will be deleted.
25727     * @warning Setting the same icon for two items will cause the icon to
25728     * dissapear from the first item.
25729     *
25730     * If an icon was passed as argument on item creation, with function
25731     * elm_diskselector_item_append(), it will be already
25732     * associated to the item.
25733     *
25734     * @see elm_diskselector_item_append()
25735     * @see elm_diskselector_item_icon_get()
25736     *
25737     * @ingroup Diskselector
25738     */
25739    EAPI void                   elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
25740
25741    /**
25742     * Get the icon associated to the item.
25743     *
25744     * @param it The diskselector item
25745     * @return The icon associated to @p it
25746     *
25747     * The return value is a pointer to the icon associated to @p item when it was
25748     * created, with function elm_diskselector_item_append(), or later
25749     * with function elm_diskselector_item_icon_set. If no icon
25750     * was passed as argument, it will return @c NULL.
25751     *
25752     * @see elm_diskselector_item_append()
25753     * @see elm_diskselector_item_icon_set()
25754     *
25755     * @ingroup Diskselector
25756     */
25757    EAPI Evas_Object           *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25758
25759    /**
25760     * Set the label of item.
25761     *
25762     * @param it The item of diskselector.
25763     * @param label The label of item.
25764     *
25765     * The label to be displayed by the item.
25766     *
25767     * If no icon is set, label will be centered on item position, otherwise
25768     * the icon will be placed at left of the label, that will be shifted
25769     * to the right.
25770     *
25771     * An item with label "January" would be displayed on side position as
25772     * "Jan" if max length is set to 3 with function
25773     * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
25774     * is set to 4.
25775     *
25776     * When this @p item is selected, the entire label will be displayed,
25777     * except for width restrictions.
25778     * In this case label will be cropped and "..." will be concatenated,
25779     * but only for display purposes. It will keep the entire string, so
25780     * if diskselector is resized the remaining characters will be displayed.
25781     *
25782     * If a label was passed as argument on item creation, with function
25783     * elm_diskselector_item_append(), it will be already
25784     * displayed by the item.
25785     *
25786     * @see elm_diskselector_side_label_lenght_set()
25787     * @see elm_diskselector_item_label_get()
25788     * @see elm_diskselector_item_append()
25789     *
25790     * @ingroup Diskselector
25791     */
25792    EAPI void                   elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
25793
25794    /**
25795     * Get the label of item.
25796     *
25797     * @param it The item of diskselector.
25798     * @return The label of item.
25799     *
25800     * The return value is a pointer to the label associated to @p item when it was
25801     * created, with function elm_diskselector_item_append(), or later
25802     * with function elm_diskselector_item_label_set. If no label
25803     * was passed as argument, it will return @c NULL.
25804     *
25805     * @see elm_diskselector_item_label_set() for more details.
25806     * @see elm_diskselector_item_append()
25807     *
25808     * @ingroup Diskselector
25809     */
25810    EAPI const char            *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25811
25812    /**
25813     * Get the selected item.
25814     *
25815     * @param obj The diskselector object.
25816     * @return The selected diskselector item.
25817     *
25818     * The selected item can be unselected with function
25819     * elm_diskselector_item_selected_set(), and the first item of
25820     * diskselector will be selected.
25821     *
25822     * The selected item always will be centered on diskselector, with
25823     * full label displayed, i.e., max lenght set to side labels won't
25824     * apply on the selected item. More details on
25825     * elm_diskselector_side_label_length_set().
25826     *
25827     * @ingroup Diskselector
25828     */
25829    EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25830
25831    /**
25832     * Set the selected state of an item.
25833     *
25834     * @param it The diskselector item
25835     * @param selected The selected state
25836     *
25837     * This sets the selected state of the given item @p it.
25838     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
25839     *
25840     * If a new item is selected the previosly selected will be unselected.
25841     * Previoulsy selected item can be get with function
25842     * elm_diskselector_selected_item_get().
25843     *
25844     * If the item @p it is unselected, the first item of diskselector will
25845     * be selected.
25846     *
25847     * Selected items will be visible on center position of diskselector.
25848     * So if it was on another position before selected, or was invisible,
25849     * diskselector will animate items until the selected item reaches center
25850     * position.
25851     *
25852     * @see elm_diskselector_item_selected_get()
25853     * @see elm_diskselector_selected_item_get()
25854     *
25855     * @ingroup Diskselector
25856     */
25857    EAPI void                   elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
25858
25859    /*
25860     * Get whether the @p item is selected or not.
25861     *
25862     * @param it The diskselector item.
25863     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
25864     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
25865     *
25866     * @see elm_diskselector_selected_item_set() for details.
25867     * @see elm_diskselector_item_selected_get()
25868     *
25869     * @ingroup Diskselector
25870     */
25871    EAPI Eina_Bool              elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25872
25873    /**
25874     * Get the first item of the diskselector.
25875     *
25876     * @param obj The diskselector object.
25877     * @return The first item, or @c NULL if none.
25878     *
25879     * The list of items follows append order. So it will return the first
25880     * item appended to the widget that wasn't deleted.
25881     *
25882     * @see elm_diskselector_item_append()
25883     * @see elm_diskselector_items_get()
25884     *
25885     * @ingroup Diskselector
25886     */
25887    EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25888
25889    /**
25890     * Get the last item of the diskselector.
25891     *
25892     * @param obj The diskselector object.
25893     * @return The last item, or @c NULL if none.
25894     *
25895     * The list of items follows append order. So it will return last first
25896     * item appended to the widget that wasn't deleted.
25897     *
25898     * @see elm_diskselector_item_append()
25899     * @see elm_diskselector_items_get()
25900     *
25901     * @ingroup Diskselector
25902     */
25903    EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25904
25905    /**
25906     * Get the item before @p item in diskselector.
25907     *
25908     * @param it The diskselector item.
25909     * @return The item before @p item, or @c NULL if none or on failure.
25910     *
25911     * The list of items follows append order. So it will return item appended
25912     * just before @p item and that wasn't deleted.
25913     *
25914     * If it is the first item, @c NULL will be returned.
25915     * First item can be get by elm_diskselector_first_item_get().
25916     *
25917     * @see elm_diskselector_item_append()
25918     * @see elm_diskselector_items_get()
25919     *
25920     * @ingroup Diskselector
25921     */
25922    EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25923
25924    /**
25925     * Get the item after @p item in diskselector.
25926     *
25927     * @param it The diskselector item.
25928     * @return The item after @p item, or @c NULL if none or on failure.
25929     *
25930     * The list of items follows append order. So it will return item appended
25931     * just after @p item and that wasn't deleted.
25932     *
25933     * If it is the last item, @c NULL will be returned.
25934     * Last item can be get by elm_diskselector_last_item_get().
25935     *
25936     * @see elm_diskselector_item_append()
25937     * @see elm_diskselector_items_get()
25938     *
25939     * @ingroup Diskselector
25940     */
25941    EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25942
25943    /**
25944     * Set the text to be shown in the diskselector item.
25945     *
25946     * @param item Target item
25947     * @param text The text to set in the content
25948     *
25949     * Setup the text as tooltip to object. The item can have only one tooltip,
25950     * so any previous tooltip data is removed.
25951     *
25952     * @see elm_object_tooltip_text_set() for more details.
25953     *
25954     * @ingroup Diskselector
25955     */
25956    EAPI void                   elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
25957
25958    /**
25959     * Set the content to be shown in the tooltip item.
25960     *
25961     * Setup the tooltip to item. The item can have only one tooltip,
25962     * so any previous tooltip data is removed. @p func(with @p data) will
25963     * be called every time that need show the tooltip and it should
25964     * return a valid Evas_Object. This object is then managed fully by
25965     * tooltip system and is deleted when the tooltip is gone.
25966     *
25967     * @param item the diskselector item being attached a tooltip.
25968     * @param func the function used to create the tooltip contents.
25969     * @param data what to provide to @a func as callback data/context.
25970     * @param del_cb called when data is not needed anymore, either when
25971     *        another callback replaces @p func, the tooltip is unset with
25972     *        elm_diskselector_item_tooltip_unset() or the owner @a item
25973     *        dies. This callback receives as the first parameter the
25974     *        given @a data, and @c event_info is the item.
25975     *
25976     * @see elm_object_tooltip_content_cb_set() for more details.
25977     *
25978     * @ingroup Diskselector
25979     */
25980    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);
25981
25982    /**
25983     * Unset tooltip from item.
25984     *
25985     * @param item diskselector item to remove previously set tooltip.
25986     *
25987     * Remove tooltip from item. The callback provided as del_cb to
25988     * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
25989     * it is not used anymore.
25990     *
25991     * @see elm_object_tooltip_unset() for more details.
25992     * @see elm_diskselector_item_tooltip_content_cb_set()
25993     *
25994     * @ingroup Diskselector
25995     */
25996    EAPI void                   elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25997
25998
25999    /**
26000     * Sets a different style for this item tooltip.
26001     *
26002     * @note before you set a style you should define a tooltip with
26003     *       elm_diskselector_item_tooltip_content_cb_set() or
26004     *       elm_diskselector_item_tooltip_text_set()
26005     *
26006     * @param item diskselector item with tooltip already set.
26007     * @param style the theme style to use (default, transparent, ...)
26008     *
26009     * @see elm_object_tooltip_style_set() for more details.
26010     *
26011     * @ingroup Diskselector
26012     */
26013    EAPI void                   elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26014
26015    /**
26016     * Get the style for this item tooltip.
26017     *
26018     * @param item diskselector item with tooltip already set.
26019     * @return style the theme style in use, defaults to "default". If the
26020     *         object does not have a tooltip set, then NULL is returned.
26021     *
26022     * @see elm_object_tooltip_style_get() for more details.
26023     * @see elm_diskselector_item_tooltip_style_set()
26024     *
26025     * @ingroup Diskselector
26026     */
26027    EAPI const char            *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26028
26029    /**
26030     * Set the cursor to be shown when mouse is over the diskselector item
26031     *
26032     * @param item Target item
26033     * @param cursor the cursor name to be used.
26034     *
26035     * @see elm_object_cursor_set() for more details.
26036     *
26037     * @ingroup Diskselector
26038     */
26039    EAPI void                   elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
26040
26041    /**
26042     * Get the cursor to be shown when mouse is over the diskselector item
26043     *
26044     * @param item diskselector item with cursor already set.
26045     * @return the cursor name.
26046     *
26047     * @see elm_object_cursor_get() for more details.
26048     * @see elm_diskselector_cursor_set()
26049     *
26050     * @ingroup Diskselector
26051     */
26052    EAPI const char            *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26053
26054
26055    /**
26056     * Unset the cursor to be shown when mouse is over the diskselector item
26057     *
26058     * @param item Target item
26059     *
26060     * @see elm_object_cursor_unset() for more details.
26061     * @see elm_diskselector_cursor_set()
26062     *
26063     * @ingroup Diskselector
26064     */
26065    EAPI void                   elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26066
26067    /**
26068     * Sets a different style for this item cursor.
26069     *
26070     * @note before you set a style you should define a cursor with
26071     *       elm_diskselector_item_cursor_set()
26072     *
26073     * @param item diskselector item with cursor already set.
26074     * @param style the theme style to use (default, transparent, ...)
26075     *
26076     * @see elm_object_cursor_style_set() for more details.
26077     *
26078     * @ingroup Diskselector
26079     */
26080    EAPI void                   elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26081
26082
26083    /**
26084     * Get the style for this item cursor.
26085     *
26086     * @param item diskselector item with cursor already set.
26087     * @return style the theme style in use, defaults to "default". If the
26088     *         object does not have a cursor set, then @c NULL is returned.
26089     *
26090     * @see elm_object_cursor_style_get() for more details.
26091     * @see elm_diskselector_item_cursor_style_set()
26092     *
26093     * @ingroup Diskselector
26094     */
26095    EAPI const char            *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26096
26097
26098    /**
26099     * Set if the cursor set should be searched on the theme or should use
26100     * the provided by the engine, only.
26101     *
26102     * @note before you set if should look on theme you should define a cursor
26103     * with elm_diskselector_item_cursor_set().
26104     * By default it will only look for cursors provided by the engine.
26105     *
26106     * @param item widget item with cursor already set.
26107     * @param engine_only boolean to define if cursors set with
26108     * elm_diskselector_item_cursor_set() should be searched only
26109     * between cursors provided by the engine or searched on widget's
26110     * theme as well.
26111     *
26112     * @see elm_object_cursor_engine_only_set() for more details.
26113     *
26114     * @ingroup Diskselector
26115     */
26116    EAPI void                   elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
26117
26118    /**
26119     * Get the cursor engine only usage for this item cursor.
26120     *
26121     * @param item widget item with cursor already set.
26122     * @return engine_only boolean to define it cursors should be looked only
26123     * between the provided by the engine or searched on widget's theme as well.
26124     * If the item does not have a cursor set, then @c EINA_FALSE is returned.
26125     *
26126     * @see elm_object_cursor_engine_only_get() for more details.
26127     * @see elm_diskselector_item_cursor_engine_only_set()
26128     *
26129     * @ingroup Diskselector
26130     */
26131    EAPI Eina_Bool              elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26132
26133    /**
26134     * @}
26135     */
26136
26137    /**
26138     * @defgroup Colorselector Colorselector
26139     *
26140     * @{
26141     *
26142     * @image html img/widget/colorselector/preview-00.png
26143     * @image latex img/widget/colorselector/preview-00.eps
26144     *
26145     * @brief Widget for user to select a color.
26146     *
26147     * Signals that you can add callbacks for are:
26148     * "changed" - When the color value changes(event_info is NULL).
26149     *
26150     * See @ref tutorial_colorselector.
26151     */
26152    /**
26153     * @brief Add a new colorselector to the parent
26154     *
26155     * @param parent The parent object
26156     * @return The new object or NULL if it cannot be created
26157     *
26158     * @ingroup Colorselector
26159     */
26160    EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26161    /**
26162     * Set a color for the colorselector
26163     *
26164     * @param obj   Colorselector object
26165     * @param r     r-value of color
26166     * @param g     g-value of color
26167     * @param b     b-value of color
26168     * @param a     a-value of color
26169     *
26170     * @ingroup Colorselector
26171     */
26172    EAPI void         elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
26173    /**
26174     * Get a color from the colorselector
26175     *
26176     * @param obj   Colorselector object
26177     * @param r     integer pointer for r-value of color
26178     * @param g     integer pointer for g-value of color
26179     * @param b     integer pointer for b-value of color
26180     * @param a     integer pointer for a-value of color
26181     *
26182     * @ingroup Colorselector
26183     */
26184    EAPI void         elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
26185    /**
26186     * @}
26187     */
26188
26189    /**
26190     * @defgroup Ctxpopup Ctxpopup
26191     *
26192     * @image html img/widget/ctxpopup/preview-00.png
26193     * @image latex img/widget/ctxpopup/preview-00.eps
26194     *
26195     * @brief Context popup widet.
26196     *
26197     * A ctxpopup is a widget that, when shown, pops up a list of items.
26198     * It automatically chooses an area inside its parent object's view
26199     * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
26200     * optimally fit into it. In the default theme, it will also point an
26201     * arrow to it's top left position at the time one shows it. Ctxpopup
26202     * items have a label and/or an icon. It is intended for a small
26203     * number of items (hence the use of list, not genlist).
26204     *
26205     * @note Ctxpopup is a especialization of @ref Hover.
26206     *
26207     * Signals that you can add callbacks for are:
26208     * "dismissed" - the ctxpopup was dismissed
26209     *
26210     * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
26211     * @{
26212     */
26213    typedef enum _Elm_Ctxpopup_Direction
26214      {
26215         ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
26216                                           area */
26217         ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
26218                                            the clicked area */
26219         ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
26220                                           the clicked area */
26221         ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
26222                                         area */
26223         ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
26224      } Elm_Ctxpopup_Direction;
26225
26226    /**
26227     * @brief Add a new Ctxpopup object to the parent.
26228     *
26229     * @param parent Parent object
26230     * @return New object or @c NULL, if it cannot be created
26231     */
26232    EAPI Evas_Object  *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26233    /**
26234     * @brief Set the Ctxpopup's parent
26235     *
26236     * @param obj The ctxpopup object
26237     * @param area The parent to use
26238     *
26239     * Set the parent object.
26240     *
26241     * @note elm_ctxpopup_add() will automatically call this function
26242     * with its @c parent argument.
26243     *
26244     * @see elm_ctxpopup_add()
26245     * @see elm_hover_parent_set()
26246     */
26247    EAPI void          elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
26248    /**
26249     * @brief Get the Ctxpopup's parent
26250     *
26251     * @param obj The ctxpopup object
26252     *
26253     * @see elm_ctxpopup_hover_parent_set() for more information
26254     */
26255    EAPI Evas_Object  *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26256    /**
26257     * @brief Clear all items in the given ctxpopup object.
26258     *
26259     * @param obj Ctxpopup object
26260     */
26261    EAPI void          elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26262    /**
26263     * @brief Change the ctxpopup's orientation to horizontal or vertical.
26264     *
26265     * @param obj Ctxpopup object
26266     * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
26267     */
26268    EAPI void          elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
26269    /**
26270     * @brief Get the value of current ctxpopup object's orientation.
26271     *
26272     * @param obj Ctxpopup object
26273     * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
26274     *
26275     * @see elm_ctxpopup_horizontal_set()
26276     */
26277    EAPI Eina_Bool     elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26278    /**
26279     * @brief Add a new item to a ctxpopup object.
26280     *
26281     * @param obj Ctxpopup object
26282     * @param icon Icon to be set on new item
26283     * @param label The Label of the new item
26284     * @param func Convenience function called when item selected
26285     * @param data Data passed to @p func
26286     * @return A handle to the item added or @c NULL, on errors
26287     *
26288     * @warning Ctxpopup can't hold both an item list and a content at the same
26289     * time. When an item is added, any previous content will be removed.
26290     *
26291     * @see elm_ctxpopup_content_set()
26292     */
26293    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);
26294    /**
26295     * @brief Delete the given item in a ctxpopup object.
26296     *
26297     * @param it Ctxpopup item to be deleted
26298     *
26299     * @see elm_ctxpopup_item_append()
26300     */
26301    EAPI void          elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26302    /**
26303     * @brief Set the ctxpopup item's state as disabled or enabled.
26304     *
26305     * @param it Ctxpopup item to be enabled/disabled
26306     * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
26307     *
26308     * When disabled the item is greyed out to indicate it's state.
26309     */
26310    EAPI void          elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
26311    /**
26312     * @brief Get the ctxpopup item's disabled/enabled state.
26313     *
26314     * @param it Ctxpopup item to be enabled/disabled
26315     * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
26316     *
26317     * @see elm_ctxpopup_item_disabled_set()
26318     */
26319    EAPI Eina_Bool     elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26320    /**
26321     * @brief Get the icon object for the given ctxpopup item.
26322     *
26323     * @param it Ctxpopup item
26324     * @return icon object or @c NULL, if the item does not have icon or an error
26325     * occurred
26326     *
26327     * @see elm_ctxpopup_item_append()
26328     * @see elm_ctxpopup_item_icon_set()
26329     */
26330    EAPI Evas_Object  *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26331    /**
26332     * @brief Sets the side icon associated with the ctxpopup item
26333     *
26334     * @param it Ctxpopup item
26335     * @param icon Icon object to be set
26336     *
26337     * Once the icon object is set, a previously set one will be deleted.
26338     * @warning Setting the same icon for two items will cause the icon to
26339     * dissapear from the first item.
26340     *
26341     * @see elm_ctxpopup_item_append()
26342     */
26343    EAPI void          elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26344    /**
26345     * @brief Get the label for the given ctxpopup item.
26346     *
26347     * @param it Ctxpopup item
26348     * @return label string or @c NULL, if the item does not have label or an
26349     * error occured
26350     *
26351     * @see elm_ctxpopup_item_append()
26352     * @see elm_ctxpopup_item_label_set()
26353     */
26354    EAPI const char   *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26355    /**
26356     * @brief (Re)set the label on the given ctxpopup item.
26357     *
26358     * @param it Ctxpopup item
26359     * @param label String to set as label
26360     */
26361    EAPI void          elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26362    /**
26363     * @brief Set an elm widget as the content of the ctxpopup.
26364     *
26365     * @param obj Ctxpopup object
26366     * @param content Content to be swallowed
26367     *
26368     * If the content object is already set, a previous one will bedeleted. If
26369     * you want to keep that old content object, use the
26370     * elm_ctxpopup_content_unset() function.
26371     *
26372     * @deprecated use elm_object_content_set()
26373     *
26374     * @warning Ctxpopup can't hold both a item list and a content at the same
26375     * time. When a content is set, any previous items will be removed.
26376     */
26377    EINA_DEPRECATED EAPI void          elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
26378    /**
26379     * @brief Unset the ctxpopup content
26380     *
26381     * @param obj Ctxpopup object
26382     * @return The content that was being used
26383     *
26384     * Unparent and return the content object which was set for this widget.
26385     *
26386     * @deprecated use elm_object_content_unset()
26387     *
26388     * @see elm_ctxpopup_content_set()
26389     */
26390    EINA_DEPRECATED EAPI Evas_Object  *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26391    /**
26392     * @brief Set the direction priority of a ctxpopup.
26393     *
26394     * @param obj Ctxpopup object
26395     * @param first 1st priority of direction
26396     * @param second 2nd priority of direction
26397     * @param third 3th priority of direction
26398     * @param fourth 4th priority of direction
26399     *
26400     * This functions gives a chance to user to set the priority of ctxpopup
26401     * showing direction. This doesn't guarantee the ctxpopup will appear in the
26402     * requested direction.
26403     *
26404     * @see Elm_Ctxpopup_Direction
26405     */
26406    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);
26407    /**
26408     * @brief Get the direction priority of a ctxpopup.
26409     *
26410     * @param obj Ctxpopup object
26411     * @param first 1st priority of direction to be returned
26412     * @param second 2nd priority of direction to be returned
26413     * @param third 3th priority of direction to be returned
26414     * @param fourth 4th priority of direction to be returned
26415     *
26416     * @see elm_ctxpopup_direction_priority_set() for more information.
26417     */
26418    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);
26419
26420    /**
26421     * @brief Get the current direction of a ctxpopup.
26422     *
26423     * @param obj Ctxpopup object
26424     * @return current direction of a ctxpopup
26425     *
26426     * @warning Once the ctxpopup showed up, the direction would be determined
26427     */
26428    EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26429
26430    /**
26431     * @}
26432     */
26433
26434    /* transit */
26435    /**
26436     *
26437     * @defgroup Transit Transit
26438     * @ingroup Elementary
26439     *
26440     * Transit is designed to apply various animated transition effects to @c
26441     * Evas_Object, such like translation, rotation, etc. For using these
26442     * effects, create an @ref Elm_Transit and add the desired transition effects.
26443     *
26444     * Once the effects are added into transit, they will be automatically
26445     * managed (their callback will be called until the duration is ended, and
26446     * they will be deleted on completion).
26447     *
26448     * Example:
26449     * @code
26450     * Elm_Transit *trans = elm_transit_add();
26451     * elm_transit_object_add(trans, obj);
26452     * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
26453     * elm_transit_duration_set(transit, 1);
26454     * elm_transit_auto_reverse_set(transit, EINA_TRUE);
26455     * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
26456     * elm_transit_repeat_times_set(transit, 3);
26457     * @endcode
26458     *
26459     * Some transition effects are used to change the properties of objects. They
26460     * are:
26461     * @li @ref elm_transit_effect_translation_add
26462     * @li @ref elm_transit_effect_color_add
26463     * @li @ref elm_transit_effect_rotation_add
26464     * @li @ref elm_transit_effect_wipe_add
26465     * @li @ref elm_transit_effect_zoom_add
26466     * @li @ref elm_transit_effect_resizing_add
26467     *
26468     * Other transition effects are used to make one object disappear and another
26469     * object appear on its old place. These effects are:
26470     *
26471     * @li @ref elm_transit_effect_flip_add
26472     * @li @ref elm_transit_effect_resizable_flip_add
26473     * @li @ref elm_transit_effect_fade_add
26474     * @li @ref elm_transit_effect_blend_add
26475     *
26476     * It's also possible to make a transition chain with @ref
26477     * elm_transit_chain_transit_add.
26478     *
26479     * @warning We strongly recommend to use elm_transit just when edje can not do
26480     * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
26481     * animations can be manipulated inside the theme.
26482     *
26483     * List of examples:
26484     * @li @ref transit_example_01_explained
26485     * @li @ref transit_example_02_explained
26486     * @li @ref transit_example_03_c
26487     * @li @ref transit_example_04_c
26488     *
26489     * @{
26490     */
26491
26492    /**
26493     * @enum Elm_Transit_Tween_Mode
26494     *
26495     * The type of acceleration used in the transition.
26496     */
26497    typedef enum
26498      {
26499         ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
26500         ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
26501                                              over time, then decrease again
26502                                              and stop slowly */
26503         ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
26504                                              speed over time */
26505         ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
26506                                             over time */
26507      } Elm_Transit_Tween_Mode;
26508
26509    /**
26510     * @enum Elm_Transit_Effect_Flip_Axis
26511     *
26512     * The axis where flip effect should be applied.
26513     */
26514    typedef enum
26515      {
26516         ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
26517         ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
26518      } Elm_Transit_Effect_Flip_Axis;
26519    /**
26520     * @enum Elm_Transit_Effect_Wipe_Dir
26521     *
26522     * The direction where the wipe effect should occur.
26523     */
26524    typedef enum
26525      {
26526         ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
26527         ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
26528         ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
26529         ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
26530      } Elm_Transit_Effect_Wipe_Dir;
26531    /** @enum Elm_Transit_Effect_Wipe_Type
26532     *
26533     * Whether the wipe effect should show or hide the object.
26534     */
26535    typedef enum
26536      {
26537         ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
26538                                              animation */
26539         ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
26540                                             animation */
26541      } Elm_Transit_Effect_Wipe_Type;
26542
26543    /**
26544     * @typedef Elm_Transit
26545     *
26546     * The Transit created with elm_transit_add(). This type has the information
26547     * about the objects which the transition will be applied, and the
26548     * transition effects that will be used. It also contains info about
26549     * duration, number of repetitions, auto-reverse, etc.
26550     */
26551    typedef struct _Elm_Transit Elm_Transit;
26552    typedef void Elm_Transit_Effect;
26553    /**
26554     * @typedef Elm_Transit_Effect_Transition_Cb
26555     *
26556     * Transition callback called for this effect on each transition iteration.
26557     */
26558    typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
26559    /**
26560     * Elm_Transit_Effect_End_Cb
26561     *
26562     * Transition callback called for this effect when the transition is over.
26563     */
26564    typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
26565
26566    /**
26567     * Elm_Transit_Del_Cb
26568     *
26569     * A callback called when the transit is deleted.
26570     */
26571    typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
26572
26573    /**
26574     * Add new transit.
26575     *
26576     * @note Is not necessary to delete the transit object, it will be deleted at
26577     * the end of its operation.
26578     * @note The transit will start playing when the program enter in the main loop, is not
26579     * necessary to give a start to the transit.
26580     *
26581     * @return The transit object.
26582     *
26583     * @ingroup Transit
26584     */
26585    EAPI Elm_Transit                *elm_transit_add(void);
26586
26587    /**
26588     * Stops the animation and delete the @p transit object.
26589     *
26590     * Call this function if you wants to stop the animation before the duration
26591     * time. Make sure the @p transit object is still alive with
26592     * elm_transit_del_cb_set() function.
26593     * All added effects will be deleted, calling its repective data_free_cb
26594     * functions. The function setted by elm_transit_del_cb_set() will be called.
26595     *
26596     * @see elm_transit_del_cb_set()
26597     *
26598     * @param transit The transit object to be deleted.
26599     *
26600     * @ingroup Transit
26601     * @warning Just call this function if you are sure the transit is alive.
26602     */
26603    EAPI void                        elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
26604
26605    /**
26606     * Add a new effect to the transit.
26607     *
26608     * @note The cb function and the data are the key to the effect. If you try to
26609     * add an already added effect, nothing is done.
26610     * @note After the first addition of an effect in @p transit, if its
26611     * effect list become empty again, the @p transit will be killed by
26612     * elm_transit_del(transit) function.
26613     *
26614     * Exemple:
26615     * @code
26616     * Elm_Transit *transit = elm_transit_add();
26617     * elm_transit_effect_add(transit,
26618     *                        elm_transit_effect_blend_op,
26619     *                        elm_transit_effect_blend_context_new(),
26620     *                        elm_transit_effect_blend_context_free);
26621     * @endcode
26622     *
26623     * @param transit The transit object.
26624     * @param transition_cb The operation function. It is called when the
26625     * animation begins, it is the function that actually performs the animation.
26626     * It is called with the @p data, @p transit and the time progression of the
26627     * animation (a double value between 0.0 and 1.0).
26628     * @param effect The context data of the effect.
26629     * @param end_cb The function to free the context data, it will be called
26630     * at the end of the effect, it must finalize the animation and free the
26631     * @p data.
26632     *
26633     * @ingroup Transit
26634     * @warning The transit free the context data at the and of the transition with
26635     * the data_free_cb function, do not use the context data in another transit.
26636     */
26637    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);
26638
26639    /**
26640     * Delete an added effect.
26641     *
26642     * This function will remove the effect from the @p transit, calling the
26643     * data_free_cb to free the @p data.
26644     *
26645     * @see elm_transit_effect_add()
26646     *
26647     * @note If the effect is not found, nothing is done.
26648     * @note If the effect list become empty, this function will call
26649     * elm_transit_del(transit), that is, it will kill the @p transit.
26650     *
26651     * @param transit The transit object.
26652     * @param transition_cb The operation function.
26653     * @param effect The context data of the effect.
26654     *
26655     * @ingroup Transit
26656     */
26657    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);
26658
26659    /**
26660     * Add new object to apply the effects.
26661     *
26662     * @note After the first addition of an object in @p transit, if its
26663     * object list become empty again, the @p transit will be killed by
26664     * elm_transit_del(transit) function.
26665     * @note If the @p obj belongs to another transit, the @p obj will be
26666     * removed from it and it will only belong to the @p transit. If the old
26667     * transit stays without objects, it will die.
26668     * @note When you add an object into the @p transit, its state from
26669     * evas_object_pass_events_get(obj) is saved, and it is applied when the
26670     * transit ends, if you change this state whith evas_object_pass_events_set()
26671     * after add the object, this state will change again when @p transit stops to
26672     * run.
26673     *
26674     * @param transit The transit object.
26675     * @param obj Object to be animated.
26676     *
26677     * @ingroup Transit
26678     * @warning It is not allowed to add a new object after transit begins to go.
26679     */
26680    EAPI void                        elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26681
26682    /**
26683     * Removes an added object from the transit.
26684     *
26685     * @note If the @p obj is not in the @p transit, nothing is done.
26686     * @note If the list become empty, this function will call
26687     * elm_transit_del(transit), that is, it will kill the @p transit.
26688     *
26689     * @param transit The transit object.
26690     * @param obj Object to be removed from @p transit.
26691     *
26692     * @ingroup Transit
26693     * @warning It is not allowed to remove objects after transit begins to go.
26694     */
26695    EAPI void                        elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26696
26697    /**
26698     * Get the objects of the transit.
26699     *
26700     * @param transit The transit object.
26701     * @return a Eina_List with the objects from the transit.
26702     *
26703     * @ingroup Transit
26704     */
26705    EAPI const Eina_List            *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26706
26707    /**
26708     * Enable/disable keeping up the objects states.
26709     * If it is not kept, the objects states will be reset when transition ends.
26710     *
26711     * @note @p transit can not be NULL.
26712     * @note One state includes geometry, color, map data.
26713     *
26714     * @param transit The transit object.
26715     * @param state_keep Keeping or Non Keeping.
26716     *
26717     * @ingroup Transit
26718     */
26719    EAPI void                        elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
26720
26721    /**
26722     * Get a value whether the objects states will be reset or not.
26723     *
26724     * @note @p transit can not be NULL
26725     *
26726     * @see elm_transit_objects_final_state_keep_set()
26727     *
26728     * @param transit The transit object.
26729     * @return EINA_TRUE means the states of the objects will be reset.
26730     * If @p transit is NULL, EINA_FALSE is returned
26731     *
26732     * @ingroup Transit
26733     */
26734    EAPI Eina_Bool                   elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26735
26736    /**
26737     * Set the event enabled when transit is operating.
26738     *
26739     * If @p enabled is EINA_TRUE, the objects of the transit will receives
26740     * events from mouse and keyboard during the animation.
26741     * @note When you add an object with elm_transit_object_add(), its state from
26742     * evas_object_pass_events_get(obj) is saved, and it is applied when the
26743     * transit ends, if you change this state with evas_object_pass_events_set()
26744     * after adding the object, this state will change again when @p transit stops
26745     * to run.
26746     *
26747     * @param transit The transit object.
26748     * @param enabled Events are received when enabled is @c EINA_TRUE, and
26749     * ignored otherwise.
26750     *
26751     * @ingroup Transit
26752     */
26753    EAPI void                        elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
26754
26755    /**
26756     * Get the value of event enabled status.
26757     *
26758     * @see elm_transit_event_enabled_set()
26759     *
26760     * @param transit The Transit object
26761     * @return EINA_TRUE, when event is enabled. If @p transit is NULL
26762     * EINA_FALSE is returned
26763     *
26764     * @ingroup Transit
26765     */
26766    EAPI Eina_Bool                   elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26767
26768    /**
26769     * Set the user-callback function when the transit is deleted.
26770     *
26771     * @note Using this function twice will overwrite the first function setted.
26772     * @note the @p transit object will be deleted after call @p cb function.
26773     *
26774     * @param transit The transit object.
26775     * @param cb Callback function pointer. This function will be called before
26776     * the deletion of the transit.
26777     * @param data Callback funtion user data. It is the @p op parameter.
26778     *
26779     * @ingroup Transit
26780     */
26781    EAPI void                        elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
26782
26783    /**
26784     * Set reverse effect automatically.
26785     *
26786     * If auto reverse is setted, after running the effects with the progress
26787     * parameter from 0 to 1, it will call the effecs again with the progress
26788     * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
26789     * where the duration was setted with the function elm_transit_add and
26790     * the repeat with the function elm_transit_repeat_times_set().
26791     *
26792     * @param transit The transit object.
26793     * @param reverse EINA_TRUE means the auto_reverse is on.
26794     *
26795     * @ingroup Transit
26796     */
26797    EAPI void                        elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
26798
26799    /**
26800     * Get if the auto reverse is on.
26801     *
26802     * @see elm_transit_auto_reverse_set()
26803     *
26804     * @param transit The transit object.
26805     * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
26806     * EINA_FALSE is returned
26807     *
26808     * @ingroup Transit
26809     */
26810    EAPI Eina_Bool                   elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26811
26812    /**
26813     * Set the transit repeat count. Effect will be repeated by repeat count.
26814     *
26815     * This function sets the number of repetition the transit will run after
26816     * the first one, that is, if @p repeat is 1, the transit will run 2 times.
26817     * If the @p repeat is a negative number, it will repeat infinite times.
26818     *
26819     * @note If this function is called during the transit execution, the transit
26820     * will run @p repeat times, ignoring the times it already performed.
26821     *
26822     * @param transit The transit object
26823     * @param repeat Repeat count
26824     *
26825     * @ingroup Transit
26826     */
26827    EAPI void                        elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
26828
26829    /**
26830     * Get the transit repeat count.
26831     *
26832     * @see elm_transit_repeat_times_set()
26833     *
26834     * @param transit The Transit object.
26835     * @return The repeat count. If @p transit is NULL
26836     * 0 is returned
26837     *
26838     * @ingroup Transit
26839     */
26840    EAPI int                         elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26841
26842    /**
26843     * Set the transit animation acceleration type.
26844     *
26845     * This function sets the tween mode of the transit that can be:
26846     * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
26847     * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
26848     * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
26849     * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
26850     *
26851     * @param transit The transit object.
26852     * @param tween_mode The tween type.
26853     *
26854     * @ingroup Transit
26855     */
26856    EAPI void                        elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
26857
26858    /**
26859     * Get the transit animation acceleration type.
26860     *
26861     * @note @p transit can not be NULL
26862     *
26863     * @param transit The transit object.
26864     * @return The tween type. If @p transit is NULL
26865     * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
26866     *
26867     * @ingroup Transit
26868     */
26869    EAPI Elm_Transit_Tween_Mode      elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26870
26871    /**
26872     * Set the transit animation time
26873     *
26874     * @note @p transit can not be NULL
26875     *
26876     * @param transit The transit object.
26877     * @param duration The animation time.
26878     *
26879     * @ingroup Transit
26880     */
26881    EAPI void                        elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
26882
26883    /**
26884     * Get the transit animation time
26885     *
26886     * @note @p transit can not be NULL
26887     *
26888     * @param transit The transit object.
26889     *
26890     * @return The transit animation time.
26891     *
26892     * @ingroup Transit
26893     */
26894    EAPI double                      elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26895
26896    /**
26897     * Starts the transition.
26898     * Once this API is called, the transit begins to measure the time.
26899     *
26900     * @note @p transit can not be NULL
26901     *
26902     * @param transit The transit object.
26903     *
26904     * @ingroup Transit
26905     */
26906    EAPI void                        elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
26907
26908    /**
26909     * Pause/Resume the transition.
26910     *
26911     * If you call elm_transit_go again, the transit will be started from the
26912     * beginning, and will be unpaused.
26913     *
26914     * @note @p transit can not be NULL
26915     *
26916     * @param transit The transit object.
26917     * @param paused Whether the transition should be paused or not.
26918     *
26919     * @ingroup Transit
26920     */
26921    EAPI void                        elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
26922
26923    /**
26924     * Get the value of paused status.
26925     *
26926     * @see elm_transit_paused_set()
26927     *
26928     * @note @p transit can not be NULL
26929     *
26930     * @param transit The transit object.
26931     * @return EINA_TRUE means transition is paused. If @p transit is NULL
26932     * EINA_FALSE is returned
26933     *
26934     * @ingroup Transit
26935     */
26936    EAPI Eina_Bool                   elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26937
26938    /**
26939     * Get the time progression of the animation (a double value between 0.0 and 1.0).
26940     *
26941     * The value returned is a fraction (current time / total time). It
26942     * represents the progression position relative to the total.
26943     *
26944     * @note @p transit can not be NULL
26945     *
26946     * @param transit The transit object.
26947     *
26948     * @return The time progression value. If @p transit is NULL
26949     * 0 is returned
26950     *
26951     * @ingroup Transit
26952     */
26953    EAPI double                      elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26954
26955    /**
26956     * Makes the chain relationship between two transits.
26957     *
26958     * @note @p transit can not be NULL. Transit would have multiple chain transits.
26959     * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
26960     *
26961     * @param transit The transit object.
26962     * @param chain_transit The chain transit object. This transit will be operated
26963     *        after transit is done.
26964     *
26965     * This function adds @p chain_transit transition to a chain after the @p
26966     * transit, and will be started as soon as @p transit ends. See @ref
26967     * transit_example_02_explained for a full example.
26968     *
26969     * @ingroup Transit
26970     */
26971    EAPI void                        elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
26972
26973    /**
26974     * Cut off the chain relationship between two transits.
26975     *
26976     * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
26977     * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
26978     *
26979     * @param transit The transit object.
26980     * @param chain_transit The chain transit object.
26981     *
26982     * This function remove the @p chain_transit transition from the @p transit.
26983     *
26984     * @ingroup Transit
26985     */
26986    EAPI void                        elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
26987
26988    /**
26989     * Get the current chain transit list.
26990     *
26991     * @note @p transit can not be NULL.
26992     *
26993     * @param transit The transit object.
26994     * @return chain transit list.
26995     *
26996     * @ingroup Transit
26997     */
26998    EAPI Eina_List                  *elm_transit_chain_transits_get(const Elm_Transit *transit);
26999
27000    /**
27001     * Add the Resizing Effect to Elm_Transit.
27002     *
27003     * @note This API is one of the facades. It creates resizing effect context
27004     * and add it's required APIs to elm_transit_effect_add.
27005     *
27006     * @see elm_transit_effect_add()
27007     *
27008     * @param transit Transit object.
27009     * @param from_w Object width size when effect begins.
27010     * @param from_h Object height size when effect begins.
27011     * @param to_w Object width size when effect ends.
27012     * @param to_h Object height size when effect ends.
27013     * @return Resizing effect context data.
27014     *
27015     * @ingroup Transit
27016     */
27017    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);
27018
27019    /**
27020     * Add the Translation Effect to Elm_Transit.
27021     *
27022     * @note This API is one of the facades. It creates translation effect context
27023     * and add it's required APIs to elm_transit_effect_add.
27024     *
27025     * @see elm_transit_effect_add()
27026     *
27027     * @param transit Transit object.
27028     * @param from_dx X Position variation when effect begins.
27029     * @param from_dy Y Position variation when effect begins.
27030     * @param to_dx X Position variation when effect ends.
27031     * @param to_dy Y Position variation when effect ends.
27032     * @return Translation effect context data.
27033     *
27034     * @ingroup Transit
27035     * @warning It is highly recommended just create a transit with this effect when
27036     * the window that the objects of the transit belongs has already been created.
27037     * This is because this effect needs the geometry information about the objects,
27038     * and if the window was not created yet, it can get a wrong information.
27039     */
27040    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);
27041
27042    /**
27043     * Add the Zoom Effect to Elm_Transit.
27044     *
27045     * @note This API is one of the facades. It creates zoom effect context
27046     * and add it's required APIs to elm_transit_effect_add.
27047     *
27048     * @see elm_transit_effect_add()
27049     *
27050     * @param transit Transit object.
27051     * @param from_rate Scale rate when effect begins (1 is current rate).
27052     * @param to_rate Scale rate when effect ends.
27053     * @return Zoom effect context data.
27054     *
27055     * @ingroup Transit
27056     * @warning It is highly recommended just create a transit with this effect when
27057     * the window that the objects of the transit belongs has already been created.
27058     * This is because this effect needs the geometry information about the objects,
27059     * and if the window was not created yet, it can get a wrong information.
27060     */
27061    EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
27062
27063    /**
27064     * Add the Flip Effect to Elm_Transit.
27065     *
27066     * @note This API is one of the facades. It creates flip effect context
27067     * and add it's required APIs to elm_transit_effect_add.
27068     * @note This effect is applied to each pair of objects in the order they are listed
27069     * in the transit list of objects. The first object in the pair will be the
27070     * "front" object and the second will be the "back" object.
27071     *
27072     * @see elm_transit_effect_add()
27073     *
27074     * @param transit Transit object.
27075     * @param axis Flipping Axis(X or Y).
27076     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27077     * @return Flip effect context data.
27078     *
27079     * @ingroup Transit
27080     * @warning It is highly recommended just create a transit with this effect when
27081     * the window that the objects of the transit belongs has already been created.
27082     * This is because this effect needs the geometry information about the objects,
27083     * and if the window was not created yet, it can get a wrong information.
27084     */
27085    EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27086
27087    /**
27088     * Add the Resizable Flip Effect to Elm_Transit.
27089     *
27090     * @note This API is one of the facades. It creates resizable flip effect context
27091     * and add it's required APIs to elm_transit_effect_add.
27092     * @note This effect is applied to each pair of objects in the order they are listed
27093     * in the transit list of objects. The first object in the pair will be the
27094     * "front" object and the second will be the "back" object.
27095     *
27096     * @see elm_transit_effect_add()
27097     *
27098     * @param transit Transit object.
27099     * @param axis Flipping Axis(X or Y).
27100     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27101     * @return Resizable flip effect context data.
27102     *
27103     * @ingroup Transit
27104     * @warning It is highly recommended just create a transit with this effect when
27105     * the window that the objects of the transit belongs has already been created.
27106     * This is because this effect needs the geometry information about the objects,
27107     * and if the window was not created yet, it can get a wrong information.
27108     */
27109    EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27110
27111    /**
27112     * Add the Wipe Effect to Elm_Transit.
27113     *
27114     * @note This API is one of the facades. It creates wipe effect context
27115     * and add it's required APIs to elm_transit_effect_add.
27116     *
27117     * @see elm_transit_effect_add()
27118     *
27119     * @param transit Transit object.
27120     * @param type Wipe type. Hide or show.
27121     * @param dir Wipe Direction.
27122     * @return Wipe effect context data.
27123     *
27124     * @ingroup Transit
27125     * @warning It is highly recommended just create a transit with this effect when
27126     * the window that the objects of the transit belongs has already been created.
27127     * This is because this effect needs the geometry information about the objects,
27128     * and if the window was not created yet, it can get a wrong information.
27129     */
27130    EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
27131
27132    /**
27133     * Add the Color Effect to Elm_Transit.
27134     *
27135     * @note This API is one of the facades. It creates color effect context
27136     * and add it's required APIs to elm_transit_effect_add.
27137     *
27138     * @see elm_transit_effect_add()
27139     *
27140     * @param transit        Transit object.
27141     * @param  from_r        RGB R when effect begins.
27142     * @param  from_g        RGB G when effect begins.
27143     * @param  from_b        RGB B when effect begins.
27144     * @param  from_a        RGB A when effect begins.
27145     * @param  to_r          RGB R when effect ends.
27146     * @param  to_g          RGB G when effect ends.
27147     * @param  to_b          RGB B when effect ends.
27148     * @param  to_a          RGB A when effect ends.
27149     * @return               Color effect context data.
27150     *
27151     * @ingroup Transit
27152     */
27153    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);
27154
27155    /**
27156     * Add the Fade Effect to Elm_Transit.
27157     *
27158     * @note This API is one of the facades. It creates fade effect context
27159     * and add it's required APIs to elm_transit_effect_add.
27160     * @note This effect is applied to each pair of objects in the order they are listed
27161     * in the transit list of objects. The first object in the pair will be the
27162     * "before" object and the second will be the "after" object.
27163     *
27164     * @see elm_transit_effect_add()
27165     *
27166     * @param transit Transit object.
27167     * @return Fade effect context data.
27168     *
27169     * @ingroup Transit
27170     * @warning It is highly recommended just create a transit with this effect when
27171     * the window that the objects of the transit belongs has already been created.
27172     * This is because this effect needs the color information about the objects,
27173     * and if the window was not created yet, it can get a wrong information.
27174     */
27175    EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
27176
27177    /**
27178     * Add the Blend Effect to Elm_Transit.
27179     *
27180     * @note This API is one of the facades. It creates blend effect context
27181     * and add it's required APIs to elm_transit_effect_add.
27182     * @note This effect is applied to each pair of objects in the order they are listed
27183     * in the transit list of objects. The first object in the pair will be the
27184     * "before" object and the second will be the "after" object.
27185     *
27186     * @see elm_transit_effect_add()
27187     *
27188     * @param transit Transit object.
27189     * @return Blend effect context data.
27190     *
27191     * @ingroup Transit
27192     * @warning It is highly recommended just create a transit with this effect when
27193     * the window that the objects of the transit belongs has already been created.
27194     * This is because this effect needs the color information about the objects,
27195     * and if the window was not created yet, it can get a wrong information.
27196     */
27197    EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
27198
27199    /**
27200     * Add the Rotation Effect to Elm_Transit.
27201     *
27202     * @note This API is one of the facades. It creates rotation effect context
27203     * and add it's required APIs to elm_transit_effect_add.
27204     *
27205     * @see elm_transit_effect_add()
27206     *
27207     * @param transit Transit object.
27208     * @param from_degree Degree when effect begins.
27209     * @param to_degree Degree when effect is ends.
27210     * @return Rotation effect context data.
27211     *
27212     * @ingroup Transit
27213     * @warning It is highly recommended just create a transit with this effect when
27214     * the window that the objects of the transit belongs has already been created.
27215     * This is because this effect needs the geometry information about the objects,
27216     * and if the window was not created yet, it can get a wrong information.
27217     */
27218    EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
27219
27220    /**
27221     * Add the ImageAnimation Effect to Elm_Transit.
27222     *
27223     * @note This API is one of the facades. It creates image animation effect context
27224     * and add it's required APIs to elm_transit_effect_add.
27225     * The @p images parameter is a list images paths. This list and
27226     * its contents will be deleted at the end of the effect by
27227     * elm_transit_effect_image_animation_context_free() function.
27228     *
27229     * Example:
27230     * @code
27231     * char buf[PATH_MAX];
27232     * Eina_List *images = NULL;
27233     * Elm_Transit *transi = elm_transit_add();
27234     *
27235     * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
27236     * images = eina_list_append(images, eina_stringshare_add(buf));
27237     *
27238     * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
27239     * images = eina_list_append(images, eina_stringshare_add(buf));
27240     * elm_transit_effect_image_animation_add(transi, images);
27241     *
27242     * @endcode
27243     *
27244     * @see elm_transit_effect_add()
27245     *
27246     * @param transit Transit object.
27247     * @param images Eina_List of images file paths. This list and
27248     * its contents will be deleted at the end of the effect by
27249     * elm_transit_effect_image_animation_context_free() function.
27250     * @return Image Animation effect context data.
27251     *
27252     * @ingroup Transit
27253     */
27254    EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
27255    /**
27256     * @}
27257     */
27258
27259    typedef struct _Elm_Store                      Elm_Store;
27260    typedef struct _Elm_Store_Filesystem           Elm_Store_Filesystem;
27261    typedef struct _Elm_Store_Item                 Elm_Store_Item;
27262    typedef struct _Elm_Store_Item_Filesystem      Elm_Store_Item_Filesystem;
27263    typedef struct _Elm_Store_Item_Info            Elm_Store_Item_Info;
27264    typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
27265    typedef struct _Elm_Store_Item_Mapping         Elm_Store_Item_Mapping;
27266    typedef struct _Elm_Store_Item_Mapping_Empty   Elm_Store_Item_Mapping_Empty;
27267    typedef struct _Elm_Store_Item_Mapping_Icon    Elm_Store_Item_Mapping_Icon;
27268    typedef struct _Elm_Store_Item_Mapping_Photo   Elm_Store_Item_Mapping_Photo;
27269    typedef struct _Elm_Store_Item_Mapping_Custom  Elm_Store_Item_Mapping_Custom;
27270
27271    typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
27272    typedef void      (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
27273    typedef void      (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
27274    typedef void     *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
27275
27276    typedef enum
27277      {
27278         ELM_STORE_ITEM_MAPPING_NONE = 0,
27279         ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
27280         ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
27281         ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
27282         ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
27283         ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
27284         // can add more here as needed by common apps
27285         ELM_STORE_ITEM_MAPPING_LAST
27286      } Elm_Store_Item_Mapping_Type;
27287
27288    struct _Elm_Store_Item_Mapping_Icon
27289      {
27290         // FIXME: allow edje file icons
27291         int                   w, h;
27292         Elm_Icon_Lookup_Order lookup_order;
27293         Eina_Bool             standard_name : 1;
27294         Eina_Bool             no_scale : 1;
27295         Eina_Bool             smooth : 1;
27296         Eina_Bool             scale_up : 1;
27297         Eina_Bool             scale_down : 1;
27298      };
27299
27300    struct _Elm_Store_Item_Mapping_Empty
27301      {
27302         Eina_Bool             dummy;
27303      };
27304
27305    struct _Elm_Store_Item_Mapping_Photo
27306      {
27307         int                   size;
27308      };
27309
27310    struct _Elm_Store_Item_Mapping_Custom
27311      {
27312         Elm_Store_Item_Mapping_Cb func;
27313      };
27314
27315    struct _Elm_Store_Item_Mapping
27316      {
27317         Elm_Store_Item_Mapping_Type     type;
27318         const char                     *part;
27319         int                             offset;
27320         union
27321           {
27322              Elm_Store_Item_Mapping_Empty  empty;
27323              Elm_Store_Item_Mapping_Icon   icon;
27324              Elm_Store_Item_Mapping_Photo  photo;
27325              Elm_Store_Item_Mapping_Custom custom;
27326              // add more types here
27327           } details;
27328      };
27329
27330    struct _Elm_Store_Item_Info
27331      {
27332         Elm_Genlist_Item_Class       *item_class;
27333         const Elm_Store_Item_Mapping *mapping;
27334         void                         *data;
27335         char                         *sort_id;
27336      };
27337
27338    struct _Elm_Store_Item_Info_Filesystem
27339      {
27340         Elm_Store_Item_Info  base;
27341         char                *path;
27342      };
27343
27344 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
27345 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
27346
27347    EAPI void                    elm_store_free(Elm_Store *st);
27348
27349    EAPI Elm_Store              *elm_store_filesystem_new(void);
27350    EAPI void                    elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
27351    EAPI const char             *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27352    EAPI const char             *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27353
27354    EAPI void                    elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
27355
27356    EAPI void                    elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
27357    EAPI int                     elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27358    EAPI void                    elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27359    EAPI void                    elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27360    EAPI void                    elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
27361    EAPI Eina_Bool               elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27362
27363    EAPI void                    elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27364    EAPI void                    elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
27365    EAPI Eina_Bool               elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27366    EAPI void                    elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
27367    EAPI void                   *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27368    EAPI const Elm_Store        *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27369    EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27370
27371    /**
27372     * @defgroup SegmentControl SegmentControl
27373     * @ingroup Elementary
27374     *
27375     * @image html img/widget/segment_control/preview-00.png
27376     * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
27377     *
27378     * @image html img/segment_control.png
27379     * @image latex img/segment_control.eps width=\textwidth
27380     *
27381     * Segment control widget is a horizontal control made of multiple segment
27382     * items, each segment item functioning similar to discrete two state button.
27383     * A segment control groups the items together and provides compact
27384     * single button with multiple equal size segments.
27385     *
27386     * Segment item size is determined by base widget
27387     * size and the number of items added.
27388     * Only one segment item can be at selected state. A segment item can display
27389     * combination of Text and any Evas_Object like Images or other widget.
27390     *
27391     * Smart callbacks one can listen to:
27392     * - "changed" - When the user clicks on a segment item which is not
27393     *   previously selected and get selected. The event_info parameter is the
27394     *   segment item index.
27395     *
27396     * Available styles for it:
27397     * - @c "default"
27398     *
27399     * Here is an example on its usage:
27400     * @li @ref segment_control_example
27401     */
27402
27403    /**
27404     * @addtogroup SegmentControl
27405     * @{
27406     */
27407
27408    typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
27409
27410    /**
27411     * Add a new segment control widget to the given parent Elementary
27412     * (container) object.
27413     *
27414     * @param parent The parent object.
27415     * @return a new segment control widget handle or @c NULL, on errors.
27416     *
27417     * This function inserts a new segment control widget on the canvas.
27418     *
27419     * @ingroup SegmentControl
27420     */
27421    EAPI Evas_Object      *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27422
27423    /**
27424     * Append a new item to the segment control object.
27425     *
27426     * @param obj The segment control object.
27427     * @param icon The icon object to use for the left side of the item. An
27428     * icon can be any Evas object, but usually it is an icon created
27429     * with elm_icon_add().
27430     * @param label The label of the item.
27431     *        Note that, NULL is different from empty string "".
27432     * @return The created item or @c NULL upon failure.
27433     *
27434     * A new item will be created and appended to the segment control, i.e., will
27435     * be set as @b last item.
27436     *
27437     * If it should be inserted at another position,
27438     * elm_segment_control_item_insert_at() should be used instead.
27439     *
27440     * Items created with this function can be deleted with function
27441     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27442     *
27443     * @note @p label set to @c NULL is different from empty string "".
27444     * If an item
27445     * only has icon, it will be displayed bigger and centered. If it has
27446     * icon and label, even that an empty string, icon will be smaller and
27447     * positioned at left.
27448     *
27449     * Simple example:
27450     * @code
27451     * sc = elm_segment_control_add(win);
27452     * ic = elm_icon_add(win);
27453     * elm_icon_file_set(ic, "path/to/image", NULL);
27454     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
27455     * elm_segment_control_item_add(sc, ic, "label");
27456     * evas_object_show(sc);
27457     * @endcode
27458     *
27459     * @see elm_segment_control_item_insert_at()
27460     * @see elm_segment_control_item_del()
27461     *
27462     * @ingroup SegmentControl
27463     */
27464    EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
27465
27466    /**
27467     * Insert a new item to the segment control object at specified position.
27468     *
27469     * @param obj The segment control object.
27470     * @param icon The icon object to use for the left side of the item. An
27471     * icon can be any Evas object, but usually it is an icon created
27472     * with elm_icon_add().
27473     * @param label The label of the item.
27474     * @param index Item position. Value should be between 0 and items count.
27475     * @return The created item or @c NULL upon failure.
27476
27477     * Index values must be between @c 0, when item will be prepended to
27478     * segment control, and items count, that can be get with
27479     * elm_segment_control_item_count_get(), case when item will be appended
27480     * to segment control, just like elm_segment_control_item_add().
27481     *
27482     * Items created with this function can be deleted with function
27483     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27484     *
27485     * @note @p label set to @c NULL is different from empty string "".
27486     * If an item
27487     * only has icon, it will be displayed bigger and centered. If it has
27488     * icon and label, even that an empty string, icon will be smaller and
27489     * positioned at left.
27490     *
27491     * @see elm_segment_control_item_add()
27492     * @see elm_segment_control_item_count_get()
27493     * @see elm_segment_control_item_del()
27494     *
27495     * @ingroup SegmentControl
27496     */
27497    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);
27498
27499    /**
27500     * Remove a segment control item from its parent, deleting it.
27501     *
27502     * @param it The item to be removed.
27503     *
27504     * Items can be added with elm_segment_control_item_add() or
27505     * elm_segment_control_item_insert_at().
27506     *
27507     * @ingroup SegmentControl
27508     */
27509    EAPI void              elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27510
27511    /**
27512     * Remove a segment control item at given index from its parent,
27513     * deleting it.
27514     *
27515     * @param obj The segment control object.
27516     * @param index The position of the segment control item to be deleted.
27517     *
27518     * Items can be added with elm_segment_control_item_add() or
27519     * elm_segment_control_item_insert_at().
27520     *
27521     * @ingroup SegmentControl
27522     */
27523    EAPI void              elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27524
27525    /**
27526     * Get the Segment items count from segment control.
27527     *
27528     * @param obj The segment control object.
27529     * @return Segment items count.
27530     *
27531     * It will just return the number of items added to segment control @p obj.
27532     *
27533     * @ingroup SegmentControl
27534     */
27535    EAPI int               elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27536
27537    /**
27538     * Get the item placed at specified index.
27539     *
27540     * @param obj The segment control object.
27541     * @param index The index of the segment item.
27542     * @return The segment control item or @c NULL on failure.
27543     *
27544     * Index is the position of an item in segment control widget. Its
27545     * range is from @c 0 to <tt> count - 1 </tt>.
27546     * Count is the number of items, that can be get with
27547     * elm_segment_control_item_count_get().
27548     *
27549     * @ingroup SegmentControl
27550     */
27551    EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27552
27553    /**
27554     * Get the label of item.
27555     *
27556     * @param obj The segment control object.
27557     * @param index The index of the segment item.
27558     * @return The label of the item at @p index.
27559     *
27560     * The return value is a pointer to the label associated to the item when
27561     * it was created, with function elm_segment_control_item_add(), or later
27562     * with function elm_segment_control_item_label_set. If no label
27563     * was passed as argument, it will return @c NULL.
27564     *
27565     * @see elm_segment_control_item_label_set() for more details.
27566     * @see elm_segment_control_item_add()
27567     *
27568     * @ingroup SegmentControl
27569     */
27570    EAPI const char       *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27571
27572    /**
27573     * Set the label of item.
27574     *
27575     * @param it The item of segment control.
27576     * @param text The label of item.
27577     *
27578     * The label to be displayed by the item.
27579     * Label will be at right of the icon (if set).
27580     *
27581     * If a label was passed as argument on item creation, with function
27582     * elm_control_segment_item_add(), it will be already
27583     * displayed by the item.
27584     *
27585     * @see elm_segment_control_item_label_get()
27586     * @see elm_segment_control_item_add()
27587     *
27588     * @ingroup SegmentControl
27589     */
27590    EAPI void              elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
27591
27592    /**
27593     * Get the icon associated to the item.
27594     *
27595     * @param obj The segment control object.
27596     * @param index The index of the segment item.
27597     * @return The left side icon associated to the item at @p index.
27598     *
27599     * The return value is a pointer to the icon associated to the item when
27600     * it was created, with function elm_segment_control_item_add(), or later
27601     * with function elm_segment_control_item_icon_set(). If no icon
27602     * was passed as argument, it will return @c NULL.
27603     *
27604     * @see elm_segment_control_item_add()
27605     * @see elm_segment_control_item_icon_set()
27606     *
27607     * @ingroup SegmentControl
27608     */
27609    EAPI Evas_Object      *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27610
27611    /**
27612     * Set the icon associated to the item.
27613     *
27614     * @param it The segment control item.
27615     * @param icon The icon object to associate with @p it.
27616     *
27617     * The icon object to use at left side of the item. An
27618     * icon can be any Evas object, but usually it is an icon created
27619     * with elm_icon_add().
27620     *
27621     * Once the icon object is set, a previously set one will be deleted.
27622     * @warning Setting the same icon for two items will cause the icon to
27623     * dissapear from the first item.
27624     *
27625     * If an icon was passed as argument on item creation, with function
27626     * elm_segment_control_item_add(), it will be already
27627     * associated to the item.
27628     *
27629     * @see elm_segment_control_item_add()
27630     * @see elm_segment_control_item_icon_get()
27631     *
27632     * @ingroup SegmentControl
27633     */
27634    EAPI void              elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
27635
27636    /**
27637     * Get the index of an item.
27638     *
27639     * @param it The segment control item.
27640     * @return The position of item in segment control widget.
27641     *
27642     * Index is the position of an item in segment control widget. Its
27643     * range is from @c 0 to <tt> count - 1 </tt>.
27644     * Count is the number of items, that can be get with
27645     * elm_segment_control_item_count_get().
27646     *
27647     * @ingroup SegmentControl
27648     */
27649    EAPI int               elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27650
27651    /**
27652     * Get the base object of the item.
27653     *
27654     * @param it The segment control item.
27655     * @return The base object associated with @p it.
27656     *
27657     * Base object is the @c Evas_Object that represents that item.
27658     *
27659     * @ingroup SegmentControl
27660     */
27661    EAPI Evas_Object      *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27662
27663    /**
27664     * Get the selected item.
27665     *
27666     * @param obj The segment control object.
27667     * @return The selected item or @c NULL if none of segment items is
27668     * selected.
27669     *
27670     * The selected item can be unselected with function
27671     * elm_segment_control_item_selected_set().
27672     *
27673     * The selected item always will be highlighted on segment control.
27674     *
27675     * @ingroup SegmentControl
27676     */
27677    EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27678
27679    /**
27680     * Set the selected state of an item.
27681     *
27682     * @param it The segment control item
27683     * @param select The selected state
27684     *
27685     * This sets the selected state of the given item @p it.
27686     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
27687     *
27688     * If a new item is selected the previosly selected will be unselected.
27689     * Previoulsy selected item can be get with function
27690     * elm_segment_control_item_selected_get().
27691     *
27692     * The selected item always will be highlighted on segment control.
27693     *
27694     * @see elm_segment_control_item_selected_get()
27695     *
27696     * @ingroup SegmentControl
27697     */
27698    EAPI void              elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
27699
27700    /**
27701     * @}
27702     */
27703
27704    /**
27705     * @defgroup Grid Grid
27706     *
27707     * The grid is a grid layout widget that lays out a series of children as a
27708     * fixed "grid" of widgets using a given percentage of the grid width and
27709     * height each using the child object.
27710     *
27711     * The Grid uses a "Virtual resolution" that is stretched to fill the grid
27712     * widgets size itself. The default is 100 x 100, so that means the
27713     * position and sizes of children will effectively be percentages (0 to 100)
27714     * of the width or height of the grid widget
27715     *
27716     * @{
27717     */
27718
27719    /**
27720     * Add a new grid to the parent
27721     *
27722     * @param parent The parent object
27723     * @return The new object or NULL if it cannot be created
27724     *
27725     * @ingroup Grid
27726     */
27727    EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
27728
27729    /**
27730     * Set the virtual size of the grid
27731     *
27732     * @param obj The grid object
27733     * @param w The virtual width of the grid
27734     * @param h The virtual height of the grid
27735     *
27736     * @ingroup Grid
27737     */
27738    EAPI void         elm_grid_size_set(Evas_Object *obj, int w, int h);
27739
27740    /**
27741     * Get the virtual size of the grid
27742     *
27743     * @param obj The grid object
27744     * @param w Pointer to integer to store the virtual width of the grid
27745     * @param h Pointer to integer to store the virtual height of the grid
27746     *
27747     * @ingroup Grid
27748     */
27749    EAPI void         elm_grid_size_get(Evas_Object *obj, int *w, int *h);
27750
27751    /**
27752     * Pack child at given position and size
27753     *
27754     * @param obj The grid object
27755     * @param subobj The child to pack
27756     * @param x The virtual x coord at which to pack it
27757     * @param y The virtual y coord at which to pack it
27758     * @param w The virtual width at which to pack it
27759     * @param h The virtual height at which to pack it
27760     *
27761     * @ingroup Grid
27762     */
27763    EAPI void         elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
27764
27765    /**
27766     * Unpack a child from a grid object
27767     *
27768     * @param obj The grid object
27769     * @param subobj The child to unpack
27770     *
27771     * @ingroup Grid
27772     */
27773    EAPI void         elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
27774
27775    /**
27776     * Faster way to remove all child objects from a grid object.
27777     *
27778     * @param obj The grid object
27779     * @param clear If true, it will delete just removed children
27780     *
27781     * @ingroup Grid
27782     */
27783    EAPI void         elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
27784
27785    /**
27786     * Set packing of an existing child at to position and size
27787     *
27788     * @param subobj The child to set packing of
27789     * @param x The virtual x coord at which to pack it
27790     * @param y The virtual y coord at which to pack it
27791     * @param w The virtual width at which to pack it
27792     * @param h The virtual height at which to pack it
27793     *
27794     * @ingroup Grid
27795     */
27796    EAPI void         elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
27797
27798    /**
27799     * get packing of a child
27800     *
27801     * @param subobj The child to query
27802     * @param x Pointer to integer to store the virtual x coord
27803     * @param y Pointer to integer to store the virtual y coord
27804     * @param w Pointer to integer to store the virtual width
27805     * @param h Pointer to integer to store the virtual height
27806     *
27807     * @ingroup Grid
27808     */
27809    EAPI void         elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
27810
27811    /**
27812     * @}
27813     */
27814
27815    EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
27816    EAPI void         elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
27817    EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
27818    EAPI void         elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
27819    EAPI Eina_Bool    elm_factory_maxmin_mode_get(const Evas_Object *obj);
27820    EAPI void         elm_factory_maxmin_reset_set(Evas_Object *obj);
27821
27822    /**
27823     * @defgroup Video Video
27824     *
27825     * @addtogroup Video
27826     * @{
27827     *
27828     * Elementary comes with two object that help design application that need
27829     * to display video. The main one, Elm_Video, display a video by using Emotion.
27830     * It does embedded the video inside an Edje object, so you can do some
27831     * animation depending on the video state change. It does also implement a
27832     * ressource management policy to remove this burden from the application writer.
27833     *
27834     * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
27835     * It take care of updating its content according to Emotion event and provide a
27836     * way to theme itself. It also does automatically raise the priority of the
27837     * linked Elm_Video so it will use the video decoder if available. It also does
27838     * activate the remember function on the linked Elm_Video object.
27839     *
27840     * Signals that you can add callback for are :
27841     *
27842     * "forward,clicked" - the user clicked the forward button.
27843     * "info,clicked" - the user clicked the info button.
27844     * "next,clicked" - the user clicked the next button.
27845     * "pause,clicked" - the user clicked the pause button.
27846     * "play,clicked" - the user clicked the play button.
27847     * "prev,clicked" - the user clicked the prev button.
27848     * "rewind,clicked" - the user clicked the rewind button.
27849     * "stop,clicked" - the user clicked the stop button.
27850     */
27851
27852    /**
27853     * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
27854     *
27855     * @param parent The parent object
27856     * @return a new player widget handle or @c NULL, on errors.
27857     *
27858     * This function inserts a new player widget on the canvas.
27859     *
27860     * @see elm_player_video_set()
27861     *
27862     * @ingroup Video
27863     */
27864    EAPI Evas_Object *elm_player_add(Evas_Object *parent);
27865
27866    /**
27867     * @brief Link a Elm_Payer with an Elm_Video object.
27868     *
27869     * @param player the Elm_Player object.
27870     * @param video The Elm_Video object.
27871     *
27872     * This mean that action on the player widget will affect the
27873     * video object and the state of the video will be reflected in
27874     * the player itself.
27875     *
27876     * @see elm_player_add()
27877     * @see elm_video_add()
27878     *
27879     * @ingroup Video
27880     */
27881    EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
27882
27883    /**
27884     * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
27885     *
27886     * @param parent The parent object
27887     * @return a new video widget handle or @c NULL, on errors.
27888     *
27889     * This function inserts a new video widget on the canvas.
27890     *
27891     * @seeelm_video_file_set()
27892     * @see elm_video_uri_set()
27893     *
27894     * @ingroup Video
27895     */
27896    EAPI Evas_Object *elm_video_add(Evas_Object *parent);
27897
27898    /**
27899     * @brief Define the file that will be the video source.
27900     *
27901     * @param video The video object to define the file for.
27902     * @param filename The file to target.
27903     *
27904     * This function will explicitly define a filename as a source
27905     * for the video of the Elm_Video object.
27906     *
27907     * @see elm_video_uri_set()
27908     * @see elm_video_add()
27909     * @see elm_player_add()
27910     *
27911     * @ingroup Video
27912     */
27913    EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
27914
27915    /**
27916     * @brief Define the uri that will be the video source.
27917     *
27918     * @param video The video object to define the file for.
27919     * @param uri The uri to target.
27920     *
27921     * This function will define an uri as a source for the video of the
27922     * Elm_Video object. URI could be remote source of video, like http:// or local source
27923     * like for example WebCam who are most of the time v4l2:// (but that depend and
27924     * you should use Emotion API to request and list the available Webcam on your system).
27925     *
27926     * @see elm_video_file_set()
27927     * @see elm_video_add()
27928     * @see elm_player_add()
27929     *
27930     * @ingroup Video
27931     */
27932    EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
27933
27934    /**
27935     * @brief Get the underlying Emotion object.
27936     *
27937     * @param video The video object to proceed the request on.
27938     * @return the underlying Emotion object.
27939     *
27940     * @ingroup Video
27941     */
27942    EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
27943
27944    /**
27945     * @brief Start to play the video
27946     *
27947     * @param video The video object to proceed the request on.
27948     *
27949     * Start to play the video and cancel all suspend state.
27950     *
27951     * @ingroup Video
27952     */
27953    EAPI void elm_video_play(Evas_Object *video);
27954
27955    /**
27956     * @brief Pause the video
27957     *
27958     * @param video The video object to proceed the request on.
27959     *
27960     * Pause the video and start a timer to trigger suspend mode.
27961     *
27962     * @ingroup Video
27963     */
27964    EAPI void elm_video_pause(Evas_Object *video);
27965
27966    /**
27967     * @brief Stop the video
27968     *
27969     * @param video The video object to proceed the request on.
27970     *
27971     * Stop the video and put the emotion in deep sleep mode.
27972     *
27973     * @ingroup Video
27974     */
27975    EAPI void elm_video_stop(Evas_Object *video);
27976
27977    /**
27978     * @brief Is the video actually playing.
27979     *
27980     * @param video The video object to proceed the request on.
27981     * @return EINA_TRUE if the video is actually playing.
27982     *
27983     * You should consider watching event on the object instead of polling
27984     * the object state.
27985     *
27986     * @ingroup Video
27987     */
27988    EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
27989
27990    /**
27991     * @brief Is it possible to seek inside the video.
27992     *
27993     * @param video The video object to proceed the request on.
27994     * @return EINA_TRUE if is possible to seek inside the video.
27995     *
27996     * @ingroup Video
27997     */
27998    EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
27999
28000    /**
28001     * @brief Is the audio muted.
28002     *
28003     * @param video The video object to proceed the request on.
28004     * @return EINA_TRUE if the audio is muted.
28005     *
28006     * @ingroup Video
28007     */
28008    EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
28009
28010    /**
28011     * @brief Change the mute state of the Elm_Video object.
28012     *
28013     * @param video The video object to proceed the request on.
28014     * @param mute The new mute state.
28015     *
28016     * @ingroup Video
28017     */
28018    EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
28019
28020    /**
28021     * @brief Get the audio level of the current video.
28022     *
28023     * @param video The video object to proceed the request on.
28024     * @return the current audio level.
28025     *
28026     * @ingroup Video
28027     */
28028    EAPI double elm_video_audio_level_get(Evas_Object *video);
28029
28030    /**
28031     * @brief Set the audio level of anElm_Video object.
28032     *
28033     * @param video The video object to proceed the request on.
28034     * @param volume The new audio volume.
28035     *
28036     * @ingroup Video
28037     */
28038    EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
28039
28040    EAPI double elm_video_play_position_get(Evas_Object *video);
28041    EAPI void elm_video_play_position_set(Evas_Object *video, double position);
28042    EAPI double elm_video_play_length_get(Evas_Object *video);
28043    EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
28044    EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
28045    EAPI const char *elm_video_title_get(Evas_Object *video);
28046    /**
28047     * @}
28048     */
28049
28050    /**
28051     * @defgroup Naviframe Naviframe
28052     * @ingroup Elementary
28053     *
28054     * @brief Naviframe is a kind of view manager for the applications.
28055     *
28056     * Naviframe provides functions to switch different pages with stack
28057     * mechanism. It means if one page(item) needs to be changed to the new one,
28058     * then naviframe would push the new page to it's internal stack. Of course,
28059     * it can be back to the previous page by popping the top page. Naviframe
28060     * provides some transition effect while the pages are switching (same as
28061     * pager).
28062     *
28063     * Since each item could keep the different styles, users could keep the
28064     * same look & feel for the pages or different styles for the items in it's
28065     * application.
28066     *
28067     * Signals that you can add callback for are:
28068     *
28069     * @li "transition,finished" - When the transition is finished in changing
28070     *     the item
28071     * @li "title,clicked" - User clicked title area
28072     *
28073     * Default contents parts for the naviframe items that you can use for are:
28074     *
28075     * @li "elm.swallow.content" - The main content of the page
28076     * @li "elm.swallow.prev_btn" - The button to go to the previous page
28077     * @li "elm.swallow.next_btn" - The button to go to the next page
28078     *
28079     * Default text parts of naviframe items that you can be used are:
28080     *
28081     * @li "elm.text.title" - The title label in the title area
28082     *
28083     * @ref tutorial_naviframe gives a good overview of the usage of the API.
28084     */
28085
28086    /**
28087     * @addtogroup Naviframe
28088     * @{
28089     */
28090
28091    /**
28092     * @brief Add a new Naviframe object to the parent.
28093     *
28094     * @param parent Parent object
28095     * @return New object or @c NULL, if it cannot be created
28096     *
28097     * @ingroup Naviframe
28098     */
28099    EAPI Evas_Object        *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28100    /**
28101     * @brief Push a new item to the top of the naviframe stack (and show it).
28102     *
28103     * @param obj The naviframe object
28104     * @param title_label The label in the title area. The name of the title
28105     *        label part is "elm.text.title"
28106     * @param prev_btn The button to go to the previous item. If it is NULL,
28107     *        then naviframe will create a back button automatically. The name of
28108     *        the prev_btn part is "elm.swallow.prev_btn"
28109     * @param next_btn The button to go to the next item. Or It could be just an
28110     *        extra function button. The name of the next_btn part is
28111     *        "elm.swallow.next_btn"
28112     * @param content The main content object. The name of content part is
28113     *        "elm.swallow.content"
28114     * @param item_style The current item style name. @c NULL would be default.
28115     * @return The created item or @c NULL upon failure.
28116     *
28117     * The item pushed becomes one page of the naviframe, this item will be
28118     * deleted when it is popped.
28119     *
28120     * @see also elm_naviframe_item_style_set()
28121     *
28122     * The following styles are available for this item:
28123     * @li @c "default"
28124     *
28125     * @ingroup Naviframe
28126     */
28127    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);
28128    /**
28129     * @brief Pop an item that is on top of the stack
28130     *
28131     * @param obj The naviframe object
28132     * @return @c NULL or the content object(if the
28133     *         elm_naviframe_content_preserve_on_pop_get is true).
28134     *
28135     * This pops an item that is on the top(visible) of the naviframe, makes it
28136     * disappear, then deletes the item. The item that was underneath it on the
28137     * stack will become visible.
28138     *
28139     * @see also elm_naviframe_content_preserve_on_pop_get()
28140     *
28141     * @ingroup Naviframe
28142     */
28143    EAPI Evas_Object        *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
28144    /**
28145     * @brief Pop the items between the top and the above one on the given item.
28146     *
28147     * @param it The naviframe item
28148     *
28149     * @ingroup Naviframe
28150     */
28151    EAPI void                elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28152    /**
28153     * @brief Delete the given item instantly.
28154     *
28155     * @param it The naviframe item
28156     *
28157     * This just deletes the given item from the naviframe item list instantly.
28158     * So this would not emit any signals for view transitions but just change
28159     * the current view if the given item is a top one.
28160     *
28161     * @ingroup Naviframe
28162     */
28163    EAPI void                elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28164    /**
28165     * @brief preserve the content objects when items are popped.
28166     *
28167     * @param obj The naviframe object
28168     * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
28169     *
28170     * @see also elm_naviframe_content_preserve_on_pop_get()
28171     *
28172     * @ingroup Naviframe
28173     */
28174    EAPI void                elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
28175    /**
28176     * @brief Get a value whether preserve mode is enabled or not.
28177     *
28178     * @param obj The naviframe object
28179     * @return If @c EINA_TRUE, preserve mode is enabled
28180     *
28181     * @see also elm_naviframe_content_preserve_on_pop_set()
28182     *
28183     * @ingroup Naviframe
28184     */
28185    EAPI Eina_Bool           elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28186    /**
28187     * @brief Get a top item on the naviframe stack
28188     *
28189     * @param obj The naviframe object
28190     * @return The top item on the naviframe stack or @c NULL, if the stack is
28191     *         empty
28192     *
28193     * @ingroup Naviframe
28194     */
28195    EAPI Elm_Object_Item    *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28196    /**
28197     * @brief Get a bottom item on the naviframe stack
28198     *
28199     * @param obj The naviframe object
28200     * @return The bottom item on the naviframe stack or @c NULL, if the stack is
28201     *         empty
28202     *
28203     * @ingroup Naviframe
28204     */
28205    EAPI Elm_Object_Item    *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28206    /**
28207     * @brief Set an item style
28208     *
28209     * @param obj The naviframe item
28210     * @param item_style The current item style name. @c NULL would be default
28211     *
28212     * The following styles are available for this item:
28213     * @li @c "default"
28214     *
28215     * @see also elm_naviframe_item_style_get()
28216     *
28217     * @ingroup Naviframe
28218     */
28219    EAPI void                elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
28220    /**
28221     * @brief Get an item style
28222     *
28223     * @param obj The naviframe item
28224     * @return The current item style name
28225     *
28226     * @see also elm_naviframe_item_style_set()
28227     *
28228     * @ingroup Naviframe
28229     */
28230    EAPI const char         *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28231    /**
28232     * @brief Show/Hide the title area
28233     *
28234     * @param it The naviframe item
28235     * @param visible If @c EINA_TRUE, title area will be visible, hidden
28236     *        otherwise
28237     *
28238     * When the title area is invisible, then the controls would be hidden so as     * to expand the content area to full-size.
28239     *
28240     * @see also elm_naviframe_item_title_visible_get()
28241     *
28242     * @ingroup Naviframe
28243     */
28244    EAPI void                elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
28245    /**
28246     * @brief Get a value whether title area is visible or not.
28247     *
28248     * @param it The naviframe item
28249     * @return If @c EINA_TRUE, title area is visible
28250     *
28251     * @see also elm_naviframe_item_title_visible_set()
28252     *
28253     * @ingroup Naviframe
28254     */
28255    EAPI Eina_Bool           elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28256
28257    /**
28258     * @brief Set creating prev button automatically or not
28259     *
28260     * @param obj The naviframe object
28261     * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
28262     *        be created internally when you pass the @c NULL to the prev_btn
28263     *        parameter in elm_naviframe_item_push
28264     *
28265     * @see also elm_naviframe_item_push()
28266     */
28267    EAPI void                elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
28268    /**
28269     * @brief Get a value whether prev button(back button) will be auto pushed or
28270     *        not.
28271     *
28272     * @param obj The naviframe object
28273     * @return If @c EINA_TRUE, prev button will be auto pushed.
28274     *
28275     * @see also elm_naviframe_item_push()
28276     *           elm_naviframe_prev_btn_auto_pushed_set()
28277     */
28278    EAPI Eina_Bool           elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
28279
28280    /**
28281     * @}
28282     */
28283
28284 #ifdef __cplusplus
28285 }
28286 #endif
28287
28288 #endif