apparently I forgot to add this in my earlier toolbar commit and nobody noticed
[framework/uifw/elementary.git] / src / lib / Elementary.h.in
1 /*
2  *
3  * vim:ts=8:sw=3:sts=3:expandtab:cino=>5n-3f0^-2{2(0W1st0
4  */
5
6 /**
7 @file Elementary.h.in
8 @brief Elementary Widget Library
9 */
10
11 /**
12 @mainpage Elementary
13 @image html  elementary.png
14 @version 0.7.0
15 @date 2008-2011
16
17 @section intro What is Elementary?
18
19 This is a VERY SIMPLE toolkit. It is not meant for writing extensive desktop
20 applications (yet). Small simple ones with simple needs.
21
22 It is meant to make the programmers work almost brainless but give them lots
23 of flexibility.
24
25 @li @ref Start - Go here to quickly get started with writing Apps
26
27 @section organization Organization
28
29 One can divide Elemementary into three main groups:
30 @li @ref infralist - These are modules that deal with Elementary as a whole.
31 @li @ref widgetslist - These are the widgets you'll compose your UI out of.
32 @li @ref containerslist - These are the containers in which the widgets will be
33                           layouted.
34
35 @section license License
36
37 LGPL v2 (see COPYING in the base of Elementary's source). This applies to
38 all files in the source tree.
39
40 @section ack Acknowledgements
41 There is a lot that goes into making a widget set, and they don't happen out of
42 nothing. It's like trying to make everyone everywhere happy, regardless of age,
43 gender, race or nationality - and that is really tough. So thanks to people and
44 organisations behind this, as listed in the @ref authors page.
45 */
46
47
48 /**
49  * @defgroup Start Getting Started
50  *
51  * To write an Elementary app, you can get started with the following:
52  *
53 @code
54 #include <Elementary.h>
55 EAPI_MAIN int
56 elm_main(int argc, char **argv)
57 {
58    // create window(s) here and do any application init
59    elm_run(); // run main loop
60    elm_shutdown(); // after mainloop finishes running, shutdown
61    return 0; // exit 0 for exit code
62 }
63 ELM_MAIN()
64 @endcode
65  *
66  * To use autotools (which helps in many ways in the long run, like being able
67  * to immediately create releases of your software directly from your tree
68  * and ensure everything needed to build it is there) you will need a
69  * configure.ac, Makefile.am and autogen.sh file.
70  *
71  * configure.ac:
72  *
73 @verbatim
74 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
75 AC_PREREQ(2.52)
76 AC_CONFIG_SRCDIR(configure.ac)
77 AM_CONFIG_HEADER(config.h)
78 AC_PROG_CC
79 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
80 PKG_CHECK_MODULES([ELEMENTARY], elementary)
81 AC_OUTPUT(Makefile)
82 @endverbatim
83  *
84  * Makefile.am:
85  *
86 @verbatim
87 AUTOMAKE_OPTIONS = 1.4 foreign
88 MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.h.in configure depcomp install-sh missing
89
90 INCLUDES = -I$(top_srcdir)
91
92 bin_PROGRAMS = myapp
93
94 myapp_SOURCES = main.c
95 myapp_LDADD = @ELEMENTARY_LIBS@
96 myapp_CFLAGS = @ELEMENTARY_CFLAGS@
97 @endverbatim
98  *
99  * autogen.sh:
100  *
101 @verbatim
102 #!/bin/sh
103 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS || exit 1
104 echo "Running autoheader..." ; autoheader || exit 1
105 echo "Running autoconf..." ; autoconf || exit 1
106 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
107 ./configure "$@"
108 @endverbatim
109  *
110  * To generate all the things needed to bootstrap just run:
111  *
112 @verbatim
113 ./autogen.sh
114 @endverbatim
115  *
116  * This will generate Makefile.in's, the confgure script and everything else.
117  * After this it works like all normal autotools projects:
118 @verbatim
119 ./configure
120 make
121 sudo make install
122 @endverbatim
123  *
124  * Note sudo was assumed to get root permissions, as this would install in
125  * /usr/local which is system-owned. Use any way you like to gain root, or
126  * specify a different prefix with configure:
127  *
128 @verbatim
129 ./confiugre --prefix=$HOME/mysoftware
130 @endverbatim
131  *
132  * Also remember that autotools buys you some useful commands like:
133 @verbatim
134 make uninstall
135 @endverbatim
136  *
137  * This uninstalls the software after it was installed with "make install".
138  * It is very useful to clear up what you built if you wish to clean the
139  * system.
140  *
141 @verbatim
142 make distcheck
143 @endverbatim
144  *
145  * This firstly checks if your build tree is "clean" and ready for
146  * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
147  * ready to upload and distribute to the world, that contains the generated
148  * Makefile.in's and configure script. The users do not need to run
149  * autogen.sh - just configure and on. They don't need autotools installed.
150  * This tarball also builds cleanly, has all the sources it needs to build
151  * included (that is sources for your application, not libraries it depends
152  * on like Elementary). It builds cleanly in a buildroot and does not
153  * contain any files that are temporarily generated like binaries and other
154  * build-generated files, so the tarball is clean, and no need to worry
155  * about cleaning up your tree before packaging.
156  *
157 @verbatim
158 make clean
159 @endverbatim
160  *
161  * This cleans up all build files (binaries, objects etc.) from the tree.
162  *
163 @verbatim
164 make distclean
165 @endverbatim
166  *
167  * This cleans out all files from the build and from configure's output too.
168  *
169 @verbatim
170 make maintainer-clean
171 @endverbatim
172  *
173  * This deletes all the files autogen.sh will produce so the tree is clean
174  * to be put into a revision-control system (like CVS, SVN or GIT for example).
175  *
176  * There is a more advanced way of making use of the quicklaunch infrastructure
177  * in Elementary (which will not be covered here due to its more advanced
178  * nature).
179  *
180  * Now let's actually create an interactive "Hello World" gui that you can
181  * click the ok button to exit. It's more code because this now does something
182  * much more significant, but it's still very simple:
183  *
184 @code
185 #include <Elementary.h>
186
187 static void
188 on_done(void *data, Evas_Object *obj, void *event_info)
189 {
190    // quit the mainloop (elm_run function will return)
191    elm_exit();
192 }
193
194 EAPI_MAIN int
195 elm_main(int argc, char **argv)
196 {
197    Evas_Object *win, *bg, *box, *lab, *btn;
198
199    // new window - do the usual and give it a name, title and delete handler
200    win = elm_win_add(NULL, "hello", ELM_WIN_BASIC);
201    elm_win_title_set(win, "Hello");
202    // when the user clicks "close" on a window there is a request to delete
203    evas_object_smart_callback_add(win, "delete,request", on_done, NULL);
204
205    // add a standard bg
206    bg = elm_bg_add(win);
207    // add object as a resize object for the window (controls window minimum
208    // size as well as gets resized if window is resized)
209    elm_win_resize_object_add(win, bg);
210    evas_object_show(bg);
211
212    // add a box object - default is vertical. a box holds children in a row,
213    // either horizontally or vertically. nothing more.
214    box = elm_box_add(win);
215    // make the box hotizontal
216    elm_box_horizontal_set(box, EINA_TRUE);
217    // add object as a resize object for the window (controls window minimum
218    // size as well as gets resized if window is resized)
219    elm_win_resize_object_add(win, box);
220    evas_object_show(box);
221
222    // add a label widget, set the text and put it in the pad frame
223    lab = elm_label_add(win);
224    // set default text of the label
225    elm_object_text_set(lab, "Hello out there world!");
226    // pack the label at the end of the box
227    elm_box_pack_end(box, lab);
228    evas_object_show(lab);
229
230    // add an ok button
231    btn = elm_button_add(win);
232    // set default text of button to "OK"
233    elm_object_text_set(btn, "OK");
234    // pack the button at the end of the box
235    elm_box_pack_end(box, btn);
236    evas_object_show(btn);
237    // call on_done when button is clicked
238    evas_object_smart_callback_add(btn, "clicked", on_done, NULL);
239
240    // now we are done, show the window
241    evas_object_show(win);
242
243    // run the mainloop and process events and callbacks
244    elm_run();
245    return 0;
246 }
247 ELM_MAIN()
248 @endcode
249    *
250    */
251
252 /**
253 @page authors Authors
254 @author Carsten Haitzler <raster@@rasterman.com>
255 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
256 @author Cedric Bail <cedric.bail@@free.fr>
257 @author Vincent Torri <vtorri@@univ-evry.fr>
258 @author Daniel Kolesa <quaker66@@gmail.com>
259 @author Jaime Thomas <avi.thomas@@gmail.com>
260 @author Swisscom - http://www.swisscom.ch/
261 @author Christopher Michael <devilhorns@@comcast.net>
262 @author Marco Trevisan (Treviño) <mail@@3v1n0.net>
263 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
264 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
265 @author Brian Wang <brian.wang.0721@@gmail.com>
266 @author Mike Blumenkrantz (zmike) <mike@@zentific.com>
267 @author Samsung Electronics <tbd>
268 @author Samsung SAIT <tbd>
269 @author Brett Nash <nash@@nash.id.au>
270 @author Bruno Dilly <bdilly@@profusion.mobi>
271 @author Rafael Fonseca <rfonseca@@profusion.mobi>
272 @author Chuneon Park <hermet@@hermet.pe.kr>
273 @author Woohyun Jung <wh0705.jung@@samsung.com>
274 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
275 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
276 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
277 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
278 @author Gustavo Lima Chaves <glima@@profusion.mobi>
279 @author Fabiano Fidêncio <fidencio@@profusion.mobi>
280 @author Tiago Falcão <tiago@@profusion.mobi>
281 @author Otavio Pontes <otavio@@profusion.mobi>
282 @author Viktor Kojouharov <vkojouharov@@gmail.com>
283 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
284 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
285 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
286 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
287 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
288 @author Jihoon Kim <jihoon48.kim@@samsung.com>
289 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
290 @author Tom Hacohen <tom@@stosb.com>
291 @author Aharon Hillel <a.hillel@@partner.samsung.com>
292 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
293 @author Shinwoo Kim <kimcinoo@@gmail.com>
294 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
295 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
296 @author Sung W. Park <sungwoo@gmail.com>
297 @author Thierry el Borgi <thierry@substantiel.fr>
298 @author Shilpa Singh <shilpa.singh@samsung.com> <shilpasingh.o@gmail.com>
299 @author Chanwook Jung <joey.jung@samsung.com>
300 @author Hyoyoung Chang <hyoyoung.chang@samsung.com>
301 @author Guillaume "Kuri" Friloux <guillaume.friloux@asp64.com>
302 @author Kim Yunhan <spbear@gmail.com>
303
304 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
305 contact with the developers and maintainers.
306  */
307
308 #ifndef ELEMENTARY_H
309 #define ELEMENTARY_H
310
311 /**
312  * @file Elementary.h
313  * @brief Elementary's API
314  *
315  * Elementary API.
316  */
317
318 @ELM_UNIX_DEF@ ELM_UNIX
319 @ELM_WIN32_DEF@ ELM_WIN32
320 @ELM_WINCE_DEF@ ELM_WINCE
321 @ELM_EDBUS_DEF@ ELM_EDBUS
322 @ELM_EFREET_DEF@ ELM_EFREET
323 @ELM_ETHUMB_DEF@ ELM_ETHUMB
324 @ELM_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 any Elementary's policy value is changed.
495     */
496    EAPI extern int ELM_EVENT_POLICY_CHANGED;
497
498    /**
499     * @typedef Elm_Event_Policy_Changed
500     *
501     * Data on the event when an Elementary policy has changed
502     */
503     typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
504
505    /**
506     * @struct _Elm_Event_Policy_Changed
507     *
508     * Data on the event when an Elementary policy has changed
509     */
510     struct _Elm_Event_Policy_Changed
511      {
512         unsigned int policy; /**< the policy identifier */
513         int          new_value; /**< value the policy had before the change */
514         int          old_value; /**< new value the policy got */
515     };
516
517    /**
518     * Policy identifiers.
519     */
520     typedef enum _Elm_Policy
521     {
522         ELM_POLICY_QUIT, /**< under which circumstances the application
523                           * should quit automatically. @see
524                           * Elm_Policy_Quit.
525                           */
526         ELM_POLICY_LAST
527     } Elm_Policy; /**< Elementary policy identifiers/groups enumeration.  @see elm_policy_set()
528  */
529
530    typedef enum _Elm_Policy_Quit
531      {
532         ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
533                                    * automatically */
534         ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
535                                             * application's last
536                                             * window is closed */
537      } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
538
539    typedef enum _Elm_Focus_Direction
540      {
541         ELM_FOCUS_PREVIOUS,
542         ELM_FOCUS_NEXT
543      } Elm_Focus_Direction;
544
545    typedef enum _Elm_Text_Format
546      {
547         ELM_TEXT_FORMAT_PLAIN_UTF8,
548         ELM_TEXT_FORMAT_MARKUP_UTF8
549      } Elm_Text_Format;
550
551    /**
552     * Line wrapping types.
553     */
554    typedef enum _Elm_Wrap_Type
555      {
556         ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
557         ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
558         ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
559         ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
560         ELM_WRAP_LAST
561      } Elm_Wrap_Type;
562
563    typedef enum
564      {
565         ELM_INPUT_PANEL_LAYOUT_NORMAL,          /**< Default layout */
566         ELM_INPUT_PANEL_LAYOUT_NUMBER,          /**< Number layout */
567         ELM_INPUT_PANEL_LAYOUT_EMAIL,           /**< Email layout */
568         ELM_INPUT_PANEL_LAYOUT_URL,             /**< URL layout */
569         ELM_INPUT_PANEL_LAYOUT_PHONENUMBER,     /**< Phone Number layout */
570         ELM_INPUT_PANEL_LAYOUT_IP,              /**< IP layout */
571         ELM_INPUT_PANEL_LAYOUT_MONTH,           /**< Month layout */
572         ELM_INPUT_PANEL_LAYOUT_NUMBERONLY,      /**< Number Only layout */
573         ELM_INPUT_PANEL_LAYOUT_INVALID
574      } Elm_Input_Panel_Layout;
575
576    /**
577     * @typedef Elm_Object_Item
578     * An Elementary Object item handle.
579     * @ingroup General
580     */
581    typedef struct _Elm_Object_Item Elm_Object_Item;
582
583
584    /**
585     * Called back when a widget's tooltip is activated and needs content.
586     * @param data user-data given to elm_object_tooltip_content_cb_set()
587     * @param obj owner widget.
588     * @param tooltip The tooltip object (affix content to this!)
589     */
590    typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
591
592    /**
593     * Called back when a widget's item tooltip is activated and needs content.
594     * @param data user-data given to elm_object_tooltip_content_cb_set()
595     * @param obj owner widget.
596     * @param tooltip The tooltip object (affix content to this!)
597     * @param item context dependent item. As an example, if tooltip was
598     *        set on Elm_List_Item, then it is of this type.
599     */
600    typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
601
602    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. */
603
604 #ifndef ELM_LIB_QUICKLAUNCH
605 #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 */
606 #else
607 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
608 #endif
609
610 /**************************************************************************/
611    /* General calls */
612
613    /**
614     * Initialize Elementary
615     *
616     * @param[in] argc System's argument count value
617     * @param[in] argv System's pointer to array of argument strings
618     * @return The init counter value.
619     *
620     * This function initializes Elementary and increments a counter of
621     * the number of calls to it. It returns the new counter's value.
622     *
623     * @warning This call is exported only for use by the @c ELM_MAIN()
624     * macro. There is no need to use this if you use this macro (which
625     * is highly advisable). An elm_main() should contain the entry
626     * point code for your application, having the same prototype as
627     * elm_init(), and @b not being static (putting the @c EAPI symbol
628     * in front of its type declaration is advisable). The @c
629     * ELM_MAIN() call should be placed just after it.
630     *
631     * Example:
632     * @dontinclude bg_example_01.c
633     * @skip static void
634     * @until ELM_MAIN
635     *
636     * See the full @ref bg_example_01_c "example".
637     *
638     * @see elm_shutdown().
639     * @ingroup General
640     */
641    EAPI int          elm_init(int argc, char **argv);
642
643    /**
644     * Shut down Elementary
645     *
646     * @return The init counter value.
647     *
648     * This should be called at the end of your application, just
649     * before it ceases to do any more processing. This will clean up
650     * any permanent resources your application may have allocated via
651     * Elementary that would otherwise persist.
652     *
653     * @see elm_init() for an example
654     *
655     * @ingroup General
656     */
657    EAPI int          elm_shutdown(void);
658
659    /**
660     * Run Elementary's main loop
661     *
662     * This call should be issued just after all initialization is
663     * completed. This function will not return until elm_exit() is
664     * called. It will keep looping, running the main
665     * (event/processing) loop for Elementary.
666     *
667     * @see elm_init() for an example
668     *
669     * @ingroup General
670     */
671    EAPI void         elm_run(void);
672
673    /**
674     * Exit Elementary's main loop
675     *
676     * If this call is issued, it will flag the main loop to cease
677     * processing and return back to its parent function (usually your
678     * elm_main() function).
679     *
680     * @see elm_init() for an example. There, just after a request to
681     * close the window comes, the main loop will be left.
682     *
683     * @note By using the #ELM_POLICY_QUIT on your Elementary
684     * applications, you'll this function called automatically for you.
685     *
686     * @ingroup General
687     */
688    EAPI void         elm_exit(void);
689
690    /**
691     * Provide information in order to make Elementary determine the @b
692     * run time location of the software in question, so other data files
693     * such as images, sound files, executable utilities, libraries,
694     * modules and locale files can be found.
695     *
696     * @param mainfunc This is your application's main function name,
697     *        whose binary's location is to be found. Providing @c NULL
698     *        will make Elementary not to use it
699     * @param dom This will be used as the application's "domain", in the
700     *        form of a prefix to any environment variables that may
701     *        override prefix detection and the directory name, inside the
702     *        standard share or data directories, where the software's
703     *        data files will be looked for.
704     * @param checkfile This is an (optional) magic file's path to check
705     *        for existence (and it must be located in the data directory,
706     *        under the share directory provided above). Its presence will
707     *        help determine the prefix found was correct. Pass @c NULL if
708     *        the check is not to be done.
709     *
710     * This function allows one to re-locate the application somewhere
711     * else after compilation, if the developer wishes for easier
712     * distribution of pre-compiled binaries.
713     *
714     * The prefix system is designed to locate where the given software is
715     * installed (under a common path prefix) at run time and then report
716     * specific locations of this prefix and common directories inside
717     * this prefix like the binary, library, data and locale directories,
718     * through the @c elm_app_*_get() family of functions.
719     *
720     * Call elm_app_info_set() early on before you change working
721     * directory or anything about @c argv[0], so it gets accurate
722     * information.
723     *
724     * It will then try and trace back which file @p mainfunc comes from,
725     * if provided, to determine the application's prefix directory.
726     *
727     * The @p dom parameter provides a string prefix to prepend before
728     * environment variables, allowing a fallback to @b specific
729     * environment variables to locate the software. You would most
730     * probably provide a lowercase string there, because it will also
731     * serve as directory domain, explained next. For environment
732     * variables purposes, this string is made uppercase. For example if
733     * @c "myapp" is provided as the prefix, then the program would expect
734     * @c "MYAPP_PREFIX" as a master environment variable to specify the
735     * exact install prefix for the software, or more specific environment
736     * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
737     * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
738     * the user or scripts before launching. If not provided (@c NULL),
739     * environment variables will not be used to override compiled-in
740     * defaults or auto detections.
741     *
742     * The @p dom string also provides a subdirectory inside the system
743     * shared data directory for data files. For example, if the system
744     * directory is @c /usr/local/share, then this directory name is
745     * appended, creating @c /usr/local/share/myapp, if it @p was @c
746     * "myapp". It is expected the application installs data files in
747     * this directory.
748     *
749     * The @p checkfile is a file name or path of something inside the
750     * share or data directory to be used to test that the prefix
751     * detection worked. For example, your app will install a wallpaper
752     * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
753     * check that this worked, provide @c "images/wallpaper.jpg" as the @p
754     * checkfile string.
755     *
756     * @see elm_app_compile_bin_dir_set()
757     * @see elm_app_compile_lib_dir_set()
758     * @see elm_app_compile_data_dir_set()
759     * @see elm_app_compile_locale_set()
760     * @see elm_app_prefix_dir_get()
761     * @see elm_app_bin_dir_get()
762     * @see elm_app_lib_dir_get()
763     * @see elm_app_data_dir_get()
764     * @see elm_app_locale_dir_get()
765     */
766    EAPI void         elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
767
768    /**
769     * Provide information on the @b fallback application's binaries
770     * directory, on scenarios where they get overriden by
771     * elm_app_info_set().
772     *
773     * @param dir The path to the default binaries directory (compile time
774     * one)
775     *
776     * @note Elementary will as well use this path to determine actual
777     * names of binaries' directory paths, maybe changing it to be @c
778     * something/local/bin instead of @c something/bin, only, for
779     * example.
780     *
781     * @warning You should call this function @b before
782     * elm_app_info_set().
783     */
784    EAPI void         elm_app_compile_bin_dir_set(const char *dir);
785
786    /**
787     * Provide information on the @b fallback application's libraries
788     * directory, on scenarios where they get overriden by
789     * elm_app_info_set().
790     *
791     * @param dir The path to the default libraries directory (compile
792     * time one)
793     *
794     * @note Elementary will as well use this path to determine actual
795     * names of libraries' directory paths, maybe changing it to be @c
796     * something/lib32 or @c something/lib64 instead of @c something/lib,
797     * only, for example.
798     *
799     * @warning You should call this function @b before
800     * elm_app_info_set().
801     */
802    EAPI void         elm_app_compile_lib_dir_set(const char *dir);
803
804    /**
805     * Provide information on the @b fallback application's data
806     * directory, on scenarios where they get overriden by
807     * elm_app_info_set().
808     *
809     * @param dir The path to the default data directory (compile time
810     * one)
811     *
812     * @note Elementary will as well use this path to determine actual
813     * names of data directory paths, maybe changing it to be @c
814     * something/local/share instead of @c something/share, only, for
815     * example.
816     *
817     * @warning You should call this function @b before
818     * elm_app_info_set().
819     */
820    EAPI void         elm_app_compile_data_dir_set(const char *dir);
821
822    /**
823     * Provide information on the @b fallback application's locale
824     * directory, on scenarios where they get overriden by
825     * elm_app_info_set().
826     *
827     * @param dir The path to the default locale directory (compile time
828     * one)
829     *
830     * @warning You should call this function @b before
831     * elm_app_info_set().
832     */
833    EAPI void         elm_app_compile_locale_set(const char *dir);
834
835    /**
836     * Retrieve the application's run time prefix directory, as set by
837     * elm_app_info_set() and the way (environment) the application was
838     * run from.
839     *
840     * @return The directory prefix the application is actually using
841     */
842    EAPI const char  *elm_app_prefix_dir_get(void);
843
844    /**
845     * Retrieve the application's run time binaries prefix directory, as
846     * set by elm_app_info_set() and the way (environment) the application
847     * was run from.
848     *
849     * @return The binaries directory prefix the application is actually
850     * using
851     */
852    EAPI const char  *elm_app_bin_dir_get(void);
853
854    /**
855     * Retrieve the application's run time libraries prefix directory, as
856     * set by elm_app_info_set() and the way (environment) the application
857     * was run from.
858     *
859     * @return The libraries directory prefix the application is actually
860     * using
861     */
862    EAPI const char  *elm_app_lib_dir_get(void);
863
864    /**
865     * Retrieve the application's run time data prefix directory, as
866     * set by elm_app_info_set() and the way (environment) the application
867     * was run from.
868     *
869     * @return The data directory prefix the application is actually
870     * using
871     */
872    EAPI const char  *elm_app_data_dir_get(void);
873
874    /**
875     * Retrieve the application's run time locale prefix directory, as
876     * set by elm_app_info_set() and the way (environment) the application
877     * was run from.
878     *
879     * @return The locale directory prefix the application is actually
880     * using
881     */
882    EAPI const char  *elm_app_locale_dir_get(void);
883
884    EAPI void         elm_quicklaunch_mode_set(Eina_Bool ql_on);
885    EAPI Eina_Bool    elm_quicklaunch_mode_get(void);
886    EAPI int          elm_quicklaunch_init(int argc, char **argv);
887    EAPI int          elm_quicklaunch_sub_init(int argc, char **argv);
888    EAPI int          elm_quicklaunch_sub_shutdown(void);
889    EAPI int          elm_quicklaunch_shutdown(void);
890    EAPI void         elm_quicklaunch_seed(void);
891    EAPI Eina_Bool    elm_quicklaunch_prepare(int argc, char **argv);
892    EAPI Eina_Bool    elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
893    EAPI void         elm_quicklaunch_cleanup(void);
894    EAPI int          elm_quicklaunch_fallback(int argc, char **argv);
895    EAPI char        *elm_quicklaunch_exe_path_get(const char *exe);
896
897    EAPI Eina_Bool    elm_need_efreet(void);
898    EAPI Eina_Bool    elm_need_e_dbus(void);
899
900    /**
901     * This must be called before any other function that handle with
902     * elm_thumb objects or ethumb_client instances.
903     *
904     * @ingroup Thumb
905     */
906    EAPI Eina_Bool    elm_need_ethumb(void);
907
908    /**
909     * Set a new policy's value (for a given policy group/identifier).
910     *
911     * @param policy policy identifier, as in @ref Elm_Policy.
912     * @param value policy value, which depends on the identifier
913     *
914     * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
915     *
916     * Elementary policies define applications' behavior,
917     * somehow. These behaviors are divided in policy groups (see
918     * #Elm_Policy enumeration). This call will emit the Ecore event
919     * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
920     * handlers. An #Elm_Event_Policy_Changed struct will be passed,
921     * then.
922     *
923     * @note Currently, we have only one policy identifier/group
924     * (#ELM_POLICY_QUIT), which has two possible values.
925     *
926     * @ingroup General
927     */
928    EAPI Eina_Bool    elm_policy_set(unsigned int policy, int value);
929
930    /**
931     * Gets the policy value set for given policy identifier.
932     *
933     * @param policy policy identifier, as in #Elm_Policy.
934     * @return The currently set policy value, for that
935     * identifier. Will be @c 0 if @p policy passed is invalid.
936     *
937     * @ingroup General
938     */
939    EAPI int          elm_policy_get(unsigned int policy);
940
941    /**
942     * Set a label of an object
943     *
944     * @param obj The Elementary object
945     * @param part The text part name to set (NULL for the default label)
946     * @param label The new text of the label
947     *
948     * @note Elementary objects may have many labels (e.g. Action Slider)
949     *
950     * @ingroup General
951     */
952    EAPI void         elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
953
954 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
955
956    /**
957     * Get a label of an object
958     *
959     * @param obj The Elementary object
960     * @param part The text part name to get (NULL for the default label)
961     * @return text of the label or NULL for any error
962     *
963     * @note Elementary objects may have many labels (e.g. Action Slider)
964     *
965     * @ingroup General
966     */
967    EAPI const char  *elm_object_text_part_get(const Evas_Object *obj, const char *part);
968
969 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
970
971    /**
972     * Set a content of an object
973     *
974     * @param obj The Elementary object
975     * @param part The content part name to set (NULL for the default content)
976     * @param content The new content of the object
977     *
978     * @note Elementary objects may have many contents
979     *
980     * @ingroup General
981     */
982    EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
983
984 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
985
986    /**
987     * Get a content of an object
988     *
989     * @param obj The Elementary object
990     * @param item The content part name to get (NULL for the default content)
991     * @return content of the object or NULL for any error
992     *
993     * @note Elementary objects may have many contents
994     *
995     * @ingroup General
996     */
997    EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
998
999 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
1000
1001    /**
1002     * Unset a content of an object
1003     *
1004     * @param obj The Elementary object
1005     * @param item The content part name to unset (NULL for the default content)
1006     *
1007     * @note Elementary objects may have many contents
1008     *
1009     * @ingroup General
1010     */
1011    EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1012
1013 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
1014
1015    /**
1016     * Set a content of an object item
1017     *
1018     * @param it The Elementary object item
1019     * @param part The content part name to set (NULL for the default content)
1020     * @param content The new content of the object item
1021     *
1022     * @note Elementary object items may have many contents
1023     *
1024     * @ingroup General
1025     */
1026    EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1027
1028 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
1029
1030    /**
1031     * Get a content of an object item
1032     *
1033     * @param it The Elementary object item
1034     * @param part The content part name to unset (NULL for the default content)
1035     * @return content of the object item or NULL for any error
1036     *
1037     * @note Elementary object items may have many contents
1038     *
1039     * @ingroup General
1040     */
1041    EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
1042
1043 #define elm_object_item_content_get(it) elm_object_item_content_part_get((it), NULL)
1044
1045    /**
1046     * Unset a content of an object item
1047     *
1048     * @param it The Elementary object item
1049     * @param part The content part name to unset (NULL for the default content)
1050     *
1051     * @note Elementary object items may have many contents
1052     *
1053     * @ingroup General
1054     */
1055    EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1056
1057 #define elm_object_item_content_unset(it) elm_object_item_content_part_unset((it), NULL)
1058
1059    /**
1060     * Set a label of an objec itemt
1061     *
1062     * @param it The Elementary object item
1063     * @param part The text part name to set (NULL for the default label)
1064     * @param label The new text of the label
1065     *
1066     * @note Elementary object items may have many labels
1067     *
1068     * @ingroup General
1069     */
1070    EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1071
1072 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1073
1074    /**
1075     * Get a label of an object
1076     *
1077     * @param it The Elementary object item
1078     * @param part The text part name to get (NULL for the default label)
1079     * @return text of the label or NULL for any error
1080     *
1081     * @note Elementary object items may have many labels
1082     *
1083     * @ingroup General
1084     */
1085    EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1086
1087    /**
1088     * Set the text to read out when in accessibility mode
1089     *
1090     * @param obj The object which is to be described
1091     * @param txt The text that describes the widget to people with poor or no vision
1092     *
1093     * @ingroup General
1094     */
1095    EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1096
1097    /**
1098     * Set the text to read out when in accessibility mode
1099     *
1100     * @param it The object item which is to be described
1101     * @param txt The text that describes the widget to people with poor or no vision
1102     *
1103     * @ingroup General
1104     */
1105    EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1106
1107
1108 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
1109
1110    /**
1111     * Get the data associated with an object item
1112     * @param it The object item
1113     * @return The data associated with @p it
1114     *
1115     * @ingroup General
1116     */
1117    EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1118
1119    /**
1120     * Set the data associated with an object item
1121     * @param it The object item
1122     * @param data The data to be associated with @p it
1123     *
1124     * @ingroup General
1125     */
1126    EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1127
1128    /**
1129     * Send a signal to the edje object of the widget item.
1130     *
1131     * This function sends a signal to the edje object of the obj item. An
1132     * edje program can respond to a signal by specifying matching
1133     * 'signal' and 'source' fields.
1134     *
1135     * @param it The Elementary object item
1136     * @param emission The signal's name.
1137     * @param source The signal's source.
1138     * @ingroup General
1139     */
1140    EAPI void             elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1141
1142    /**
1143     * @}
1144     */
1145
1146    /**
1147     * @defgroup Caches Caches
1148     *
1149     * These are functions which let one fine-tune some cache values for
1150     * Elementary applications, thus allowing for performance adjustments.
1151     *
1152     * @{
1153     */
1154
1155    /**
1156     * @brief Flush all caches.
1157     *
1158     * Frees all data that was in cache and is not currently being used to reduce
1159     * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1160     * to calling all of the following functions:
1161     * @li edje_file_cache_flush()
1162     * @li edje_collection_cache_flush()
1163     * @li eet_clearcache()
1164     * @li evas_image_cache_flush()
1165     * @li evas_font_cache_flush()
1166     * @li evas_render_dump()
1167     * @note Evas caches are flushed for every canvas associated with a window.
1168     *
1169     * @ingroup Caches
1170     */
1171    EAPI void         elm_all_flush(void);
1172
1173    /**
1174     * Get the configured cache flush interval time
1175     *
1176     * This gets the globally configured cache flush interval time, in
1177     * ticks
1178     *
1179     * @return The cache flush interval time
1180     * @ingroup Caches
1181     *
1182     * @see elm_all_flush()
1183     */
1184    EAPI int          elm_cache_flush_interval_get(void);
1185
1186    /**
1187     * Set the configured cache flush interval time
1188     *
1189     * This sets the globally configured cache flush interval time, in ticks
1190     *
1191     * @param size The cache flush interval time
1192     * @ingroup Caches
1193     *
1194     * @see elm_all_flush()
1195     */
1196    EAPI void         elm_cache_flush_interval_set(int size);
1197
1198    /**
1199     * Set the configured cache flush interval time for all applications on the
1200     * display
1201     *
1202     * This sets the globally configured cache flush interval time -- in ticks
1203     * -- for all applications on the display.
1204     *
1205     * @param size The cache flush interval time
1206     * @ingroup Caches
1207     */
1208    EAPI void         elm_cache_flush_interval_all_set(int size);
1209
1210    /**
1211     * Get the configured cache flush enabled state
1212     *
1213     * This gets the globally configured cache flush state - if it is enabled
1214     * or not. When cache flushing is enabled, elementary will regularly
1215     * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1216     * memory and allow usage to re-seed caches and data in memory where it
1217     * can do so. An idle application will thus minimise its memory usage as
1218     * data will be freed from memory and not be re-loaded as it is idle and
1219     * not rendering or doing anything graphically right now.
1220     *
1221     * @return The cache flush state
1222     * @ingroup Caches
1223     *
1224     * @see elm_all_flush()
1225     */
1226    EAPI Eina_Bool    elm_cache_flush_enabled_get(void);
1227
1228    /**
1229     * Set the configured cache flush enabled state
1230     *
1231     * This sets the globally configured cache flush enabled state
1232     *
1233     * @param size The cache flush enabled state
1234     * @ingroup Caches
1235     *
1236     * @see elm_all_flush()
1237     */
1238    EAPI void         elm_cache_flush_enabled_set(Eina_Bool enabled);
1239
1240    /**
1241     * Set the configured cache flush enabled state for all applications on the
1242     * display
1243     *
1244     * This sets the globally configured cache flush enabled state for all
1245     * applications on the display.
1246     *
1247     * @param size The cache flush enabled state
1248     * @ingroup Caches
1249     */
1250    EAPI void         elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1251
1252    /**
1253     * Get the configured font cache size
1254     *
1255     * This gets the globally configured font cache size, in bytes
1256     *
1257     * @return The font cache size
1258     * @ingroup Caches
1259     */
1260    EAPI int          elm_font_cache_get(void);
1261
1262    /**
1263     * Set the configured font cache size
1264     *
1265     * This sets the globally configured font cache size, in bytes
1266     *
1267     * @param size The font cache size
1268     * @ingroup Caches
1269     */
1270    EAPI void         elm_font_cache_set(int size);
1271
1272    /**
1273     * Set the configured font cache size for all applications on the
1274     * display
1275     *
1276     * This sets the globally configured font cache size -- in bytes
1277     * -- for all applications on the display.
1278     *
1279     * @param size The font cache size
1280     * @ingroup Caches
1281     */
1282    EAPI void         elm_font_cache_all_set(int size);
1283
1284    /**
1285     * Get the configured image cache size
1286     *
1287     * This gets the globally configured image cache size, in bytes
1288     *
1289     * @return The image cache size
1290     * @ingroup Caches
1291     */
1292    EAPI int          elm_image_cache_get(void);
1293
1294    /**
1295     * Set the configured image cache size
1296     *
1297     * This sets the globally configured image cache size, in bytes
1298     *
1299     * @param size The image cache size
1300     * @ingroup Caches
1301     */
1302    EAPI void         elm_image_cache_set(int size);
1303
1304    /**
1305     * Set the configured image cache size for all applications on the
1306     * display
1307     *
1308     * This sets the globally configured image cache size -- in bytes
1309     * -- for all applications on the display.
1310     *
1311     * @param size The image cache size
1312     * @ingroup Caches
1313     */
1314    EAPI void         elm_image_cache_all_set(int size);
1315
1316    /**
1317     * Get the configured edje file cache size.
1318     *
1319     * This gets the globally configured edje file cache size, in number
1320     * of files.
1321     *
1322     * @return The edje file cache size
1323     * @ingroup Caches
1324     */
1325    EAPI int          elm_edje_file_cache_get(void);
1326
1327    /**
1328     * Set the configured edje file cache size
1329     *
1330     * This sets the globally configured edje file cache size, in number
1331     * of files.
1332     *
1333     * @param size The edje file cache size
1334     * @ingroup Caches
1335     */
1336    EAPI void         elm_edje_file_cache_set(int size);
1337
1338    /**
1339     * Set the configured edje file cache size for all applications on the
1340     * display
1341     *
1342     * This sets the globally configured edje file cache size -- in number
1343     * of files -- for all applications on the display.
1344     *
1345     * @param size The edje file cache size
1346     * @ingroup Caches
1347     */
1348    EAPI void         elm_edje_file_cache_all_set(int size);
1349
1350    /**
1351     * Get the configured edje collections (groups) cache size.
1352     *
1353     * This gets the globally configured edje collections cache size, in
1354     * number of collections.
1355     *
1356     * @return The edje collections cache size
1357     * @ingroup Caches
1358     */
1359    EAPI int          elm_edje_collection_cache_get(void);
1360
1361    /**
1362     * Set the configured edje collections (groups) cache size
1363     *
1364     * This sets the globally configured edje collections cache size, in
1365     * number of collections.
1366     *
1367     * @param size The edje collections cache size
1368     * @ingroup Caches
1369     */
1370    EAPI void         elm_edje_collection_cache_set(int size);
1371
1372    /**
1373     * Set the configured edje collections (groups) cache size for all
1374     * applications on the display
1375     *
1376     * This sets the globally configured edje collections cache size -- in
1377     * number of collections -- for all applications on the display.
1378     *
1379     * @param size The edje collections cache size
1380     * @ingroup Caches
1381     */
1382    EAPI void         elm_edje_collection_cache_all_set(int size);
1383
1384    /**
1385     * @}
1386     */
1387
1388    /**
1389     * @defgroup Scaling Widget Scaling
1390     *
1391     * Different widgets can be scaled independently. These functions
1392     * allow you to manipulate this scaling on a per-widget basis. The
1393     * object and all its children get their scaling factors multiplied
1394     * by the scale factor set. This is multiplicative, in that if a
1395     * child also has a scale size set it is in turn multiplied by its
1396     * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
1397     * double size, @c 0.5 is half, etc.
1398     *
1399     * @ref general_functions_example_page "This" example contemplates
1400     * some of these functions.
1401     */
1402
1403    /**
1404     * Get the global scaling factor
1405     *
1406     * This gets the globally configured scaling factor that is applied to all
1407     * objects.
1408     *
1409     * @return The scaling factor
1410     * @ingroup Scaling
1411     */
1412    EAPI double       elm_scale_get(void);
1413
1414    /**
1415     * Set the global scaling factor
1416     *
1417     * This sets the globally configured scaling factor that is applied to all
1418     * objects.
1419     *
1420     * @param scale The scaling factor to set
1421     * @ingroup Scaling
1422     */
1423    EAPI void         elm_scale_set(double scale);
1424
1425    /**
1426     * Set the global scaling factor for all applications on the display
1427     *
1428     * This sets the globally configured scaling factor that is applied to all
1429     * objects for all applications.
1430     * @param scale The scaling factor to set
1431     * @ingroup Scaling
1432     */
1433    EAPI void         elm_scale_all_set(double scale);
1434
1435    /**
1436     * Set the scaling factor for a given Elementary object
1437     *
1438     * @param obj The Elementary to operate on
1439     * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1440     * no scaling)
1441     *
1442     * @ingroup Scaling
1443     */
1444    EAPI void         elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1445
1446    /**
1447     * Get the scaling factor for a given Elementary object
1448     *
1449     * @param obj The object
1450     * @return The scaling factor set by elm_object_scale_set()
1451     *
1452     * @ingroup Scaling
1453     */
1454    EAPI double       elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1455
1456    /**
1457     * @defgroup Password_last_show Password last input show
1458     *
1459     * Last show feature of password mode enables user to view
1460     * the last input entered for few seconds before masking it.
1461     * These functions allow to set this feature in password mode
1462     * of entry widget and also allow to manipulate the duration
1463     * for which the input has to be visible.
1464     *
1465     * @{
1466     */
1467
1468    /**
1469     * Get show last setting of password mode.
1470     *
1471     * This gets the show last input setting of password mode which might be
1472     * enabled or disabled.
1473     *
1474     * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1475     *            if it's disabled.
1476     * @ingroup Password_last_show
1477     */
1478    EAPI Eina_Bool elm_password_show_last_get(void);
1479
1480    /**
1481     * Set show last setting in password mode.
1482     *
1483     * This enables or disables show last setting of password mode.
1484     *
1485     * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1486     * @see elm_password_show_last_timeout_set()
1487     * @ingroup Password_last_show
1488     */
1489    EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1490
1491    /**
1492     * Get's the timeout value in last show password mode.
1493     *
1494     * This gets the time out value for which the last input entered in password
1495     * mode will be visible.
1496     *
1497     * @return The timeout value of last show password mode.
1498     * @ingroup Password_last_show
1499     */
1500    EAPI double elm_password_show_last_timeout_get(void);
1501
1502    /**
1503     * Set's the timeout value in last show password mode.
1504     *
1505     * This sets the time out value for which the last input entered in password
1506     * mode will be visible.
1507     *
1508     * @param password_show_last_timeout The timeout value.
1509     * @see elm_password_show_last_set()
1510     * @ingroup Password_last_show
1511     */
1512    EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1513
1514    /**
1515     * @}
1516     */
1517
1518    /**
1519     * @defgroup UI-Mirroring Selective Widget mirroring
1520     *
1521     * These functions allow you to set ui-mirroring on specific
1522     * widgets or the whole interface. Widgets can be in one of two
1523     * modes, automatic and manual.  Automatic means they'll be changed
1524     * according to the system mirroring mode and manual means only
1525     * explicit changes will matter. You are not supposed to change
1526     * mirroring state of a widget set to automatic, will mostly work,
1527     * but the behavior is not really defined.
1528     *
1529     * @{
1530     */
1531
1532    EAPI Eina_Bool    elm_mirrored_get(void);
1533    EAPI void         elm_mirrored_set(Eina_Bool mirrored);
1534
1535    /**
1536     * Get the system mirrored mode. This determines the default mirrored mode
1537     * of widgets.
1538     *
1539     * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1540     */
1541    EAPI Eina_Bool    elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1542
1543    /**
1544     * Set the system mirrored mode. This determines the default mirrored mode
1545     * of widgets.
1546     *
1547     * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1548     */
1549    EAPI void         elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1550
1551    /**
1552     * Returns the widget's mirrored mode setting.
1553     *
1554     * @param obj The widget.
1555     * @return mirrored mode setting of the object.
1556     *
1557     **/
1558    EAPI Eina_Bool    elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1559
1560    /**
1561     * Sets the widget's mirrored mode setting.
1562     * When widget in automatic mode, it follows the system mirrored mode set by
1563     * elm_mirrored_set().
1564     * @param obj The widget.
1565     * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1566     */
1567    EAPI void         elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1568
1569    /**
1570     * @}
1571     */
1572
1573    /**
1574     * Set the style to use by a widget
1575     *
1576     * Sets the style name that will define the appearance of a widget. Styles
1577     * vary from widget to widget and may also be defined by other themes
1578     * by means of extensions and overlays.
1579     *
1580     * @param obj The Elementary widget to style
1581     * @param style The style name to use
1582     *
1583     * @see elm_theme_extension_add()
1584     * @see elm_theme_extension_del()
1585     * @see elm_theme_overlay_add()
1586     * @see elm_theme_overlay_del()
1587     *
1588     * @ingroup Styles
1589     */
1590    EAPI void         elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1591    /**
1592     * Get the style used by the widget
1593     *
1594     * This gets the style being used for that widget. Note that the string
1595     * pointer is only valid as longas the object is valid and the style doesn't
1596     * change.
1597     *
1598     * @param obj The Elementary widget to query for its style
1599     * @return The style name used
1600     *
1601     * @see elm_object_style_set()
1602     *
1603     * @ingroup Styles
1604     */
1605    EAPI const char  *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1606
1607    /**
1608     * @defgroup Styles Styles
1609     *
1610     * Widgets can have different styles of look. These generic API's
1611     * set styles of widgets, if they support them (and if the theme(s)
1612     * do).
1613     *
1614     * @ref general_functions_example_page "This" example contemplates
1615     * some of these functions.
1616     */
1617
1618    /**
1619     * Set the disabled state of an Elementary object.
1620     *
1621     * @param obj The Elementary object to operate on
1622     * @param disabled The state to put in in: @c EINA_TRUE for
1623     *        disabled, @c EINA_FALSE for enabled
1624     *
1625     * Elementary objects can be @b disabled, in which state they won't
1626     * receive input and, in general, will be themed differently from
1627     * their normal state, usually greyed out. Useful for contexts
1628     * where you don't want your users to interact with some of the
1629     * parts of you interface.
1630     *
1631     * This sets the state for the widget, either disabling it or
1632     * enabling it back.
1633     *
1634     * @ingroup Styles
1635     */
1636    EAPI void         elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1637
1638    /**
1639     * Get the disabled state of an Elementary object.
1640     *
1641     * @param obj The Elementary object to operate on
1642     * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1643     *            if it's enabled (or on errors)
1644     *
1645     * This gets the state of the widget, which might be enabled or disabled.
1646     *
1647     * @ingroup Styles
1648     */
1649    EAPI Eina_Bool    elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1650
1651    /**
1652     * @defgroup WidgetNavigation Widget Tree Navigation.
1653     *
1654     * How to check if an Evas Object is an Elementary widget? How to
1655     * get the first elementary widget that is parent of the given
1656     * object?  These are all covered in widget tree navigation.
1657     *
1658     * @ref general_functions_example_page "This" example contemplates
1659     * some of these functions.
1660     */
1661
1662    /**
1663     * Check if the given Evas Object is an Elementary widget.
1664     *
1665     * @param obj the object to query.
1666     * @return @c EINA_TRUE if it is an elementary widget variant,
1667     *         @c EINA_FALSE otherwise
1668     * @ingroup WidgetNavigation
1669     */
1670    EAPI Eina_Bool    elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1671
1672    /**
1673     * Get the first parent of the given object that is an Elementary
1674     * widget.
1675     *
1676     * @param obj the Elementary object to query parent from.
1677     * @return the parent object that is an Elementary widget, or @c
1678     *         NULL, if it was not found.
1679     *
1680     * Use this to query for an object's parent widget.
1681     *
1682     * @note Most of Elementary users wouldn't be mixing non-Elementary
1683     * smart objects in the objects tree of an application, as this is
1684     * an advanced usage of Elementary with Evas. So, except for the
1685     * application's window, which is the root of that tree, all other
1686     * objects would have valid Elementary widget parents.
1687     *
1688     * @ingroup WidgetNavigation
1689     */
1690    EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1691
1692    /**
1693     * Get the top level parent of an Elementary widget.
1694     *
1695     * @param obj The object to query.
1696     * @return The top level Elementary widget, or @c NULL if parent cannot be
1697     * found.
1698     * @ingroup WidgetNavigation
1699     */
1700    EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1701
1702    /**
1703     * Get the string that represents this Elementary widget.
1704     *
1705     * @note Elementary is weird and exposes itself as a single
1706     *       Evas_Object_Smart_Class of type "elm_widget", so
1707     *       evas_object_type_get() always return that, making debug and
1708     *       language bindings hard. This function tries to mitigate this
1709     *       problem, but the solution is to change Elementary to use
1710     *       proper inheritance.
1711     *
1712     * @param obj the object to query.
1713     * @return Elementary widget name, or @c NULL if not a valid widget.
1714     * @ingroup WidgetNavigation
1715     */
1716    EAPI const char  *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1717
1718    /**
1719     * @defgroup Config Elementary Config
1720     *
1721     * Elementary configuration is formed by a set options bounded to a
1722     * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1723     * "finger size", etc. These are functions with which one syncronizes
1724     * changes made to those values to the configuration storing files, de
1725     * facto. You most probably don't want to use the functions in this
1726     * group unlees you're writing an elementary configuration manager.
1727     *
1728     * @{
1729     */
1730
1731    /**
1732     * Save back Elementary's configuration, so that it will persist on
1733     * future sessions.
1734     *
1735     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1736     * @ingroup Config
1737     *
1738     * This function will take effect -- thus, do I/O -- immediately. Use
1739     * it when you want to apply all configuration changes at once. The
1740     * current configuration set will get saved onto the current profile
1741     * configuration file.
1742     *
1743     */
1744    EAPI Eina_Bool    elm_config_save(void);
1745
1746    /**
1747     * Reload Elementary's configuration, bounded to current selected
1748     * profile.
1749     *
1750     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1751     * @ingroup Config
1752     *
1753     * Useful when you want to force reloading of configuration values for
1754     * a profile. If one removes user custom configuration directories,
1755     * for example, it will force a reload with system values insted.
1756     *
1757     */
1758    EAPI void         elm_config_reload(void);
1759
1760    /**
1761     * @}
1762     */
1763
1764    /**
1765     * @defgroup Profile Elementary Profile
1766     *
1767     * Profiles are pre-set options that affect the whole look-and-feel of
1768     * Elementary-based applications. There are, for example, profiles
1769     * aimed at desktop computer applications and others aimed at mobile,
1770     * touchscreen-based ones. You most probably don't want to use the
1771     * functions in this group unlees you're writing an elementary
1772     * configuration manager.
1773     *
1774     * @{
1775     */
1776
1777    /**
1778     * Get Elementary's profile in use.
1779     *
1780     * This gets the global profile that is applied to all Elementary
1781     * applications.
1782     *
1783     * @return The profile's name
1784     * @ingroup Profile
1785     */
1786    EAPI const char  *elm_profile_current_get(void);
1787
1788    /**
1789     * Get an Elementary's profile directory path in the filesystem. One
1790     * may want to fetch a system profile's dir or an user one (fetched
1791     * inside $HOME).
1792     *
1793     * @param profile The profile's name
1794     * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1795     *                or a system one (@c EINA_FALSE)
1796     * @return The profile's directory path.
1797     * @ingroup Profile
1798     *
1799     * @note You must free it with elm_profile_dir_free().
1800     */
1801    EAPI const char  *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1802
1803    /**
1804     * Free an Elementary's profile directory path, as returned by
1805     * elm_profile_dir_get().
1806     *
1807     * @param p_dir The profile's path
1808     * @ingroup Profile
1809     *
1810     */
1811    EAPI void         elm_profile_dir_free(const char *p_dir);
1812
1813    /**
1814     * Get Elementary's list of available profiles.
1815     *
1816     * @return The profiles list. List node data are the profile name
1817     *         strings.
1818     * @ingroup Profile
1819     *
1820     * @note One must free this list, after usage, with the function
1821     *       elm_profile_list_free().
1822     */
1823    EAPI Eina_List   *elm_profile_list_get(void);
1824
1825    /**
1826     * Free Elementary's list of available profiles.
1827     *
1828     * @param l The profiles list, as returned by elm_profile_list_get().
1829     * @ingroup Profile
1830     *
1831     */
1832    EAPI void         elm_profile_list_free(Eina_List *l);
1833
1834    /**
1835     * Set Elementary's profile.
1836     *
1837     * This sets the global profile that is applied to Elementary
1838     * applications. Just the process the call comes from will be
1839     * affected.
1840     *
1841     * @param profile The profile's name
1842     * @ingroup Profile
1843     *
1844     */
1845    EAPI void         elm_profile_set(const char *profile);
1846
1847    /**
1848     * Set Elementary's profile.
1849     *
1850     * This sets the global profile that is applied to all Elementary
1851     * applications. All running Elementary windows will be affected.
1852     *
1853     * @param profile The profile's name
1854     * @ingroup Profile
1855     *
1856     */
1857    EAPI void         elm_profile_all_set(const char *profile);
1858
1859    /**
1860     * @}
1861     */
1862
1863    /**
1864     * @defgroup Engine Elementary Engine
1865     *
1866     * These are functions setting and querying which rendering engine
1867     * Elementary will use for drawing its windows' pixels.
1868     *
1869     * The following are the available engines:
1870     * @li "software_x11"
1871     * @li "fb"
1872     * @li "directfb"
1873     * @li "software_16_x11"
1874     * @li "software_8_x11"
1875     * @li "xrender_x11"
1876     * @li "opengl_x11"
1877     * @li "software_gdi"
1878     * @li "software_16_wince_gdi"
1879     * @li "sdl"
1880     * @li "software_16_sdl"
1881     * @li "opengl_sdl"
1882     * @li "buffer"
1883     *
1884     * @{
1885     */
1886
1887    /**
1888     * @brief Get Elementary's rendering engine in use.
1889     *
1890     * @return The rendering engine's name
1891     * @note there's no need to free the returned string, here.
1892     *
1893     * This gets the global rendering engine that is applied to all Elementary
1894     * applications.
1895     *
1896     * @see elm_engine_set()
1897     */
1898    EAPI const char  *elm_engine_current_get(void);
1899
1900    /**
1901     * @brief Set Elementary's rendering engine for use.
1902     *
1903     * @param engine The rendering engine's name
1904     *
1905     * This sets global rendering engine that is applied to all Elementary
1906     * applications. Note that it will take effect only to Elementary windows
1907     * created after this is called.
1908     *
1909     * @see elm_win_add()
1910     */
1911    EAPI void         elm_engine_set(const char *engine);
1912
1913    /**
1914     * @}
1915     */
1916
1917    /**
1918     * @defgroup Fonts Elementary Fonts
1919     *
1920     * These are functions dealing with font rendering, selection and the
1921     * like for Elementary applications. One might fetch which system
1922     * fonts are there to use and set custom fonts for individual classes
1923     * of UI items containing text (text classes).
1924     *
1925     * @{
1926     */
1927
1928   typedef struct _Elm_Text_Class
1929     {
1930        const char *name;
1931        const char *desc;
1932     } Elm_Text_Class;
1933
1934   typedef struct _Elm_Font_Overlay
1935     {
1936        const char     *text_class;
1937        const char     *font;
1938        Evas_Font_Size  size;
1939     } Elm_Font_Overlay;
1940
1941   typedef struct _Elm_Font_Properties
1942     {
1943        const char *name;
1944        Eina_List  *styles;
1945     } Elm_Font_Properties;
1946
1947    /**
1948     * Get Elementary's list of supported text classes.
1949     *
1950     * @return The text classes list, with @c Elm_Text_Class blobs as data.
1951     * @ingroup Fonts
1952     *
1953     * Release the list with elm_text_classes_list_free().
1954     */
1955    EAPI const Eina_List     *elm_text_classes_list_get(void);
1956
1957    /**
1958     * Free Elementary's list of supported text classes.
1959     *
1960     * @ingroup Fonts
1961     *
1962     * @see elm_text_classes_list_get().
1963     */
1964    EAPI void                 elm_text_classes_list_free(const Eina_List *list);
1965
1966    /**
1967     * Get Elementary's list of font overlays, set with
1968     * elm_font_overlay_set().
1969     *
1970     * @return The font overlays list, with @c Elm_Font_Overlay blobs as
1971     * data.
1972     *
1973     * @ingroup Fonts
1974     *
1975     * For each text class, one can set a <b>font overlay</b> for it,
1976     * overriding the default font properties for that class coming from
1977     * the theme in use. There is no need to free this list.
1978     *
1979     * @see elm_font_overlay_set() and elm_font_overlay_unset().
1980     */
1981    EAPI const Eina_List     *elm_font_overlay_list_get(void);
1982
1983    /**
1984     * Set a font overlay for a given Elementary text class.
1985     *
1986     * @param text_class Text class name
1987     * @param font Font name and style string
1988     * @param size Font size
1989     *
1990     * @ingroup Fonts
1991     *
1992     * @p font has to be in the format returned by
1993     * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
1994     * and elm_font_overlay_unset().
1995     */
1996    EAPI void                 elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
1997
1998    /**
1999     * Unset a font overlay for a given Elementary text class.
2000     *
2001     * @param text_class Text class name
2002     *
2003     * @ingroup Fonts
2004     *
2005     * This will bring back text elements belonging to text class
2006     * @p text_class back to their default font settings.
2007     */
2008    EAPI void                 elm_font_overlay_unset(const char *text_class);
2009
2010    /**
2011     * Apply the changes made with elm_font_overlay_set() and
2012     * elm_font_overlay_unset() on the current Elementary window.
2013     *
2014     * @ingroup Fonts
2015     *
2016     * This applies all font overlays set to all objects in the UI.
2017     */
2018    EAPI void                 elm_font_overlay_apply(void);
2019
2020    /**
2021     * Apply the changes made with elm_font_overlay_set() and
2022     * elm_font_overlay_unset() on all Elementary application windows.
2023     *
2024     * @ingroup Fonts
2025     *
2026     * This applies all font overlays set to all objects in the UI.
2027     */
2028    EAPI void                 elm_font_overlay_all_apply(void);
2029
2030    /**
2031     * Translate a font (family) name string in fontconfig's font names
2032     * syntax into an @c Elm_Font_Properties struct.
2033     *
2034     * @param font The font name and styles string
2035     * @return the font properties struct
2036     *
2037     * @ingroup Fonts
2038     *
2039     * @note The reverse translation can be achived with
2040     * elm_font_fontconfig_name_get(), for one style only (single font
2041     * instance, not family).
2042     */
2043    EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2044
2045    /**
2046     * Free font properties return by elm_font_properties_get().
2047     *
2048     * @param efp the font properties struct
2049     *
2050     * @ingroup Fonts
2051     */
2052    EAPI void                 elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2053
2054    /**
2055     * Translate a font name, bound to a style, into fontconfig's font names
2056     * syntax.
2057     *
2058     * @param name The font (family) name
2059     * @param style The given style (may be @c NULL)
2060     *
2061     * @return the font name and style string
2062     *
2063     * @ingroup Fonts
2064     *
2065     * @note The reverse translation can be achived with
2066     * elm_font_properties_get(), for one style only (single font
2067     * instance, not family).
2068     */
2069    EAPI const char          *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2070
2071    /**
2072     * Free the font string return by elm_font_fontconfig_name_get().
2073     *
2074     * @param efp the font properties struct
2075     *
2076     * @ingroup Fonts
2077     */
2078    EAPI void                 elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2079
2080    /**
2081     * Create a font hash table of available system fonts.
2082     *
2083     * One must call it with @p list being the return value of
2084     * evas_font_available_list(). The hash will be indexed by font
2085     * (family) names, being its values @c Elm_Font_Properties blobs.
2086     *
2087     * @param list The list of available system fonts, as returned by
2088     * evas_font_available_list().
2089     * @return the font hash.
2090     *
2091     * @ingroup Fonts
2092     *
2093     * @note The user is supposed to get it populated at least with 3
2094     * default font families (Sans, Serif, Monospace), which should be
2095     * present on most systems.
2096     */
2097    EAPI Eina_Hash           *elm_font_available_hash_add(Eina_List *list);
2098
2099    /**
2100     * Free the hash return by elm_font_available_hash_add().
2101     *
2102     * @param hash the hash to be freed.
2103     *
2104     * @ingroup Fonts
2105     */
2106    EAPI void                 elm_font_available_hash_del(Eina_Hash *hash);
2107
2108    /**
2109     * @}
2110     */
2111
2112    /**
2113     * @defgroup Fingers Fingers
2114     *
2115     * Elementary is designed to be finger-friendly for touchscreens,
2116     * and so in addition to scaling for display resolution, it can
2117     * also scale based on finger "resolution" (or size). You can then
2118     * customize the granularity of the areas meant to receive clicks
2119     * on touchscreens.
2120     *
2121     * Different profiles may have pre-set values for finger sizes.
2122     *
2123     * @ref general_functions_example_page "This" example contemplates
2124     * some of these functions.
2125     *
2126     * @{
2127     */
2128
2129    /**
2130     * Get the configured "finger size"
2131     *
2132     * @return The finger size
2133     *
2134     * This gets the globally configured finger size, <b>in pixels</b>
2135     *
2136     * @ingroup Fingers
2137     */
2138    EAPI Evas_Coord       elm_finger_size_get(void);
2139
2140    /**
2141     * Set the configured finger size
2142     *
2143     * This sets the globally configured finger size in pixels
2144     *
2145     * @param size The finger size
2146     * @ingroup Fingers
2147     */
2148    EAPI void             elm_finger_size_set(Evas_Coord size);
2149
2150    /**
2151     * Set the configured finger size for all applications on the display
2152     *
2153     * This sets the globally configured finger size in pixels for all
2154     * applications on the display
2155     *
2156     * @param size The finger size
2157     * @ingroup Fingers
2158     */
2159    EAPI void             elm_finger_size_all_set(Evas_Coord size);
2160
2161    /**
2162     * @}
2163     */
2164
2165    /**
2166     * @defgroup Focus Focus
2167     *
2168     * An Elementary application has, at all times, one (and only one)
2169     * @b focused object. This is what determines where the input
2170     * events go to within the application's window. Also, focused
2171     * objects can be decorated differently, in order to signal to the
2172     * user where the input is, at a given moment.
2173     *
2174     * Elementary applications also have the concept of <b>focus
2175     * chain</b>: one can cycle through all the windows' focusable
2176     * objects by input (tab key) or programmatically. The default
2177     * focus chain for an application is the one define by the order in
2178     * which the widgets where added in code. One will cycle through
2179     * top level widgets, and, for each one containg sub-objects, cycle
2180     * through them all, before returning to the level
2181     * above. Elementary also allows one to set @b custom focus chains
2182     * for their applications.
2183     *
2184     * Besides the focused decoration a widget may exhibit, when it
2185     * gets focus, Elementary has a @b global focus highlight object
2186     * that can be enabled for a window. If one chooses to do so, this
2187     * extra highlight effect will surround the current focused object,
2188     * too.
2189     *
2190     * @note Some Elementary widgets are @b unfocusable, after
2191     * creation, by their very nature: they are not meant to be
2192     * interacted with input events, but are there just for visual
2193     * purposes.
2194     *
2195     * @ref general_functions_example_page "This" example contemplates
2196     * some of these functions.
2197     */
2198
2199    /**
2200     * Get the enable status of the focus highlight
2201     *
2202     * This gets whether the highlight on focused objects is enabled or not
2203     * @ingroup Focus
2204     */
2205    EAPI Eina_Bool        elm_focus_highlight_enabled_get(void);
2206
2207    /**
2208     * Set the enable status of the focus highlight
2209     *
2210     * Set whether to show or not the highlight on focused objects
2211     * @param enable Enable highlight if EINA_TRUE, disable otherwise
2212     * @ingroup Focus
2213     */
2214    EAPI void             elm_focus_highlight_enabled_set(Eina_Bool enable);
2215
2216    /**
2217     * Get the enable status of the highlight animation
2218     *
2219     * Get whether the focus highlight, if enabled, will animate its switch from
2220     * one object to the next
2221     * @ingroup Focus
2222     */
2223    EAPI Eina_Bool        elm_focus_highlight_animate_get(void);
2224
2225    /**
2226     * Set the enable status of the highlight animation
2227     *
2228     * Set whether the focus highlight, if enabled, will animate its switch from
2229     * one object to the next
2230     * @param animate Enable animation if EINA_TRUE, disable otherwise
2231     * @ingroup Focus
2232     */
2233    EAPI void             elm_focus_highlight_animate_set(Eina_Bool animate);
2234
2235    /**
2236     * Get the whether an Elementary object has the focus or not.
2237     *
2238     * @param obj The Elementary object to get the information from
2239     * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2240     *            not (and on errors).
2241     *
2242     * @see elm_object_focus_set()
2243     *
2244     * @ingroup Focus
2245     */
2246    EAPI Eina_Bool        elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2247
2248    /**
2249     * Set/unset focus to a given Elementary object.
2250     *
2251     * @param obj The Elementary object to operate on.
2252     * @param enable @c EINA_TRUE Set focus to a given object,
2253     *               @c EINA_FALSE Unset focus to a given object.
2254     *
2255     * @note When you set focus to this object, if it can handle focus, will
2256     * take the focus away from the one who had it previously and will, for
2257     * now on, be the one receiving input events. Unsetting focus will remove
2258     * the focus from @p obj, passing it back to the previous element in the
2259     * focus chain list.
2260     *
2261     * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2262     *
2263     * @ingroup Focus
2264     */
2265    EAPI void             elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2266
2267    /**
2268     * Make a given Elementary object the focused one.
2269     *
2270     * @param obj The Elementary object to make focused.
2271     *
2272     * @note This object, if it can handle focus, will take the focus
2273     * away from the one who had it previously and will, for now on, be
2274     * the one receiving input events.
2275     *
2276     * @see elm_object_focus_get()
2277     * @deprecated use elm_object_focus_set() instead.
2278     *
2279     * @ingroup Focus
2280     */
2281    EINA_DEPRECATED EAPI void             elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2282
2283    /**
2284     * Remove the focus from an Elementary object
2285     *
2286     * @param obj The Elementary to take focus from
2287     *
2288     * This removes the focus from @p obj, passing it back to the
2289     * previous element in the focus chain list.
2290     *
2291     * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2292     * @deprecated use elm_object_focus_set() instead.
2293     *
2294     * @ingroup Focus
2295     */
2296    EINA_DEPRECATED EAPI void             elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2297
2298    /**
2299     * Set the ability for an Element object to be focused
2300     *
2301     * @param obj The Elementary object to operate on
2302     * @param enable @c EINA_TRUE if the object can be focused, @c
2303     *        EINA_FALSE if not (and on errors)
2304     *
2305     * This sets whether the object @p obj is able to take focus or
2306     * not. Unfocusable objects do nothing when programmatically
2307     * focused, being the nearest focusable parent object the one
2308     * really getting focus. Also, when they receive mouse input, they
2309     * will get the event, but not take away the focus from where it
2310     * was previously.
2311     *
2312     * @ingroup Focus
2313     */
2314    EAPI void             elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2315
2316    /**
2317     * Get whether an Elementary object is focusable or not
2318     *
2319     * @param obj The Elementary object to operate on
2320     * @return @c EINA_TRUE if the object is allowed to be focused, @c
2321     *             EINA_FALSE if not (and on errors)
2322     *
2323     * @note Objects which are meant to be interacted with by input
2324     * events are created able to be focused, by default. All the
2325     * others are not.
2326     *
2327     * @ingroup Focus
2328     */
2329    EAPI Eina_Bool        elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2330
2331    /**
2332     * Set custom focus chain.
2333     *
2334     * This function overwrites any previous custom focus chain within
2335     * the list of objects. The previous list will be deleted and this list
2336     * will be managed by elementary. After it is set, don't modify it.
2337     *
2338     * @note On focus cycle, only will be evaluated children of this container.
2339     *
2340     * @param obj The container object
2341     * @param objs Chain of objects to pass focus
2342     * @ingroup Focus
2343     */
2344    EAPI void             elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2345
2346    /**
2347     * Unset a custom focus chain on a given Elementary widget
2348     *
2349     * @param obj The container object to remove focus chain from
2350     *
2351     * Any focus chain previously set on @p obj (for its child objects)
2352     * is removed entirely after this call.
2353     *
2354     * @ingroup Focus
2355     */
2356    EAPI void             elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2357
2358    /**
2359     * Get custom focus chain
2360     *
2361     * @param obj The container object
2362     * @ingroup Focus
2363     */
2364    EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2365
2366    /**
2367     * Append object to custom focus chain.
2368     *
2369     * @note If relative_child equal to NULL or not in custom chain, the object
2370     * will be added in end.
2371     *
2372     * @note On focus cycle, only will be evaluated children of this container.
2373     *
2374     * @param obj The container object
2375     * @param child The child to be added in custom chain
2376     * @param relative_child The relative object to position the child
2377     * @ingroup Focus
2378     */
2379    EAPI void             elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2380
2381    /**
2382     * Prepend object to custom focus chain.
2383     *
2384     * @note If relative_child equal to NULL or not in custom chain, the object
2385     * will be added in begin.
2386     *
2387     * @note On focus cycle, only will be evaluated children of this container.
2388     *
2389     * @param obj The container object
2390     * @param child The child to be added in custom chain
2391     * @param relative_child The relative object to position the child
2392     * @ingroup Focus
2393     */
2394    EAPI void             elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2395
2396    /**
2397     * Give focus to next object in object tree.
2398     *
2399     * Give focus to next object in focus chain of one object sub-tree.
2400     * If the last object of chain already have focus, the focus will go to the
2401     * first object of chain.
2402     *
2403     * @param obj The object root of sub-tree
2404     * @param dir Direction to cycle the focus
2405     *
2406     * @ingroup Focus
2407     */
2408    EAPI void             elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2409
2410    /**
2411     * Give focus to near object in one direction.
2412     *
2413     * Give focus to near object in direction of one object.
2414     * If none focusable object in given direction, the focus will not change.
2415     *
2416     * @param obj The reference object
2417     * @param x Horizontal component of direction to focus
2418     * @param y Vertical component of direction to focus
2419     *
2420     * @ingroup Focus
2421     */
2422    EAPI void             elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2423
2424    /**
2425     * Make the elementary object and its children to be unfocusable
2426     * (or focusable).
2427     *
2428     * @param obj The Elementary object to operate on
2429     * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2430     *        @c EINA_FALSE for focusable.
2431     *
2432     * This sets whether the object @p obj and its children objects
2433     * are able to take focus or not. If the tree is set as unfocusable,
2434     * newest focused object which is not in this tree will get focus.
2435     * This API can be helpful for an object to be deleted.
2436     * When an object will be deleted soon, it and its children may not
2437     * want to get focus (by focus reverting or by other focus controls).
2438     * Then, just use this API before deleting.
2439     *
2440     * @see elm_object_tree_unfocusable_get()
2441     *
2442     * @ingroup Focus
2443     */
2444    EAPI void             elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2445
2446    /**
2447     * Get whether an Elementary object and its children are unfocusable or not.
2448     *
2449     * @param obj The Elementary object to get the information from
2450     * @return @c EINA_TRUE, if the tree is unfocussable,
2451     *         @c EINA_FALSE if not (and on errors).
2452     *
2453     * @see elm_object_tree_unfocusable_set()
2454     *
2455     * @ingroup Focus
2456     */
2457    EAPI Eina_Bool        elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2458
2459    /**
2460     * @defgroup Scrolling Scrolling
2461     *
2462     * These are functions setting how scrollable views in Elementary
2463     * widgets should behave on user interaction.
2464     *
2465     * @{
2466     */
2467
2468    /**
2469     * Get whether scrollers should bounce when they reach their
2470     * viewport's edge during a scroll.
2471     *
2472     * @return the thumb scroll bouncing state
2473     *
2474     * This is the default behavior for touch screens, in general.
2475     * @ingroup Scrolling
2476     */
2477    EAPI Eina_Bool        elm_scroll_bounce_enabled_get(void);
2478
2479    /**
2480     * Set whether scrollers should bounce when they reach their
2481     * viewport's edge during a scroll.
2482     *
2483     * @param enabled the thumb scroll bouncing state
2484     *
2485     * @see elm_thumbscroll_bounce_enabled_get()
2486     * @ingroup Scrolling
2487     */
2488    EAPI void             elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2489
2490    /**
2491     * Set whether scrollers should bounce when they reach their
2492     * viewport's edge during a scroll, for all Elementary application
2493     * windows.
2494     *
2495     * @param enabled the thumb scroll bouncing state
2496     *
2497     * @see elm_thumbscroll_bounce_enabled_get()
2498     * @ingroup Scrolling
2499     */
2500    EAPI void             elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2501
2502    /**
2503     * Get the amount of inertia a scroller will impose at bounce
2504     * animations.
2505     *
2506     * @return the thumb scroll bounce friction
2507     *
2508     * @ingroup Scrolling
2509     */
2510    EAPI double           elm_scroll_bounce_friction_get(void);
2511
2512    /**
2513     * Set the amount of inertia a scroller will impose at bounce
2514     * animations.
2515     *
2516     * @param friction the thumb scroll bounce friction
2517     *
2518     * @see elm_thumbscroll_bounce_friction_get()
2519     * @ingroup Scrolling
2520     */
2521    EAPI void             elm_scroll_bounce_friction_set(double friction);
2522
2523    /**
2524     * Set the amount of inertia a scroller will impose at bounce
2525     * animations, for all Elementary application windows.
2526     *
2527     * @param friction the thumb scroll bounce friction
2528     *
2529     * @see elm_thumbscroll_bounce_friction_get()
2530     * @ingroup Scrolling
2531     */
2532    EAPI void             elm_scroll_bounce_friction_all_set(double friction);
2533
2534    /**
2535     * Get the amount of inertia a <b>paged</b> scroller will impose at
2536     * page fitting animations.
2537     *
2538     * @return the page scroll friction
2539     *
2540     * @ingroup Scrolling
2541     */
2542    EAPI double           elm_scroll_page_scroll_friction_get(void);
2543
2544    /**
2545     * Set the amount of inertia a <b>paged</b> scroller will impose at
2546     * page fitting animations.
2547     *
2548     * @param friction the page scroll friction
2549     *
2550     * @see elm_thumbscroll_page_scroll_friction_get()
2551     * @ingroup Scrolling
2552     */
2553    EAPI void             elm_scroll_page_scroll_friction_set(double friction);
2554
2555    /**
2556     * Set the amount of inertia a <b>paged</b> scroller will impose at
2557     * page fitting animations, for all Elementary application windows.
2558     *
2559     * @param friction the page scroll friction
2560     *
2561     * @see elm_thumbscroll_page_scroll_friction_get()
2562     * @ingroup Scrolling
2563     */
2564    EAPI void             elm_scroll_page_scroll_friction_all_set(double friction);
2565
2566    /**
2567     * Get the amount of inertia a scroller will impose at region bring
2568     * animations.
2569     *
2570     * @return the bring in scroll friction
2571     *
2572     * @ingroup Scrolling
2573     */
2574    EAPI double           elm_scroll_bring_in_scroll_friction_get(void);
2575
2576    /**
2577     * Set the amount of inertia a scroller will impose at region bring
2578     * animations.
2579     *
2580     * @param friction the bring in scroll friction
2581     *
2582     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2583     * @ingroup Scrolling
2584     */
2585    EAPI void             elm_scroll_bring_in_scroll_friction_set(double friction);
2586
2587    /**
2588     * Set the amount of inertia a scroller will impose at region bring
2589     * animations, for all Elementary application windows.
2590     *
2591     * @param friction the bring in scroll friction
2592     *
2593     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2594     * @ingroup Scrolling
2595     */
2596    EAPI void             elm_scroll_bring_in_scroll_friction_all_set(double friction);
2597
2598    /**
2599     * Get the amount of inertia scrollers will impose at animations
2600     * triggered by Elementary widgets' zooming API.
2601     *
2602     * @return the zoom friction
2603     *
2604     * @ingroup Scrolling
2605     */
2606    EAPI double           elm_scroll_zoom_friction_get(void);
2607
2608    /**
2609     * Set the amount of inertia scrollers will impose at animations
2610     * triggered by Elementary widgets' zooming API.
2611     *
2612     * @param friction the zoom friction
2613     *
2614     * @see elm_thumbscroll_zoom_friction_get()
2615     * @ingroup Scrolling
2616     */
2617    EAPI void             elm_scroll_zoom_friction_set(double friction);
2618
2619    /**
2620     * Set the amount of inertia scrollers will impose at animations
2621     * triggered by Elementary widgets' zooming API, for all Elementary
2622     * application windows.
2623     *
2624     * @param friction the zoom friction
2625     *
2626     * @see elm_thumbscroll_zoom_friction_get()
2627     * @ingroup Scrolling
2628     */
2629    EAPI void             elm_scroll_zoom_friction_all_set(double friction);
2630
2631    /**
2632     * Get whether scrollers should be draggable from any point in their
2633     * views.
2634     *
2635     * @return the thumb scroll state
2636     *
2637     * @note This is the default behavior for touch screens, in general.
2638     * @note All other functions namespaced with "thumbscroll" will only
2639     *       have effect if this mode is enabled.
2640     *
2641     * @ingroup Scrolling
2642     */
2643    EAPI Eina_Bool        elm_scroll_thumbscroll_enabled_get(void);
2644
2645    /**
2646     * Set whether scrollers should be draggable from any point in their
2647     * views.
2648     *
2649     * @param enabled the thumb scroll state
2650     *
2651     * @see elm_thumbscroll_enabled_get()
2652     * @ingroup Scrolling
2653     */
2654    EAPI void             elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2655
2656    /**
2657     * Set whether scrollers should be draggable from any point in their
2658     * views, for all Elementary application windows.
2659     *
2660     * @param enabled the thumb scroll state
2661     *
2662     * @see elm_thumbscroll_enabled_get()
2663     * @ingroup Scrolling
2664     */
2665    EAPI void             elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2666
2667    /**
2668     * Get the number of pixels one should travel while dragging a
2669     * scroller's view to actually trigger scrolling.
2670     *
2671     * @return the thumb scroll threshould
2672     *
2673     * One would use higher values for touch screens, in general, because
2674     * of their inherent imprecision.
2675     * @ingroup Scrolling
2676     */
2677    EAPI unsigned int     elm_scroll_thumbscroll_threshold_get(void);
2678
2679    /**
2680     * Set the number of pixels one should travel while dragging a
2681     * scroller's view to actually trigger scrolling.
2682     *
2683     * @param threshold the thumb scroll threshould
2684     *
2685     * @see elm_thumbscroll_threshould_get()
2686     * @ingroup Scrolling
2687     */
2688    EAPI void             elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2689
2690    /**
2691     * Set the number of pixels one should travel while dragging a
2692     * scroller's view to actually trigger scrolling, for all Elementary
2693     * application windows.
2694     *
2695     * @param threshold the thumb scroll threshould
2696     *
2697     * @see elm_thumbscroll_threshould_get()
2698     * @ingroup Scrolling
2699     */
2700    EAPI void             elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2701
2702    /**
2703     * Get the minimum speed of mouse cursor movement which will trigger
2704     * list self scrolling animation after a mouse up event
2705     * (pixels/second).
2706     *
2707     * @return the thumb scroll momentum threshould
2708     *
2709     * @ingroup Scrolling
2710     */
2711    EAPI double           elm_scroll_thumbscroll_momentum_threshold_get(void);
2712
2713    /**
2714     * Set the minimum speed of mouse cursor movement which will trigger
2715     * list self scrolling animation after a mouse up event
2716     * (pixels/second).
2717     *
2718     * @param threshold the thumb scroll momentum threshould
2719     *
2720     * @see elm_thumbscroll_momentum_threshould_get()
2721     * @ingroup Scrolling
2722     */
2723    EAPI void             elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2724
2725    /**
2726     * Set the minimum speed of mouse cursor movement which will trigger
2727     * list self scrolling animation after a mouse up event
2728     * (pixels/second), for all Elementary application windows.
2729     *
2730     * @param threshold the thumb scroll momentum threshould
2731     *
2732     * @see elm_thumbscroll_momentum_threshould_get()
2733     * @ingroup Scrolling
2734     */
2735    EAPI void             elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2736
2737    /**
2738     * Get the amount of inertia a scroller will impose at self scrolling
2739     * animations.
2740     *
2741     * @return the thumb scroll friction
2742     *
2743     * @ingroup Scrolling
2744     */
2745    EAPI double           elm_scroll_thumbscroll_friction_get(void);
2746
2747    /**
2748     * Set the amount of inertia a scroller will impose at self scrolling
2749     * animations.
2750     *
2751     * @param friction the thumb scroll friction
2752     *
2753     * @see elm_thumbscroll_friction_get()
2754     * @ingroup Scrolling
2755     */
2756    EAPI void             elm_scroll_thumbscroll_friction_set(double friction);
2757
2758    /**
2759     * Set the amount of inertia a scroller will impose at self scrolling
2760     * animations, for all Elementary application windows.
2761     *
2762     * @param friction the thumb scroll friction
2763     *
2764     * @see elm_thumbscroll_friction_get()
2765     * @ingroup Scrolling
2766     */
2767    EAPI void             elm_scroll_thumbscroll_friction_all_set(double friction);
2768
2769    /**
2770     * Get the amount of lag between your actual mouse cursor dragging
2771     * movement and a scroller's view movement itself, while pushing it
2772     * into bounce state manually.
2773     *
2774     * @return the thumb scroll border friction
2775     *
2776     * @ingroup Scrolling
2777     */
2778    EAPI double           elm_scroll_thumbscroll_border_friction_get(void);
2779
2780    /**
2781     * Set the amount of lag between your actual mouse cursor dragging
2782     * movement and a scroller's view movement itself, while pushing it
2783     * into bounce state manually.
2784     *
2785     * @param friction the thumb scroll border friction. @c 0.0 for
2786     *        perfect synchrony between two movements, @c 1.0 for maximum
2787     *        lag.
2788     *
2789     * @see elm_thumbscroll_border_friction_get()
2790     * @note parameter value will get bound to 0.0 - 1.0 interval, always
2791     *
2792     * @ingroup Scrolling
2793     */
2794    EAPI void             elm_scroll_thumbscroll_border_friction_set(double friction);
2795
2796    /**
2797     * Set the amount of lag between your actual mouse cursor dragging
2798     * movement and a scroller's view movement itself, while pushing it
2799     * into bounce state manually, for all Elementary application windows.
2800     *
2801     * @param friction the thumb scroll border friction. @c 0.0 for
2802     *        perfect synchrony between two movements, @c 1.0 for maximum
2803     *        lag.
2804     *
2805     * @see elm_thumbscroll_border_friction_get()
2806     * @note parameter value will get bound to 0.0 - 1.0 interval, always
2807     *
2808     * @ingroup Scrolling
2809     */
2810    EAPI void             elm_scroll_thumbscroll_border_friction_all_set(double friction);
2811
2812    /**
2813     * @}
2814     */
2815
2816    /**
2817     * @defgroup Scrollhints Scrollhints
2818     *
2819     * Objects when inside a scroller can scroll, but this may not always be
2820     * desirable in certain situations. This allows an object to hint to itself
2821     * and parents to "not scroll" in one of 2 ways. If any child object of a
2822     * scroller has pushed a scroll freeze or hold then it affects all parent
2823     * scrollers until all children have released them.
2824     *
2825     * 1. To hold on scrolling. This means just flicking and dragging may no
2826     * longer scroll, but pressing/dragging near an edge of the scroller will
2827     * still scroll. This is automatically used by the entry object when
2828     * selecting text.
2829     *
2830     * 2. To totally freeze scrolling. This means it stops. until
2831     * popped/released.
2832     *
2833     * @{
2834     */
2835
2836    /**
2837     * Push the scroll hold by 1
2838     *
2839     * This increments the scroll hold count by one. If it is more than 0 it will
2840     * take effect on the parents of the indicated object.
2841     *
2842     * @param obj The object
2843     * @ingroup Scrollhints
2844     */
2845    EAPI void             elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2846
2847    /**
2848     * Pop the scroll hold by 1
2849     *
2850     * This decrements the scroll hold count by one. If it is more than 0 it will
2851     * take effect on the parents of the indicated object.
2852     *
2853     * @param obj The object
2854     * @ingroup Scrollhints
2855     */
2856    EAPI void             elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2857
2858    /**
2859     * Push the scroll freeze by 1
2860     *
2861     * This increments the scroll freeze count by one. If it is more
2862     * than 0 it will take effect on the parents of the indicated
2863     * object.
2864     *
2865     * @param obj The object
2866     * @ingroup Scrollhints
2867     */
2868    EAPI void             elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2869
2870    /**
2871     * Pop the scroll freeze by 1
2872     *
2873     * This decrements the scroll freeze count by one. If it is more
2874     * than 0 it will take effect on the parents of the indicated
2875     * object.
2876     *
2877     * @param obj The object
2878     * @ingroup Scrollhints
2879     */
2880    EAPI void             elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2881
2882    /**
2883     * Lock the scrolling of the given widget (and thus all parents)
2884     *
2885     * This locks the given object from scrolling in the X axis (and implicitly
2886     * also locks all parent scrollers too from doing the same).
2887     *
2888     * @param obj The object
2889     * @param lock The lock state (1 == locked, 0 == unlocked)
2890     * @ingroup Scrollhints
2891     */
2892    EAPI void             elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2893
2894    /**
2895     * Lock the scrolling of the given widget (and thus all parents)
2896     *
2897     * This locks the given object from scrolling in the Y axis (and implicitly
2898     * also locks all parent scrollers too from doing the same).
2899     *
2900     * @param obj The object
2901     * @param lock The lock state (1 == locked, 0 == unlocked)
2902     * @ingroup Scrollhints
2903     */
2904    EAPI void             elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2905
2906    /**
2907     * Get the scrolling lock of the given widget
2908     *
2909     * This gets the lock for X axis scrolling.
2910     *
2911     * @param obj The object
2912     * @ingroup Scrollhints
2913     */
2914    EAPI Eina_Bool        elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2915
2916    /**
2917     * Get the scrolling lock of the given widget
2918     *
2919     * This gets the lock for X axis scrolling.
2920     *
2921     * @param obj The object
2922     * @ingroup Scrollhints
2923     */
2924    EAPI Eina_Bool        elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2925
2926    /**
2927     * @}
2928     */
2929
2930    /**
2931     * Send a signal to the widget edje object.
2932     *
2933     * This function sends a signal to the edje object of the obj. An
2934     * edje program can respond to a signal by specifying matching
2935     * 'signal' and 'source' fields.
2936     *
2937     * @param obj The object
2938     * @param emission The signal's name.
2939     * @param source The signal's source.
2940     * @ingroup General
2941     */
2942    EAPI void             elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
2943
2944    /**
2945     * Add a callback for a signal emitted by widget edje object.
2946     *
2947     * This function connects a callback function to a signal emitted by the
2948     * edje object of the obj.
2949     * Globs can occur in either the emission or source name.
2950     *
2951     * @param obj The object
2952     * @param emission The signal's name.
2953     * @param source The signal's source.
2954     * @param func The callback function to be executed when the signal is
2955     * emitted.
2956     * @param data A pointer to data to pass in to the callback function.
2957     * @ingroup General
2958     */
2959    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);
2960
2961    /**
2962     * Remove a signal-triggered callback from a widget edje object.
2963     *
2964     * This function removes a callback, previoulsy attached to a
2965     * signal emitted by the edje object of the obj.  The parameters
2966     * emission, source and func must match exactly those passed to a
2967     * previous call to elm_object_signal_callback_add(). The data
2968     * pointer that was passed to this call will be returned.
2969     *
2970     * @param obj The object
2971     * @param emission The signal's name.
2972     * @param source The signal's source.
2973     * @param func The callback function to be executed when the signal is
2974     * emitted.
2975     * @return The data pointer
2976     * @ingroup General
2977     */
2978    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);
2979
2980    /**
2981     * Add a callback for input events (key up, key down, mouse wheel)
2982     * on a given Elementary widget
2983     *
2984     * @param obj The widget to add an event callback on
2985     * @param func The callback function to be executed when the event
2986     * happens
2987     * @param data Data to pass in to @p func
2988     *
2989     * Every widget in an Elementary interface set to receive focus,
2990     * with elm_object_focus_allow_set(), will propagate @b all of its
2991     * key up, key down and mouse wheel input events up to its parent
2992     * object, and so on. All of the focusable ones in this chain which
2993     * had an event callback set, with this call, will be able to treat
2994     * those events. There are two ways of making the propagation of
2995     * these event upwards in the tree of widgets to @b cease:
2996     * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
2997     *   the event was @b not processed, so the propagation will go on.
2998     * - The @c event_info pointer passed to @p func will contain the
2999     *   event's structure and, if you OR its @c event_flags inner
3000     *   value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
3001     *   one has already handled it, thus killing the event's
3002     *   propagation, too.
3003     *
3004     * @note Your event callback will be issued on those events taking
3005     * place only if no other child widget of @obj has consumed the
3006     * event already.
3007     *
3008     * @note Not to be confused with @c
3009     * evas_object_event_callback_add(), which will add event callbacks
3010     * per type on general Evas objects (no event propagation
3011     * infrastructure taken in account).
3012     *
3013     * @note Not to be confused with @c
3014     * elm_object_signal_callback_add(), which will add callbacks to @b
3015     * signals coming from a widget's theme, not input events.
3016     *
3017     * @note Not to be confused with @c
3018     * edje_object_signal_callback_add(), which does the same as
3019     * elm_object_signal_callback_add(), but directly on an Edje
3020     * object.
3021     *
3022     * @note Not to be confused with @c
3023     * evas_object_smart_callback_add(), which adds callbacks to smart
3024     * objects' <b>smart events</b>, and not input events.
3025     *
3026     * @see elm_object_event_callback_del()
3027     *
3028     * @ingroup General
3029     */
3030    EAPI void             elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3031
3032    /**
3033     * Remove an event callback from a widget.
3034     *
3035     * This function removes a callback, previoulsy attached to event emission
3036     * by the @p obj.
3037     * The parameters func and data must match exactly those passed to
3038     * a previous call to elm_object_event_callback_add(). The data pointer that
3039     * was passed to this call will be returned.
3040     *
3041     * @param obj The object
3042     * @param func The callback function to be executed when the event is
3043     * emitted.
3044     * @param data Data to pass in to the callback function.
3045     * @return The data pointer
3046     * @ingroup General
3047     */
3048    EAPI void            *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3049
3050    /**
3051     * Adjust size of an element for finger usage.
3052     *
3053     * @param times_w How many fingers should fit horizontally
3054     * @param w Pointer to the width size to adjust
3055     * @param times_h How many fingers should fit vertically
3056     * @param h Pointer to the height size to adjust
3057     *
3058     * This takes width and height sizes (in pixels) as input and a
3059     * size multiple (which is how many fingers you want to place
3060     * within the area, being "finger" the size set by
3061     * elm_finger_size_set()), and adjusts the size to be large enough
3062     * to accommodate the resulting size -- if it doesn't already
3063     * accommodate it. On return the @p w and @p h sizes pointed to by
3064     * these parameters will be modified, on those conditions.
3065     *
3066     * @note This is kind of a low level Elementary call, most useful
3067     * on size evaluation times for widgets. An external user wouldn't
3068     * be calling, most of the time.
3069     *
3070     * @ingroup Fingers
3071     */
3072    EAPI void             elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3073
3074    /**
3075     * Get the duration for occuring long press event.
3076     *
3077     * @return Timeout for long press event
3078     * @ingroup Longpress
3079     */
3080    EAPI double           elm_longpress_timeout_get(void);
3081
3082    /**
3083     * Set the duration for occuring long press event.
3084     *
3085     * @param lonpress_timeout Timeout for long press event
3086     * @ingroup Longpress
3087     */
3088    EAPI void             elm_longpress_timeout_set(double longpress_timeout);
3089
3090    /**
3091     * @defgroup Debug Debug
3092     * don't use it unless you are sure
3093     *
3094     * @{
3095     */
3096
3097    /**
3098     * Print Tree object hierarchy in stdout
3099     *
3100     * @param obj The root object
3101     * @ingroup Debug
3102     */
3103    EAPI void             elm_object_tree_dump(const Evas_Object *top);
3104
3105    /**
3106     * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3107     *
3108     * @param obj The root object
3109     * @param file The path of output file
3110     * @ingroup Debug
3111     */
3112    EAPI void             elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3113
3114    /**
3115     * @}
3116     */
3117
3118    /**
3119     * @defgroup Theme Theme
3120     *
3121     * Elementary uses Edje to theme its widgets, naturally. But for the most
3122     * part this is hidden behind a simpler interface that lets the user set
3123     * extensions and choose the style of widgets in a much easier way.
3124     *
3125     * Instead of thinking in terms of paths to Edje files and their groups
3126     * each time you want to change the appearance of a widget, Elementary
3127     * works so you can add any theme file with extensions or replace the
3128     * main theme at one point in the application, and then just set the style
3129     * of widgets with elm_object_style_set() and related functions. Elementary
3130     * will then look in its list of themes for a matching group and apply it,
3131     * and when the theme changes midway through the application, all widgets
3132     * will be updated accordingly.
3133     *
3134     * There are three concepts you need to know to understand how Elementary
3135     * theming works: default theme, extensions and overlays.
3136     *
3137     * Default theme, obviously enough, is the one that provides the default
3138     * look of all widgets. End users can change the theme used by Elementary
3139     * by setting the @c ELM_THEME environment variable before running an
3140     * application, or globally for all programs using the @c elementary_config
3141     * utility. Applications can change the default theme using elm_theme_set(),
3142     * but this can go against the user wishes, so it's not an adviced practice.
3143     *
3144     * Ideally, applications should find everything they need in the already
3145     * provided theme, but there may be occasions when that's not enough and
3146     * custom styles are required to correctly express the idea. For this
3147     * cases, Elementary has extensions.
3148     *
3149     * Extensions allow the application developer to write styles of its own
3150     * to apply to some widgets. This requires knowledge of how each widget
3151     * is themed, as extensions will always replace the entire group used by
3152     * the widget, so important signals and parts need to be there for the
3153     * object to behave properly (see documentation of Edje for details).
3154     * Once the theme for the extension is done, the application needs to add
3155     * it to the list of themes Elementary will look into, using
3156     * elm_theme_extension_add(), and set the style of the desired widgets as
3157     * he would normally with elm_object_style_set().
3158     *
3159     * Overlays, on the other hand, can replace the look of all widgets by
3160     * overriding the default style. Like extensions, it's up to the application
3161     * developer to write the theme for the widgets it wants, the difference
3162     * being that when looking for the theme, Elementary will check first the
3163     * list of overlays, then the set theme and lastly the list of extensions,
3164     * so with overlays it's possible to replace the default view and every
3165     * widget will be affected. This is very much alike to setting the whole
3166     * theme for the application and will probably clash with the end user
3167     * options, not to mention the risk of ending up with not matching styles
3168     * across the program. Unless there's a very special reason to use them,
3169     * overlays should be avoided for the resons exposed before.
3170     *
3171     * All these theme lists are handled by ::Elm_Theme instances. Elementary
3172     * keeps one default internally and every function that receives one of
3173     * these can be called with NULL to refer to this default (except for
3174     * elm_theme_free()). It's possible to create a new instance of a
3175     * ::Elm_Theme to set other theme for a specific widget (and all of its
3176     * children), but this is as discouraged, if not even more so, than using
3177     * overlays. Don't use this unless you really know what you are doing.
3178     *
3179     * But to be less negative about things, you can look at the following
3180     * examples:
3181     * @li @ref theme_example_01 "Using extensions"
3182     * @li @ref theme_example_02 "Using overlays"
3183     *
3184     * @{
3185     */
3186    /**
3187     * @typedef Elm_Theme
3188     *
3189     * Opaque handler for the list of themes Elementary looks for when
3190     * rendering widgets.
3191     *
3192     * Stay out of this unless you really know what you are doing. For most
3193     * cases, sticking to the default is all a developer needs.
3194     */
3195    typedef struct _Elm_Theme Elm_Theme;
3196
3197    /**
3198     * Create a new specific theme
3199     *
3200     * This creates an empty specific theme that only uses the default theme. A
3201     * specific theme has its own private set of extensions and overlays too
3202     * (which are empty by default). Specific themes do not fall back to themes
3203     * of parent objects. They are not intended for this use. Use styles, overlays
3204     * and extensions when needed, but avoid specific themes unless there is no
3205     * other way (example: you want to have a preview of a new theme you are
3206     * selecting in a "theme selector" window. The preview is inside a scroller
3207     * and should display what the theme you selected will look like, but not
3208     * actually apply it yet. The child of the scroller will have a specific
3209     * theme set to show this preview before the user decides to apply it to all
3210     * applications).
3211     */
3212    EAPI Elm_Theme       *elm_theme_new(void);
3213    /**
3214     * Free a specific theme
3215     *
3216     * @param th The theme to free
3217     *
3218     * This frees a theme created with elm_theme_new().
3219     */
3220    EAPI void             elm_theme_free(Elm_Theme *th);
3221    /**
3222     * Copy the theme fom the source to the destination theme
3223     *
3224     * @param th The source theme to copy from
3225     * @param thdst The destination theme to copy data to
3226     *
3227     * This makes a one-time static copy of all the theme config, extensions
3228     * and overlays from @p th to @p thdst. If @p th references a theme, then
3229     * @p thdst is also set to reference it, with all the theme settings,
3230     * overlays and extensions that @p th had.
3231     */
3232    EAPI void             elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3233    /**
3234     * Tell the source theme to reference the ref theme
3235     *
3236     * @param th The theme that will do the referencing
3237     * @param thref The theme that is the reference source
3238     *
3239     * This clears @p th to be empty and then sets it to refer to @p thref
3240     * so @p th acts as an override to @p thref, but where its overrides
3241     * don't apply, it will fall through to @p thref for configuration.
3242     */
3243    EAPI void             elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3244    /**
3245     * Return the theme referred to
3246     *
3247     * @param th The theme to get the reference from
3248     * @return The referenced theme handle
3249     *
3250     * This gets the theme set as the reference theme by elm_theme_ref_set().
3251     * If no theme is set as a reference, NULL is returned.
3252     */
3253    EAPI Elm_Theme       *elm_theme_ref_get(Elm_Theme *th);
3254    /**
3255     * Return the default theme
3256     *
3257     * @return The default theme handle
3258     *
3259     * This returns the internal default theme setup handle that all widgets
3260     * use implicitly unless a specific theme is set. This is also often use
3261     * as a shorthand of NULL.
3262     */
3263    EAPI Elm_Theme       *elm_theme_default_get(void);
3264    /**
3265     * Prepends a theme overlay to the list of overlays
3266     *
3267     * @param th The theme to add to, or if NULL, the default theme
3268     * @param item The Edje file path to be used
3269     *
3270     * Use this if your application needs to provide some custom overlay theme
3271     * (An Edje file that replaces some default styles of widgets) where adding
3272     * new styles, or changing system theme configuration is not possible. Do
3273     * NOT use this instead of a proper system theme configuration. Use proper
3274     * configuration files, profiles, environment variables etc. to set a theme
3275     * so that the theme can be altered by simple confiugration by a user. Using
3276     * this call to achieve that effect is abusing the API and will create lots
3277     * of trouble.
3278     *
3279     * @see elm_theme_extension_add()
3280     */
3281    EAPI void             elm_theme_overlay_add(Elm_Theme *th, const char *item);
3282    /**
3283     * Delete a theme overlay from the list of overlays
3284     *
3285     * @param th The theme to delete from, or if NULL, the default theme
3286     * @param item The name of the theme overlay
3287     *
3288     * @see elm_theme_overlay_add()
3289     */
3290    EAPI void             elm_theme_overlay_del(Elm_Theme *th, const char *item);
3291    /**
3292     * Appends a theme extension to the list of extensions.
3293     *
3294     * @param th The theme to add to, or if NULL, the default theme
3295     * @param item The Edje file path to be used
3296     *
3297     * This is intended when an application needs more styles of widgets or new
3298     * widget themes that the default does not provide (or may not provide). The
3299     * application has "extended" usage by coming up with new custom style names
3300     * for widgets for specific uses, but as these are not "standard", they are
3301     * not guaranteed to be provided by a default theme. This means the
3302     * application is required to provide these extra elements itself in specific
3303     * Edje files. This call adds one of those Edje files to the theme search
3304     * path to be search after the default theme. The use of this call is
3305     * encouraged when default styles do not meet the needs of the application.
3306     * Use this call instead of elm_theme_overlay_add() for almost all cases.
3307     *
3308     * @see elm_object_style_set()
3309     */
3310    EAPI void             elm_theme_extension_add(Elm_Theme *th, const char *item);
3311    /**
3312     * Deletes a theme extension from the list of extensions.
3313     *
3314     * @param th The theme to delete from, or if NULL, the default theme
3315     * @param item The name of the theme extension
3316     *
3317     * @see elm_theme_extension_add()
3318     */
3319    EAPI void             elm_theme_extension_del(Elm_Theme *th, const char *item);
3320    /**
3321     * Set the theme search order for the given theme
3322     *
3323     * @param th The theme to set the search order, or if NULL, the default theme
3324     * @param theme Theme search string
3325     *
3326     * This sets the search string for the theme in path-notation from first
3327     * theme to search, to last, delimited by the : character. Example:
3328     *
3329     * "shiny:/path/to/file.edj:default"
3330     *
3331     * See the ELM_THEME environment variable for more information.
3332     *
3333     * @see elm_theme_get()
3334     * @see elm_theme_list_get()
3335     */
3336    EAPI void             elm_theme_set(Elm_Theme *th, const char *theme);
3337    /**
3338     * Return the theme search order
3339     *
3340     * @param th The theme to get the search order, or if NULL, the default theme
3341     * @return The internal search order path
3342     *
3343     * This function returns a colon separated string of theme elements as
3344     * returned by elm_theme_list_get().
3345     *
3346     * @see elm_theme_set()
3347     * @see elm_theme_list_get()
3348     */
3349    EAPI const char      *elm_theme_get(Elm_Theme *th);
3350    /**
3351     * Return a list of theme elements to be used in a theme.
3352     *
3353     * @param th Theme to get the list of theme elements from.
3354     * @return The internal list of theme elements
3355     *
3356     * This returns the internal list of theme elements (will only be valid as
3357     * long as the theme is not modified by elm_theme_set() or theme is not
3358     * freed by elm_theme_free(). This is a list of strings which must not be
3359     * altered as they are also internal. If @p th is NULL, then the default
3360     * theme element list is returned.
3361     *
3362     * A theme element can consist of a full or relative path to a .edj file,
3363     * or a name, without extension, for a theme to be searched in the known
3364     * theme paths for Elemementary.
3365     *
3366     * @see elm_theme_set()
3367     * @see elm_theme_get()
3368     */
3369    EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3370    /**
3371     * Return the full patrh for a theme element
3372     *
3373     * @param f The theme element name
3374     * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3375     * @return The full path to the file found.
3376     *
3377     * This returns a string you should free with free() on success, NULL on
3378     * failure. This will search for the given theme element, and if it is a
3379     * full or relative path element or a simple searchable name. The returned
3380     * path is the full path to the file, if searched, and the file exists, or it
3381     * is simply the full path given in the element or a resolved path if
3382     * relative to home. The @p in_search_path boolean pointed to is set to
3383     * EINA_TRUE if the file was a searchable file andis in the search path,
3384     * and EINA_FALSE otherwise.
3385     */
3386    EAPI char            *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3387    /**
3388     * Flush the current theme.
3389     *
3390     * @param th Theme to flush
3391     *
3392     * This flushes caches that let elementary know where to find theme elements
3393     * in the given theme. If @p th is NULL, then the default theme is flushed.
3394     * Call this function if source theme data has changed in such a way as to
3395     * make any caches Elementary kept invalid.
3396     */
3397    EAPI void             elm_theme_flush(Elm_Theme *th);
3398    /**
3399     * This flushes all themes (default and specific ones).
3400     *
3401     * This will flush all themes in the current application context, by calling
3402     * elm_theme_flush() on each of them.
3403     */
3404    EAPI void             elm_theme_full_flush(void);
3405    /**
3406     * Set the theme for all elementary using applications on the current display
3407     *
3408     * @param theme The name of the theme to use. Format same as the ELM_THEME
3409     * environment variable.
3410     */
3411    EAPI void             elm_theme_all_set(const char *theme);
3412    /**
3413     * Return a list of theme elements in the theme search path
3414     *
3415     * @return A list of strings that are the theme element names.
3416     *
3417     * This lists all available theme files in the standard Elementary search path
3418     * for theme elements, and returns them in alphabetical order as theme
3419     * element names in a list of strings. Free this with
3420     * elm_theme_name_available_list_free() when you are done with the list.
3421     */
3422    EAPI Eina_List       *elm_theme_name_available_list_new(void);
3423    /**
3424     * Free the list returned by elm_theme_name_available_list_new()
3425     *
3426     * This frees the list of themes returned by
3427     * elm_theme_name_available_list_new(). Once freed the list should no longer
3428     * be used. a new list mys be created.
3429     */
3430    EAPI void             elm_theme_name_available_list_free(Eina_List *list);
3431    /**
3432     * Set a specific theme to be used for this object and its children
3433     *
3434     * @param obj The object to set the theme on
3435     * @param th The theme to set
3436     *
3437     * This sets a specific theme that will be used for the given object and any
3438     * child objects it has. If @p th is NULL then the theme to be used is
3439     * cleared and the object will inherit its theme from its parent (which
3440     * ultimately will use the default theme if no specific themes are set).
3441     *
3442     * Use special themes with great care as this will annoy users and make
3443     * configuration difficult. Avoid any custom themes at all if it can be
3444     * helped.
3445     */
3446    EAPI void             elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3447    /**
3448     * Get the specific theme to be used
3449     *
3450     * @param obj The object to get the specific theme from
3451     * @return The specifc theme set.
3452     *
3453     * This will return a specific theme set, or NULL if no specific theme is
3454     * set on that object. It will not return inherited themes from parents, only
3455     * the specific theme set for that specific object. See elm_object_theme_set()
3456     * for more information.
3457     */
3458    EAPI Elm_Theme       *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3459
3460    /**
3461     * Get a data item from a theme
3462     *
3463     * @param th The theme, or NULL for default theme
3464     * @param key The data key to search with
3465     * @return The data value, or NULL on failure
3466     *
3467     * This function is used to return data items from edc in @p th, an overlay, or an extension.
3468     * It works the same way as edje_file_data_get() except that the return is stringshared.
3469     */
3470    EAPI const char      *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3471    /**
3472     * @}
3473     */
3474
3475    /* win */
3476    /** @defgroup Win Win
3477     *
3478     * @image html img/widget/win/preview-00.png
3479     * @image latex img/widget/win/preview-00.eps
3480     *
3481     * The window class of Elementary.  Contains functions to manipulate
3482     * windows. The Evas engine used to render the window contents is specified
3483     * in the system or user elementary config files (whichever is found last),
3484     * and can be overridden with the ELM_ENGINE environment variable for
3485     * testing.  Engines that may be supported (depending on Evas and Ecore-Evas
3486     * compilation setup and modules actually installed at runtime) are (listed
3487     * in order of best supported and most likely to be complete and work to
3488     * lowest quality).
3489     *
3490     * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3491     * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3492     * rendering in X11)
3493     * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3494     * exits)
3495     * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3496     * rendering)
3497     * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3498     * buffer)
3499     * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3500     * rendering using SDL as the buffer)
3501     * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3502     * GDI with software)
3503     * @li "dfb", "directfb" (Rendering to a DirectFB window)
3504     * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3505     * grayscale using dedicated 8bit software engine in X11)
3506     * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3507     * X11 using 16bit software engine)
3508     * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3509     * (Windows CE rendering via GDI with 16bit software renderer)
3510     * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3511     * buffer with 16bit software renderer)
3512     *
3513     * All engines use a simple string to select the engine to render, EXCEPT
3514     * the "shot" engine. This actually encodes the output of the virtual
3515     * screenshot and how long to delay in the engine string. The engine string
3516     * is encoded in the following way:
3517     *
3518     *   "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3519     *
3520     * Where options are separated by a ":" char if more than one option is
3521     * given, with delay, if provided being the first option and file the last
3522     * (order is important). The delay specifies how long to wait after the
3523     * window is shown before doing the virtual "in memory" rendering and then
3524     * save the output to the file specified by the file option (and then exit).
3525     * If no delay is given, the default is 0.5 seconds. If no file is given the
3526     * default output file is "out.png". Repeat option is for continous
3527     * capturing screenshots. Repeat range is from 1 to 999 and filename is
3528     * fixed to "out001.png" Some examples of using the shot engine:
3529     *
3530     *   ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3531     *   ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3532     *   ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3533     *   ELM_ENGINE="shot:delay=2.0" elementary_test
3534     *   ELM_ENGINE="shot:" elementary_test
3535     *
3536     * Signals that you can add callbacks for are:
3537     *
3538     * @li "delete,request": the user requested to close the window. See
3539     * elm_win_autodel_set().
3540     * @li "focus,in": window got focus
3541     * @li "focus,out": window lost focus
3542     * @li "moved": window that holds the canvas was moved
3543     *
3544     * Examples:
3545     * @li @ref win_example_01
3546     *
3547     * @{
3548     */
3549    /**
3550     * Defines the types of window that can be created
3551     *
3552     * These are hints set on the window so that a running Window Manager knows
3553     * how the window should be handled and/or what kind of decorations it
3554     * should have.
3555     *
3556     * Currently, only the X11 backed engines use them.
3557     */
3558    typedef enum _Elm_Win_Type
3559      {
3560         ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3561                          window. Almost every window will be created with this
3562                          type. */
3563         ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3564         ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3565                            window holding desktop icons. */
3566         ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3567                         be kept on top of any other window by the Window
3568                         Manager. */
3569         ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3570                            similar. */
3571         ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3572         ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3573                            pallete. */
3574         ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3575         ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3576                                  entry in a menubar is clicked. Typically used
3577                                  with elm_win_override_set(). This hint exists
3578                                  for completion only, as the EFL way of
3579                                  implementing a menu would not normally use a
3580                                  separate window for its contents. */
3581         ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3582                               triggered by right-clicking an object. */
3583         ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3584                            explanatory text that typically appear after the
3585                            mouse cursor hovers over an object for a while.
3586                            Typically used with elm_win_override_set() and also
3587                            not very commonly used in the EFL. */
3588         ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3589                                 battery life or a new E-Mail received. */
3590         ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3591                          usually used in the EFL. */
3592         ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3593                        object being dragged across different windows, or even
3594                        applications. Typically used with
3595                        elm_win_override_set(). */
3596         ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3597                                  buffer. No actual window is created for this
3598                                  type, instead the window and all of its
3599                                  contents will be rendered to an image buffer.
3600                                  This allows to have children window inside a
3601                                  parent one just like any other object would
3602                                  be, and do other things like applying @c
3603                                  Evas_Map effects to it. This is the only type
3604                                  of window that requires the @c parent
3605                                  parameter of elm_win_add() to be a valid @c
3606                                  Evas_Object. */
3607      } Elm_Win_Type;
3608
3609    /**
3610     * The differents layouts that can be requested for the virtual keyboard.
3611     *
3612     * When the application window is being managed by Illume, it may request
3613     * any of the following layouts for the virtual keyboard.
3614     */
3615    typedef enum _Elm_Win_Keyboard_Mode
3616      {
3617         ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3618         ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3619         ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3620         ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3621         ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3622         ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3623         ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3624         ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3625         ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3626         ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3627         ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3628         ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3629         ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3630         ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3631         ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3632         ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3633      } Elm_Win_Keyboard_Mode;
3634
3635    /**
3636     * Available commands that can be sent to the Illume manager.
3637     *
3638     * When running under an Illume session, a window may send commands to the
3639     * Illume manager to perform different actions.
3640     */
3641    typedef enum _Elm_Illume_Command
3642      {
3643         ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3644                                          window */
3645         ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3646                                             in the list */
3647         ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3648                                          screen */
3649         ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3650      } Elm_Illume_Command;
3651
3652    /**
3653     * Adds a window object. If this is the first window created, pass NULL as
3654     * @p parent.
3655     *
3656     * @param parent Parent object to add the window to, or NULL
3657     * @param name The name of the window
3658     * @param type The window type, one of #Elm_Win_Type.
3659     *
3660     * The @p parent paramter can be @c NULL for every window @p type except
3661     * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3662     * which the image object will be created.
3663     *
3664     * @return The created object, or NULL on failure
3665     */
3666    EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3667    /**
3668     * Add @p subobj as a resize object of window @p obj.
3669     *
3670     *
3671     * Setting an object as a resize object of the window means that the
3672     * @p subobj child's size and position will be controlled by the window
3673     * directly. That is, the object will be resized to match the window size
3674     * and should never be moved or resized manually by the developer.
3675     *
3676     * In addition, resize objects of the window control what the minimum size
3677     * of it will be, as well as whether it can or not be resized by the user.
3678     *
3679     * For the end user to be able to resize a window by dragging the handles
3680     * or borders provided by the Window Manager, or using any other similar
3681     * mechanism, all of the resize objects in the window should have their
3682     * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3683     *
3684     * @param obj The window object
3685     * @param subobj The resize object to add
3686     */
3687    EAPI void         elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3688    /**
3689     * Delete @p subobj as a resize object of window @p obj.
3690     *
3691     * This function removes the object @p subobj from the resize objects of
3692     * the window @p obj. It will not delete the object itself, which will be
3693     * left unmanaged and should be deleted by the developer, manually handled
3694     * or set as child of some other container.
3695     *
3696     * @param obj The window object
3697     * @param subobj The resize object to add
3698     */
3699    EAPI void         elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3700    /**
3701     * Set the title of the window
3702     *
3703     * @param obj The window object
3704     * @param title The title to set
3705     */
3706    EAPI void         elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3707    /**
3708     * Get the title of the window
3709     *
3710     * The returned string is an internal one and should not be freed or
3711     * modified. It will also be rendered invalid if a new title is set or if
3712     * the window is destroyed.
3713     *
3714     * @param obj The window object
3715     * @return The title
3716     */
3717    EAPI const char  *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3718    /**
3719     * Set the window's autodel state.
3720     *
3721     * When closing the window in any way outside of the program control, like
3722     * pressing the X button in the titlebar or using a command from the
3723     * Window Manager, a "delete,request" signal is emitted to indicate that
3724     * this event occurred and the developer can take any action, which may
3725     * include, or not, destroying the window object.
3726     *
3727     * When the @p autodel parameter is set, the window will be automatically
3728     * destroyed when this event occurs, after the signal is emitted.
3729     * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3730     * and is up to the program to do so when it's required.
3731     *
3732     * @param obj The window object
3733     * @param autodel If true, the window will automatically delete itself when
3734     * closed
3735     */
3736    EAPI void         elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3737    /**
3738     * Get the window's autodel state.
3739     *
3740     * @param obj The window object
3741     * @return If the window will automatically delete itself when closed
3742     *
3743     * @see elm_win_autodel_set()
3744     */
3745    EAPI Eina_Bool    elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3746    /**
3747     * Activate a window object.
3748     *
3749     * This function sends a request to the Window Manager to activate the
3750     * window pointed by @p obj. If honored by the WM, the window will receive
3751     * the keyboard focus.
3752     *
3753     * @note This is just a request that a Window Manager may ignore, so calling
3754     * this function does not ensure in any way that the window will be the
3755     * active one after it.
3756     *
3757     * @param obj The window object
3758     */
3759    EAPI void         elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3760    /**
3761     * Lower a window object.
3762     *
3763     * Places the window pointed by @p obj at the bottom of the stack, so that
3764     * no other window is covered by it.
3765     *
3766     * If elm_win_override_set() is not set, the Window Manager may ignore this
3767     * request.
3768     *
3769     * @param obj The window object
3770     */
3771    EAPI void         elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3772    /**
3773     * Raise a window object.
3774     *
3775     * Places the window pointed by @p obj at the top of the stack, so that it's
3776     * not covered by any other window.
3777     *
3778     * If elm_win_override_set() is not set, the Window Manager may ignore this
3779     * request.
3780     *
3781     * @param obj The window object
3782     */
3783    EAPI void         elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3784    /**
3785     * Set the borderless state of a window.
3786     *
3787     * This function requests the Window Manager to not draw any decoration
3788     * around the window.
3789     *
3790     * @param obj The window object
3791     * @param borderless If true, the window is borderless
3792     */
3793    EAPI void         elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3794    /**
3795     * Get the borderless state of a window.
3796     *
3797     * @param obj The window object
3798     * @return If true, the window is borderless
3799     */
3800    EAPI Eina_Bool    elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3801    /**
3802     * Set the shaped state of a window.
3803     *
3804     * Shaped windows, when supported, will render the parts of the window that
3805     * has no content, transparent.
3806     *
3807     * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3808     * background object or cover the entire window in any other way, or the
3809     * parts of the canvas that have no data will show framebuffer artifacts.
3810     *
3811     * @param obj The window object
3812     * @param shaped If true, the window is shaped
3813     *
3814     * @see elm_win_alpha_set()
3815     */
3816    EAPI void         elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3817    /**
3818     * Get the shaped state of a window.
3819     *
3820     * @param obj The window object
3821     * @return If true, the window is shaped
3822     *
3823     * @see elm_win_shaped_set()
3824     */
3825    EAPI Eina_Bool    elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3826    /**
3827     * Set the alpha channel state of a window.
3828     *
3829     * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3830     * possibly making parts of the window completely or partially transparent.
3831     * This is also subject to the underlying system supporting it, like for
3832     * example, running under a compositing manager. If no compositing is
3833     * available, enabling this option will instead fallback to using shaped
3834     * windows, with elm_win_shaped_set().
3835     *
3836     * @param obj The window object
3837     * @param alpha If true, the window has an alpha channel
3838     *
3839     * @see elm_win_alpha_set()
3840     */
3841    EAPI void         elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
3842    /**
3843     * Get the transparency state of a window.
3844     *
3845     * @param obj The window object
3846     * @return If true, the window is transparent
3847     *
3848     * @see elm_win_transparent_set()
3849     */
3850    EAPI Eina_Bool    elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3851    /**
3852     * Set the transparency state of a window.
3853     *
3854     * Use elm_win_alpha_set() instead.
3855     *
3856     * @param obj The window object
3857     * @param transparent If true, the window is transparent
3858     *
3859     * @see elm_win_alpha_set()
3860     */
3861    EAPI void         elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
3862    /**
3863     * Get the alpha channel state of a window.
3864     *
3865     * @param obj The window object
3866     * @return If true, the window has an alpha channel
3867     */
3868    EAPI Eina_Bool    elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3869    /**
3870     * Set the override state of a window.
3871     *
3872     * A window with @p override set to EINA_TRUE will not be managed by the
3873     * Window Manager. This means that no decorations of any kind will be shown
3874     * for it, moving and resizing must be handled by the application, as well
3875     * as the window visibility.
3876     *
3877     * This should not be used for normal windows, and even for not so normal
3878     * ones, it should only be used when there's a good reason and with a lot
3879     * of care. Mishandling override windows may result situations that
3880     * disrupt the normal workflow of the end user.
3881     *
3882     * @param obj The window object
3883     * @param override If true, the window is overridden
3884     */
3885    EAPI void         elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
3886    /**
3887     * Get the override state of a window.
3888     *
3889     * @param obj The window object
3890     * @return If true, the window is overridden
3891     *
3892     * @see elm_win_override_set()
3893     */
3894    EAPI Eina_Bool    elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3895    /**
3896     * Set the fullscreen state of a window.
3897     *
3898     * @param obj The window object
3899     * @param fullscreen If true, the window is fullscreen
3900     */
3901    EAPI void         elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
3902    /**
3903     * Get the fullscreen state of a window.
3904     *
3905     * @param obj The window object
3906     * @return If true, the window is fullscreen
3907     */
3908    EAPI Eina_Bool    elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3909    /**
3910     * Set the maximized state of a window.
3911     *
3912     * @param obj The window object
3913     * @param maximized If true, the window is maximized
3914     */
3915    EAPI void         elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
3916    /**
3917     * Get the maximized state of a window.
3918     *
3919     * @param obj The window object
3920     * @return If true, the window is maximized
3921     */
3922    EAPI Eina_Bool    elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3923    /**
3924     * Set the iconified state of a window.
3925     *
3926     * @param obj The window object
3927     * @param iconified If true, the window is iconified
3928     */
3929    EAPI void         elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
3930    /**
3931     * Get the iconified state of a window.
3932     *
3933     * @param obj The window object
3934     * @return If true, the window is iconified
3935     */
3936    EAPI Eina_Bool    elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3937    /**
3938     * Set the layer of the window.
3939     *
3940     * What this means exactly will depend on the underlying engine used.
3941     *
3942     * In the case of X11 backed engines, the value in @p layer has the
3943     * following meanings:
3944     * @li < 3: The window will be placed below all others.
3945     * @li > 5: The window will be placed above all others.
3946     * @li other: The window will be placed in the default layer.
3947     *
3948     * @param obj The window object
3949     * @param layer The layer of the window
3950     */
3951    EAPI void         elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
3952    /**
3953     * Get the layer of the window.
3954     *
3955     * @param obj The window object
3956     * @return The layer of the window
3957     *
3958     * @see elm_win_layer_set()
3959     */
3960    EAPI int          elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3961    /**
3962     * Set the rotation of the window.
3963     *
3964     * Most engines only work with multiples of 90.
3965     *
3966     * This function is used to set the orientation of the window @p obj to
3967     * match that of the screen. The window itself will be resized to adjust
3968     * to the new geometry of its contents. If you want to keep the window size,
3969     * see elm_win_rotation_with_resize_set().
3970     *
3971     * @param obj The window object
3972     * @param rotation The rotation of the window, in degrees (0-360),
3973     * counter-clockwise.
3974     */
3975    EAPI void         elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3976    /**
3977     * Rotates the window and resizes it.
3978     *
3979     * Like elm_win_rotation_set(), but it also resizes the window's contents so
3980     * that they fit inside the current window geometry.
3981     *
3982     * @param obj The window object
3983     * @param layer The rotation of the window in degrees (0-360),
3984     * counter-clockwise.
3985     */
3986    EAPI void         elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3987    /**
3988     * Get the rotation of the window.
3989     *
3990     * @param obj The window object
3991     * @return The rotation of the window in degrees (0-360)
3992     *
3993     * @see elm_win_rotation_set()
3994     * @see elm_win_rotation_with_resize_set()
3995     */
3996    EAPI int          elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3997    /**
3998     * Set the sticky state of the window.
3999     *
4000     * Hints the Window Manager that the window in @p obj should be left fixed
4001     * at its position even when the virtual desktop it's on moves or changes.
4002     *
4003     * @param obj The window object
4004     * @param sticky If true, the window's sticky state is enabled
4005     */
4006    EAPI void         elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4007    /**
4008     * Get the sticky state of the window.
4009     *
4010     * @param obj The window object
4011     * @return If true, the window's sticky state is enabled
4012     *
4013     * @see elm_win_sticky_set()
4014     */
4015    EAPI Eina_Bool    elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4016    /**
4017     * Set if this window is an illume conformant window
4018     *
4019     * @param obj The window object
4020     * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4021     */
4022    EAPI void         elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4023    /**
4024     * Get if this window is an illume conformant window
4025     *
4026     * @param obj The window object
4027     * @return A boolean if this window is illume conformant or not
4028     */
4029    EAPI Eina_Bool    elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4030    /**
4031     * Set a window to be an illume quickpanel window
4032     *
4033     * By default window objects are not quickpanel windows.
4034     *
4035     * @param obj The window object
4036     * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4037     */
4038    EAPI void         elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4039    /**
4040     * Get if this window is a quickpanel or not
4041     *
4042     * @param obj The window object
4043     * @return A boolean if this window is a quickpanel or not
4044     */
4045    EAPI Eina_Bool    elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4046    /**
4047     * Set the major priority of a quickpanel window
4048     *
4049     * @param obj The window object
4050     * @param priority The major priority for this quickpanel
4051     */
4052    EAPI void         elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4053    /**
4054     * Get the major priority of a quickpanel window
4055     *
4056     * @param obj The window object
4057     * @return The major priority of this quickpanel
4058     */
4059    EAPI int          elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4060    /**
4061     * Set the minor priority of a quickpanel window
4062     *
4063     * @param obj The window object
4064     * @param priority The minor priority for this quickpanel
4065     */
4066    EAPI void         elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4067    /**
4068     * Get the minor priority of a quickpanel window
4069     *
4070     * @param obj The window object
4071     * @return The minor priority of this quickpanel
4072     */
4073    EAPI int          elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4074    /**
4075     * Set which zone this quickpanel should appear in
4076     *
4077     * @param obj The window object
4078     * @param zone The requested zone for this quickpanel
4079     */
4080    EAPI void         elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4081    /**
4082     * Get which zone this quickpanel should appear in
4083     *
4084     * @param obj The window object
4085     * @return The requested zone for this quickpanel
4086     */
4087    EAPI int          elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4088    /**
4089     * Set the window to be skipped by keyboard focus
4090     *
4091     * This sets the window to be skipped by normal keyboard input. This means
4092     * a window manager will be asked to not focus this window as well as omit
4093     * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4094     *
4095     * Call this and enable it on a window BEFORE you show it for the first time,
4096     * otherwise it may have no effect.
4097     *
4098     * Use this for windows that have only output information or might only be
4099     * interacted with by the mouse or fingers, and never for typing input.
4100     * Be careful that this may have side-effects like making the window
4101     * non-accessible in some cases unless the window is specially handled. Use
4102     * this with care.
4103     *
4104     * @param obj The window object
4105     * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4106     */
4107    EAPI void         elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4108    /**
4109     * Send a command to the windowing environment
4110     *
4111     * This is intended to work in touchscreen or small screen device
4112     * environments where there is a more simplistic window management policy in
4113     * place. This uses the window object indicated to select which part of the
4114     * environment to control (the part that this window lives in), and provides
4115     * a command and an optional parameter structure (use NULL for this if not
4116     * needed).
4117     *
4118     * @param obj The window object that lives in the environment to control
4119     * @param command The command to send
4120     * @param params Optional parameters for the command
4121     */
4122    EAPI void         elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4123    /**
4124     * Get the inlined image object handle
4125     *
4126     * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4127     * then the window is in fact an evas image object inlined in the parent
4128     * canvas. You can get this object (be careful to not manipulate it as it
4129     * is under control of elementary), and use it to do things like get pixel
4130     * data, save the image to a file, etc.
4131     *
4132     * @param obj The window object to get the inlined image from
4133     * @return The inlined image object, or NULL if none exists
4134     */
4135    EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4136    /**
4137     * Set the enabled status for the focus highlight in a window
4138     *
4139     * This function will enable or disable the focus highlight only for the
4140     * given window, regardless of the global setting for it
4141     *
4142     * @param obj The window where to enable the highlight
4143     * @param enabled The enabled value for the highlight
4144     */
4145    EAPI void         elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4146    /**
4147     * Get the enabled value of the focus highlight for this window
4148     *
4149     * @param obj The window in which to check if the focus highlight is enabled
4150     *
4151     * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4152     */
4153    EAPI Eina_Bool    elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4154    /**
4155     * Set the style for the focus highlight on this window
4156     *
4157     * Sets the style to use for theming the highlight of focused objects on
4158     * the given window. If @p style is NULL, the default will be used.
4159     *
4160     * @param obj The window where to set the style
4161     * @param style The style to set
4162     */
4163    EAPI void         elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4164    /**
4165     * Get the style set for the focus highlight object
4166     *
4167     * Gets the style set for this windows highilght object, or NULL if none
4168     * is set.
4169     *
4170     * @param obj The window to retrieve the highlights style from
4171     *
4172     * @return The style set or NULL if none was. Default is used in that case.
4173     */
4174    EAPI const char  *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4175    /*...
4176     * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4177     * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4178     * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4179     * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4180     * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4181     * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4182     * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4183     *
4184     * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4185     * (blank mouse, private mouse obj, defaultmouse)
4186     *
4187     */
4188    /**
4189     * Sets the keyboard mode of the window.
4190     *
4191     * @param obj The window object
4192     * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4193     */
4194    EAPI void                  elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4195    /**
4196     * Gets the keyboard mode of the window.
4197     *
4198     * @param obj The window object
4199     * @return The mode, one of #Elm_Win_Keyboard_Mode
4200     */
4201    EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4202    /**
4203     * Sets whether the window is a keyboard.
4204     *
4205     * @param obj The window object
4206     * @param is_keyboard If true, the window is a virtual keyboard
4207     */
4208    EAPI void                  elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4209    /**
4210     * Gets whether the window is a keyboard.
4211     *
4212     * @param obj The window object
4213     * @return If the window is a virtual keyboard
4214     */
4215    EAPI Eina_Bool             elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4216
4217    /**
4218     * Get the screen position of a window.
4219     *
4220     * @param obj The window object
4221     * @param x The int to store the x coordinate to
4222     * @param y The int to store the y coordinate to
4223     */
4224    EAPI void                  elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4225    /**
4226     * @}
4227     */
4228
4229    /**
4230     * @defgroup Inwin Inwin
4231     *
4232     * @image html img/widget/inwin/preview-00.png
4233     * @image latex img/widget/inwin/preview-00.eps
4234     * @image html img/widget/inwin/preview-01.png
4235     * @image latex img/widget/inwin/preview-01.eps
4236     * @image html img/widget/inwin/preview-02.png
4237     * @image latex img/widget/inwin/preview-02.eps
4238     *
4239     * An inwin is a window inside a window that is useful for a quick popup.
4240     * It does not hover.
4241     *
4242     * It works by creating an object that will occupy the entire window, so it
4243     * must be created using an @ref Win "elm_win" as parent only. The inwin
4244     * object can be hidden or restacked below every other object if it's
4245     * needed to show what's behind it without destroying it. If this is done,
4246     * the elm_win_inwin_activate() function can be used to bring it back to
4247     * full visibility again.
4248     *
4249     * There are three styles available in the default theme. These are:
4250     * @li default: The inwin is sized to take over most of the window it's
4251     * placed in.
4252     * @li minimal: The size of the inwin will be the minimum necessary to show
4253     * its contents.
4254     * @li minimal_vertical: Horizontally, the inwin takes as much space as
4255     * possible, but it's sized vertically the most it needs to fit its\
4256     * contents.
4257     *
4258     * Some examples of Inwin can be found in the following:
4259     * @li @ref inwin_example_01
4260     *
4261     * @{
4262     */
4263    /**
4264     * Adds an inwin to the current window
4265     *
4266     * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4267     * Never call this function with anything other than the top-most window
4268     * as its parameter, unless you are fond of undefined behavior.
4269     *
4270     * After creating the object, the widget will set itself as resize object
4271     * for the window with elm_win_resize_object_add(), so when shown it will
4272     * appear to cover almost the entire window (how much of it depends on its
4273     * content and the style used). It must not be added into other container
4274     * objects and it needs not be moved or resized manually.
4275     *
4276     * @param parent The parent object
4277     * @return The new object or NULL if it cannot be created
4278     */
4279    EAPI Evas_Object          *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4280    /**
4281     * Activates an inwin object, ensuring its visibility
4282     *
4283     * This function will make sure that the inwin @p obj is completely visible
4284     * by calling evas_object_show() and evas_object_raise() on it, to bring it
4285     * to the front. It also sets the keyboard focus to it, which will be passed
4286     * onto its content.
4287     *
4288     * The object's theme will also receive the signal "elm,action,show" with
4289     * source "elm".
4290     *
4291     * @param obj The inwin to activate
4292     */
4293    EAPI void                  elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4294    /**
4295     * Set the content of an inwin object.
4296     *
4297     * Once the content object is set, a previously set one will be deleted.
4298     * If you want to keep that old content object, use the
4299     * elm_win_inwin_content_unset() function.
4300     *
4301     * @param obj The inwin object
4302     * @param content The object to set as content
4303     */
4304    EAPI void                  elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4305    /**
4306     * Get the content of an inwin object.
4307     *
4308     * Return the content object which is set for this widget.
4309     *
4310     * The returned object is valid as long as the inwin is still alive and no
4311     * other content is set on it. Deleting the object will notify the inwin
4312     * about it and this one will be left empty.
4313     *
4314     * If you need to remove an inwin's content to be reused somewhere else,
4315     * see elm_win_inwin_content_unset().
4316     *
4317     * @param obj The inwin object
4318     * @return The content that is being used
4319     */
4320    EAPI Evas_Object          *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4321    /**
4322     * Unset the content of an inwin object.
4323     *
4324     * Unparent and return the content object which was set for this widget.
4325     *
4326     * @param obj The inwin object
4327     * @return The content that was being used
4328     */
4329    EAPI Evas_Object          *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4330    /**
4331     * @}
4332     */
4333    /* X specific calls - won't work on non-x engines (return 0) */
4334
4335    /**
4336     * Get the Ecore_X_Window of an Evas_Object
4337     *
4338     * @param obj The object
4339     *
4340     * @return The Ecore_X_Window of @p obj
4341     *
4342     * @ingroup Win
4343     */
4344    EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4345
4346    /* smart callbacks called:
4347     * "delete,request" - the user requested to delete the window
4348     * "focus,in" - window got focus
4349     * "focus,out" - window lost focus
4350     * "moved" - window that holds the canvas was moved
4351     */
4352
4353    /**
4354     * @defgroup Bg Bg
4355     *
4356     * @image html img/widget/bg/preview-00.png
4357     * @image latex img/widget/bg/preview-00.eps
4358     *
4359     * @brief Background object, used for setting a solid color, image or Edje
4360     * group as background to a window or any container object.
4361     *
4362     * The bg object is used for setting a solid background to a window or
4363     * packing into any container object. It works just like an image, but has
4364     * some properties useful to a background, like setting it to tiled,
4365     * centered, scaled or stretched.
4366     *
4367     * Here is some sample code using it:
4368     * @li @ref bg_01_example_page
4369     * @li @ref bg_02_example_page
4370     * @li @ref bg_03_example_page
4371     */
4372
4373    /* bg */
4374    typedef enum _Elm_Bg_Option
4375      {
4376         ELM_BG_OPTION_CENTER,  /**< center the background */
4377         ELM_BG_OPTION_SCALE,   /**< scale the background retaining aspect ratio */
4378         ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4379         ELM_BG_OPTION_TILE     /**< tile background at its original size */
4380      } Elm_Bg_Option;
4381
4382    /**
4383     * Add a new background to the parent
4384     *
4385     * @param parent The parent object
4386     * @return The new object or NULL if it cannot be created
4387     *
4388     * @ingroup Bg
4389     */
4390    EAPI Evas_Object  *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4391
4392    /**
4393     * Set the file (image or edje) used for the background
4394     *
4395     * @param obj The bg object
4396     * @param file The file path
4397     * @param group Optional key (group in Edje) within the file
4398     *
4399     * This sets the image file used in the background object. The image (or edje)
4400     * will be stretched (retaining aspect if its an image file) to completely fill
4401     * the bg object. This may mean some parts are not visible.
4402     *
4403     * @note  Once the image of @p obj is set, a previously set one will be deleted,
4404     * even if @p file is NULL.
4405     *
4406     * @ingroup Bg
4407     */
4408    EAPI void          elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4409
4410    /**
4411     * Get the file (image or edje) used for the background
4412     *
4413     * @param obj The bg object
4414     * @param file The file path
4415     * @param group Optional key (group in Edje) within the file
4416     *
4417     * @ingroup Bg
4418     */
4419    EAPI void          elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4420
4421    /**
4422     * Set the option used for the background image
4423     *
4424     * @param obj The bg object
4425     * @param option The desired background option (TILE, SCALE)
4426     *
4427     * This sets the option used for manipulating the display of the background
4428     * image. The image can be tiled or scaled.
4429     *
4430     * @ingroup Bg
4431     */
4432    EAPI void          elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4433
4434    /**
4435     * Get the option used for the background image
4436     *
4437     * @param obj The bg object
4438     * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4439     *
4440     * @ingroup Bg
4441     */
4442    EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4443    /**
4444     * Set the option used for the background color
4445     *
4446     * @param obj The bg object
4447     * @param r
4448     * @param g
4449     * @param b
4450     *
4451     * This sets the color used for the background rectangle. Its range goes
4452     * from 0 to 255.
4453     *
4454     * @ingroup Bg
4455     */
4456    EAPI void          elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4457    /**
4458     * Get the option used for the background color
4459     *
4460     * @param obj The bg object
4461     * @param r
4462     * @param g
4463     * @param b
4464     *
4465     * @ingroup Bg
4466     */
4467    EAPI void          elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4468
4469    /**
4470     * Set the overlay object used for the background object.
4471     *
4472     * @param obj The bg object
4473     * @param overlay The overlay object
4474     *
4475     * This provides a way for elm_bg to have an 'overlay' that will be on top
4476     * of the bg. Once the over object is set, a previously set one will be
4477     * deleted, even if you set the new one to NULL. If you want to keep that
4478     * old content object, use the elm_bg_overlay_unset() function.
4479     *
4480     * @ingroup Bg
4481     */
4482
4483    EAPI void          elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4484
4485    /**
4486     * Get the overlay object used for the background object.
4487     *
4488     * @param obj The bg object
4489     * @return The content that is being used
4490     *
4491     * Return the content object which is set for this widget
4492     *
4493     * @ingroup Bg
4494     */
4495    EAPI Evas_Object  *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4496
4497    /**
4498     * Get the overlay object used for the background object.
4499     *
4500     * @param obj The bg object
4501     * @return The content that was being used
4502     *
4503     * Unparent and return the overlay object which was set for this widget
4504     *
4505     * @ingroup Bg
4506     */
4507    EAPI Evas_Object  *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4508
4509    /**
4510     * Set the size of the pixmap representation of the image.
4511     *
4512     * This option just makes sense if an image is going to be set in the bg.
4513     *
4514     * @param obj The bg object
4515     * @param w The new width of the image pixmap representation.
4516     * @param h The new height of the image pixmap representation.
4517     *
4518     * This function sets a new size for pixmap representation of the given bg
4519     * image. It allows the image to be loaded already in the specified size,
4520     * reducing the memory usage and load time when loading a big image with load
4521     * size set to a smaller size.
4522     *
4523     * NOTE: this is just a hint, the real size of the pixmap may differ
4524     * depending on the type of image being loaded, being bigger than requested.
4525     *
4526     * @ingroup Bg
4527     */
4528    EAPI void          elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4529    /* smart callbacks called:
4530     */
4531
4532    /**
4533     * @defgroup Icon Icon
4534     *
4535     * @image html img/widget/icon/preview-00.png
4536     * @image latex img/widget/icon/preview-00.eps
4537     *
4538     * An object that provides standard icon images (delete, edit, arrows, etc.)
4539     * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4540     *
4541     * The icon image requested can be in the elementary theme, or in the
4542     * freedesktop.org paths. It's possible to set the order of preference from
4543     * where the image will be used.
4544     *
4545     * This API is very similar to @ref Image, but with ready to use images.
4546     *
4547     * Default images provided by the theme are described below.
4548     *
4549     * The first list contains icons that were first intended to be used in
4550     * toolbars, but can be used in many other places too:
4551     * @li home
4552     * @li close
4553     * @li apps
4554     * @li arrow_up
4555     * @li arrow_down
4556     * @li arrow_left
4557     * @li arrow_right
4558     * @li chat
4559     * @li clock
4560     * @li delete
4561     * @li edit
4562     * @li refresh
4563     * @li folder
4564     * @li file
4565     *
4566     * Now some icons that were designed to be used in menus (but again, you can
4567     * use them anywhere else):
4568     * @li menu/home
4569     * @li menu/close
4570     * @li menu/apps
4571     * @li menu/arrow_up
4572     * @li menu/arrow_down
4573     * @li menu/arrow_left
4574     * @li menu/arrow_right
4575     * @li menu/chat
4576     * @li menu/clock
4577     * @li menu/delete
4578     * @li menu/edit
4579     * @li menu/refresh
4580     * @li menu/folder
4581     * @li menu/file
4582     *
4583     * And here we have some media player specific icons:
4584     * @li media_player/forward
4585     * @li media_player/info
4586     * @li media_player/next
4587     * @li media_player/pause
4588     * @li media_player/play
4589     * @li media_player/prev
4590     * @li media_player/rewind
4591     * @li media_player/stop
4592     *
4593     * Signals that you can add callbacks for are:
4594     *
4595     * "clicked" - This is called when a user has clicked the icon
4596     *
4597     * An example of usage for this API follows:
4598     * @li @ref tutorial_icon
4599     */
4600
4601    /**
4602     * @addtogroup Icon
4603     * @{
4604     */
4605
4606    typedef enum _Elm_Icon_Type
4607      {
4608         ELM_ICON_NONE,
4609         ELM_ICON_FILE,
4610         ELM_ICON_STANDARD
4611      } Elm_Icon_Type;
4612    /**
4613     * @enum _Elm_Icon_Lookup_Order
4614     * @typedef Elm_Icon_Lookup_Order
4615     *
4616     * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4617     * theme, FDO paths, or both?
4618     *
4619     * @ingroup Icon
4620     */
4621    typedef enum _Elm_Icon_Lookup_Order
4622      {
4623         ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4624         ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4625         ELM_ICON_LOOKUP_FDO,       /**< icon look up order: freedesktop */
4626         ELM_ICON_LOOKUP_THEME      /**< icon look up order: theme */
4627      } Elm_Icon_Lookup_Order;
4628
4629    /**
4630     * Add a new icon object to the parent.
4631     *
4632     * @param parent The parent object
4633     * @return The new object or NULL if it cannot be created
4634     *
4635     * @see elm_icon_file_set()
4636     *
4637     * @ingroup Icon
4638     */
4639    EAPI Evas_Object          *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4640    /**
4641     * Set the file that will be used as icon.
4642     *
4643     * @param obj The icon object
4644     * @param file The path to file that will be used as icon image
4645     * @param group The group that the icon belongs to in edje file
4646     *
4647     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4648     *
4649     * @note The icon image set by this function can be changed by
4650     * elm_icon_standard_set().
4651     *
4652     * @see elm_icon_file_get()
4653     *
4654     * @ingroup Icon
4655     */
4656    EAPI Eina_Bool             elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4657    /**
4658     * Set a location in memory to be used as an icon
4659     *
4660     * @param obj The icon object
4661     * @param img The binary data that will be used as an image
4662     * @param size The size of binary data @p img
4663     * @param format Optional format of @p img to pass to the image loader
4664     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4665     *
4666     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4667     *
4668     * @note The icon image set by this function can be changed by
4669     * elm_icon_standard_set().
4670     *
4671     * @ingroup Icon
4672     */
4673    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);
4674    /**
4675     * Get the file that will be used as icon.
4676     *
4677     * @param obj The icon object
4678     * @param file The path to file that will be used as icon icon image
4679     * @param group The group that the icon belongs to in edje file
4680     *
4681     * @see elm_icon_file_set()
4682     *
4683     * @ingroup Icon
4684     */
4685    EAPI void                  elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4686    EAPI void                  elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4687    /**
4688     * Set the icon by icon standards names.
4689     *
4690     * @param obj The icon object
4691     * @param name The icon name
4692     *
4693     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4694     *
4695     * For example, freedesktop.org defines standard icon names such as "home",
4696     * "network", etc. There can be different icon sets to match those icon
4697     * keys. The @p name given as parameter is one of these "keys", and will be
4698     * used to look in the freedesktop.org paths and elementary theme. One can
4699     * change the lookup order with elm_icon_order_lookup_set().
4700     *
4701     * If name is not found in any of the expected locations and it is the
4702     * absolute path of an image file, this image will be used.
4703     *
4704     * @note The icon image set by this function can be changed by
4705     * elm_icon_file_set().
4706     *
4707     * @see elm_icon_standard_get()
4708     * @see elm_icon_file_set()
4709     *
4710     * @ingroup Icon
4711     */
4712    EAPI Eina_Bool             elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4713    /**
4714     * Get the icon name set by icon standard names.
4715     *
4716     * @param obj The icon object
4717     * @return The icon name
4718     *
4719     * If the icon image was set using elm_icon_file_set() instead of
4720     * elm_icon_standard_set(), then this function will return @c NULL.
4721     *
4722     * @see elm_icon_standard_set()
4723     *
4724     * @ingroup Icon
4725     */
4726    EAPI const char           *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4727    /**
4728     * Set the smooth effect for an icon object.
4729     *
4730     * @param obj The icon object
4731     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4732     * otherwise. Default is @c EINA_TRUE.
4733     *
4734     * Set the scaling algorithm to be used when scaling the icon image. Smooth
4735     * scaling provides a better resulting image, but is slower.
4736     *
4737     * The smooth scaling should be disabled when making animations that change
4738     * the icon size, since they will be faster. Animations that don't require
4739     * resizing of the icon can keep the smooth scaling enabled (even if the icon
4740     * is already scaled, since the scaled icon image will be cached).
4741     *
4742     * @see elm_icon_smooth_get()
4743     *
4744     * @ingroup Icon
4745     */
4746    EAPI void                  elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4747    /**
4748     * Get the smooth effect for an icon object.
4749     *
4750     * @param obj The icon object
4751     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4752     *
4753     * @see elm_icon_smooth_set()
4754     *
4755     * @ingroup Icon
4756     */
4757    EAPI Eina_Bool             elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4758    /**
4759     * Disable scaling of this object.
4760     *
4761     * @param obj The icon object.
4762     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4763     * otherwise. Default is @c EINA_FALSE.
4764     *
4765     * This function disables scaling of the icon object through the function
4766     * elm_object_scale_set(). However, this does not affect the object
4767     * size/resize in any way. For that effect, take a look at
4768     * elm_icon_scale_set().
4769     *
4770     * @see elm_icon_no_scale_get()
4771     * @see elm_icon_scale_set()
4772     * @see elm_object_scale_set()
4773     *
4774     * @ingroup Icon
4775     */
4776    EAPI void                  elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4777    /**
4778     * Get whether scaling is disabled on the object.
4779     *
4780     * @param obj The icon object
4781     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4782     *
4783     * @see elm_icon_no_scale_set()
4784     *
4785     * @ingroup Icon
4786     */
4787    EAPI Eina_Bool             elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4788    /**
4789     * Set if the object is (up/down) resizable.
4790     *
4791     * @param obj The icon object
4792     * @param scale_up A bool to set if the object is resizable up. Default is
4793     * @c EINA_TRUE.
4794     * @param scale_down A bool to set if the object is resizable down. Default
4795     * is @c EINA_TRUE.
4796     *
4797     * This function limits the icon object resize ability. If @p scale_up is set to
4798     * @c EINA_FALSE, the object can't have its height or width resized to a value
4799     * higher than the original icon size. Same is valid for @p scale_down.
4800     *
4801     * @see elm_icon_scale_get()
4802     *
4803     * @ingroup Icon
4804     */
4805    EAPI void                  elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4806    /**
4807     * Get if the object is (up/down) resizable.
4808     *
4809     * @param obj The icon object
4810     * @param scale_up A bool to set if the object is resizable up
4811     * @param scale_down A bool to set if the object is resizable down
4812     *
4813     * @see elm_icon_scale_set()
4814     *
4815     * @ingroup Icon
4816     */
4817    EAPI void                  elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4818    /**
4819     * Get the object's image size
4820     *
4821     * @param obj The icon object
4822     * @param w A pointer to store the width in
4823     * @param h A pointer to store the height in
4824     *
4825     * @ingroup Icon
4826     */
4827    EAPI void                  elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4828    /**
4829     * Set if the icon fill the entire object area.
4830     *
4831     * @param obj The icon object
4832     * @param fill_outside @c EINA_TRUE if the object is filled outside,
4833     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4834     *
4835     * When the icon object is resized to a different aspect ratio from the
4836     * original icon image, the icon image will still keep its aspect. This flag
4837     * tells how the image should fill the object's area. They are: keep the
4838     * entire icon inside the limits of height and width of the object (@p
4839     * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
4840     * of the object, and the icon will fill the entire object (@p fill_outside
4841     * is @c EINA_TRUE).
4842     *
4843     * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
4844     * retain property to false. Thus, the icon image will always keep its
4845     * original aspect ratio.
4846     *
4847     * @see elm_icon_fill_outside_get()
4848     * @see elm_image_fill_outside_set()
4849     *
4850     * @ingroup Icon
4851     */
4852    EAPI void                  elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
4853    /**
4854     * Get if the object is filled outside.
4855     *
4856     * @param obj The icon object
4857     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
4858     *
4859     * @see elm_icon_fill_outside_set()
4860     *
4861     * @ingroup Icon
4862     */
4863    EAPI Eina_Bool             elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4864    /**
4865     * Set the prescale size for the icon.
4866     *
4867     * @param obj The icon object
4868     * @param size The prescale size. This value is used for both width and
4869     * height.
4870     *
4871     * This function sets a new size for pixmap representation of the given
4872     * icon. It allows the icon to be loaded already in the specified size,
4873     * reducing the memory usage and load time when loading a big icon with load
4874     * size set to a smaller size.
4875     *
4876     * It's equivalent to the elm_bg_load_size_set() function for bg.
4877     *
4878     * @note this is just a hint, the real size of the pixmap may differ
4879     * depending on the type of icon being loaded, being bigger than requested.
4880     *
4881     * @see elm_icon_prescale_get()
4882     * @see elm_bg_load_size_set()
4883     *
4884     * @ingroup Icon
4885     */
4886    EAPI void                  elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
4887    /**
4888     * Get the prescale size for the icon.
4889     *
4890     * @param obj The icon object
4891     * @return The prescale size
4892     *
4893     * @see elm_icon_prescale_set()
4894     *
4895     * @ingroup Icon
4896     */
4897    EAPI int                   elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4898    /**
4899     * Sets the icon lookup order used by elm_icon_standard_set().
4900     *
4901     * @param obj The icon object
4902     * @param order The icon lookup order (can be one of
4903     * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
4904     * or ELM_ICON_LOOKUP_THEME)
4905     *
4906     * @see elm_icon_order_lookup_get()
4907     * @see Elm_Icon_Lookup_Order
4908     *
4909     * @ingroup Icon
4910     */
4911    EAPI void                  elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
4912    /**
4913     * Gets the icon lookup order.
4914     *
4915     * @param obj The icon object
4916     * @return The icon lookup order
4917     *
4918     * @see elm_icon_order_lookup_set()
4919     * @see Elm_Icon_Lookup_Order
4920     *
4921     * @ingroup Icon
4922     */
4923    EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4924    /**
4925     * Get if the icon supports animation or not.
4926     *
4927     * @param obj The icon object
4928     * @return @c EINA_TRUE if the icon supports animation,
4929     *         @c EINA_FALSE otherwise.
4930     *
4931     * Return if this elm icon's image can be animated. Currently Evas only
4932     * supports gif animation. If the return value is EINA_FALSE, other
4933     * elm_icon_animated_XXX APIs won't work.
4934     * @ingroup Icon
4935     */
4936    EAPI Eina_Bool           elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4937    /**
4938     * Set animation mode of the icon.
4939     *
4940     * @param obj The icon object
4941     * @param anim @c EINA_TRUE if the object do animation job,
4942     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4943     *
4944     * Even though elm icon's file can be animated,
4945     * sometimes appication developer want to just first page of image.
4946     * In that time, don't call this function, because default value is EINA_FALSE
4947     * Only when you want icon support anition,
4948     * use this function and set animated to EINA_TURE
4949     * @ingroup Icon
4950     */
4951    EAPI void                elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
4952    /**
4953     * Get animation mode of the icon.
4954     *
4955     * @param obj The icon object
4956     * @return The animation mode of the icon object
4957     * @see elm_icon_animated_set
4958     * @ingroup Icon
4959     */
4960    EAPI Eina_Bool           elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4961    /**
4962     * Set animation play mode of the icon.
4963     *
4964     * @param obj The icon object
4965     * @param play @c EINA_TRUE the object play animation images,
4966     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4967     *
4968     * If you want to play elm icon's animation, you set play to EINA_TURE.
4969     * For example, you make gif player using this set/get API and click event.
4970     *
4971     * 1. Click event occurs
4972     * 2. Check play flag using elm_icon_animaged_play_get
4973     * 3. If elm icon was playing, set play to EINA_FALSE.
4974     *    Then animation will be stopped and vice versa
4975     * @ingroup Icon
4976     */
4977    EAPI void                elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
4978    /**
4979     * Get animation play mode of the icon.
4980     *
4981     * @param obj The icon object
4982     * @return The play mode of the icon object
4983     *
4984     * @see elm_icon_animated_lay_get
4985     * @ingroup Icon
4986     */
4987    EAPI Eina_Bool           elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4988
4989    /**
4990     * @}
4991     */
4992
4993    /**
4994     * @defgroup Image Image
4995     *
4996     * @image html img/widget/image/preview-00.png
4997     * @image latex img/widget/image/preview-00.eps
4998
4999     *
5000     * An object that allows one to load an image file to it. It can be used
5001     * anywhere like any other elementary widget.
5002     *
5003     * This widget provides most of the functionality provided from @ref Bg or @ref
5004     * Icon, but with a slightly different API (use the one that fits better your
5005     * needs).
5006     *
5007     * The features not provided by those two other image widgets are:
5008     * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5009     * @li change the object orientation with elm_image_orient_set();
5010     * @li and turning the image editable with elm_image_editable_set().
5011     *
5012     * Signals that you can add callbacks for are:
5013     *
5014     * @li @c "clicked" - This is called when a user has clicked the image
5015     *
5016     * An example of usage for this API follows:
5017     * @li @ref tutorial_image
5018     */
5019
5020    /**
5021     * @addtogroup Image
5022     * @{
5023     */
5024
5025    /**
5026     * @enum _Elm_Image_Orient
5027     * @typedef Elm_Image_Orient
5028     *
5029     * Possible orientation options for elm_image_orient_set().
5030     *
5031     * @image html elm_image_orient_set.png
5032     * @image latex elm_image_orient_set.eps width=\textwidth
5033     *
5034     * @ingroup Image
5035     */
5036    typedef enum _Elm_Image_Orient
5037      {
5038         ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5039         ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5040         ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5041         ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5042         ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5043         ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5044         ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5045         ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5046      } Elm_Image_Orient;
5047
5048    /**
5049     * Add a new image to the parent.
5050     *
5051     * @param parent The parent object
5052     * @return The new object or NULL if it cannot be created
5053     *
5054     * @see elm_image_file_set()
5055     *
5056     * @ingroup Image
5057     */
5058    EAPI Evas_Object     *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5059    /**
5060     * Set the file that will be used as image.
5061     *
5062     * @param obj The image object
5063     * @param file The path to file that will be used as image
5064     * @param group The group that the image belongs in edje file (if it's an
5065     * edje image)
5066     *
5067     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5068     *
5069     * @see elm_image_file_get()
5070     *
5071     * @ingroup Image
5072     */
5073    EAPI Eina_Bool        elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5074    /**
5075     * Get the file that will be used as image.
5076     *
5077     * @param obj The image object
5078     * @param file The path to file
5079     * @param group The group that the image belongs in edje file
5080     *
5081     * @see elm_image_file_set()
5082     *
5083     * @ingroup Image
5084     */
5085    EAPI void             elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5086    /**
5087     * Set the smooth effect for an image.
5088     *
5089     * @param obj The image object
5090     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5091     * otherwise. Default is @c EINA_TRUE.
5092     *
5093     * Set the scaling algorithm to be used when scaling the image. Smooth
5094     * scaling provides a better resulting image, but is slower.
5095     *
5096     * The smooth scaling should be disabled when making animations that change
5097     * the image size, since it will be faster. Animations that don't require
5098     * resizing of the image can keep the smooth scaling enabled (even if the
5099     * image is already scaled, since the scaled image will be cached).
5100     *
5101     * @see elm_image_smooth_get()
5102     *
5103     * @ingroup Image
5104     */
5105    EAPI void             elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5106    /**
5107     * Get the smooth effect for an image.
5108     *
5109     * @param obj The image object
5110     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5111     *
5112     * @see elm_image_smooth_get()
5113     *
5114     * @ingroup Image
5115     */
5116    EAPI Eina_Bool        elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5117    /**
5118     * Gets the current size of the image.
5119     *
5120     * @param obj The image object.
5121     * @param w Pointer to store width, or NULL.
5122     * @param h Pointer to store height, or NULL.
5123     *
5124     * This is the real size of the image, not the size of the object.
5125     *
5126     * On error, neither w or h will be written.
5127     *
5128     * @ingroup Image
5129     */
5130    EAPI void             elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5131    /**
5132     * Disable scaling of this object.
5133     *
5134     * @param obj The image object.
5135     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5136     * otherwise. Default is @c EINA_FALSE.
5137     *
5138     * This function disables scaling of the elm_image widget through the
5139     * function elm_object_scale_set(). However, this does not affect the widget
5140     * size/resize in any way. For that effect, take a look at
5141     * elm_image_scale_set().
5142     *
5143     * @see elm_image_no_scale_get()
5144     * @see elm_image_scale_set()
5145     * @see elm_object_scale_set()
5146     *
5147     * @ingroup Image
5148     */
5149    EAPI void             elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5150    /**
5151     * Get whether scaling is disabled on the object.
5152     *
5153     * @param obj The image object
5154     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5155     *
5156     * @see elm_image_no_scale_set()
5157     *
5158     * @ingroup Image
5159     */
5160    EAPI Eina_Bool        elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5161    /**
5162     * Set if the object is (up/down) resizable.
5163     *
5164     * @param obj The image object
5165     * @param scale_up A bool to set if the object is resizable up. Default is
5166     * @c EINA_TRUE.
5167     * @param scale_down A bool to set if the object is resizable down. Default
5168     * is @c EINA_TRUE.
5169     *
5170     * This function limits the image resize ability. If @p scale_up is set to
5171     * @c EINA_FALSE, the object can't have its height or width resized to a value
5172     * higher than the original image size. Same is valid for @p scale_down.
5173     *
5174     * @see elm_image_scale_get()
5175     *
5176     * @ingroup Image
5177     */
5178    EAPI void             elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5179    /**
5180     * Get if the object is (up/down) resizable.
5181     *
5182     * @param obj The image object
5183     * @param scale_up A bool to set if the object is resizable up
5184     * @param scale_down A bool to set if the object is resizable down
5185     *
5186     * @see elm_image_scale_set()
5187     *
5188     * @ingroup Image
5189     */
5190    EAPI void             elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5191    /**
5192     * Set if the image fill the entire object area when keeping the aspect ratio.
5193     *
5194     * @param obj The image object
5195     * @param fill_outside @c EINA_TRUE if the object is filled outside,
5196     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5197     *
5198     * When the image should keep its aspect ratio even if resized to another
5199     * aspect ratio, there are two possibilities to resize it: keep the entire
5200     * image inside the limits of height and width of the object (@p fill_outside
5201     * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5202     * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5203     *
5204     * @note This option will have no effect if
5205     * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5206     *
5207     * @see elm_image_fill_outside_get()
5208     * @see elm_image_aspect_ratio_retained_set()
5209     *
5210     * @ingroup Image
5211     */
5212    EAPI void             elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5213    /**
5214     * Get if the object is filled outside
5215     *
5216     * @param obj The image object
5217     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5218     *
5219     * @see elm_image_fill_outside_set()
5220     *
5221     * @ingroup Image
5222     */
5223    EAPI Eina_Bool        elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5224    /**
5225     * Set the prescale size for the image
5226     *
5227     * @param obj The image object
5228     * @param size The prescale size. This value is used for both width and
5229     * height.
5230     *
5231     * This function sets a new size for pixmap representation of the given
5232     * image. It allows the image to be loaded already in the specified size,
5233     * reducing the memory usage and load time when loading a big image with load
5234     * size set to a smaller size.
5235     *
5236     * It's equivalent to the elm_bg_load_size_set() function for bg.
5237     *
5238     * @note this is just a hint, the real size of the pixmap may differ
5239     * depending on the type of image being loaded, being bigger than requested.
5240     *
5241     * @see elm_image_prescale_get()
5242     * @see elm_bg_load_size_set()
5243     *
5244     * @ingroup Image
5245     */
5246    EAPI void             elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5247    /**
5248     * Get the prescale size for the image
5249     *
5250     * @param obj The image object
5251     * @return The prescale size
5252     *
5253     * @see elm_image_prescale_set()
5254     *
5255     * @ingroup Image
5256     */
5257    EAPI int              elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5258    /**
5259     * Set the image orientation.
5260     *
5261     * @param obj The image object
5262     * @param orient The image orientation
5263     * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5264     *  #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5265     *  #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5266     *  #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
5267     *  Default is #ELM_IMAGE_ORIENT_NONE.
5268     *
5269     * This function allows to rotate or flip the given image.
5270     *
5271     * @see elm_image_orient_get()
5272     * @see @ref Elm_Image_Orient
5273     *
5274     * @ingroup Image
5275     */
5276    EAPI void             elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5277    /**
5278     * Get the image orientation.
5279     *
5280     * @param obj The image object
5281     * @return The image orientation
5282     * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5283     *  #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5284     *  #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5285     *  #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
5286     *
5287     * @see elm_image_orient_set()
5288     * @see @ref Elm_Image_Orient
5289     *
5290     * @ingroup Image
5291     */
5292    EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5293    /**
5294     * Make the image 'editable'.
5295     *
5296     * @param obj Image object.
5297     * @param set Turn on or off editability. Default is @c EINA_FALSE.
5298     *
5299     * This means the image is a valid drag target for drag and drop, and can be
5300     * cut or pasted too.
5301     *
5302     * @ingroup Image
5303     */
5304    EAPI void             elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5305    /**
5306     * Make the image 'editable'.
5307     *
5308     * @param obj Image object.
5309     * @return Editability.
5310     *
5311     * This means the image is a valid drag target for drag and drop, and can be
5312     * cut or pasted too.
5313     *
5314     * @ingroup Image
5315     */
5316    EAPI Eina_Bool        elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5317    /**
5318     * Get the basic Evas_Image object from this object (widget).
5319     *
5320     * @param obj The image object to get the inlined image from
5321     * @return The inlined image object, or NULL if none exists
5322     *
5323     * This function allows one to get the underlying @c Evas_Object of type
5324     * Image from this elementary widget. It can be useful to do things like get
5325     * the pixel data, save the image to a file, etc.
5326     *
5327     * @note Be careful to not manipulate it, as it is under control of
5328     * elementary.
5329     *
5330     * @ingroup Image
5331     */
5332    EAPI Evas_Object     *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5333    /**
5334     * Set whether the original aspect ratio of the image should be kept on resize.
5335     *
5336     * @param obj The image object.
5337     * @param retained @c EINA_TRUE if the image should retain the aspect,
5338     * @c EINA_FALSE otherwise.
5339     *
5340     * The original aspect ratio (width / height) of the image is usually
5341     * distorted to match the object's size. Enabling this option will retain
5342     * this original aspect, and the way that the image is fit into the object's
5343     * area depends on the option set by elm_image_fill_outside_set().
5344     *
5345     * @see elm_image_aspect_ratio_retained_get()
5346     * @see elm_image_fill_outside_set()
5347     *
5348     * @ingroup Image
5349     */
5350    EAPI void             elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5351    /**
5352     * Get if the object retains the original aspect ratio.
5353     *
5354     * @param obj The image object.
5355     * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5356     * otherwise.
5357     *
5358     * @ingroup Image
5359     */
5360    EAPI Eina_Bool        elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5361
5362    /**
5363     * @}
5364     */
5365
5366    /* glview */
5367    typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5368
5369    typedef enum _Elm_GLView_Mode
5370      {
5371         ELM_GLVIEW_ALPHA   = 1,
5372         ELM_GLVIEW_DEPTH   = 2,
5373         ELM_GLVIEW_STENCIL = 4
5374      } Elm_GLView_Mode;
5375
5376    /**
5377     * Defines a policy for the glview resizing.
5378     *
5379     * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5380     */
5381    typedef enum _Elm_GLView_Resize_Policy
5382      {
5383         ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1,      /**< Resize the internal surface along with the image */
5384         ELM_GLVIEW_RESIZE_POLICY_SCALE    = 2       /**< Only reize the internal image and not the surface */
5385      } Elm_GLView_Resize_Policy;
5386
5387    typedef enum _Elm_GLView_Render_Policy
5388      {
5389         ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1,     /**< Render only when there is a need for redrawing */
5390         ELM_GLVIEW_RENDER_POLICY_ALWAYS    = 2      /**< Render always even when it is not visible */
5391      } Elm_GLView_Render_Policy;
5392
5393    /**
5394     * @defgroup GLView
5395     *
5396     * A simple GLView widget that allows GL rendering.
5397     *
5398     * Signals that you can add callbacks for are:
5399     *
5400     * @{
5401     */
5402
5403    /**
5404     * Add a new glview to the parent
5405     *
5406     * @param parent The parent object
5407     * @return The new object or NULL if it cannot be created
5408     *
5409     * @ingroup GLView
5410     */
5411    EAPI Evas_Object     *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5412
5413    /**
5414     * Sets the size of the glview
5415     *
5416     * @param obj The glview object
5417     * @param width width of the glview object
5418     * @param height height of the glview object
5419     *
5420     * @ingroup GLView
5421     */
5422    EAPI void             elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5423
5424    /**
5425     * Gets the size of the glview.
5426     *
5427     * @param obj The glview object
5428     * @param width width of the glview object
5429     * @param height height of the glview object
5430     *
5431     * Note that this function returns the actual image size of the
5432     * glview.  This means that when the scale policy is set to
5433     * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5434     * size.
5435     *
5436     * @ingroup GLView
5437     */
5438    EAPI void             elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5439
5440    /**
5441     * Gets the gl api struct for gl rendering
5442     *
5443     * @param obj The glview object
5444     * @return The api object or NULL if it cannot be created
5445     *
5446     * @ingroup GLView
5447     */
5448    EAPI Evas_GL_API     *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5449
5450    /**
5451     * Set the mode of the GLView. Supports Three simple modes.
5452     *
5453     * @param obj The glview object
5454     * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5455     * @return True if set properly.
5456     *
5457     * @ingroup GLView
5458     */
5459    EAPI Eina_Bool        elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5460
5461    /**
5462     * Set the resize policy for the glview object.
5463     *
5464     * @param obj The glview object.
5465     * @param policy The scaling policy.
5466     *
5467     * By default, the resize policy is set to
5468     * ELM_GLVIEW_RESIZE_POLICY_RECREATE.  When resize is called it
5469     * destroys the previous surface and recreates the newly specified
5470     * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5471     * however, glview only scales the image object and not the underlying
5472     * GL Surface.
5473     *
5474     * @ingroup GLView
5475     */
5476    EAPI Eina_Bool        elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5477
5478    /**
5479     * Set the render policy for the glview object.
5480     *
5481     * @param obj The glview object.
5482     * @param policy The render policy.
5483     *
5484     * By default, the render policy is set to
5485     * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND.  This policy is set such
5486     * that during the render loop, glview is only redrawn if it needs
5487     * to be redrawn. (i.e. When it is visible) If the policy is set to
5488     * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5489     * whether it is visible/need redrawing or not.
5490     *
5491     * @ingroup GLView
5492     */
5493    EAPI Eina_Bool        elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5494
5495    /**
5496     * Set the init function that runs once in the main loop.
5497     *
5498     * @param obj The glview object.
5499     * @param func The init function to be registered.
5500     *
5501     * The registered init function gets called once during the render loop.
5502     *
5503     * @ingroup GLView
5504     */
5505    EAPI void             elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5506
5507    /**
5508     * Set the render function that runs in the main loop.
5509     *
5510     * @param obj The glview object.
5511     * @param func The delete function to be registered.
5512     *
5513     * The registered del function gets called when GLView object is deleted.
5514     *
5515     * @ingroup GLView
5516     */
5517    EAPI void             elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5518
5519    /**
5520     * Set the resize function that gets called when resize happens.
5521     *
5522     * @param obj The glview object.
5523     * @param func The resize function to be registered.
5524     *
5525     * @ingroup GLView
5526     */
5527    EAPI void             elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5528
5529    /**
5530     * Set the render function that runs in the main loop.
5531     *
5532     * @param obj The glview object.
5533     * @param func The render function to be registered.
5534     *
5535     * @ingroup GLView
5536     */
5537    EAPI void             elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5538
5539    /**
5540     * Notifies that there has been changes in the GLView.
5541     *
5542     * @param obj The glview object.
5543     *
5544     * @ingroup GLView
5545     */
5546    EAPI void             elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5547
5548    /**
5549     * @}
5550     */
5551
5552    /* box */
5553    /**
5554     * @defgroup Box Box
5555     *
5556     * @image html img/widget/box/preview-00.png
5557     * @image latex img/widget/box/preview-00.eps width=\textwidth
5558     *
5559     * @image html img/box.png
5560     * @image latex img/box.eps width=\textwidth
5561     *
5562     * A box arranges objects in a linear fashion, governed by a layout function
5563     * that defines the details of this arrangement.
5564     *
5565     * By default, the box will use an internal function to set the layout to
5566     * a single row, either vertical or horizontal. This layout is affected
5567     * by a number of parameters, such as the homogeneous flag set by
5568     * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5569     * elm_box_align_set() and the hints set to each object in the box.
5570     *
5571     * For this default layout, it's possible to change the orientation with
5572     * elm_box_horizontal_set(). The box will start in the vertical orientation,
5573     * placing its elements ordered from top to bottom. When horizontal is set,
5574     * the order will go from left to right. If the box is set to be
5575     * homogeneous, every object in it will be assigned the same space, that
5576     * of the largest object. Padding can be used to set some spacing between
5577     * the cell given to each object. The alignment of the box, set with
5578     * elm_box_align_set(), determines how the bounding box of all the elements
5579     * will be placed within the space given to the box widget itself.
5580     *
5581     * The size hints of each object also affect how they are placed and sized
5582     * within the box. evas_object_size_hint_min_set() will give the minimum
5583     * size the object can have, and the box will use it as the basis for all
5584     * latter calculations. Elementary widgets set their own minimum size as
5585     * needed, so there's rarely any need to use it manually.
5586     *
5587     * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5588     * used to tell whether the object will be allocated the minimum size it
5589     * needs or if the space given to it should be expanded. It's important
5590     * to realize that expanding the size given to the object is not the same
5591     * thing as resizing the object. It could very well end being a small
5592     * widget floating in a much larger empty space. If not set, the weight
5593     * for objects will normally be 0.0 for both axis, meaning the widget will
5594     * not be expanded. To take as much space possible, set the weight to
5595     * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5596     *
5597     * Besides how much space each object is allocated, it's possible to control
5598     * how the widget will be placed within that space using
5599     * evas_object_size_hint_align_set(). By default, this value will be 0.5
5600     * for both axis, meaning the object will be centered, but any value from
5601     * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5602     * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5603     * is -1.0, means the object will be resized to fill the entire space it
5604     * was allocated.
5605     *
5606     * In addition, customized functions to define the layout can be set, which
5607     * allow the application developer to organize the objects within the box
5608     * in any number of ways.
5609     *
5610     * The special elm_box_layout_transition() function can be used
5611     * to switch from one layout to another, animating the motion of the
5612     * children of the box.
5613     *
5614     * @note Objects should not be added to box objects using _add() calls.
5615     *
5616     * Some examples on how to use boxes follow:
5617     * @li @ref box_example_01
5618     * @li @ref box_example_02
5619     *
5620     * @{
5621     */
5622    /**
5623     * @typedef Elm_Box_Transition
5624     *
5625     * Opaque handler containing the parameters to perform an animated
5626     * transition of the layout the box uses.
5627     *
5628     * @see elm_box_transition_new()
5629     * @see elm_box_layout_set()
5630     * @see elm_box_layout_transition()
5631     */
5632    typedef struct _Elm_Box_Transition Elm_Box_Transition;
5633
5634    /**
5635     * Add a new box to the parent
5636     *
5637     * By default, the box will be in vertical mode and non-homogeneous.
5638     *
5639     * @param parent The parent object
5640     * @return The new object or NULL if it cannot be created
5641     */
5642    EAPI Evas_Object        *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5643    /**
5644     * Set the horizontal orientation
5645     *
5646     * By default, box object arranges their contents vertically from top to
5647     * bottom.
5648     * By calling this function with @p horizontal as EINA_TRUE, the box will
5649     * become horizontal, arranging contents from left to right.
5650     *
5651     * @note This flag is ignored if a custom layout function is set.
5652     *
5653     * @param obj The box object
5654     * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5655     * EINA_FALSE = vertical)
5656     */
5657    EAPI void                elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5658    /**
5659     * Get the horizontal orientation
5660     *
5661     * @param obj The box object
5662     * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5663     */
5664    EAPI Eina_Bool           elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5665    /**
5666     * Set the box to arrange its children homogeneously
5667     *
5668     * If enabled, homogeneous layout makes all items the same size, according
5669     * to the size of the largest of its children.
5670     *
5671     * @note This flag is ignored if a custom layout function is set.
5672     *
5673     * @param obj The box object
5674     * @param homogeneous The homogeneous flag
5675     */
5676    EAPI void                elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5677    /**
5678     * Get whether the box is using homogeneous mode or not
5679     *
5680     * @param obj The box object
5681     * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5682     */
5683    EAPI Eina_Bool           elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5684    EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5685    EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5686    /**
5687     * Add an object to the beginning of the pack list
5688     *
5689     * Pack @p subobj into the box @p obj, placing it first in the list of
5690     * children objects. The actual position the object will get on screen
5691     * depends on the layout used. If no custom layout is set, it will be at
5692     * the top or left, depending if the box is vertical or horizontal,
5693     * respectively.
5694     *
5695     * @param obj The box object
5696     * @param subobj The object to add to the box
5697     *
5698     * @see elm_box_pack_end()
5699     * @see elm_box_pack_before()
5700     * @see elm_box_pack_after()
5701     * @see elm_box_unpack()
5702     * @see elm_box_unpack_all()
5703     * @see elm_box_clear()
5704     */
5705    EAPI void                elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5706    /**
5707     * Add an object at the end of the pack list
5708     *
5709     * Pack @p subobj into the box @p obj, placing it last in the list of
5710     * children objects. The actual position the object will get on screen
5711     * depends on the layout used. If no custom layout is set, it will be at
5712     * the bottom or right, depending if the box is vertical or horizontal,
5713     * respectively.
5714     *
5715     * @param obj The box object
5716     * @param subobj The object to add to the box
5717     *
5718     * @see elm_box_pack_start()
5719     * @see elm_box_pack_before()
5720     * @see elm_box_pack_after()
5721     * @see elm_box_unpack()
5722     * @see elm_box_unpack_all()
5723     * @see elm_box_clear()
5724     */
5725    EAPI void                elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5726    /**
5727     * Adds an object to the box before the indicated object
5728     *
5729     * This will add the @p subobj to the box indicated before the object
5730     * indicated with @p before. If @p before is not already in the box, results
5731     * are undefined. Before means either to the left of the indicated object or
5732     * above it depending on orientation.
5733     *
5734     * @param obj The box object
5735     * @param subobj The object to add to the box
5736     * @param before The object before which to add it
5737     *
5738     * @see elm_box_pack_start()
5739     * @see elm_box_pack_end()
5740     * @see elm_box_pack_after()
5741     * @see elm_box_unpack()
5742     * @see elm_box_unpack_all()
5743     * @see elm_box_clear()
5744     */
5745    EAPI void                elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5746    /**
5747     * Adds an object to the box after the indicated object
5748     *
5749     * This will add the @p subobj to the box indicated after the object
5750     * indicated with @p after. If @p after is not already in the box, results
5751     * are undefined. After means either to the right of the indicated object or
5752     * below it depending on orientation.
5753     *
5754     * @param obj The box object
5755     * @param subobj The object to add to the box
5756     * @param after The object after which to add it
5757     *
5758     * @see elm_box_pack_start()
5759     * @see elm_box_pack_end()
5760     * @see elm_box_pack_before()
5761     * @see elm_box_unpack()
5762     * @see elm_box_unpack_all()
5763     * @see elm_box_clear()
5764     */
5765    EAPI void                elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5766    /**
5767     * Clear the box of all children
5768     *
5769     * Remove all the elements contained by the box, deleting the respective
5770     * objects.
5771     *
5772     * @param obj The box object
5773     *
5774     * @see elm_box_unpack()
5775     * @see elm_box_unpack_all()
5776     */
5777    EAPI void                elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5778    /**
5779     * Unpack a box item
5780     *
5781     * Remove the object given by @p subobj from the box @p obj without
5782     * deleting it.
5783     *
5784     * @param obj The box object
5785     *
5786     * @see elm_box_unpack_all()
5787     * @see elm_box_clear()
5788     */
5789    EAPI void                elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5790    /**
5791     * Remove all items from the box, without deleting them
5792     *
5793     * Clear the box from all children, but don't delete the respective objects.
5794     * If no other references of the box children exist, the objects will never
5795     * be deleted, and thus the application will leak the memory. Make sure
5796     * when using this function that you hold a reference to all the objects
5797     * in the box @p obj.
5798     *
5799     * @param obj The box object
5800     *
5801     * @see elm_box_clear()
5802     * @see elm_box_unpack()
5803     */
5804    EAPI void                elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5805    /**
5806     * Retrieve a list of the objects packed into the box
5807     *
5808     * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5809     * The order of the list corresponds to the packing order the box uses.
5810     *
5811     * You must free this list with eina_list_free() once you are done with it.
5812     *
5813     * @param obj The box object
5814     */
5815    EAPI const Eina_List    *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5816    /**
5817     * Set the space (padding) between the box's elements.
5818     *
5819     * Extra space in pixels that will be added between a box child and its
5820     * neighbors after its containing cell has been calculated. This padding
5821     * is set for all elements in the box, besides any possible padding that
5822     * individual elements may have through their size hints.
5823     *
5824     * @param obj The box object
5825     * @param horizontal The horizontal space between elements
5826     * @param vertical The vertical space between elements
5827     */
5828    EAPI void                elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5829    /**
5830     * Get the space (padding) between the box's elements.
5831     *
5832     * @param obj The box object
5833     * @param horizontal The horizontal space between elements
5834     * @param vertical The vertical space between elements
5835     *
5836     * @see elm_box_padding_set()
5837     */
5838    EAPI void                elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5839    /**
5840     * Set the alignment of the whole bouding box of contents.
5841     *
5842     * Sets how the bounding box containing all the elements of the box, after
5843     * their sizes and position has been calculated, will be aligned within
5844     * the space given for the whole box widget.
5845     *
5846     * @param obj The box object
5847     * @param horizontal The horizontal alignment of elements
5848     * @param vertical The vertical alignment of elements
5849     */
5850    EAPI void                elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
5851    /**
5852     * Get the alignment of the whole bouding box of contents.
5853     *
5854     * @param obj The box object
5855     * @param horizontal The horizontal alignment of elements
5856     * @param vertical The vertical alignment of elements
5857     *
5858     * @see elm_box_align_set()
5859     */
5860    EAPI void                elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
5861
5862    /**
5863     * Force the box to recalculate its children packing.
5864     *
5865     * If any children was added or removed, box will not calculate the
5866     * values immediately rather leaving it to the next main loop
5867     * iteration. While this is great as it would save lots of
5868     * recalculation, whenever you need to get the position of a just
5869     * added item you must force recalculate before doing so.
5870     *
5871     * @param obj The box object.
5872     */
5873    EAPI void                 elm_box_recalculate(Evas_Object *obj);
5874
5875    /**
5876     * Set the layout defining function to be used by the box
5877     *
5878     * Whenever anything changes that requires the box in @p obj to recalculate
5879     * the size and position of its elements, the function @p cb will be called
5880     * to determine what the layout of the children will be.
5881     *
5882     * Once a custom function is set, everything about the children layout
5883     * is defined by it. The flags set by elm_box_horizontal_set() and
5884     * elm_box_homogeneous_set() no longer have any meaning, and the values
5885     * given by elm_box_padding_set() and elm_box_align_set() are up to this
5886     * layout function to decide if they are used and how. These last two
5887     * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
5888     * passed to @p cb. The @c Evas_Object the function receives is not the
5889     * Elementary widget, but the internal Evas Box it uses, so none of the
5890     * functions described here can be used on it.
5891     *
5892     * Any of the layout functions in @c Evas can be used here, as well as the
5893     * special elm_box_layout_transition().
5894     *
5895     * The final @p data argument received by @p cb is the same @p data passed
5896     * here, and the @p free_data function will be called to free it
5897     * whenever the box is destroyed or another layout function is set.
5898     *
5899     * Setting @p cb to NULL will revert back to the default layout function.
5900     *
5901     * @param obj The box object
5902     * @param cb The callback function used for layout
5903     * @param data Data that will be passed to layout function
5904     * @param free_data Function called to free @p data
5905     *
5906     * @see elm_box_layout_transition()
5907     */
5908    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);
5909    /**
5910     * Special layout function that animates the transition from one layout to another
5911     *
5912     * Normally, when switching the layout function for a box, this will be
5913     * reflected immediately on screen on the next render, but it's also
5914     * possible to do this through an animated transition.
5915     *
5916     * This is done by creating an ::Elm_Box_Transition and setting the box
5917     * layout to this function.
5918     *
5919     * For example:
5920     * @code
5921     * Elm_Box_Transition *t = elm_box_transition_new(1.0,
5922     *                            evas_object_box_layout_vertical, // start
5923     *                            NULL, // data for initial layout
5924     *                            NULL, // free function for initial data
5925     *                            evas_object_box_layout_horizontal, // end
5926     *                            NULL, // data for final layout
5927     *                            NULL, // free function for final data
5928     *                            anim_end, // will be called when animation ends
5929     *                            NULL); // data for anim_end function\
5930     * elm_box_layout_set(box, elm_box_layout_transition, t,
5931     *                    elm_box_transition_free);
5932     * @endcode
5933     *
5934     * @note This function can only be used with elm_box_layout_set(). Calling
5935     * it directly will not have the expected results.
5936     *
5937     * @see elm_box_transition_new
5938     * @see elm_box_transition_free
5939     * @see elm_box_layout_set
5940     */
5941    EAPI void                elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
5942    /**
5943     * Create a new ::Elm_Box_Transition to animate the switch of layouts
5944     *
5945     * If you want to animate the change from one layout to another, you need
5946     * to set the layout function of the box to elm_box_layout_transition(),
5947     * passing as user data to it an instance of ::Elm_Box_Transition with the
5948     * necessary information to perform this animation. The free function to
5949     * set for the layout is elm_box_transition_free().
5950     *
5951     * The parameters to create an ::Elm_Box_Transition sum up to how long
5952     * will it be, in seconds, a layout function to describe the initial point,
5953     * another for the final position of the children and one function to be
5954     * called when the whole animation ends. This last function is useful to
5955     * set the definitive layout for the box, usually the same as the end
5956     * layout for the animation, but could be used to start another transition.
5957     *
5958     * @param start_layout The layout function that will be used to start the animation
5959     * @param start_layout_data The data to be passed the @p start_layout function
5960     * @param start_layout_free_data Function to free @p start_layout_data
5961     * @param end_layout The layout function that will be used to end the animation
5962     * @param end_layout_free_data The data to be passed the @p end_layout function
5963     * @param end_layout_free_data Function to free @p end_layout_data
5964     * @param transition_end_cb Callback function called when animation ends
5965     * @param transition_end_data Data to be passed to @p transition_end_cb
5966     * @return An instance of ::Elm_Box_Transition
5967     *
5968     * @see elm_box_transition_new
5969     * @see elm_box_layout_transition
5970     */
5971    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);
5972    /**
5973     * Free a Elm_Box_Transition instance created with elm_box_transition_new().
5974     *
5975     * This function is mostly useful as the @c free_data parameter in
5976     * elm_box_layout_set() when elm_box_layout_transition().
5977     *
5978     * @param data The Elm_Box_Transition instance to be freed.
5979     *
5980     * @see elm_box_transition_new
5981     * @see elm_box_layout_transition
5982     */
5983    EAPI void                elm_box_transition_free(void *data);
5984    /**
5985     * @}
5986     */
5987
5988    /* button */
5989    /**
5990     * @defgroup Button Button
5991     *
5992     * @image html img/widget/button/preview-00.png
5993     * @image latex img/widget/button/preview-00.eps
5994     * @image html img/widget/button/preview-01.png
5995     * @image latex img/widget/button/preview-01.eps
5996     * @image html img/widget/button/preview-02.png
5997     * @image latex img/widget/button/preview-02.eps
5998     *
5999     * This is a push-button. Press it and run some function. It can contain
6000     * a simple label and icon object and it also has an autorepeat feature.
6001     *
6002     * This widgets emits the following signals:
6003     * @li "clicked": the user clicked the button (press/release).
6004     * @li "repeated": the user pressed the button without releasing it.
6005     * @li "pressed": button was pressed.
6006     * @li "unpressed": button was released after being pressed.
6007     * In all three cases, the @c event parameter of the callback will be
6008     * @c NULL.
6009     *
6010     * Also, defined in the default theme, the button has the following styles
6011     * available:
6012     * @li default: a normal button.
6013     * @li anchor: Like default, but the button fades away when the mouse is not
6014     * over it, leaving only the text or icon.
6015     * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6016     * continuous look across its options.
6017     * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6018     *
6019     * Follow through a complete example @ref button_example_01 "here".
6020     * @{
6021     */
6022    /**
6023     * Add a new button to the parent's canvas
6024     *
6025     * @param parent The parent object
6026     * @return The new object or NULL if it cannot be created
6027     */
6028    EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6029    /**
6030     * Set the label used in the button
6031     *
6032     * The passed @p label can be NULL to clean any existing text in it and
6033     * leave the button as an icon only object.
6034     *
6035     * @param obj The button object
6036     * @param label The text will be written on the button
6037     * @deprecated use elm_object_text_set() instead.
6038     */
6039    EINA_DEPRECATED EAPI void         elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6040    /**
6041     * Get the label set for the button
6042     *
6043     * The string returned is an internal pointer and should not be freed or
6044     * altered. It will also become invalid when the button is destroyed.
6045     * The string returned, if not NULL, is a stringshare, so if you need to
6046     * keep it around even after the button is destroyed, you can use
6047     * eina_stringshare_ref().
6048     *
6049     * @param obj The button object
6050     * @return The text set to the label, or NULL if nothing is set
6051     * @deprecated use elm_object_text_set() instead.
6052     */
6053    EINA_DEPRECATED EAPI const char  *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6054    /**
6055     * Set the icon used for the button
6056     *
6057     * Setting a new icon will delete any other that was previously set, making
6058     * any reference to them invalid. If you need to maintain the previous
6059     * object alive, unset it first with elm_button_icon_unset().
6060     *
6061     * @param obj The button object
6062     * @param icon The icon object for the button
6063     */
6064    EAPI void         elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6065    /**
6066     * Get the icon used for the button
6067     *
6068     * Return the icon object which is set for this widget. If the button is
6069     * destroyed or another icon is set, the returned object will be deleted
6070     * and any reference to it will be invalid.
6071     *
6072     * @param obj The button object
6073     * @return The icon object that is being used
6074     *
6075     * @see elm_button_icon_unset()
6076     */
6077    EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6078    /**
6079     * Remove the icon set without deleting it and return the object
6080     *
6081     * This function drops the reference the button holds of the icon object
6082     * and returns this last object. It is used in case you want to remove any
6083     * icon, or set another one, without deleting the actual object. The button
6084     * will be left without an icon set.
6085     *
6086     * @param obj The button object
6087     * @return The icon object that was being used
6088     */
6089    EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6090    /**
6091     * Turn on/off the autorepeat event generated when the button is kept pressed
6092     *
6093     * When off, no autorepeat is performed and buttons emit a normal @c clicked
6094     * signal when they are clicked.
6095     *
6096     * When on, keeping a button pressed will continuously emit a @c repeated
6097     * signal until the button is released. The time it takes until it starts
6098     * emitting the signal is given by
6099     * elm_button_autorepeat_initial_timeout_set(), and the time between each
6100     * new emission by elm_button_autorepeat_gap_timeout_set().
6101     *
6102     * @param obj The button object
6103     * @param on  A bool to turn on/off the event
6104     */
6105    EAPI void         elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6106    /**
6107     * Get whether the autorepeat feature is enabled
6108     *
6109     * @param obj The button object
6110     * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6111     *
6112     * @see elm_button_autorepeat_set()
6113     */
6114    EAPI Eina_Bool    elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6115    /**
6116     * Set the initial timeout before the autorepeat event is generated
6117     *
6118     * Sets the timeout, in seconds, since the button is pressed until the
6119     * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6120     * won't be any delay and the even will be fired the moment the button is
6121     * pressed.
6122     *
6123     * @param obj The button object
6124     * @param t   Timeout in seconds
6125     *
6126     * @see elm_button_autorepeat_set()
6127     * @see elm_button_autorepeat_gap_timeout_set()
6128     */
6129    EAPI void         elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6130    /**
6131     * Get the initial timeout before the autorepeat event is generated
6132     *
6133     * @param obj The button object
6134     * @return Timeout in seconds
6135     *
6136     * @see elm_button_autorepeat_initial_timeout_set()
6137     */
6138    EAPI double       elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6139    /**
6140     * Set the interval between each generated autorepeat event
6141     *
6142     * After the first @c repeated event is fired, all subsequent ones will
6143     * follow after a delay of @p t seconds for each.
6144     *
6145     * @param obj The button object
6146     * @param t   Interval in seconds
6147     *
6148     * @see elm_button_autorepeat_initial_timeout_set()
6149     */
6150    EAPI void         elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6151    /**
6152     * Get the interval between each generated autorepeat event
6153     *
6154     * @param obj The button object
6155     * @return Interval in seconds
6156     */
6157    EAPI double       elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6158    /**
6159     * @}
6160     */
6161
6162    /**
6163     * @defgroup File_Selector_Button File Selector Button
6164     *
6165     * @image html img/widget/fileselector_button/preview-00.png
6166     * @image latex img/widget/fileselector_button/preview-00.eps
6167     * @image html img/widget/fileselector_button/preview-01.png
6168     * @image latex img/widget/fileselector_button/preview-01.eps
6169     * @image html img/widget/fileselector_button/preview-02.png
6170     * @image latex img/widget/fileselector_button/preview-02.eps
6171     *
6172     * This is a button that, when clicked, creates an Elementary
6173     * window (or inner window) <b> with a @ref Fileselector "file
6174     * selector widget" within</b>. When a file is chosen, the (inner)
6175     * window is closed and the button emits a signal having the
6176     * selected file as it's @c event_info.
6177     *
6178     * This widget encapsulates operations on its internal file
6179     * selector on its own API. There is less control over its file
6180     * selector than that one would have instatiating one directly.
6181     *
6182     * The following styles are available for this button:
6183     * @li @c "default"
6184     * @li @c "anchor"
6185     * @li @c "hoversel_vertical"
6186     * @li @c "hoversel_vertical_entry"
6187     *
6188     * Smart callbacks one can register to:
6189     * - @c "file,chosen" - the user has selected a path, whose string
6190     *   pointer comes as the @c event_info data (a stringshared
6191     *   string)
6192     *
6193     * Here is an example on its usage:
6194     * @li @ref fileselector_button_example
6195     *
6196     * @see @ref File_Selector_Entry for a similar widget.
6197     * @{
6198     */
6199
6200    /**
6201     * Add a new file selector button widget to the given parent
6202     * Elementary (container) object
6203     *
6204     * @param parent The parent object
6205     * @return a new file selector button widget handle or @c NULL, on
6206     * errors
6207     */
6208    EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6209
6210    /**
6211     * Set the label for a given file selector button widget
6212     *
6213     * @param obj The file selector button widget
6214     * @param label The text label to be displayed on @p obj
6215     *
6216     * @deprecated use elm_object_text_set() instead.
6217     */
6218    EINA_DEPRECATED EAPI void         elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6219
6220    /**
6221     * Get the label set for a given file selector button widget
6222     *
6223     * @param obj The file selector button widget
6224     * @return The button label
6225     *
6226     * @deprecated use elm_object_text_set() instead.
6227     */
6228    EINA_DEPRECATED EAPI const char  *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6229
6230    /**
6231     * Set the icon on a given file selector button widget
6232     *
6233     * @param obj The file selector button widget
6234     * @param icon The icon object for the button
6235     *
6236     * Once the icon object is set, a previously set one will be
6237     * deleted. If you want to keep the latter, use the
6238     * elm_fileselector_button_icon_unset() function.
6239     *
6240     * @see elm_fileselector_button_icon_get()
6241     */
6242    EAPI void         elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6243
6244    /**
6245     * Get the icon set for a given file selector button widget
6246     *
6247     * @param obj The file selector button widget
6248     * @return The icon object currently set on @p obj or @c NULL, if
6249     * none is
6250     *
6251     * @see elm_fileselector_button_icon_set()
6252     */
6253    EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6254
6255    /**
6256     * Unset the icon used in a given file selector button widget
6257     *
6258     * @param obj The file selector button widget
6259     * @return The icon object that was being used on @p obj or @c
6260     * NULL, on errors
6261     *
6262     * Unparent and return the icon object which was set for this
6263     * widget.
6264     *
6265     * @see elm_fileselector_button_icon_set()
6266     */
6267    EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6268
6269    /**
6270     * Set the title for a given file selector button widget's window
6271     *
6272     * @param obj The file selector button widget
6273     * @param title The title string
6274     *
6275     * This will change the window's title, when the file selector pops
6276     * out after a click on the button. Those windows have the default
6277     * (unlocalized) value of @c "Select a file" as titles.
6278     *
6279     * @note It will only take any effect if the file selector
6280     * button widget is @b not under "inwin mode".
6281     *
6282     * @see elm_fileselector_button_window_title_get()
6283     */
6284    EAPI void         elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6285
6286    /**
6287     * Get the title set for a given file selector button widget's
6288     * window
6289     *
6290     * @param obj The file selector button widget
6291     * @return Title of the file selector button's window
6292     *
6293     * @see elm_fileselector_button_window_title_get() for more details
6294     */
6295    EAPI const char  *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6296
6297    /**
6298     * Set the size of a given file selector button widget's window,
6299     * holding the file selector itself.
6300     *
6301     * @param obj The file selector button widget
6302     * @param width The window's width
6303     * @param height The window's height
6304     *
6305     * @note it will only take any effect if the file selector button
6306     * widget is @b not under "inwin mode". The default size for the
6307     * window (when applicable) is 400x400 pixels.
6308     *
6309     * @see elm_fileselector_button_window_size_get()
6310     */
6311    EAPI void         elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6312
6313    /**
6314     * Get the size of a given file selector button widget's window,
6315     * holding the file selector itself.
6316     *
6317     * @param obj The file selector button widget
6318     * @param width Pointer into which to store the width value
6319     * @param height Pointer into which to store the height value
6320     *
6321     * @note Use @c NULL pointers on the size values you're not
6322     * interested in: they'll be ignored by the function.
6323     *
6324     * @see elm_fileselector_button_window_size_set(), for more details
6325     */
6326    EAPI void         elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6327
6328    /**
6329     * Set the initial file system path for a given file selector
6330     * button widget
6331     *
6332     * @param obj The file selector button widget
6333     * @param path The path string
6334     *
6335     * It must be a <b>directory</b> path, which will have the contents
6336     * displayed initially in the file selector's view, when invoked
6337     * from @p obj. The default initial path is the @c "HOME"
6338     * environment variable's value.
6339     *
6340     * @see elm_fileselector_button_path_get()
6341     */
6342    EAPI void         elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6343
6344    /**
6345     * Get the initial file system path set for a given file selector
6346     * button widget
6347     *
6348     * @param obj The file selector button widget
6349     * @return path The path string
6350     *
6351     * @see elm_fileselector_button_path_set() for more details
6352     */
6353    EAPI const char  *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6354
6355    /**
6356     * Enable/disable a tree view in the given file selector button
6357     * widget's internal file selector
6358     *
6359     * @param obj The file selector button widget
6360     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6361     * disable
6362     *
6363     * This has the same effect as elm_fileselector_expandable_set(),
6364     * but now applied to a file selector button's internal file
6365     * selector.
6366     *
6367     * @note There's no way to put a file selector button's internal
6368     * file selector in "grid mode", as one may do with "pure" file
6369     * selectors.
6370     *
6371     * @see elm_fileselector_expandable_get()
6372     */
6373    EAPI void         elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6374
6375    /**
6376     * Get whether tree view is enabled for the given file selector
6377     * button widget's internal file selector
6378     *
6379     * @param obj The file selector button widget
6380     * @return @c EINA_TRUE if @p obj widget's internal file selector
6381     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6382     *
6383     * @see elm_fileselector_expandable_set() for more details
6384     */
6385    EAPI Eina_Bool    elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6386
6387    /**
6388     * Set whether a given file selector button widget's internal file
6389     * selector is to display folders only or the directory contents,
6390     * as well.
6391     *
6392     * @param obj The file selector button widget
6393     * @param only @c EINA_TRUE to make @p obj widget's internal file
6394     * selector only display directories, @c EINA_FALSE to make files
6395     * to be displayed in it too
6396     *
6397     * This has the same effect as elm_fileselector_folder_only_set(),
6398     * but now applied to a file selector button's internal file
6399     * selector.
6400     *
6401     * @see elm_fileselector_folder_only_get()
6402     */
6403    EAPI void         elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6404
6405    /**
6406     * Get whether a given file selector button widget's internal file
6407     * selector is displaying folders only or the directory contents,
6408     * as well.
6409     *
6410     * @param obj The file selector button widget
6411     * @return @c EINA_TRUE if @p obj widget's internal file
6412     * selector is only displaying directories, @c EINA_FALSE if files
6413     * are being displayed in it too (and on errors)
6414     *
6415     * @see elm_fileselector_button_folder_only_set() for more details
6416     */
6417    EAPI Eina_Bool    elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6418
6419    /**
6420     * Enable/disable the file name entry box where the user can type
6421     * in a name for a file, in a given file selector button widget's
6422     * internal file selector.
6423     *
6424     * @param obj The file selector button widget
6425     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6426     * file selector a "saving dialog", @c EINA_FALSE otherwise
6427     *
6428     * This has the same effect as elm_fileselector_is_save_set(),
6429     * but now applied to a file selector button's internal file
6430     * selector.
6431     *
6432     * @see elm_fileselector_is_save_get()
6433     */
6434    EAPI void         elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6435
6436    /**
6437     * Get whether the given file selector button widget's internal
6438     * file selector is in "saving dialog" mode
6439     *
6440     * @param obj The file selector button widget
6441     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6442     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6443     * errors)
6444     *
6445     * @see elm_fileselector_button_is_save_set() for more details
6446     */
6447    EAPI Eina_Bool    elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6448
6449    /**
6450     * Set whether a given file selector button widget's internal file
6451     * selector will raise an Elementary "inner window", instead of a
6452     * dedicated Elementary window. By default, it won't.
6453     *
6454     * @param obj The file selector button widget
6455     * @param value @c EINA_TRUE to make it use an inner window, @c
6456     * EINA_TRUE to make it use a dedicated window
6457     *
6458     * @see elm_win_inwin_add() for more information on inner windows
6459     * @see elm_fileselector_button_inwin_mode_get()
6460     */
6461    EAPI void         elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6462
6463    /**
6464     * Get whether a given file selector button widget's internal file
6465     * selector will raise an Elementary "inner window", instead of a
6466     * dedicated Elementary window.
6467     *
6468     * @param obj The file selector button widget
6469     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6470     * if it will use a dedicated window
6471     *
6472     * @see elm_fileselector_button_inwin_mode_set() for more details
6473     */
6474    EAPI Eina_Bool    elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6475
6476    /**
6477     * @}
6478     */
6479
6480     /**
6481     * @defgroup File_Selector_Entry File Selector Entry
6482     *
6483     * @image html img/widget/fileselector_entry/preview-00.png
6484     * @image latex img/widget/fileselector_entry/preview-00.eps
6485     *
6486     * This is an entry made to be filled with or display a <b>file
6487     * system path string</b>. Besides the entry itself, the widget has
6488     * a @ref File_Selector_Button "file selector button" on its side,
6489     * which will raise an internal @ref Fileselector "file selector widget",
6490     * when clicked, for path selection aided by file system
6491     * navigation.
6492     *
6493     * This file selector may appear in an Elementary window or in an
6494     * inner window. When a file is chosen from it, the (inner) window
6495     * is closed and the selected file's path string is exposed both as
6496     * an smart event and as the new text on the entry.
6497     *
6498     * This widget encapsulates operations on its internal file
6499     * selector on its own API. There is less control over its file
6500     * selector than that one would have instatiating one directly.
6501     *
6502     * Smart callbacks one can register to:
6503     * - @c "changed" - The text within the entry was changed
6504     * - @c "activated" - The entry has had editing finished and
6505     *   changes are to be "committed"
6506     * - @c "press" - The entry has been clicked
6507     * - @c "longpressed" - The entry has been clicked (and held) for a
6508     *   couple seconds
6509     * - @c "clicked" - The entry has been clicked
6510     * - @c "clicked,double" - The entry has been double clicked
6511     * - @c "focused" - The entry has received focus
6512     * - @c "unfocused" - The entry has lost focus
6513     * - @c "selection,paste" - A paste action has occurred on the
6514     *   entry
6515     * - @c "selection,copy" - A copy action has occurred on the entry
6516     * - @c "selection,cut" - A cut action has occurred on the entry
6517     * - @c "unpressed" - The file selector entry's button was released
6518     *   after being pressed.
6519     * - @c "file,chosen" - The user has selected a path via the file
6520     *   selector entry's internal file selector, whose string pointer
6521     *   comes as the @c event_info data (a stringshared string)
6522     *
6523     * Here is an example on its usage:
6524     * @li @ref fileselector_entry_example
6525     *
6526     * @see @ref File_Selector_Button for a similar widget.
6527     * @{
6528     */
6529
6530    /**
6531     * Add a new file selector entry widget to the given parent
6532     * Elementary (container) object
6533     *
6534     * @param parent The parent object
6535     * @return a new file selector entry widget handle or @c NULL, on
6536     * errors
6537     */
6538    EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6539
6540    /**
6541     * Set the label for a given file selector entry widget's button
6542     *
6543     * @param obj The file selector entry widget
6544     * @param label The text label to be displayed on @p obj widget's
6545     * button
6546     *
6547     * @deprecated use elm_object_text_set() instead.
6548     */
6549    EINA_DEPRECATED EAPI void         elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6550
6551    /**
6552     * Get the label set for a given file selector entry widget's button
6553     *
6554     * @param obj The file selector entry widget
6555     * @return The widget button's label
6556     *
6557     * @deprecated use elm_object_text_set() instead.
6558     */
6559    EINA_DEPRECATED EAPI const char  *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6560
6561    /**
6562     * Set the icon on a given file selector entry widget's button
6563     *
6564     * @param obj The file selector entry widget
6565     * @param icon The icon object for the entry's button
6566     *
6567     * Once the icon object is set, a previously set one will be
6568     * deleted. If you want to keep the latter, use the
6569     * elm_fileselector_entry_button_icon_unset() function.
6570     *
6571     * @see elm_fileselector_entry_button_icon_get()
6572     */
6573    EAPI void         elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6574
6575    /**
6576     * Get the icon set for a given file selector entry widget's button
6577     *
6578     * @param obj The file selector entry widget
6579     * @return The icon object currently set on @p obj widget's button
6580     * or @c NULL, if none is
6581     *
6582     * @see elm_fileselector_entry_button_icon_set()
6583     */
6584    EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6585
6586    /**
6587     * Unset the icon used in a given file selector entry widget's
6588     * button
6589     *
6590     * @param obj The file selector entry widget
6591     * @return The icon object that was being used on @p obj widget's
6592     * button or @c NULL, on errors
6593     *
6594     * Unparent and return the icon object which was set for this
6595     * widget's button.
6596     *
6597     * @see elm_fileselector_entry_button_icon_set()
6598     */
6599    EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6600
6601    /**
6602     * Set the title for a given file selector entry widget's window
6603     *
6604     * @param obj The file selector entry widget
6605     * @param title The title string
6606     *
6607     * This will change the window's title, when the file selector pops
6608     * out after a click on the entry's button. Those windows have the
6609     * default (unlocalized) value of @c "Select a file" as titles.
6610     *
6611     * @note It will only take any effect if the file selector
6612     * entry widget is @b not under "inwin mode".
6613     *
6614     * @see elm_fileselector_entry_window_title_get()
6615     */
6616    EAPI void         elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6617
6618    /**
6619     * Get the title set for a given file selector entry widget's
6620     * window
6621     *
6622     * @param obj The file selector entry widget
6623     * @return Title of the file selector entry's window
6624     *
6625     * @see elm_fileselector_entry_window_title_get() for more details
6626     */
6627    EAPI const char  *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6628
6629    /**
6630     * Set the size of a given file selector entry widget's window,
6631     * holding the file selector itself.
6632     *
6633     * @param obj The file selector entry widget
6634     * @param width The window's width
6635     * @param height The window's height
6636     *
6637     * @note it will only take any effect if the file selector entry
6638     * widget is @b not under "inwin mode". The default size for the
6639     * window (when applicable) is 400x400 pixels.
6640     *
6641     * @see elm_fileselector_entry_window_size_get()
6642     */
6643    EAPI void         elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6644
6645    /**
6646     * Get the size of a given file selector entry widget's window,
6647     * holding the file selector itself.
6648     *
6649     * @param obj The file selector entry widget
6650     * @param width Pointer into which to store the width value
6651     * @param height Pointer into which to store the height value
6652     *
6653     * @note Use @c NULL pointers on the size values you're not
6654     * interested in: they'll be ignored by the function.
6655     *
6656     * @see elm_fileselector_entry_window_size_set(), for more details
6657     */
6658    EAPI void         elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6659
6660    /**
6661     * Set the initial file system path and the entry's path string for
6662     * a given file selector entry widget
6663     *
6664     * @param obj The file selector entry widget
6665     * @param path The path string
6666     *
6667     * It must be a <b>directory</b> path, which will have the contents
6668     * displayed initially in the file selector's view, when invoked
6669     * from @p obj. The default initial path is the @c "HOME"
6670     * environment variable's value.
6671     *
6672     * @see elm_fileselector_entry_path_get()
6673     */
6674    EAPI void         elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6675
6676    /**
6677     * Get the entry's path string for a given file selector entry
6678     * widget
6679     *
6680     * @param obj The file selector entry widget
6681     * @return path The path string
6682     *
6683     * @see elm_fileselector_entry_path_set() for more details
6684     */
6685    EAPI const char  *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6686
6687    /**
6688     * Enable/disable a tree view in the given file selector entry
6689     * widget's internal file selector
6690     *
6691     * @param obj The file selector entry widget
6692     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6693     * disable
6694     *
6695     * This has the same effect as elm_fileselector_expandable_set(),
6696     * but now applied to a file selector entry's internal file
6697     * selector.
6698     *
6699     * @note There's no way to put a file selector entry's internal
6700     * file selector in "grid mode", as one may do with "pure" file
6701     * selectors.
6702     *
6703     * @see elm_fileselector_expandable_get()
6704     */
6705    EAPI void         elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6706
6707    /**
6708     * Get whether tree view is enabled for the given file selector
6709     * entry widget's internal file selector
6710     *
6711     * @param obj The file selector entry widget
6712     * @return @c EINA_TRUE if @p obj widget's internal file selector
6713     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6714     *
6715     * @see elm_fileselector_expandable_set() for more details
6716     */
6717    EAPI Eina_Bool    elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6718
6719    /**
6720     * Set whether a given file selector entry widget's internal file
6721     * selector is to display folders only or the directory contents,
6722     * as well.
6723     *
6724     * @param obj The file selector entry widget
6725     * @param only @c EINA_TRUE to make @p obj widget's internal file
6726     * selector only display directories, @c EINA_FALSE to make files
6727     * to be displayed in it too
6728     *
6729     * This has the same effect as elm_fileselector_folder_only_set(),
6730     * but now applied to a file selector entry's internal file
6731     * selector.
6732     *
6733     * @see elm_fileselector_folder_only_get()
6734     */
6735    EAPI void         elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6736
6737    /**
6738     * Get whether a given file selector entry widget's internal file
6739     * selector is displaying folders only or the directory contents,
6740     * as well.
6741     *
6742     * @param obj The file selector entry widget
6743     * @return @c EINA_TRUE if @p obj widget's internal file
6744     * selector is only displaying directories, @c EINA_FALSE if files
6745     * are being displayed in it too (and on errors)
6746     *
6747     * @see elm_fileselector_entry_folder_only_set() for more details
6748     */
6749    EAPI Eina_Bool    elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6750
6751    /**
6752     * Enable/disable the file name entry box where the user can type
6753     * in a name for a file, in a given file selector entry widget's
6754     * internal file selector.
6755     *
6756     * @param obj The file selector entry widget
6757     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6758     * file selector a "saving dialog", @c EINA_FALSE otherwise
6759     *
6760     * This has the same effect as elm_fileselector_is_save_set(),
6761     * but now applied to a file selector entry's internal file
6762     * selector.
6763     *
6764     * @see elm_fileselector_is_save_get()
6765     */
6766    EAPI void         elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6767
6768    /**
6769     * Get whether the given file selector entry widget's internal
6770     * file selector is in "saving dialog" mode
6771     *
6772     * @param obj The file selector entry widget
6773     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6774     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6775     * errors)
6776     *
6777     * @see elm_fileselector_entry_is_save_set() for more details
6778     */
6779    EAPI Eina_Bool    elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6780
6781    /**
6782     * Set whether a given file selector entry widget's internal file
6783     * selector will raise an Elementary "inner window", instead of a
6784     * dedicated Elementary window. By default, it won't.
6785     *
6786     * @param obj The file selector entry widget
6787     * @param value @c EINA_TRUE to make it use an inner window, @c
6788     * EINA_TRUE to make it use a dedicated window
6789     *
6790     * @see elm_win_inwin_add() for more information on inner windows
6791     * @see elm_fileselector_entry_inwin_mode_get()
6792     */
6793    EAPI void         elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6794
6795    /**
6796     * Get whether a given file selector entry widget's internal file
6797     * selector will raise an Elementary "inner window", instead of a
6798     * dedicated Elementary window.
6799     *
6800     * @param obj The file selector entry widget
6801     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6802     * if it will use a dedicated window
6803     *
6804     * @see elm_fileselector_entry_inwin_mode_set() for more details
6805     */
6806    EAPI Eina_Bool    elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6807
6808    /**
6809     * Set the initial file system path for a given file selector entry
6810     * widget
6811     *
6812     * @param obj The file selector entry widget
6813     * @param path The path string
6814     *
6815     * It must be a <b>directory</b> path, which will have the contents
6816     * displayed initially in the file selector's view, when invoked
6817     * from @p obj. The default initial path is the @c "HOME"
6818     * environment variable's value.
6819     *
6820     * @see elm_fileselector_entry_path_get()
6821     */
6822    EAPI void         elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6823
6824    /**
6825     * Get the parent directory's path to the latest file selection on
6826     * a given filer selector entry widget
6827     *
6828     * @param obj The file selector object
6829     * @return The (full) path of the directory of the last selection
6830     * on @p obj widget, a @b stringshared string
6831     *
6832     * @see elm_fileselector_entry_path_set()
6833     */
6834    EAPI const char  *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6835
6836    /**
6837     * @}
6838     */
6839
6840    /**
6841     * @defgroup Scroller Scroller
6842     *
6843     * A scroller holds a single object and "scrolls it around". This means that
6844     * it allows the user to use a scrollbar (or a finger) to drag the viewable
6845     * region around, allowing to move through a much larger object that is
6846     * contained in the scroller. The scroiller will always have a small minimum
6847     * size by default as it won't be limited by the contents of the scroller.
6848     *
6849     * Signals that you can add callbacks for are:
6850     * @li "edge,left" - the left edge of the content has been reached
6851     * @li "edge,right" - the right edge of the content has been reached
6852     * @li "edge,top" - the top edge of the content has been reached
6853     * @li "edge,bottom" - the bottom edge of the content has been reached
6854     * @li "scroll" - the content has been scrolled (moved)
6855     * @li "scroll,anim,start" - scrolling animation has started
6856     * @li "scroll,anim,stop" - scrolling animation has stopped
6857     * @li "scroll,drag,start" - dragging the contents around has started
6858     * @li "scroll,drag,stop" - dragging the contents around has stopped
6859     * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
6860     * user intervetion.
6861     *
6862     * @note When Elemementary is in embedded mode the scrollbars will not be
6863     * dragable, they appear merely as indicators of how much has been scrolled.
6864     * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
6865     * fingerscroll) won't work.
6866     *
6867     * In @ref tutorial_scroller you'll find an example of how to use most of
6868     * this API.
6869     * @{
6870     */
6871    /**
6872     * @brief Type that controls when scrollbars should appear.
6873     *
6874     * @see elm_scroller_policy_set()
6875     */
6876    typedef enum _Elm_Scroller_Policy
6877      {
6878         ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
6879         ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
6880         ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
6881         ELM_SCROLLER_POLICY_LAST
6882      } Elm_Scroller_Policy;
6883    /**
6884     * @brief Add a new scroller to the parent
6885     *
6886     * @param parent The parent object
6887     * @return The new object or NULL if it cannot be created
6888     */
6889    EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6890    /**
6891     * @brief Set the content of the scroller widget (the object to be scrolled around).
6892     *
6893     * @param obj The scroller object
6894     * @param content The new content object
6895     *
6896     * Once the content object is set, a previously set one will be deleted.
6897     * If you want to keep that old content object, use the
6898     * elm_scroller_content_unset() function.
6899     */
6900    EAPI void         elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
6901    /**
6902     * @brief Get the content of the scroller widget
6903     *
6904     * @param obj The slider object
6905     * @return The content that is being used
6906     *
6907     * Return the content object which is set for this widget
6908     *
6909     * @see elm_scroller_content_set()
6910     */
6911    EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6912    /**
6913     * @brief Unset the content of the scroller widget
6914     *
6915     * @param obj The slider object
6916     * @return The content that was being used
6917     *
6918     * Unparent and return the content object which was set for this widget
6919     *
6920     * @see elm_scroller_content_set()
6921     */
6922    EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6923    /**
6924     * @brief Set custom theme elements for the scroller
6925     *
6926     * @param obj The scroller object
6927     * @param widget The widget name to use (default is "scroller")
6928     * @param base The base name to use (default is "base")
6929     */
6930    EAPI void         elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
6931    /**
6932     * @brief Make the scroller minimum size limited to the minimum size of the content
6933     *
6934     * @param obj The scroller object
6935     * @param w Enable limiting minimum size horizontally
6936     * @param h Enable limiting minimum size vertically
6937     *
6938     * By default the scroller will be as small as its design allows,
6939     * irrespective of its content. This will make the scroller minimum size the
6940     * right size horizontally and/or vertically to perfectly fit its content in
6941     * that direction.
6942     */
6943    EAPI void         elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
6944    /**
6945     * @brief Show a specific virtual region within the scroller content object
6946     *
6947     * @param obj The scroller object
6948     * @param x X coordinate of the region
6949     * @param y Y coordinate of the region
6950     * @param w Width of the region
6951     * @param h Height of the region
6952     *
6953     * This will ensure all (or part if it does not fit) of the designated
6954     * region in the virtual content object (0, 0 starting at the top-left of the
6955     * virtual content object) is shown within the scroller.
6956     */
6957    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);
6958    /**
6959     * @brief Set the scrollbar visibility policy
6960     *
6961     * @param obj The scroller object
6962     * @param policy_h Horizontal scrollbar policy
6963     * @param policy_v Vertical scrollbar policy
6964     *
6965     * This sets the scrollbar visibility policy for the given scroller.
6966     * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
6967     * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
6968     * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
6969     * respectively for the horizontal and vertical scrollbars.
6970     */
6971    EAPI void         elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
6972    /**
6973     * @brief Gets scrollbar visibility policy
6974     *
6975     * @param obj The scroller object
6976     * @param policy_h Horizontal scrollbar policy
6977     * @param policy_v Vertical scrollbar policy
6978     *
6979     * @see elm_scroller_policy_set()
6980     */
6981    EAPI void         elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
6982    /**
6983     * @brief Get the currently visible content region
6984     *
6985     * @param obj The scroller object
6986     * @param x X coordinate of the region
6987     * @param y Y coordinate of the region
6988     * @param w Width of the region
6989     * @param h Height of the region
6990     *
6991     * This gets the current region in the content object that is visible through
6992     * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
6993     * w, @p h values pointed to.
6994     *
6995     * @note All coordinates are relative to the content.
6996     *
6997     * @see elm_scroller_region_show()
6998     */
6999    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);
7000    /**
7001     * @brief Get the size of the content object
7002     *
7003     * @param obj The scroller object
7004     * @param w Width return
7005     * @param h Height return
7006     *
7007     * This gets the size of the content object of the scroller.
7008     */
7009    EAPI void         elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7010    /**
7011     * @brief Set bouncing behavior
7012     *
7013     * @param obj The scroller object
7014     * @param h_bounce Will the scroller bounce horizontally or not
7015     * @param v_bounce Will the scroller bounce vertically or not
7016     *
7017     * When scrolling, the scroller may "bounce" when reaching an edge of the
7018     * content object. This is a visual way to indicate the end has been reached.
7019     * This is enabled by default for both axis. This will set if it is enabled
7020     * for that axis with the boolean parameters for each axis.
7021     */
7022    EAPI void         elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7023    /**
7024     * @brief Get the bounce mode
7025     *
7026     * @param obj The Scroller object
7027     * @param h_bounce Allow bounce horizontally
7028     * @param v_bounce Allow bounce vertically
7029     *
7030     * @see elm_scroller_bounce_set()
7031     */
7032    EAPI void         elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7033    /**
7034     * @brief Set scroll page size relative to viewport size.
7035     *
7036     * @param obj The scroller object
7037     * @param h_pagerel The horizontal page relative size
7038     * @param v_pagerel The vertical page relative size
7039     *
7040     * The scroller is capable of limiting scrolling by the user to "pages". That
7041     * is to jump by and only show a "whole page" at a time as if the continuous
7042     * area of the scroller content is split into page sized pieces. This sets
7043     * the size of a page relative to the viewport of the scroller. 1.0 is "1
7044     * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7045     * axis. This is mutually exclusive with page size
7046     * (see elm_scroller_page_size_set()  for more information). Likewise 0.5
7047     * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
7048     * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7049     * the other axis.
7050     */
7051    EAPI void         elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7052    /**
7053     * @brief Set scroll page size.
7054     *
7055     * @param obj The scroller object
7056     * @param h_pagesize The horizontal page size
7057     * @param v_pagesize The vertical page size
7058     *
7059     * This sets the page size to an absolute fixed value, with 0 turning it off
7060     * for that axis.
7061     *
7062     * @see elm_scroller_page_relative_set()
7063     */
7064    EAPI void         elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7065    /**
7066     * @brief Get scroll current page number.
7067     *
7068     * @param obj The scroller object
7069     * @param h_pagenumber The horizontal page number
7070     * @param v_pagenumber The vertical page number
7071     *
7072     * The page number starts from 0. 0 is the first page.
7073     * Current page means the page which meet the top-left of the viewport.
7074     * If there are two or more pages in the viewport, it returns the number of page
7075     * which meet the top-left of the viewport.
7076     *
7077     * @see elm_scroller_last_page_get()
7078     * @see elm_scroller_page_show()
7079     * @see elm_scroller_page_brint_in()
7080     */
7081    EAPI void         elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7082    /**
7083     * @brief Get scroll last page number.
7084     *
7085     * @param obj The scroller object
7086     * @param h_pagenumber The horizontal page number
7087     * @param v_pagenumber The vertical page number
7088     *
7089     * The page number starts from 0. 0 is the first page.
7090     * This returns the last page number among the pages.
7091     *
7092     * @see elm_scroller_current_page_get()
7093     * @see elm_scroller_page_show()
7094     * @see elm_scroller_page_brint_in()
7095     */
7096    EAPI void         elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7097    /**
7098     * Show a specific virtual region within the scroller content object by page number.
7099     *
7100     * @param obj The scroller object
7101     * @param h_pagenumber The horizontal page number
7102     * @param v_pagenumber The vertical page number
7103     *
7104     * 0, 0 of the indicated page is located at the top-left of the viewport.
7105     * This will jump to the page directly without animation.
7106     *
7107     * Example of usage:
7108     *
7109     * @code
7110     * sc = elm_scroller_add(win);
7111     * elm_scroller_content_set(sc, content);
7112     * elm_scroller_page_relative_set(sc, 1, 0);
7113     * elm_scroller_current_page_get(sc, &h_page, &v_page);
7114     * elm_scroller_page_show(sc, h_page + 1, v_page);
7115     * @endcode
7116     *
7117     * @see elm_scroller_page_bring_in()
7118     */
7119    EAPI void         elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7120    /**
7121     * Show a specific virtual region within the scroller content object by page number.
7122     *
7123     * @param obj The scroller object
7124     * @param h_pagenumber The horizontal page number
7125     * @param v_pagenumber The vertical page number
7126     *
7127     * 0, 0 of the indicated page is located at the top-left of the viewport.
7128     * This will slide to the page with animation.
7129     *
7130     * Example of usage:
7131     *
7132     * @code
7133     * sc = elm_scroller_add(win);
7134     * elm_scroller_content_set(sc, content);
7135     * elm_scroller_page_relative_set(sc, 1, 0);
7136     * elm_scroller_last_page_get(sc, &h_page, &v_page);
7137     * elm_scroller_page_bring_in(sc, h_page, v_page);
7138     * @endcode
7139     *
7140     * @see elm_scroller_page_show()
7141     */
7142    EAPI void         elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7143    /**
7144     * @brief Show a specific virtual region within the scroller content object.
7145     *
7146     * @param obj The scroller object
7147     * @param x X coordinate of the region
7148     * @param y Y coordinate of the region
7149     * @param w Width of the region
7150     * @param h Height of the region
7151     *
7152     * This will ensure all (or part if it does not fit) of the designated
7153     * region in the virtual content object (0, 0 starting at the top-left of the
7154     * virtual content object) is shown within the scroller. Unlike
7155     * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7156     * to this location (if configuration in general calls for transitions). It
7157     * may not jump immediately to the new location and make take a while and
7158     * show other content along the way.
7159     *
7160     * @see elm_scroller_region_show()
7161     */
7162    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);
7163    /**
7164     * @brief Set event propagation on a scroller
7165     *
7166     * @param obj The scroller object
7167     * @param propagation If propagation is enabled or not
7168     *
7169     * This enables or disabled event propagation from the scroller content to
7170     * the scroller and its parent. By default event propagation is disabled.
7171     */
7172    EAPI void         elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
7173    /**
7174     * @brief Get event propagation for a scroller
7175     *
7176     * @param obj The scroller object
7177     * @return The propagation state
7178     *
7179     * This gets the event propagation for a scroller.
7180     *
7181     * @see elm_scroller_propagate_events_set()
7182     */
7183    EAPI Eina_Bool    elm_scroller_propagate_events_get(const Evas_Object *obj);
7184    /**
7185     * @}
7186     */
7187
7188    /**
7189     * @defgroup Label Label
7190     *
7191     * @image html img/widget/label/preview-00.png
7192     * @image latex img/widget/label/preview-00.eps
7193     *
7194     * @brief Widget to display text, with simple html-like markup.
7195     *
7196     * The Label widget @b doesn't allow text to overflow its boundaries, if the
7197     * text doesn't fit the geometry of the label it will be ellipsized or be
7198     * cut. Elementary provides several themes for this widget:
7199     * @li default - No animation
7200     * @li marker - Centers the text in the label and make it bold by default
7201     * @li slide_long - The entire text appears from the right of the screen and
7202     * slides until it disappears in the left of the screen(reappering on the
7203     * right again).
7204     * @li slide_short - The text appears in the left of the label and slides to
7205     * the right to show the overflow. When all of the text has been shown the
7206     * position is reset.
7207     * @li slide_bounce - The text appears in the left of the label and slides to
7208     * the right to show the overflow. When all of the text has been shown the
7209     * animation reverses, moving the text to the left.
7210     *
7211     * Custom themes can of course invent new markup tags and style them any way
7212     * they like.
7213     *
7214     * See @ref tutorial_label for a demonstration of how to use a label widget.
7215     * @{
7216     */
7217    /**
7218     * @brief Add a new label to the parent
7219     *
7220     * @param parent The parent object
7221     * @return The new object or NULL if it cannot be created
7222     */
7223    EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7224    /**
7225     * @brief Set the label on the label object
7226     *
7227     * @param obj The label object
7228     * @param label The label will be used on the label object
7229     * @deprecated See elm_object_text_set()
7230     */
7231    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 */
7232    /**
7233     * @brief Get the label used on the label object
7234     *
7235     * @param obj The label object
7236     * @return The string inside the label
7237     * @deprecated See elm_object_text_get()
7238     */
7239    EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7240    /**
7241     * @brief Set the wrapping behavior of the label
7242     *
7243     * @param obj The label object
7244     * @param wrap To wrap text or not
7245     *
7246     * By default no wrapping is done. Possible values for @p wrap are:
7247     * @li ELM_WRAP_NONE - No wrapping
7248     * @li ELM_WRAP_CHAR - wrap between characters
7249     * @li ELM_WRAP_WORD - wrap between words
7250     * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7251     */
7252    EAPI void         elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7253    /**
7254     * @brief Get the wrapping behavior of the label
7255     *
7256     * @param obj The label object
7257     * @return Wrap type
7258     *
7259     * @see elm_label_line_wrap_set()
7260     */
7261    EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7262    /**
7263     * @brief Set wrap width of the label
7264     *
7265     * @param obj The label object
7266     * @param w The wrap width in pixels at a minimum where words need to wrap
7267     *
7268     * This function sets the maximum width size hint of the label.
7269     *
7270     * @warning This is only relevant if the label is inside a container.
7271     */
7272    EAPI void         elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7273    /**
7274     * @brief Get wrap width of the label
7275     *
7276     * @param obj The label object
7277     * @return The wrap width in pixels at a minimum where words need to wrap
7278     *
7279     * @see elm_label_wrap_width_set()
7280     */
7281    EAPI Evas_Coord   elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7282    /**
7283     * @brief Set wrap height of the label
7284     *
7285     * @param obj The label object
7286     * @param h The wrap height in pixels at a minimum where words need to wrap
7287     *
7288     * This function sets the maximum height size hint of the label.
7289     *
7290     * @warning This is only relevant if the label is inside a container.
7291     */
7292    EAPI void         elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7293    /**
7294     * @brief get wrap width of the label
7295     *
7296     * @param obj The label object
7297     * @return The wrap height in pixels at a minimum where words need to wrap
7298     */
7299    EAPI Evas_Coord   elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7300    /**
7301     * @brief Set the font size on the label object.
7302     *
7303     * @param obj The label object
7304     * @param size font size
7305     *
7306     * @warning NEVER use this. It is for hyper-special cases only. use styles
7307     * instead. e.g. "big", "medium", "small" - or better name them by use:
7308     * "title", "footnote", "quote" etc.
7309     */
7310    EAPI void         elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7311    /**
7312     * @brief Set the text color on the label object
7313     *
7314     * @param obj The label object
7315     * @param r Red property background color of The label object
7316     * @param g Green property background color of The label object
7317     * @param b Blue property background color of The label object
7318     * @param a Alpha property background color of The label object
7319     *
7320     * @warning NEVER use this. It is for hyper-special cases only. use styles
7321     * instead. e.g. "big", "medium", "small" - or better name them by use:
7322     * "title", "footnote", "quote" etc.
7323     */
7324    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);
7325    /**
7326     * @brief Set the text align on the label object
7327     *
7328     * @param obj The label object
7329     * @param align align mode ("left", "center", "right")
7330     *
7331     * @warning NEVER use this. It is for hyper-special cases only. use styles
7332     * instead. e.g. "big", "medium", "small" - or better name them by use:
7333     * "title", "footnote", "quote" etc.
7334     */
7335    EAPI void         elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7336    /**
7337     * @brief Set background color of the label
7338     *
7339     * @param obj The label object
7340     * @param r Red property background color of The label object
7341     * @param g Green property background color of The label object
7342     * @param b Blue property background color of The label object
7343     * @param a Alpha property background alpha of The label object
7344     *
7345     * @warning NEVER use this. It is for hyper-special cases only. use styles
7346     * instead. e.g. "big", "medium", "small" - or better name them by use:
7347     * "title", "footnote", "quote" etc.
7348     */
7349    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);
7350    /**
7351     * @brief Set the ellipsis behavior of the label
7352     *
7353     * @param obj The label object
7354     * @param ellipsis To ellipsis text or not
7355     *
7356     * If set to true and the text doesn't fit in the label an ellipsis("...")
7357     * will be shown at the end of the widget.
7358     *
7359     * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7360     * choosen wrap method was ELM_WRAP_WORD.
7361     */
7362    EAPI void         elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7363    /**
7364     * @brief Set the text slide of the label
7365     *
7366     * @param obj The label object
7367     * @param slide To start slide or stop
7368     *
7369     * If set to true the text of the label will slide throught the length of
7370     * label.
7371     *
7372     * @warning This only work with the themes "slide_short", "slide_long" and
7373     * "slide_bounce".
7374     */
7375    EAPI void         elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7376    /**
7377     * @brief Get the text slide mode of the label
7378     *
7379     * @param obj The label object
7380     * @return slide slide mode value
7381     *
7382     * @see elm_label_slide_set()
7383     */
7384    EAPI Eina_Bool    elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7385    /**
7386     * @brief Set the slide duration(speed) of the label
7387     *
7388     * @param obj The label object
7389     * @return The duration in seconds in moving text from slide begin position
7390     * to slide end position
7391     */
7392    EAPI void         elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7393    /**
7394     * @brief Get the slide duration(speed) of the label
7395     *
7396     * @param obj The label object
7397     * @return The duration time in moving text from slide begin position to slide end position
7398     *
7399     * @see elm_label_slide_duration_set()
7400     */
7401    EAPI double       elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7402    /**
7403     * @}
7404     */
7405
7406    /**
7407     * @defgroup Toggle Toggle
7408     *
7409     * @image html img/widget/toggle/preview-00.png
7410     * @image latex img/widget/toggle/preview-00.eps
7411     *
7412     * @brief A toggle is a slider which can be used to toggle between
7413     * two values.  It has two states: on and off.
7414     *
7415     * Signals that you can add callbacks for are:
7416     * @li "changed" - Whenever the toggle value has been changed.  Is not called
7417     *                 until the toggle is released by the cursor (assuming it
7418     *                 has been triggered by the cursor in the first place).
7419     *
7420     * @ref tutorial_toggle show how to use a toggle.
7421     * @{
7422     */
7423    /**
7424     * @brief Add a toggle to @p parent.
7425     *
7426     * @param parent The parent object
7427     *
7428     * @return The toggle object
7429     */
7430    EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7431    /**
7432     * @brief Sets the label to be displayed with the toggle.
7433     *
7434     * @param obj The toggle object
7435     * @param label The label to be displayed
7436     *
7437     * @deprecated use elm_object_text_set() instead.
7438     */
7439    EINA_DEPRECATED EAPI void         elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7440    /**
7441     * @brief Gets the label of the toggle
7442     *
7443     * @param obj  toggle object
7444     * @return The label of the toggle
7445     *
7446     * @deprecated use elm_object_text_get() instead.
7447     */
7448    EINA_DEPRECATED EAPI const char  *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7449    /**
7450     * @brief Set the icon used for the toggle
7451     *
7452     * @param obj The toggle object
7453     * @param icon The icon object for the button
7454     *
7455     * Once the icon object is set, a previously set one will be deleted
7456     * If you want to keep that old content object, use the
7457     * elm_toggle_icon_unset() function.
7458     */
7459    EAPI void         elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7460    /**
7461     * @brief Get the icon used for the toggle
7462     *
7463     * @param obj The toggle object
7464     * @return The icon object that is being used
7465     *
7466     * Return the icon object which is set for this widget.
7467     *
7468     * @see elm_toggle_icon_set()
7469     */
7470    EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7471    /**
7472     * @brief Unset the icon used for the toggle
7473     *
7474     * @param obj The toggle object
7475     * @return The icon object that was being used
7476     *
7477     * Unparent and return the icon object which was set for this widget.
7478     *
7479     * @see elm_toggle_icon_set()
7480     */
7481    EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7482    /**
7483     * @brief Sets the labels to be associated with the on and off states of the toggle.
7484     *
7485     * @param obj The toggle object
7486     * @param onlabel The label displayed when the toggle is in the "on" state
7487     * @param offlabel The label displayed when the toggle is in the "off" state
7488     */
7489    EAPI void         elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7490    /**
7491     * @brief Gets the labels associated with the on and off states of the toggle.
7492     *
7493     * @param obj The toggle object
7494     * @param onlabel A char** to place the onlabel of @p obj into
7495     * @param offlabel A char** to place the offlabel of @p obj into
7496     */
7497    EAPI void         elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7498    /**
7499     * @brief Sets the state of the toggle to @p state.
7500     *
7501     * @param obj The toggle object
7502     * @param state The state of @p obj
7503     */
7504    EAPI void         elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7505    /**
7506     * @brief Gets the state of the toggle to @p state.
7507     *
7508     * @param obj The toggle object
7509     * @return The state of @p obj
7510     */
7511    EAPI Eina_Bool    elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7512    /**
7513     * @brief Sets the state pointer of the toggle to @p statep.
7514     *
7515     * @param obj The toggle object
7516     * @param statep The state pointer of @p obj
7517     */
7518    EAPI void         elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7519    /**
7520     * @}
7521     */
7522
7523    /**
7524     * @defgroup Frame Frame
7525     *
7526     * @image html img/widget/frame/preview-00.png
7527     * @image latex img/widget/frame/preview-00.eps
7528     *
7529     * @brief Frame is a widget that holds some content and has a title.
7530     *
7531     * The default look is a frame with a title, but Frame supports multple
7532     * styles:
7533     * @li default
7534     * @li pad_small
7535     * @li pad_medium
7536     * @li pad_large
7537     * @li pad_huge
7538     * @li outdent_top
7539     * @li outdent_bottom
7540     *
7541     * Of all this styles only default shows the title. Frame emits no signals.
7542     *
7543     * For a detailed example see the @ref tutorial_frame.
7544     *
7545     * @{
7546     */
7547    /**
7548     * @brief Add a new frame to the parent
7549     *
7550     * @param parent The parent object
7551     * @return The new object or NULL if it cannot be created
7552     */
7553    EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7554    /**
7555     * @brief Set the frame label
7556     *
7557     * @param obj The frame object
7558     * @param label The label of this frame object
7559     *
7560     * @deprecated use elm_object_text_set() instead.
7561     */
7562    EINA_DEPRECATED EAPI void         elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7563    /**
7564     * @brief Get the frame label
7565     *
7566     * @param obj The frame object
7567     *
7568     * @return The label of this frame objet or NULL if unable to get frame
7569     *
7570     * @deprecated use elm_object_text_get() instead.
7571     */
7572    EINA_DEPRECATED EAPI const char  *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7573    /**
7574     * @brief Set the content of the frame widget
7575     *
7576     * Once the content object is set, a previously set one will be deleted.
7577     * If you want to keep that old content object, use the
7578     * elm_frame_content_unset() function.
7579     *
7580     * @param obj The frame object
7581     * @param content The content will be filled in this frame object
7582     */
7583    EAPI void         elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7584    /**
7585     * @brief Get the content of the frame widget
7586     *
7587     * Return the content object which is set for this widget
7588     *
7589     * @param obj The frame object
7590     * @return The content that is being used
7591     */
7592    EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7593    /**
7594     * @brief Unset the content of the frame widget
7595     *
7596     * Unparent and return the content object which was set for this widget
7597     *
7598     * @param obj The frame object
7599     * @return The content that was being used
7600     */
7601    EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7602    /**
7603     * @}
7604     */
7605
7606    /**
7607     * @defgroup Table Table
7608     *
7609     * A container widget to arrange other widgets in a table where items can
7610     * also span multiple columns or rows - even overlap (and then be raised or
7611     * lowered accordingly to adjust stacking if they do overlap).
7612     *
7613     * The followin are examples of how to use a table:
7614     * @li @ref tutorial_table_01
7615     * @li @ref tutorial_table_02
7616     *
7617     * @{
7618     */
7619    /**
7620     * @brief Add a new table to the parent
7621     *
7622     * @param parent The parent object
7623     * @return The new object or NULL if it cannot be created
7624     */
7625    EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7626    /**
7627     * @brief Set the homogeneous layout in the table
7628     *
7629     * @param obj The layout object
7630     * @param homogeneous A boolean to set if the layout is homogeneous in the
7631     * table (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7632     */
7633    EAPI void         elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7634    /**
7635     * @brief Get the current table homogeneous mode.
7636     *
7637     * @param obj The table object
7638     * @return A boolean to indicating if the layout is homogeneous in the table
7639     * (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7640     */
7641    EAPI Eina_Bool    elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7642    /**
7643     * @warning <b>Use elm_table_homogeneous_set() instead</b>
7644     */
7645    EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7646    /**
7647     * @warning <b>Use elm_table_homogeneous_get() instead</b>
7648     */
7649    EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7650    /**
7651     * @brief Set padding between cells.
7652     *
7653     * @param obj The layout object.
7654     * @param horizontal set the horizontal padding.
7655     * @param vertical set the vertical padding.
7656     *
7657     * Default value is 0.
7658     */
7659    EAPI void         elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7660    /**
7661     * @brief Get padding between cells.
7662     *
7663     * @param obj The layout object.
7664     * @param horizontal set the horizontal padding.
7665     * @param vertical set the vertical padding.
7666     */
7667    EAPI void         elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7668    /**
7669     * @brief Add a subobject on the table with the coordinates passed
7670     *
7671     * @param obj The table object
7672     * @param subobj The subobject to be added to the table
7673     * @param x Row number
7674     * @param y Column number
7675     * @param w rowspan
7676     * @param h colspan
7677     *
7678     * @note All positioning inside the table is relative to rows and columns, so
7679     * a value of 0 for x and y, means the top left cell of the table, and a
7680     * value of 1 for w and h means @p subobj only takes that 1 cell.
7681     */
7682    EAPI void         elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7683    /**
7684     * @brief Remove child from table.
7685     *
7686     * @param obj The table object
7687     * @param subobj The subobject
7688     */
7689    EAPI void         elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7690    /**
7691     * @brief Faster way to remove all child objects from a table object.
7692     *
7693     * @param obj The table object
7694     * @param clear If true, will delete children, else just remove from table.
7695     */
7696    EAPI void         elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7697    /**
7698     * @brief Set the packing location of an existing child of the table
7699     *
7700     * @param subobj The subobject to be modified in the table
7701     * @param x Row number
7702     * @param y Column number
7703     * @param w rowspan
7704     * @param h colspan
7705     *
7706     * Modifies the position of an object already in the table.
7707     *
7708     * @note All positioning inside the table is relative to rows and columns, so
7709     * a value of 0 for x and y, means the top left cell of the table, and a
7710     * value of 1 for w and h means @p subobj only takes that 1 cell.
7711     */
7712    EAPI void         elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7713    /**
7714     * @brief Get the packing location of an existing child of the table
7715     *
7716     * @param subobj The subobject to be modified in the table
7717     * @param x Row number
7718     * @param y Column number
7719     * @param w rowspan
7720     * @param h colspan
7721     *
7722     * @see elm_table_pack_set()
7723     */
7724    EAPI void         elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7725    /**
7726     * @}
7727     */
7728
7729    /**
7730     * @defgroup Gengrid Gengrid (Generic grid)
7731     *
7732     * This widget aims to position objects in a grid layout while
7733     * actually creating and rendering only the visible ones, using the
7734     * same idea as the @ref Genlist "genlist": the user defines a @b
7735     * class for each item, specifying functions that will be called at
7736     * object creation, deletion, etc. When those items are selected by
7737     * the user, a callback function is issued. Users may interact with
7738     * a gengrid via the mouse (by clicking on items to select them and
7739     * clicking on the grid's viewport and swiping to pan the whole
7740     * view) or via the keyboard, navigating through item with the
7741     * arrow keys.
7742     *
7743     * @section Gengrid_Layouts Gengrid layouts
7744     *
7745     * Gengrids may layout its items in one of two possible layouts:
7746     * - horizontal or
7747     * - vertical.
7748     *
7749     * When in "horizontal mode", items will be placed in @b columns,
7750     * from top to bottom and, when the space for a column is filled,
7751     * another one is started on the right, thus expanding the grid
7752     * horizontally, making for horizontal scrolling. When in "vertical
7753     * mode" , though, items will be placed in @b rows, from left to
7754     * right and, when the space for a row is filled, another one is
7755     * started below, thus expanding the grid vertically (and making
7756     * for vertical scrolling).
7757     *
7758     * @section Gengrid_Items Gengrid items
7759     *
7760     * An item in a gengrid can have 0 or more text labels (they can be
7761     * regular text or textblock Evas objects - that's up to the style
7762     * to determine), 0 or more icons (which are simply objects
7763     * swallowed into the gengrid item's theming Edje object) and 0 or
7764     * more <b>boolean states</b>, which have the behavior left to the
7765     * user to define. The Edje part names for each of these properties
7766     * will be looked up, in the theme file for the gengrid, under the
7767     * Edje (string) data items named @c "labels", @c "icons" and @c
7768     * "states", respectively. For each of those properties, if more
7769     * than one part is provided, they must have names listed separated
7770     * by spaces in the data fields. For the default gengrid item
7771     * theme, we have @b one label part (@c "elm.text"), @b two icon
7772     * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
7773     * no state parts.
7774     *
7775     * A gengrid item may be at one of several styles. Elementary
7776     * provides one by default - "default", but this can be extended by
7777     * system or application custom themes/overlays/extensions (see
7778     * @ref Theme "themes" for more details).
7779     *
7780     * @section Gengrid_Item_Class Gengrid item classes
7781     *
7782     * In order to have the ability to add and delete items on the fly,
7783     * gengrid implements a class (callback) system where the
7784     * application provides a structure with information about that
7785     * type of item (gengrid may contain multiple different items with
7786     * different classes, states and styles). Gengrid will call the
7787     * functions in this struct (methods) when an item is "realized"
7788     * (i.e., created dynamically, while the user is scrolling the
7789     * grid). All objects will simply be deleted when no longer needed
7790     * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
7791     * contains the following members:
7792     * - @c item_style - This is a constant string and simply defines
7793     * the name of the item style. It @b must be specified and the
7794     * default should be @c "default".
7795     * - @c func.label_get - This function is called when an item
7796     * object is actually created. The @c data parameter will point to
7797     * the same data passed to elm_gengrid_item_append() and related
7798     * item creation functions. The @c obj parameter is the gengrid
7799     * object itself, while the @c part one is the name string of one
7800     * of the existing text parts in the Edje group implementing the
7801     * item's theme. This function @b must return a strdup'()ed string,
7802     * as the caller will free() it when done. See
7803     * #Elm_Gengrid_Item_Label_Get_Cb.
7804     * - @c func.icon_get - This function is called when an item object
7805     * is actually created. The @c data parameter will point to the
7806     * same data passed to elm_gengrid_item_append() and related item
7807     * creation functions. The @c obj parameter is the gengrid object
7808     * itself, while the @c part one is the name string of one of the
7809     * existing (icon) swallow parts in the Edje group implementing the
7810     * item's theme. It must return @c NULL, when no icon is desired,
7811     * or a valid object handle, otherwise. The object will be deleted
7812     * by the gengrid on its deletion or when the item is "unrealized".
7813     * See #Elm_Gengrid_Item_Icon_Get_Cb.
7814     * - @c func.state_get - This function is called when an item
7815     * object is actually created. The @c data parameter will point to
7816     * the same data passed to elm_gengrid_item_append() and related
7817     * item creation functions. The @c obj parameter is the gengrid
7818     * object itself, while the @c part one is the name string of one
7819     * of the state parts in the Edje group implementing the item's
7820     * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
7821     * true/on. Gengrids will emit a signal to its theming Edje object
7822     * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
7823     * "source" arguments, respectively, when the state is true (the
7824     * default is false), where @c XXX is the name of the (state) part.
7825     * See #Elm_Gengrid_Item_State_Get_Cb.
7826     * - @c func.del - This is called when elm_gengrid_item_del() is
7827     * called on an item or elm_gengrid_clear() is called on the
7828     * gengrid. This is intended for use when gengrid items are
7829     * deleted, so any data attached to the item (e.g. its data
7830     * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
7831     *
7832     * @section Gengrid_Usage_Hints Usage hints
7833     *
7834     * If the user wants to have multiple items selected at the same
7835     * time, elm_gengrid_multi_select_set() will permit it. If the
7836     * gengrid is single-selection only (the default), then
7837     * elm_gengrid_select_item_get() will return the selected item or
7838     * @c NULL, if none is selected. If the gengrid is under
7839     * multi-selection, then elm_gengrid_selected_items_get() will
7840     * return a list (that is only valid as long as no items are
7841     * modified (added, deleted, selected or unselected) of child items
7842     * on a gengrid.
7843     *
7844     * If an item changes (internal (boolean) state, label or icon
7845     * changes), then use elm_gengrid_item_update() to have gengrid
7846     * update the item with the new state. A gengrid will re-"realize"
7847     * the item, thus calling the functions in the
7848     * #Elm_Gengrid_Item_Class set for that item.
7849     *
7850     * To programmatically (un)select an item, use
7851     * elm_gengrid_item_selected_set(). To get its selected state use
7852     * elm_gengrid_item_selected_get(). To make an item disabled
7853     * (unable to be selected and appear differently) use
7854     * elm_gengrid_item_disabled_set() to set this and
7855     * elm_gengrid_item_disabled_get() to get the disabled state.
7856     *
7857     * Grid cells will only have their selection smart callbacks called
7858     * when firstly getting selected. Any further clicks will do
7859     * nothing, unless you enable the "always select mode", with
7860     * elm_gengrid_always_select_mode_set(), thus making every click to
7861     * issue selection callbacks. elm_gengrid_no_select_mode_set() will
7862     * turn off the ability to select items entirely in the widget and
7863     * they will neither appear selected nor call the selection smart
7864     * callbacks.
7865     *
7866     * Remember that you can create new styles and add your own theme
7867     * augmentation per application with elm_theme_extension_add(). If
7868     * you absolutely must have a specific style that overrides any
7869     * theme the user or system sets up you can use
7870     * elm_theme_overlay_add() to add such a file.
7871     *
7872     * @section Gengrid_Smart_Events Gengrid smart events
7873     *
7874     * Smart events that you can add callbacks for are:
7875     * - @c "activated" - The user has double-clicked or pressed
7876     *   (enter|return|spacebar) on an item. The @c event_info parameter
7877     *   is the gengrid item that was activated.
7878     * - @c "clicked,double" - The user has double-clicked an item.
7879     *   The @c event_info parameter is the gengrid item that was double-clicked.
7880     * - @c "longpressed" - This is called when the item is pressed for a certain
7881     *   amount of time. By default it's 1 second.
7882     * - @c "selected" - The user has made an item selected. The
7883     *   @c event_info parameter is the gengrid item that was selected.
7884     * - @c "unselected" - The user has made an item unselected. The
7885     *   @c event_info parameter is the gengrid item that was unselected.
7886     * - @c "realized" - This is called when the item in the gengrid
7887     *   has its implementing Evas object instantiated, de facto. @c
7888     *   event_info is the gengrid item that was created. The object
7889     *   may be deleted at any time, so it is highly advised to the
7890     *   caller @b not to use the object pointer returned from
7891     *   elm_gengrid_item_object_get(), because it may point to freed
7892     *   objects.
7893     * - @c "unrealized" - This is called when the implementing Evas
7894     *   object for this item is deleted. @c event_info is the gengrid
7895     *   item that was deleted.
7896     * - @c "changed" - Called when an item is added, removed, resized
7897     *   or moved and when the gengrid is resized or gets "horizontal"
7898     *   property changes.
7899     * - @c "scroll,anim,start" - This is called when scrolling animation has
7900     *   started.
7901     * - @c "scroll,anim,stop" - This is called when scrolling animation has
7902     *   stopped.
7903     * - @c "drag,start,up" - Called when the item in the gengrid has
7904     *   been dragged (not scrolled) up.
7905     * - @c "drag,start,down" - Called when the item in the gengrid has
7906     *   been dragged (not scrolled) down.
7907     * - @c "drag,start,left" - Called when the item in the gengrid has
7908     *   been dragged (not scrolled) left.
7909     * - @c "drag,start,right" - Called when the item in the gengrid has
7910     *   been dragged (not scrolled) right.
7911     * - @c "drag,stop" - Called when the item in the gengrid has
7912     *   stopped being dragged.
7913     * - @c "drag" - Called when the item in the gengrid is being
7914     *   dragged.
7915     * - @c "scroll" - called when the content has been scrolled
7916     *   (moved).
7917     * - @c "scroll,drag,start" - called when dragging the content has
7918     *   started.
7919     * - @c "scroll,drag,stop" - called when dragging the content has
7920     *   stopped.
7921     * - @c "scroll,edge,top" - This is called when the gengrid is scrolled until
7922     *   the top edge.
7923     * - @c "scroll,edge,bottom" - This is called when the gengrid is scrolled
7924     *   until the bottom edge.
7925     * - @c "scroll,edge,left" - This is called when the gengrid is scrolled
7926     *   until the left edge.
7927     * - @c "scroll,edge,right" - This is called when the gengrid is scrolled
7928     *   until the right edge.
7929     *
7930     * List of gengrid examples:
7931     * @li @ref gengrid_example
7932     */
7933
7934    /**
7935     * @addtogroup Gengrid
7936     * @{
7937     */
7938
7939    typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
7940    typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
7941    typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
7942    typedef char        *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
7943    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. */
7944    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. */
7945    typedef void         (*Elm_Gengrid_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
7946
7947    typedef char        *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Label_Get_Cb. */
7948    typedef Evas_Object *(*GridItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Icon_Get_Cb. */
7949    typedef Eina_Bool    (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_State_Get_Cb. */
7950    typedef void         (*GridItemDelFunc)      (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Del_Cb. */
7951
7952    /**
7953     * @struct _Elm_Gengrid_Item_Class
7954     *
7955     * Gengrid item class definition. See @ref Gengrid_Item_Class for
7956     * field details.
7957     */
7958    struct _Elm_Gengrid_Item_Class
7959      {
7960         const char             *item_style;
7961         struct _Elm_Gengrid_Item_Class_Func
7962           {
7963              Elm_Gengrid_Item_Label_Get_Cb label_get;
7964              Elm_Gengrid_Item_Icon_Get_Cb  icon_get;
7965              Elm_Gengrid_Item_State_Get_Cb state_get;
7966              Elm_Gengrid_Item_Del_Cb       del;
7967           } func;
7968      }; /**< #Elm_Gengrid_Item_Class member definitions */
7969
7970    /**
7971     * Add a new gengrid widget to the given parent Elementary
7972     * (container) object
7973     *
7974     * @param parent The parent object
7975     * @return a new gengrid widget handle or @c NULL, on errors
7976     *
7977     * This function inserts a new gengrid widget on the canvas.
7978     *
7979     * @see elm_gengrid_item_size_set()
7980     * @see elm_gengrid_group_item_size_set()
7981     * @see elm_gengrid_horizontal_set()
7982     * @see elm_gengrid_item_append()
7983     * @see elm_gengrid_item_del()
7984     * @see elm_gengrid_clear()
7985     *
7986     * @ingroup Gengrid
7987     */
7988    EAPI Evas_Object       *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7989
7990    /**
7991     * Set the size for the items of a given gengrid widget
7992     *
7993     * @param obj The gengrid object.
7994     * @param w The items' width.
7995     * @param h The items' height;
7996     *
7997     * A gengrid, after creation, has still no information on the size
7998     * to give to each of its cells. So, you most probably will end up
7999     * with squares one @ref Fingers "finger" wide, the default
8000     * size. Use this function to force a custom size for you items,
8001     * making them as big as you wish.
8002     *
8003     * @see elm_gengrid_item_size_get()
8004     *
8005     * @ingroup Gengrid
8006     */
8007    EAPI void               elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8008
8009    /**
8010     * Get the size set for the items of a given gengrid widget
8011     *
8012     * @param obj The gengrid object.
8013     * @param w Pointer to a variable where to store the items' width.
8014     * @param h Pointer to a variable where to store the items' height.
8015     *
8016     * @note Use @c NULL pointers on the size values you're not
8017     * interested in: they'll be ignored by the function.
8018     *
8019     * @see elm_gengrid_item_size_get() for more details
8020     *
8021     * @ingroup Gengrid
8022     */
8023    EAPI void               elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8024
8025    /**
8026     * Set the size for the group items of a given gengrid widget
8027     *
8028     * @param obj The gengrid object.
8029     * @param w The group items' width.
8030     * @param h The group items' height;
8031     *
8032     * A gengrid, after creation, has still no information on the size
8033     * to give to each of its cells. So, you most probably will end up
8034     * with squares one @ref Fingers "finger" wide, the default
8035     * size. Use this function to force a custom size for you group items,
8036     * making them as big as you wish.
8037     *
8038     * @see elm_gengrid_group_item_size_get()
8039     *
8040     * @ingroup Gengrid
8041     */
8042    EAPI void               elm_gengrid_group_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8043
8044    /**
8045     * Get the size set for the group items of a given gengrid widget
8046     *
8047     * @param obj The gengrid object.
8048     * @param w Pointer to a variable where to store the group items' width.
8049     * @param h Pointer to a variable where to store the group items' height.
8050     *
8051     * @note Use @c NULL pointers on the size values you're not
8052     * interested in: they'll be ignored by the function.
8053     *
8054     * @see elm_gengrid_group_item_size_get() for more details
8055     *
8056     * @ingroup Gengrid
8057     */
8058    EAPI void               elm_gengrid_group_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8059
8060    /**
8061     * Set the items grid's alignment within a given gengrid widget
8062     *
8063     * @param obj The gengrid object.
8064     * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8065     * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8066     *
8067     * This sets the alignment of the whole grid of items of a gengrid
8068     * within its given viewport. By default, those values are both
8069     * 0.5, meaning that the gengrid will have its items grid placed
8070     * exactly in the middle of its viewport.
8071     *
8072     * @note If given alignment values are out of the cited ranges,
8073     * they'll be changed to the nearest boundary values on the valid
8074     * ranges.
8075     *
8076     * @see elm_gengrid_align_get()
8077     *
8078     * @ingroup Gengrid
8079     */
8080    EAPI void               elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8081
8082    /**
8083     * Get the items grid's alignment values within a given gengrid
8084     * widget
8085     *
8086     * @param obj The gengrid object.
8087     * @param align_x Pointer to a variable where to store the
8088     * horizontal alignment.
8089     * @param align_y Pointer to a variable where to store the vertical
8090     * alignment.
8091     *
8092     * @note Use @c NULL pointers on the alignment values you're not
8093     * interested in: they'll be ignored by the function.
8094     *
8095     * @see elm_gengrid_align_set() for more details
8096     *
8097     * @ingroup Gengrid
8098     */
8099    EAPI void               elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8100
8101    /**
8102     * Set whether a given gengrid widget is or not able have items
8103     * @b reordered
8104     *
8105     * @param obj The gengrid object
8106     * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8107     * @c EINA_FALSE to turn it off
8108     *
8109     * If a gengrid is set to allow reordering, a click held for more
8110     * than 0.5 over a given item will highlight it specially,
8111     * signalling the gengrid has entered the reordering state. From
8112     * that time on, the user will be able to, while still holding the
8113     * mouse button down, move the item freely in the gengrid's
8114     * viewport, replacing to said item to the locations it goes to.
8115     * The replacements will be animated and, whenever the user
8116     * releases the mouse button, the item being replaced gets a new
8117     * definitive place in the grid.
8118     *
8119     * @see elm_gengrid_reorder_mode_get()
8120     *
8121     * @ingroup Gengrid
8122     */
8123    EAPI void               elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8124
8125    /**
8126     * Get whether a given gengrid widget is or not able have items
8127     * @b reordered
8128     *
8129     * @param obj The gengrid object
8130     * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8131     * off
8132     *
8133     * @see elm_gengrid_reorder_mode_set() for more details
8134     *
8135     * @ingroup Gengrid
8136     */
8137    EAPI Eina_Bool          elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8138
8139    /**
8140     * Append a new item in a given gengrid widget.
8141     *
8142     * @param obj The gengrid object.
8143     * @param gic The item class for the item.
8144     * @param data The item data.
8145     * @param func Convenience function called when the item is
8146     * selected.
8147     * @param func_data Data to be passed to @p func.
8148     * @return A handle to the item added or @c NULL, on errors.
8149     *
8150     * This adds an item to the beginning of the gengrid.
8151     *
8152     * @see elm_gengrid_item_prepend()
8153     * @see elm_gengrid_item_insert_before()
8154     * @see elm_gengrid_item_insert_after()
8155     * @see elm_gengrid_item_del()
8156     *
8157     * @ingroup Gengrid
8158     */
8159    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);
8160
8161    /**
8162     * Prepend a new item in a given gengrid widget.
8163     *
8164     * @param obj The gengrid object.
8165     * @param gic The item class for the item.
8166     * @param data The item data.
8167     * @param func Convenience function called when the item is
8168     * selected.
8169     * @param func_data Data to be passed to @p func.
8170     * @return A handle to the item added or @c NULL, on errors.
8171     *
8172     * This adds an item to the end of the gengrid.
8173     *
8174     * @see elm_gengrid_item_append()
8175     * @see elm_gengrid_item_insert_before()
8176     * @see elm_gengrid_item_insert_after()
8177     * @see elm_gengrid_item_del()
8178     *
8179     * @ingroup Gengrid
8180     */
8181    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);
8182
8183    /**
8184     * Insert an item before another in a gengrid widget
8185     *
8186     * @param obj The gengrid object.
8187     * @param gic The item class for the item.
8188     * @param data The item data.
8189     * @param relative The item to place this new one before.
8190     * @param func Convenience function called when the item is
8191     * selected.
8192     * @param func_data Data to be passed to @p func.
8193     * @return A handle to the item added or @c NULL, on errors.
8194     *
8195     * This inserts an item before another in the gengrid.
8196     *
8197     * @see elm_gengrid_item_append()
8198     * @see elm_gengrid_item_prepend()
8199     * @see elm_gengrid_item_insert_after()
8200     * @see elm_gengrid_item_del()
8201     *
8202     * @ingroup Gengrid
8203     */
8204    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);
8205
8206    /**
8207     * Insert an item after another in a gengrid widget
8208     *
8209     * @param obj The gengrid object.
8210     * @param gic The item class for the item.
8211     * @param data The item data.
8212     * @param relative The item to place this new one after.
8213     * @param func Convenience function called when the item is
8214     * selected.
8215     * @param func_data Data to be passed to @p func.
8216     * @return A handle to the item added or @c NULL, on errors.
8217     *
8218     * This inserts an item after another in the gengrid.
8219     *
8220     * @see elm_gengrid_item_append()
8221     * @see elm_gengrid_item_prepend()
8222     * @see elm_gengrid_item_insert_after()
8223     * @see elm_gengrid_item_del()
8224     *
8225     * @ingroup Gengrid
8226     */
8227    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);
8228
8229    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);
8230
8231    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);
8232
8233    /**
8234     * Set whether items on a given gengrid widget are to get their
8235     * selection callbacks issued for @b every subsequent selection
8236     * click on them or just for the first click.
8237     *
8238     * @param obj The gengrid object
8239     * @param always_select @c EINA_TRUE to make items "always
8240     * selected", @c EINA_FALSE, otherwise
8241     *
8242     * By default, grid items will only call their selection callback
8243     * function when firstly getting selected, any subsequent further
8244     * clicks will do nothing. With this call, you make those
8245     * subsequent clicks also to issue the selection callbacks.
8246     *
8247     * @note <b>Double clicks</b> will @b always be reported on items.
8248     *
8249     * @see elm_gengrid_always_select_mode_get()
8250     *
8251     * @ingroup Gengrid
8252     */
8253    EAPI void               elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8254
8255    /**
8256     * Get whether items on a given gengrid widget have their selection
8257     * callbacks issued for @b every subsequent selection click on them
8258     * or just for the first click.
8259     *
8260     * @param obj The gengrid object.
8261     * @return @c EINA_TRUE if the gengrid items are "always selected",
8262     * @c EINA_FALSE, otherwise
8263     *
8264     * @see elm_gengrid_always_select_mode_set() for more details
8265     *
8266     * @ingroup Gengrid
8267     */
8268    EAPI Eina_Bool          elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8269
8270    /**
8271     * Set whether items on a given gengrid widget can be selected or not.
8272     *
8273     * @param obj The gengrid object
8274     * @param no_select @c EINA_TRUE to make items selectable,
8275     * @c EINA_FALSE otherwise
8276     *
8277     * This will make items in @p obj selectable or not. In the latter
8278     * case, any user interaction on the gengrid items will neither make
8279     * them appear selected nor them call their selection callback
8280     * functions.
8281     *
8282     * @see elm_gengrid_no_select_mode_get()
8283     *
8284     * @ingroup Gengrid
8285     */
8286    EAPI void               elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8287
8288    /**
8289     * Get whether items on a given gengrid widget can be selected or
8290     * not.
8291     *
8292     * @param obj The gengrid object
8293     * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8294     * otherwise
8295     *
8296     * @see elm_gengrid_no_select_mode_set() for more details
8297     *
8298     * @ingroup Gengrid
8299     */
8300    EAPI Eina_Bool          elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8301
8302    /**
8303     * Enable or disable multi-selection in a given gengrid widget
8304     *
8305     * @param obj The gengrid object.
8306     * @param multi @c EINA_TRUE, to enable multi-selection,
8307     * @c EINA_FALSE to disable it.
8308     *
8309     * Multi-selection is the ability for one to have @b more than one
8310     * item selected, on a given gengrid, simultaneously. When it is
8311     * enabled, a sequence of clicks on different items will make them
8312     * all selected, progressively. A click on an already selected item
8313     * will unselect it. If interecting via the keyboard,
8314     * multi-selection is enabled while holding the "Shift" key.
8315     *
8316     * @note By default, multi-selection is @b disabled on gengrids
8317     *
8318     * @see elm_gengrid_multi_select_get()
8319     *
8320     * @ingroup Gengrid
8321     */
8322    EAPI void               elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8323
8324    /**
8325     * Get whether multi-selection is enabled or disabled for a given
8326     * gengrid widget
8327     *
8328     * @param obj The gengrid object.
8329     * @return @c EINA_TRUE, if multi-selection is enabled, @c
8330     * EINA_FALSE otherwise
8331     *
8332     * @see elm_gengrid_multi_select_set() for more details
8333     *
8334     * @ingroup Gengrid
8335     */
8336    EAPI Eina_Bool          elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8337
8338    /**
8339     * Enable or disable bouncing effect for a given gengrid widget
8340     *
8341     * @param obj The gengrid object
8342     * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8343     * @c EINA_FALSE to disable it
8344     * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8345     * @c EINA_FALSE to disable it
8346     *
8347     * The bouncing effect occurs whenever one reaches the gengrid's
8348     * edge's while panning it -- it will scroll past its limits a
8349     * little bit and return to the edge again, in a animated for,
8350     * automatically.
8351     *
8352     * @note By default, gengrids have bouncing enabled on both axis
8353     *
8354     * @see elm_gengrid_bounce_get()
8355     *
8356     * @ingroup Gengrid
8357     */
8358    EAPI void               elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8359
8360    /**
8361     * Get whether bouncing effects are enabled or disabled, for a
8362     * given gengrid widget, on each axis
8363     *
8364     * @param obj The gengrid object
8365     * @param h_bounce Pointer to a variable where to store the
8366     * horizontal bouncing flag.
8367     * @param v_bounce Pointer to a variable where to store the
8368     * vertical bouncing flag.
8369     *
8370     * @see elm_gengrid_bounce_set() for more details
8371     *
8372     * @ingroup Gengrid
8373     */
8374    EAPI void               elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8375
8376    /**
8377     * Set a given gengrid widget's scrolling page size, relative to
8378     * its viewport size.
8379     *
8380     * @param obj The gengrid object
8381     * @param h_pagerel The horizontal page (relative) size
8382     * @param v_pagerel The vertical page (relative) size
8383     *
8384     * The gengrid's scroller is capable of binding scrolling by the
8385     * user to "pages". It means that, while scrolling and, specially
8386     * after releasing the mouse button, the grid will @b snap to the
8387     * nearest displaying page's area. When page sizes are set, the
8388     * grid's continuous content area is split into (equal) page sized
8389     * pieces.
8390     *
8391     * This function sets the size of a page <b>relatively to the
8392     * viewport dimensions</b> of the gengrid, for each axis. A value
8393     * @c 1.0 means "the exact viewport's size", in that axis, while @c
8394     * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8395     * a viewport". Sane usable values are, than, between @c 0.0 and @c
8396     * 1.0. Values beyond those will make it behave behave
8397     * inconsistently. If you only want one axis to snap to pages, use
8398     * the value @c 0.0 for the other one.
8399     *
8400     * There is a function setting page size values in @b absolute
8401     * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8402     * is mutually exclusive to this one.
8403     *
8404     * @see elm_gengrid_page_relative_get()
8405     *
8406     * @ingroup Gengrid
8407     */
8408    EAPI void               elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8409
8410    /**
8411     * Get a given gengrid widget's scrolling page size, relative to
8412     * its viewport size.
8413     *
8414     * @param obj The gengrid object
8415     * @param h_pagerel Pointer to a variable where to store the
8416     * horizontal page (relative) size
8417     * @param v_pagerel Pointer to a variable where to store the
8418     * vertical page (relative) size
8419     *
8420     * @see elm_gengrid_page_relative_set() for more details
8421     *
8422     * @ingroup Gengrid
8423     */
8424    EAPI void               elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8425
8426    /**
8427     * Set a given gengrid widget's scrolling page size
8428     *
8429     * @param obj The gengrid object
8430     * @param h_pagerel The horizontal page size, in pixels
8431     * @param v_pagerel The vertical page size, in pixels
8432     *
8433     * The gengrid's scroller is capable of binding scrolling by the
8434     * user to "pages". It means that, while scrolling and, specially
8435     * after releasing the mouse button, the grid will @b snap to the
8436     * nearest displaying page's area. When page sizes are set, the
8437     * grid's continuous content area is split into (equal) page sized
8438     * pieces.
8439     *
8440     * This function sets the size of a page of the gengrid, in pixels,
8441     * for each axis. Sane usable values are, between @c 0 and the
8442     * dimensions of @p obj, for each axis. Values beyond those will
8443     * make it behave behave inconsistently. If you only want one axis
8444     * to snap to pages, use the value @c 0 for the other one.
8445     *
8446     * There is a function setting page size values in @b relative
8447     * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8448     * use is mutually exclusive to this one.
8449     *
8450     * @ingroup Gengrid
8451     */
8452    EAPI void               elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8453
8454    /**
8455     * @brief Get gengrid current page number.
8456     *
8457     * @param obj The gengrid object
8458     * @param h_pagenumber The horizontal page number
8459     * @param v_pagenumber The vertical page number
8460     *
8461     * The page number starts from 0. 0 is the first page.
8462     * Current page means the page which meet the top-left of the viewport.
8463     * If there are two or more pages in the viewport, it returns the number of page
8464     * which meet the top-left of the viewport.
8465     *
8466     * @see elm_gengrid_last_page_get()
8467     * @see elm_gengrid_page_show()
8468     * @see elm_gengrid_page_brint_in()
8469     */
8470    EAPI void         elm_gengrid_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8471
8472    /**
8473     * @brief Get scroll last page number.
8474     *
8475     * @param obj The gengrid object
8476     * @param h_pagenumber The horizontal page number
8477     * @param v_pagenumber The vertical page number
8478     *
8479     * The page number starts from 0. 0 is the first page.
8480     * This returns the last page number among the pages.
8481     *
8482     * @see elm_gengrid_current_page_get()
8483     * @see elm_gengrid_page_show()
8484     * @see elm_gengrid_page_brint_in()
8485     */
8486    EAPI void         elm_gengrid_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8487
8488    /**
8489     * Show a specific virtual region within the gengrid content object by page number.
8490     *
8491     * @param obj The gengrid object
8492     * @param h_pagenumber The horizontal page number
8493     * @param v_pagenumber The vertical page number
8494     *
8495     * 0, 0 of the indicated page is located at the top-left of the viewport.
8496     * This will jump to the page directly without animation.
8497     *
8498     * Example of usage:
8499     *
8500     * @code
8501     * sc = elm_gengrid_add(win);
8502     * elm_gengrid_content_set(sc, content);
8503     * elm_gengrid_page_relative_set(sc, 1, 0);
8504     * elm_gengrid_current_page_get(sc, &h_page, &v_page);
8505     * elm_gengrid_page_show(sc, h_page + 1, v_page);
8506     * @endcode
8507     *
8508     * @see elm_gengrid_page_bring_in()
8509     */
8510    EAPI void         elm_gengrid_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8511
8512    /**
8513     * Show a specific virtual region within the gengrid content object by page number.
8514     *
8515     * @param obj The gengrid object
8516     * @param h_pagenumber The horizontal page number
8517     * @param v_pagenumber The vertical page number
8518     *
8519     * 0, 0 of the indicated page is located at the top-left of the viewport.
8520     * This will slide to the page with animation.
8521     *
8522     * Example of usage:
8523     *
8524     * @code
8525     * sc = elm_gengrid_add(win);
8526     * elm_gengrid_content_set(sc, content);
8527     * elm_gengrid_page_relative_set(sc, 1, 0);
8528     * elm_gengrid_last_page_get(sc, &h_page, &v_page);
8529     * elm_gengrid_page_bring_in(sc, h_page, v_page);
8530     * @endcode
8531     *
8532     * @see elm_gengrid_page_show()
8533     */
8534     EAPI void         elm_gengrid_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8535
8536    /**
8537     * Set for what direction a given gengrid widget will expand while
8538     * placing its items.
8539     *
8540     * @param obj The gengrid object.
8541     * @param setting @c EINA_TRUE to make the gengrid expand
8542     * horizontally, @c EINA_FALSE to expand vertically.
8543     *
8544     * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8545     * in @b columns, from top to bottom and, when the space for a
8546     * column is filled, another one is started on the right, thus
8547     * expanding the grid horizontally. When in "vertical mode"
8548     * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8549     * to right and, when the space for a row is filled, another one is
8550     * started below, thus expanding the grid vertically.
8551     *
8552     * @see elm_gengrid_horizontal_get()
8553     *
8554     * @ingroup Gengrid
8555     */
8556    EAPI void               elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8557
8558    /**
8559     * Get for what direction a given gengrid widget will expand while
8560     * placing its items.
8561     *
8562     * @param obj The gengrid object.
8563     * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8564     * @c EINA_FALSE if it's set to expand vertically.
8565     *
8566     * @see elm_gengrid_horizontal_set() for more detais
8567     *
8568     * @ingroup Gengrid
8569     */
8570    EAPI Eina_Bool          elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8571
8572    /**
8573     * Get the first item in a given gengrid widget
8574     *
8575     * @param obj The gengrid object
8576     * @return The first item's handle or @c NULL, if there are no
8577     * items in @p obj (and on errors)
8578     *
8579     * This returns the first item in the @p obj's internal list of
8580     * items.
8581     *
8582     * @see elm_gengrid_last_item_get()
8583     *
8584     * @ingroup Gengrid
8585     */
8586    EAPI Elm_Gengrid_Item  *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8587
8588    /**
8589     * Get the last item in a given gengrid widget
8590     *
8591     * @param obj The gengrid object
8592     * @return The last item's handle or @c NULL, if there are no
8593     * items in @p obj (and on errors)
8594     *
8595     * This returns the last item in the @p obj's internal list of
8596     * items.
8597     *
8598     * @see elm_gengrid_first_item_get()
8599     *
8600     * @ingroup Gengrid
8601     */
8602    EAPI Elm_Gengrid_Item  *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8603
8604    /**
8605     * Get the @b next item in a gengrid widget's internal list of items,
8606     * given a handle to one of those items.
8607     *
8608     * @param item The gengrid item to fetch next from
8609     * @return The item after @p item, or @c NULL if there's none (and
8610     * on errors)
8611     *
8612     * This returns the item placed after the @p item, on the container
8613     * gengrid.
8614     *
8615     * @see elm_gengrid_item_prev_get()
8616     *
8617     * @ingroup Gengrid
8618     */
8619    EAPI Elm_Gengrid_Item  *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8620
8621    /**
8622     * Get the @b previous item in a gengrid widget's internal list of items,
8623     * given a handle to one of those items.
8624     *
8625     * @param item The gengrid item to fetch previous from
8626     * @return The item before @p item, or @c NULL if there's none (and
8627     * on errors)
8628     *
8629     * This returns the item placed before the @p item, on the container
8630     * gengrid.
8631     *
8632     * @see elm_gengrid_item_next_get()
8633     *
8634     * @ingroup Gengrid
8635     */
8636    EAPI Elm_Gengrid_Item  *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8637
8638    /**
8639     * Get the gengrid object's handle which contains a given gengrid
8640     * item
8641     *
8642     * @param item The item to fetch the container from
8643     * @return The gengrid (parent) object
8644     *
8645     * This returns the gengrid object itself that an item belongs to.
8646     *
8647     * @ingroup Gengrid
8648     */
8649    EAPI Evas_Object       *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8650
8651    /**
8652     * Remove a gengrid item from the its parent, deleting it.
8653     *
8654     * @param item The item to be removed.
8655     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8656     *
8657     * @see elm_gengrid_clear(), to remove all items in a gengrid at
8658     * once.
8659     *
8660     * @ingroup Gengrid
8661     */
8662    EAPI void               elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8663
8664    /**
8665     * Update the contents of a given gengrid item
8666     *
8667     * @param item The gengrid item
8668     *
8669     * This updates an item by calling all the item class functions
8670     * again to get the icons, labels and states. Use this when the
8671     * original item data has changed and you want thta changes to be
8672     * reflected.
8673     *
8674     * @ingroup Gengrid
8675     */
8676    EAPI void               elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8677    EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8678    EAPI void               elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8679
8680    /**
8681     * Return the data associated to a given gengrid item
8682     *
8683     * @param item The gengrid item.
8684     * @return the data associated to this item.
8685     *
8686     * This returns the @c data value passed on the
8687     * elm_gengrid_item_append() and related item addition calls.
8688     *
8689     * @see elm_gengrid_item_append()
8690     * @see elm_gengrid_item_data_set()
8691     *
8692     * @ingroup Gengrid
8693     */
8694    EAPI void              *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8695
8696    /**
8697     * Set the data associated to a given gengrid item
8698     *
8699     * @param item The gengrid item
8700     * @param data The new data pointer to set on it
8701     *
8702     * This @b overrides the @c data value passed on the
8703     * elm_gengrid_item_append() and related item addition calls. This
8704     * function @b won't call elm_gengrid_item_update() automatically,
8705     * so you'd issue it afterwards if you want to hove the item
8706     * updated to reflect the that new data.
8707     *
8708     * @see elm_gengrid_item_data_get()
8709     *
8710     * @ingroup Gengrid
8711     */
8712    EAPI void               elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8713
8714    /**
8715     * Get a given gengrid item's position, relative to the whole
8716     * gengrid's grid area.
8717     *
8718     * @param item The Gengrid item.
8719     * @param x Pointer to variable where to store the item's <b>row
8720     * number</b>.
8721     * @param y Pointer to variable where to store the item's <b>column
8722     * number</b>.
8723     *
8724     * This returns the "logical" position of the item whithin the
8725     * gengrid. For example, @c (0, 1) would stand for first row,
8726     * second column.
8727     *
8728     * @ingroup Gengrid
8729     */
8730    EAPI void               elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
8731
8732    /**
8733     * Set whether a given gengrid item is selected or not
8734     *
8735     * @param item The gengrid item
8736     * @param selected Use @c EINA_TRUE, to make it selected, @c
8737     * EINA_FALSE to make it unselected
8738     *
8739     * This sets the selected state of an item. If multi selection is
8740     * not enabled on the containing gengrid and @p selected is @c
8741     * EINA_TRUE, any other previously selected items will get
8742     * unselected in favor of this new one.
8743     *
8744     * @see elm_gengrid_item_selected_get()
8745     *
8746     * @ingroup Gengrid
8747     */
8748    EAPI void               elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
8749
8750    /**
8751     * Get whether a given gengrid item is selected or not
8752     *
8753     * @param item The gengrid item
8754     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
8755     *
8756     * @see elm_gengrid_item_selected_set() for more details
8757     *
8758     * @ingroup Gengrid
8759     */
8760    EAPI Eina_Bool          elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8761
8762    /**
8763     * Get the real Evas object created to implement the view of a
8764     * given gengrid item
8765     *
8766     * @param item The gengrid item.
8767     * @return the Evas object implementing this item's view.
8768     *
8769     * This returns the actual Evas object used to implement the
8770     * specified gengrid item's view. This may be @c NULL, as it may
8771     * not have been created or may have been deleted, at any time, by
8772     * the gengrid. <b>Do not modify this object</b> (move, resize,
8773     * show, hide, etc.), as the gengrid is controlling it. This
8774     * function is for querying, emitting custom signals or hooking
8775     * lower level callbacks for events on that object. Do not delete
8776     * this object under any circumstances.
8777     *
8778     * @see elm_gengrid_item_data_get()
8779     *
8780     * @ingroup Gengrid
8781     */
8782    EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8783
8784    /**
8785     * Show the portion of a gengrid's internal grid containing a given
8786     * item, @b immediately.
8787     *
8788     * @param item The item to display
8789     *
8790     * This causes gengrid to @b redraw its viewport's contents to the
8791     * region contining the given @p item item, if it is not fully
8792     * visible.
8793     *
8794     * @see elm_gengrid_item_bring_in()
8795     *
8796     * @ingroup Gengrid
8797     */
8798    EAPI void               elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8799
8800    /**
8801     * Animatedly bring in, to the visible are of a gengrid, a given
8802     * item on it.
8803     *
8804     * @param item The gengrid item to display
8805     *
8806     * This causes gengrig to jump to the given @p item item and show
8807     * it (by scrolling), if it is not fully visible. This will use
8808     * animation to do so and take a period of time to complete.
8809     *
8810     * @see elm_gengrid_item_show()
8811     *
8812     * @ingroup Gengrid
8813     */
8814    EAPI void               elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8815
8816    /**
8817     * Set whether a given gengrid item is disabled or not.
8818     *
8819     * @param item The gengrid item
8820     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
8821     * to enable it back.
8822     *
8823     * A disabled item cannot be selected or unselected. It will also
8824     * change its appearance, to signal the user it's disabled.
8825     *
8826     * @see elm_gengrid_item_disabled_get()
8827     *
8828     * @ingroup Gengrid
8829     */
8830    EAPI void               elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8831
8832    /**
8833     * Get whether a given gengrid item is disabled or not.
8834     *
8835     * @param item The gengrid item
8836     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
8837     * (and on errors).
8838     *
8839     * @see elm_gengrid_item_disabled_set() for more details
8840     *
8841     * @ingroup Gengrid
8842     */
8843    EAPI Eina_Bool          elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8844
8845    /**
8846     * Set the text to be shown in a given gengrid item's tooltips.
8847     *
8848     * @param item The gengrid item
8849     * @param text The text to set in the content
8850     *
8851     * This call will setup the text to be used as tooltip to that item
8852     * (analogous to elm_object_tooltip_text_set(), but being item
8853     * tooltips with higher precedence than object tooltips). It can
8854     * have only one tooltip at a time, so any previous tooltip data
8855     * will get removed.
8856     *
8857     * @ingroup Gengrid
8858     */
8859    EAPI void               elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
8860
8861    /**
8862     * Set the content to be shown in a given gengrid item's tooltips
8863     *
8864     * @param item The gengrid item.
8865     * @param func The function returning the tooltip contents.
8866     * @param data What to provide to @a func as callback data/context.
8867     * @param del_cb Called when data is not needed anymore, either when
8868     *        another callback replaces @p func, the tooltip is unset with
8869     *        elm_gengrid_item_tooltip_unset() or the owner @p item
8870     *        dies. This callback receives as its first parameter the
8871     *        given @p data, being @c event_info the item handle.
8872     *
8873     * This call will setup the tooltip's contents to @p item
8874     * (analogous to elm_object_tooltip_content_cb_set(), but being
8875     * item tooltips with higher precedence than object tooltips). It
8876     * can have only one tooltip at a time, so any previous tooltip
8877     * content will get removed. @p func (with @p data) will be called
8878     * every time Elementary needs to show the tooltip and it should
8879     * return a valid Evas object, which will be fully managed by the
8880     * tooltip system, getting deleted when the tooltip is gone.
8881     *
8882     * @ingroup Gengrid
8883     */
8884    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);
8885
8886    /**
8887     * Unset a tooltip from a given gengrid item
8888     *
8889     * @param item gengrid item to remove a previously set tooltip from.
8890     *
8891     * This call removes any tooltip set on @p item. The callback
8892     * provided as @c del_cb to
8893     * elm_gengrid_item_tooltip_content_cb_set() will be called to
8894     * notify it is not used anymore (and have resources cleaned, if
8895     * need be).
8896     *
8897     * @see elm_gengrid_item_tooltip_content_cb_set()
8898     *
8899     * @ingroup Gengrid
8900     */
8901    EAPI void               elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8902
8903    /**
8904     * Set a different @b style for a given gengrid item's tooltip.
8905     *
8906     * @param item gengrid item with tooltip set
8907     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
8908     * "default", @c "transparent", etc)
8909     *
8910     * Tooltips can have <b>alternate styles</b> to be displayed on,
8911     * which are defined by the theme set on Elementary. This function
8912     * works analogously as elm_object_tooltip_style_set(), but here
8913     * applied only to gengrid item objects. The default style for
8914     * tooltips is @c "default".
8915     *
8916     * @note before you set a style you should define a tooltip with
8917     *       elm_gengrid_item_tooltip_content_cb_set() or
8918     *       elm_gengrid_item_tooltip_text_set()
8919     *
8920     * @see elm_gengrid_item_tooltip_style_get()
8921     *
8922     * @ingroup Gengrid
8923     */
8924    EAPI void               elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8925
8926    /**
8927     * Get the style set a given gengrid item's tooltip.
8928     *
8929     * @param item gengrid item with tooltip already set on.
8930     * @return style the theme style in use, which defaults to
8931     *         "default". If the object does not have a tooltip set,
8932     *         then @c NULL is returned.
8933     *
8934     * @see elm_gengrid_item_tooltip_style_set() for more details
8935     *
8936     * @ingroup Gengrid
8937     */
8938    EAPI const char        *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8939    /**
8940     * @brief Disable size restrictions on an object's tooltip
8941     * @param item The tooltip's anchor object
8942     * @param disable If EINA_TRUE, size restrictions are disabled
8943     * @return EINA_FALSE on failure, EINA_TRUE on success
8944     *
8945     * This function allows a tooltip to expand beyond its parant window's canvas.
8946     * It will instead be limited only by the size of the display.
8947     */
8948    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
8949    /**
8950     * @brief Retrieve size restriction state of an object's tooltip
8951     * @param item The tooltip's anchor object
8952     * @return If EINA_TRUE, size restrictions are disabled
8953     *
8954     * This function returns whether a tooltip is allowed to expand beyond
8955     * its parant window's canvas.
8956     * It will instead be limited only by the size of the display.
8957     */
8958    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
8959    /**
8960     * Set the type of mouse pointer/cursor decoration to be shown,
8961     * when the mouse pointer is over the given gengrid widget item
8962     *
8963     * @param item gengrid item to customize cursor on
8964     * @param cursor the cursor type's name
8965     *
8966     * This function works analogously as elm_object_cursor_set(), but
8967     * here the cursor's changing area is restricted to the item's
8968     * area, and not the whole widget's. Note that that item cursors
8969     * have precedence over widget cursors, so that a mouse over @p
8970     * item will always show cursor @p type.
8971     *
8972     * If this function is called twice for an object, a previously set
8973     * cursor will be unset on the second call.
8974     *
8975     * @see elm_object_cursor_set()
8976     * @see elm_gengrid_item_cursor_get()
8977     * @see elm_gengrid_item_cursor_unset()
8978     *
8979     * @ingroup Gengrid
8980     */
8981    EAPI void               elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
8982
8983    /**
8984     * Get the type of mouse pointer/cursor decoration set to be shown,
8985     * when the mouse pointer is over the given gengrid widget item
8986     *
8987     * @param item gengrid item with custom cursor set
8988     * @return the cursor type's name or @c NULL, if no custom cursors
8989     * were set to @p item (and on errors)
8990     *
8991     * @see elm_object_cursor_get()
8992     * @see elm_gengrid_item_cursor_set() for more details
8993     * @see elm_gengrid_item_cursor_unset()
8994     *
8995     * @ingroup Gengrid
8996     */
8997    EAPI const char        *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8998
8999    /**
9000     * Unset any custom mouse pointer/cursor decoration set to be
9001     * shown, when the mouse pointer is over the given gengrid widget
9002     * item, thus making it show the @b default cursor again.
9003     *
9004     * @param item a gengrid item
9005     *
9006     * Use this call to undo any custom settings on this item's cursor
9007     * decoration, bringing it back to defaults (no custom style set).
9008     *
9009     * @see elm_object_cursor_unset()
9010     * @see elm_gengrid_item_cursor_set() for more details
9011     *
9012     * @ingroup Gengrid
9013     */
9014    EAPI void               elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9015
9016    /**
9017     * Set a different @b style for a given custom cursor set for a
9018     * gengrid item.
9019     *
9020     * @param item gengrid item with custom cursor set
9021     * @param style the <b>theme style</b> to use (e.g. @c "default",
9022     * @c "transparent", etc)
9023     *
9024     * This function only makes sense when one is using custom mouse
9025     * cursor decorations <b>defined in a theme file</b> , which can
9026     * have, given a cursor name/type, <b>alternate styles</b> on
9027     * it. It works analogously as elm_object_cursor_style_set(), but
9028     * here applied only to gengrid item objects.
9029     *
9030     * @warning Before you set a cursor style you should have defined a
9031     *       custom cursor previously on the item, with
9032     *       elm_gengrid_item_cursor_set()
9033     *
9034     * @see elm_gengrid_item_cursor_engine_only_set()
9035     * @see elm_gengrid_item_cursor_style_get()
9036     *
9037     * @ingroup Gengrid
9038     */
9039    EAPI void               elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9040
9041    /**
9042     * Get the current @b style set for a given gengrid item's custom
9043     * cursor
9044     *
9045     * @param item gengrid item with custom cursor set.
9046     * @return style the cursor style in use. If the object does not
9047     *         have a cursor set, then @c NULL is returned.
9048     *
9049     * @see elm_gengrid_item_cursor_style_set() for more details
9050     *
9051     * @ingroup Gengrid
9052     */
9053    EAPI const char        *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9054
9055    /**
9056     * Set if the (custom) cursor for a given gengrid item should be
9057     * searched in its theme, also, or should only rely on the
9058     * rendering engine.
9059     *
9060     * @param item item with custom (custom) cursor already set on
9061     * @param engine_only Use @c EINA_TRUE to have cursors looked for
9062     * only on those provided by the rendering engine, @c EINA_FALSE to
9063     * have them searched on the widget's theme, as well.
9064     *
9065     * @note This call is of use only if you've set a custom cursor
9066     * for gengrid items, with elm_gengrid_item_cursor_set().
9067     *
9068     * @note By default, cursors will only be looked for between those
9069     * provided by the rendering engine.
9070     *
9071     * @ingroup Gengrid
9072     */
9073    EAPI void               elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9074
9075    /**
9076     * Get if the (custom) cursor for a given gengrid item is being
9077     * searched in its theme, also, or is only relying on the rendering
9078     * engine.
9079     *
9080     * @param item a gengrid item
9081     * @return @c EINA_TRUE, if cursors are being looked for only on
9082     * those provided by the rendering engine, @c EINA_FALSE if they
9083     * are being searched on the widget's theme, as well.
9084     *
9085     * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9086     *
9087     * @ingroup Gengrid
9088     */
9089    EAPI Eina_Bool          elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9090
9091    /**
9092     * Remove all items from a given gengrid widget
9093     *
9094     * @param obj The gengrid object.
9095     *
9096     * This removes (and deletes) all items in @p obj, leaving it
9097     * empty.
9098     *
9099     * @see elm_gengrid_item_del(), to remove just one item.
9100     *
9101     * @ingroup Gengrid
9102     */
9103    EAPI void               elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9104
9105    /**
9106     * Get the selected item in a given gengrid widget
9107     *
9108     * @param obj The gengrid object.
9109     * @return The selected item's handleor @c NULL, if none is
9110     * selected at the moment (and on errors)
9111     *
9112     * This returns the selected item in @p obj. If multi selection is
9113     * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9114     * the first item in the list is selected, which might not be very
9115     * useful. For that case, see elm_gengrid_selected_items_get().
9116     *
9117     * @ingroup Gengrid
9118     */
9119    EAPI Elm_Gengrid_Item  *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9120
9121    /**
9122     * Get <b>a list</b> of selected items in a given gengrid
9123     *
9124     * @param obj The gengrid object.
9125     * @return The list of selected items or @c NULL, if none is
9126     * selected at the moment (and on errors)
9127     *
9128     * This returns a list of the selected items, in the order that
9129     * they appear in the grid. This list is only valid as long as no
9130     * more items are selected or unselected (or unselected implictly
9131     * by deletion). The list contains #Elm_Gengrid_Item pointers as
9132     * data, naturally.
9133     *
9134     * @see elm_gengrid_selected_item_get()
9135     *
9136     * @ingroup Gengrid
9137     */
9138    EAPI const Eina_List   *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9139
9140    /**
9141     * @}
9142     */
9143
9144    /**
9145     * @defgroup Clock Clock
9146     *
9147     * @image html img/widget/clock/preview-00.png
9148     * @image latex img/widget/clock/preview-00.eps
9149     *
9150     * This is a @b digital clock widget. In its default theme, it has a
9151     * vintage "flipping numbers clock" appearance, which will animate
9152     * sheets of individual algarisms individually as time goes by.
9153     *
9154     * A newly created clock will fetch system's time (already
9155     * considering local time adjustments) to start with, and will tick
9156     * accondingly. It may or may not show seconds.
9157     *
9158     * Clocks have an @b edition mode. When in it, the sheets will
9159     * display extra arrow indications on the top and bottom and the
9160     * user may click on them to raise or lower the time values. After
9161     * it's told to exit edition mode, it will keep ticking with that
9162     * new time set (it keeps the difference from local time).
9163     *
9164     * Also, when under edition mode, user clicks on the cited arrows
9165     * which are @b held for some time will make the clock to flip the
9166     * sheet, thus editing the time, continuosly and automatically for
9167     * the user. The interval between sheet flips will keep growing in
9168     * time, so that it helps the user to reach a time which is distant
9169     * from the one set.
9170     *
9171     * The time display is, by default, in military mode (24h), but an
9172     * am/pm indicator may be optionally shown, too, when it will
9173     * switch to 12h.
9174     *
9175     * Smart callbacks one can register to:
9176     * - "changed" - the clock's user changed the time
9177     *
9178     * Here is an example on its usage:
9179     * @li @ref clock_example
9180     */
9181
9182    /**
9183     * @addtogroup Clock
9184     * @{
9185     */
9186
9187    /**
9188     * Identifiers for which clock digits should be editable, when a
9189     * clock widget is in edition mode. Values may be ORed together to
9190     * make a mask, naturally.
9191     *
9192     * @see elm_clock_edit_set()
9193     * @see elm_clock_digit_edit_set()
9194     */
9195    typedef enum _Elm_Clock_Digedit
9196      {
9197         ELM_CLOCK_NONE         = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9198         ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9199         ELM_CLOCK_HOUR_UNIT    = 1 << 1, /**< Unit algarism of hours value should be editable */
9200         ELM_CLOCK_MIN_DECIMAL  = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9201         ELM_CLOCK_MIN_UNIT     = 1 << 3, /**< Unit algarism of minutes value should be editable */
9202         ELM_CLOCK_SEC_DECIMAL  = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9203         ELM_CLOCK_SEC_UNIT     = 1 << 5, /**< Unit algarism of seconds value should be editable */
9204         ELM_CLOCK_ALL          = (1 << 6) - 1 /**< All digits should be editable */
9205      } Elm_Clock_Digedit;
9206
9207    /**
9208     * Add a new clock widget to the given parent Elementary
9209     * (container) object
9210     *
9211     * @param parent The parent object
9212     * @return a new clock widget handle or @c NULL, on errors
9213     *
9214     * This function inserts a new clock widget on the canvas.
9215     *
9216     * @ingroup Clock
9217     */
9218    EAPI Evas_Object      *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9219
9220    /**
9221     * Set a clock widget's time, programmatically
9222     *
9223     * @param obj The clock widget object
9224     * @param hrs The hours to set
9225     * @param min The minutes to set
9226     * @param sec The secondes to set
9227     *
9228     * This function updates the time that is showed by the clock
9229     * widget.
9230     *
9231     *  Values @b must be set within the following ranges:
9232     * - 0 - 23, for hours
9233     * - 0 - 59, for minutes
9234     * - 0 - 59, for seconds,
9235     *
9236     * even if the clock is not in "military" mode.
9237     *
9238     * @warning The behavior for values set out of those ranges is @b
9239     * indefined.
9240     *
9241     * @ingroup Clock
9242     */
9243    EAPI void              elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9244
9245    /**
9246     * Get a clock widget's time values
9247     *
9248     * @param obj The clock object
9249     * @param[out] hrs Pointer to the variable to get the hours value
9250     * @param[out] min Pointer to the variable to get the minutes value
9251     * @param[out] sec Pointer to the variable to get the seconds value
9252     *
9253     * This function gets the time set for @p obj, returning
9254     * it on the variables passed as the arguments to function
9255     *
9256     * @note Use @c NULL pointers on the time values you're not
9257     * interested in: they'll be ignored by the function.
9258     *
9259     * @ingroup Clock
9260     */
9261    EAPI void              elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9262
9263    /**
9264     * Set whether a given clock widget is under <b>edition mode</b> or
9265     * under (default) displaying-only mode.
9266     *
9267     * @param obj The clock object
9268     * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9269     * put it back to "displaying only" mode
9270     *
9271     * This function makes a clock's time to be editable or not <b>by
9272     * user interaction</b>. When in edition mode, clocks @b stop
9273     * ticking, until one brings them back to canonical mode. The
9274     * elm_clock_digit_edit_set() function will influence which digits
9275     * of the clock will be editable. By default, all of them will be
9276     * (#ELM_CLOCK_NONE).
9277     *
9278     * @note am/pm sheets, if being shown, will @b always be editable
9279     * under edition mode.
9280     *
9281     * @see elm_clock_edit_get()
9282     *
9283     * @ingroup Clock
9284     */
9285    EAPI void              elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9286
9287    /**
9288     * Retrieve whether a given clock widget is under <b>edition
9289     * mode</b> or under (default) displaying-only mode.
9290     *
9291     * @param obj The clock object
9292     * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9293     * otherwise
9294     *
9295     * This function retrieves whether the clock's time can be edited
9296     * or not by user interaction.
9297     *
9298     * @see elm_clock_edit_set() for more details
9299     *
9300     * @ingroup Clock
9301     */
9302    EAPI Eina_Bool         elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9303
9304    /**
9305     * Set what digits of the given clock widget should be editable
9306     * when in edition mode.
9307     *
9308     * @param obj The clock object
9309     * @param digedit Bit mask indicating the digits to be editable
9310     * (values in #Elm_Clock_Digedit).
9311     *
9312     * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9313     * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9314     * EINA_FALSE).
9315     *
9316     * @see elm_clock_digit_edit_get()
9317     *
9318     * @ingroup Clock
9319     */
9320    EAPI void              elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9321
9322    /**
9323     * Retrieve what digits of the given clock widget should be
9324     * editable when in edition mode.
9325     *
9326     * @param obj The clock object
9327     * @return Bit mask indicating the digits to be editable
9328     * (values in #Elm_Clock_Digedit).
9329     *
9330     * @see elm_clock_digit_edit_set() for more details
9331     *
9332     * @ingroup Clock
9333     */
9334    EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9335
9336    /**
9337     * Set if the given clock widget must show hours in military or
9338     * am/pm mode
9339     *
9340     * @param obj The clock object
9341     * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9342     * to military mode
9343     *
9344     * This function sets if the clock must show hours in military or
9345     * am/pm mode. In some countries like Brazil the military mode
9346     * (00-24h-format) is used, in opposition to the USA, where the
9347     * am/pm mode is more commonly used.
9348     *
9349     * @see elm_clock_show_am_pm_get()
9350     *
9351     * @ingroup Clock
9352     */
9353    EAPI void              elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9354
9355    /**
9356     * Get if the given clock widget shows hours in military or am/pm
9357     * mode
9358     *
9359     * @param obj The clock object
9360     * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9361     * military
9362     *
9363     * This function gets if the clock shows hours in military or am/pm
9364     * mode.
9365     *
9366     * @see elm_clock_show_am_pm_set() for more details
9367     *
9368     * @ingroup Clock
9369     */
9370    EAPI Eina_Bool         elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9371
9372    /**
9373     * Set if the given clock widget must show time with seconds or not
9374     *
9375     * @param obj The clock object
9376     * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9377     *
9378     * This function sets if the given clock must show or not elapsed
9379     * seconds. By default, they are @b not shown.
9380     *
9381     * @see elm_clock_show_seconds_get()
9382     *
9383     * @ingroup Clock
9384     */
9385    EAPI void              elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9386
9387    /**
9388     * Get whether the given clock widget is showing time with seconds
9389     * or not
9390     *
9391     * @param obj The clock object
9392     * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9393     *
9394     * This function gets whether @p obj is showing or not the elapsed
9395     * seconds.
9396     *
9397     * @see elm_clock_show_seconds_set()
9398     *
9399     * @ingroup Clock
9400     */
9401    EAPI Eina_Bool         elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9402
9403    /**
9404     * Set the interval on time updates for an user mouse button hold
9405     * on clock widgets' time edition.
9406     *
9407     * @param obj The clock object
9408     * @param interval The (first) interval value in seconds
9409     *
9410     * This interval value is @b decreased while the user holds the
9411     * mouse pointer either incrementing or decrementing a given the
9412     * clock digit's value.
9413     *
9414     * This helps the user to get to a given time distant from the
9415     * current one easier/faster, as it will start to flip quicker and
9416     * quicker on mouse button holds.
9417     *
9418     * The calculation for the next flip interval value, starting from
9419     * the one set with this call, is the previous interval divided by
9420     * 1.05, so it decreases a little bit.
9421     *
9422     * The default starting interval value for automatic flips is
9423     * @b 0.85 seconds.
9424     *
9425     * @see elm_clock_interval_get()
9426     *
9427     * @ingroup Clock
9428     */
9429    EAPI void              elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9430
9431    /**
9432     * Get the interval on time updates for an user mouse button hold
9433     * on clock widgets' time edition.
9434     *
9435     * @param obj The clock object
9436     * @return The (first) interval value, in seconds, set on it
9437     *
9438     * @see elm_clock_interval_set() for more details
9439     *
9440     * @ingroup Clock
9441     */
9442    EAPI double            elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9443
9444    /**
9445     * @}
9446     */
9447
9448    /**
9449     * @defgroup Layout Layout
9450     *
9451     * @image html img/widget/layout/preview-00.png
9452     * @image latex img/widget/layout/preview-00.eps width=\textwidth
9453     *
9454     * @image html img/layout-predefined.png
9455     * @image latex img/layout-predefined.eps width=\textwidth
9456     *
9457     * This is a container widget that takes a standard Edje design file and
9458     * wraps it very thinly in a widget.
9459     *
9460     * An Edje design (theme) file has a very wide range of possibilities to
9461     * describe the behavior of elements added to the Layout. Check out the Edje
9462     * documentation and the EDC reference to get more information about what can
9463     * be done with Edje.
9464     *
9465     * Just like @ref List, @ref Box, and other container widgets, any
9466     * object added to the Layout will become its child, meaning that it will be
9467     * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9468     *
9469     * The Layout widget can contain as many Contents, Boxes or Tables as
9470     * described in its theme file. For instance, objects can be added to
9471     * different Tables by specifying the respective Table part names. The same
9472     * is valid for Content and Box.
9473     *
9474     * The objects added as child of the Layout will behave as described in the
9475     * part description where they were added. There are 3 possible types of
9476     * parts where a child can be added:
9477     *
9478     * @section secContent Content (SWALLOW part)
9479     *
9480     * Only one object can be added to the @c SWALLOW part (but you still can
9481     * have many @c SWALLOW parts and one object on each of them). Use the @c
9482     * elm_layout_content_* set of functions to set, retrieve and unset objects
9483     * as content of the @c SWALLOW. After being set to this part, the object
9484     * size, position, visibility, clipping and other description properties
9485     * will be totally controled by the description of the given part (inside
9486     * the Edje theme file).
9487     *
9488     * One can use @c evas_object_size_hint_* functions on the child to have some
9489     * kind of control over its behavior, but the resulting behavior will still
9490     * depend heavily on the @c SWALLOW part description.
9491     *
9492     * The Edje theme also can change the part description, based on signals or
9493     * scripts running inside the theme. This change can also be animated. All of
9494     * this will affect the child object set as content accordingly. The object
9495     * size will be changed if the part size is changed, it will animate move if
9496     * the part is moving, and so on.
9497     *
9498     * The following picture demonstrates a Layout widget with a child object
9499     * added to its @c SWALLOW:
9500     *
9501     * @image html layout_swallow.png
9502     * @image latex layout_swallow.eps width=\textwidth
9503     *
9504     * @section secBox Box (BOX part)
9505     *
9506     * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9507     * allows one to add objects to the box and have them distributed along its
9508     * area, accordingly to the specified @a layout property (now by @a layout we
9509     * mean the chosen layouting design of the Box, not the Layout widget
9510     * itself).
9511     *
9512     * A similar effect for having a box with its position, size and other things
9513     * controled by the Layout theme would be to create an Elementary @ref Box
9514     * widget and add it as a Content in the @c SWALLOW part.
9515     *
9516     * The main difference of using the Layout Box is that its behavior, the box
9517     * properties like layouting format, padding, align, etc. will be all
9518     * controled by the theme. This means, for example, that a signal could be
9519     * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9520     * handled the signal by changing the box padding, or align, or both. Using
9521     * the Elementary @ref Box widget is not necessarily harder or easier, it
9522     * just depends on the circunstances and requirements.
9523     *
9524     * The Layout Box can be used through the @c elm_layout_box_* set of
9525     * functions.
9526     *
9527     * The following picture demonstrates a Layout widget with many child objects
9528     * added to its @c BOX part:
9529     *
9530     * @image html layout_box.png
9531     * @image latex layout_box.eps width=\textwidth
9532     *
9533     * @section secTable Table (TABLE part)
9534     *
9535     * Just like the @ref secBox, the Layout Table is very similar to the
9536     * Elementary @ref Table widget. It allows one to add objects to the Table
9537     * specifying the row and column where the object should be added, and any
9538     * column or row span if necessary.
9539     *
9540     * Again, we could have this design by adding a @ref Table widget to the @c
9541     * SWALLOW part using elm_layout_content_set(). The same difference happens
9542     * here when choosing to use the Layout Table (a @c TABLE part) instead of
9543     * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9544     *
9545     * The Layout Table can be used through the @c elm_layout_table_* set of
9546     * functions.
9547     *
9548     * The following picture demonstrates a Layout widget with many child objects
9549     * added to its @c TABLE part:
9550     *
9551     * @image html layout_table.png
9552     * @image latex layout_table.eps width=\textwidth
9553     *
9554     * @section secPredef Predefined Layouts
9555     *
9556     * Another interesting thing about the Layout widget is that it offers some
9557     * predefined themes that come with the default Elementary theme. These
9558     * themes can be set by the call elm_layout_theme_set(), and provide some
9559     * basic functionality depending on the theme used.
9560     *
9561     * Most of them already send some signals, some already provide a toolbar or
9562     * back and next buttons.
9563     *
9564     * These are available predefined theme layouts. All of them have class = @c
9565     * layout, group = @c application, and style = one of the following options:
9566     *
9567     * @li @c toolbar-content - application with toolbar and main content area
9568     * @li @c toolbar-content-back - application with toolbar and main content
9569     * area with a back button and title area
9570     * @li @c toolbar-content-back-next - application with toolbar and main
9571     * content area with a back and next buttons and title area
9572     * @li @c content-back - application with a main content area with a back
9573     * button and title area
9574     * @li @c content-back-next - application with a main content area with a
9575     * back and next buttons and title area
9576     * @li @c toolbar-vbox - application with toolbar and main content area as a
9577     * vertical box
9578     * @li @c toolbar-table - application with toolbar and main content area as a
9579     * table
9580     *
9581     * @section secExamples Examples
9582     *
9583     * Some examples of the Layout widget can be found here:
9584     * @li @ref layout_example_01
9585     * @li @ref layout_example_02
9586     * @li @ref layout_example_03
9587     * @li @ref layout_example_edc
9588     *
9589     */
9590
9591    /**
9592     * Add a new layout to the parent
9593     *
9594     * @param parent The parent object
9595     * @return The new object or NULL if it cannot be created
9596     *
9597     * @see elm_layout_file_set()
9598     * @see elm_layout_theme_set()
9599     *
9600     * @ingroup Layout
9601     */
9602    EAPI Evas_Object       *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9603    /**
9604     * Set the file that will be used as layout
9605     *
9606     * @param obj The layout object
9607     * @param file The path to file (edj) that will be used as layout
9608     * @param group The group that the layout belongs in edje file
9609     *
9610     * @return (1 = success, 0 = error)
9611     *
9612     * @ingroup Layout
9613     */
9614    EAPI Eina_Bool          elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9615    /**
9616     * Set the edje group from the elementary theme that will be used as layout
9617     *
9618     * @param obj The layout object
9619     * @param clas the clas of the group
9620     * @param group the group
9621     * @param style the style to used
9622     *
9623     * @return (1 = success, 0 = error)
9624     *
9625     * @ingroup Layout
9626     */
9627    EAPI Eina_Bool          elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9628    /**
9629     * Set the layout content.
9630     *
9631     * @param obj The layout object
9632     * @param swallow The swallow part name in the edje file
9633     * @param content The child that will be added in this layout object
9634     *
9635     * Once the content object is set, a previously set one will be deleted.
9636     * If you want to keep that old content object, use the
9637     * elm_layout_content_unset() function.
9638     *
9639     * @note In an Edje theme, the part used as a content container is called @c
9640     * SWALLOW. This is why the parameter name is called @p swallow, but it is
9641     * expected to be a part name just like the second parameter of
9642     * elm_layout_box_append().
9643     *
9644     * @see elm_layout_box_append()
9645     * @see elm_layout_content_get()
9646     * @see elm_layout_content_unset()
9647     * @see @ref secBox
9648     *
9649     * @ingroup Layout
9650     */
9651    EAPI void               elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9652    /**
9653     * Get the child object in the given content part.
9654     *
9655     * @param obj The layout object
9656     * @param swallow The SWALLOW part to get its content
9657     *
9658     * @return The swallowed object or NULL if none or an error occurred
9659     *
9660     * @see elm_layout_content_set()
9661     *
9662     * @ingroup Layout
9663     */
9664    EAPI Evas_Object       *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9665    /**
9666     * Unset the layout content.
9667     *
9668     * @param obj The layout object
9669     * @param swallow The swallow part name in the edje file
9670     * @return The content that was being used
9671     *
9672     * Unparent and return the content object which was set for this part.
9673     *
9674     * @see elm_layout_content_set()
9675     *
9676     * @ingroup Layout
9677     */
9678     EAPI Evas_Object       *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9679    /**
9680     * Set the text of the given part
9681     *
9682     * @param obj The layout object
9683     * @param part The TEXT part where to set the text
9684     * @param text The text to set
9685     *
9686     * @ingroup Layout
9687     * @deprecated use elm_object_text_* instead.
9688     */
9689    EINA_DEPRECATED EAPI void               elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9690    /**
9691     * Get the text set in the given part
9692     *
9693     * @param obj The layout object
9694     * @param part The TEXT part to retrieve the text off
9695     *
9696     * @return The text set in @p part
9697     *
9698     * @ingroup Layout
9699     * @deprecated use elm_object_text_* instead.
9700     */
9701    EINA_DEPRECATED EAPI const char        *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9702    /**
9703     * Append child to layout box part.
9704     *
9705     * @param obj the layout object
9706     * @param part the box part to which the object will be appended.
9707     * @param child the child object to append to box.
9708     *
9709     * Once the object is appended, it will become child of the layout. Its
9710     * lifetime will be bound to the layout, whenever the layout dies the child
9711     * will be deleted automatically. One should use elm_layout_box_remove() to
9712     * make this layout forget about the object.
9713     *
9714     * @see elm_layout_box_prepend()
9715     * @see elm_layout_box_insert_before()
9716     * @see elm_layout_box_insert_at()
9717     * @see elm_layout_box_remove()
9718     *
9719     * @ingroup Layout
9720     */
9721    EAPI void               elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9722    /**
9723     * Prepend child to layout box part.
9724     *
9725     * @param obj the layout object
9726     * @param part the box part to prepend.
9727     * @param child the child object to prepend to box.
9728     *
9729     * Once the object is prepended, it will become child of the layout. Its
9730     * lifetime will be bound to the layout, whenever the layout dies the child
9731     * will be deleted automatically. One should use elm_layout_box_remove() to
9732     * make this layout forget about the object.
9733     *
9734     * @see elm_layout_box_append()
9735     * @see elm_layout_box_insert_before()
9736     * @see elm_layout_box_insert_at()
9737     * @see elm_layout_box_remove()
9738     *
9739     * @ingroup Layout
9740     */
9741    EAPI void               elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9742    /**
9743     * Insert child to layout box part before a reference object.
9744     *
9745     * @param obj the layout object
9746     * @param part the box part to insert.
9747     * @param child the child object to insert into box.
9748     * @param reference another reference object to insert before in box.
9749     *
9750     * Once the object is inserted, it will become child of the layout. Its
9751     * lifetime will be bound to the layout, whenever the layout dies the child
9752     * will be deleted automatically. One should use elm_layout_box_remove() to
9753     * make this layout forget about the object.
9754     *
9755     * @see elm_layout_box_append()
9756     * @see elm_layout_box_prepend()
9757     * @see elm_layout_box_insert_before()
9758     * @see elm_layout_box_remove()
9759     *
9760     * @ingroup Layout
9761     */
9762    EAPI void               elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
9763    /**
9764     * Insert child to layout box part at a given position.
9765     *
9766     * @param obj the layout object
9767     * @param part the box part to insert.
9768     * @param child the child object to insert into box.
9769     * @param pos the numeric position >=0 to insert the child.
9770     *
9771     * Once the object is inserted, it will become child of the layout. Its
9772     * lifetime will be bound to the layout, whenever the layout dies the child
9773     * will be deleted automatically. One should use elm_layout_box_remove() to
9774     * make this layout forget about the object.
9775     *
9776     * @see elm_layout_box_append()
9777     * @see elm_layout_box_prepend()
9778     * @see elm_layout_box_insert_before()
9779     * @see elm_layout_box_remove()
9780     *
9781     * @ingroup Layout
9782     */
9783    EAPI void               elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
9784    /**
9785     * Remove a child of the given part box.
9786     *
9787     * @param obj The layout object
9788     * @param part The box part name to remove child.
9789     * @param child The object to remove from box.
9790     * @return The object that was being used, or NULL if not found.
9791     *
9792     * The object will be removed from the box part and its lifetime will
9793     * not be handled by the layout anymore. This is equivalent to
9794     * elm_layout_content_unset() for box.
9795     *
9796     * @see elm_layout_box_append()
9797     * @see elm_layout_box_remove_all()
9798     *
9799     * @ingroup Layout
9800     */
9801    EAPI Evas_Object       *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
9802    /**
9803     * Remove all child of the given part box.
9804     *
9805     * @param obj The layout object
9806     * @param part The box part name to remove child.
9807     * @param clear If EINA_TRUE, then all objects will be deleted as
9808     *        well, otherwise they will just be removed and will be
9809     *        dangling on the canvas.
9810     *
9811     * The objects will be removed from the box part and their lifetime will
9812     * not be handled by the layout anymore. This is equivalent to
9813     * elm_layout_box_remove() for all box children.
9814     *
9815     * @see elm_layout_box_append()
9816     * @see elm_layout_box_remove()
9817     *
9818     * @ingroup Layout
9819     */
9820    EAPI void               elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9821    /**
9822     * Insert child to layout table part.
9823     *
9824     * @param obj the layout object
9825     * @param part the box part to pack child.
9826     * @param child_obj the child object to pack into table.
9827     * @param col the column to which the child should be added. (>= 0)
9828     * @param row the row to which the child should be added. (>= 0)
9829     * @param colspan how many columns should be used to store this object. (>=
9830     *        1)
9831     * @param rowspan how many rows should be used to store this object. (>= 1)
9832     *
9833     * Once the object is inserted, it will become child of the table. Its
9834     * lifetime will be bound to the layout, and whenever the layout dies the
9835     * child will be deleted automatically. One should use
9836     * elm_layout_table_remove() to make this layout forget about the object.
9837     *
9838     * If @p colspan or @p rowspan are bigger than 1, that object will occupy
9839     * more space than a single cell. For instance, the following code:
9840     * @code
9841     * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
9842     * @endcode
9843     *
9844     * Would result in an object being added like the following picture:
9845     *
9846     * @image html layout_colspan.png
9847     * @image latex layout_colspan.eps width=\textwidth
9848     *
9849     * @see elm_layout_table_unpack()
9850     * @see elm_layout_table_clear()
9851     *
9852     * @ingroup Layout
9853     */
9854    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);
9855    /**
9856     * Unpack (remove) a child of the given part table.
9857     *
9858     * @param obj The layout object
9859     * @param part The table part name to remove child.
9860     * @param child_obj The object to remove from table.
9861     * @return The object that was being used, or NULL if not found.
9862     *
9863     * The object will be unpacked from the table part and its lifetime
9864     * will not be handled by the layout anymore. This is equivalent to
9865     * elm_layout_content_unset() for table.
9866     *
9867     * @see elm_layout_table_pack()
9868     * @see elm_layout_table_clear()
9869     *
9870     * @ingroup Layout
9871     */
9872    EAPI Evas_Object       *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
9873    /**
9874     * Remove all child of the given part table.
9875     *
9876     * @param obj The layout object
9877     * @param part The table part name to remove child.
9878     * @param clear If EINA_TRUE, then all objects will be deleted as
9879     *        well, otherwise they will just be removed and will be
9880     *        dangling on the canvas.
9881     *
9882     * The objects will be removed from the table part and their lifetime will
9883     * not be handled by the layout anymore. This is equivalent to
9884     * elm_layout_table_unpack() for all table children.
9885     *
9886     * @see elm_layout_table_pack()
9887     * @see elm_layout_table_unpack()
9888     *
9889     * @ingroup Layout
9890     */
9891    EAPI void               elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9892    /**
9893     * Get the edje layout
9894     *
9895     * @param obj The layout object
9896     *
9897     * @return A Evas_Object with the edje layout settings loaded
9898     * with function elm_layout_file_set
9899     *
9900     * This returns the edje object. It is not expected to be used to then
9901     * swallow objects via edje_object_part_swallow() for example. Use
9902     * elm_layout_content_set() instead so child object handling and sizing is
9903     * done properly.
9904     *
9905     * @note This function should only be used if you really need to call some
9906     * low level Edje function on this edje object. All the common stuff (setting
9907     * text, emitting signals, hooking callbacks to signals, etc.) can be done
9908     * with proper elementary functions.
9909     *
9910     * @see elm_object_signal_callback_add()
9911     * @see elm_object_signal_emit()
9912     * @see elm_object_text_part_set()
9913     * @see elm_layout_content_set()
9914     * @see elm_layout_box_append()
9915     * @see elm_layout_table_pack()
9916     * @see elm_layout_data_get()
9917     *
9918     * @ingroup Layout
9919     */
9920    EAPI Evas_Object       *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9921    /**
9922     * Get the edje data from the given layout
9923     *
9924     * @param obj The layout object
9925     * @param key The data key
9926     *
9927     * @return The edje data string
9928     *
9929     * This function fetches data specified inside the edje theme of this layout.
9930     * This function return NULL if data is not found.
9931     *
9932     * In EDC this comes from a data block within the group block that @p
9933     * obj was loaded from. E.g.
9934     *
9935     * @code
9936     * collections {
9937     *   group {
9938     *     name: "a_group";
9939     *     data {
9940     *       item: "key1" "value1";
9941     *       item: "key2" "value2";
9942     *     }
9943     *   }
9944     * }
9945     * @endcode
9946     *
9947     * @ingroup Layout
9948     */
9949    EAPI const char        *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
9950    /**
9951     * Eval sizing
9952     *
9953     * @param obj The layout object
9954     *
9955     * Manually forces a sizing re-evaluation. This is useful when the minimum
9956     * size required by the edje theme of this layout has changed. The change on
9957     * the minimum size required by the edje theme is not immediately reported to
9958     * the elementary layout, so one needs to call this function in order to tell
9959     * the widget (layout) that it needs to reevaluate its own size.
9960     *
9961     * The minimum size of the theme is calculated based on minimum size of
9962     * parts, the size of elements inside containers like box and table, etc. All
9963     * of this can change due to state changes, and that's when this function
9964     * should be called.
9965     *
9966     * Also note that a standard signal of "size,eval" "elm" emitted from the
9967     * edje object will cause this to happen too.
9968     *
9969     * @ingroup Layout
9970     */
9971    EAPI void               elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
9972
9973    /**
9974     * Sets a specific cursor for an edje part.
9975     *
9976     * @param obj The layout object.
9977     * @param part_name a part from loaded edje group.
9978     * @param cursor cursor name to use, see Elementary_Cursor.h
9979     *
9980     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9981     *         part not exists or it has "mouse_events: 0".
9982     *
9983     * @ingroup Layout
9984     */
9985    EAPI Eina_Bool          elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
9986
9987    /**
9988     * Get the cursor to be shown when mouse is over an edje part
9989     *
9990     * @param obj The layout object.
9991     * @param part_name a part from loaded edje group.
9992     * @return the cursor name.
9993     *
9994     * @ingroup Layout
9995     */
9996    EAPI const char        *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9997
9998    /**
9999     * Unsets a cursor previously set with elm_layout_part_cursor_set().
10000     *
10001     * @param obj The layout object.
10002     * @param part_name a part from loaded edje group, that had a cursor set
10003     *        with elm_layout_part_cursor_set().
10004     *
10005     * @ingroup Layout
10006     */
10007    EAPI void               elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10008
10009    /**
10010     * Sets a specific cursor style for an edje part.
10011     *
10012     * @param obj The layout object.
10013     * @param part_name a part from loaded edje group.
10014     * @param style the theme style to use (default, transparent, ...)
10015     *
10016     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10017     *         part not exists or it did not had a cursor set.
10018     *
10019     * @ingroup Layout
10020     */
10021    EAPI Eina_Bool          elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10022
10023    /**
10024     * Gets a specific cursor style for an edje part.
10025     *
10026     * @param obj The layout object.
10027     * @param part_name a part from loaded edje group.
10028     *
10029     * @return the theme style in use, defaults to "default". If the
10030     *         object does not have a cursor set, then NULL is returned.
10031     *
10032     * @ingroup Layout
10033     */
10034    EAPI const char        *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10035
10036    /**
10037     * Sets if the cursor set should be searched on the theme or should use
10038     * the provided by the engine, only.
10039     *
10040     * @note before you set if should look on theme you should define a
10041     * cursor with elm_layout_part_cursor_set(). By default it will only
10042     * look for cursors provided by the engine.
10043     *
10044     * @param obj The layout object.
10045     * @param part_name a part from loaded edje group.
10046     * @param engine_only if cursors should be just provided by the engine
10047     *        or should also search on widget's theme as well
10048     *
10049     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10050     *         part not exists or it did not had a cursor set.
10051     *
10052     * @ingroup Layout
10053     */
10054    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);
10055
10056    /**
10057     * Gets a specific cursor engine_only for an edje part.
10058     *
10059     * @param obj The layout object.
10060     * @param part_name a part from loaded edje group.
10061     *
10062     * @return whenever the cursor is just provided by engine or also from theme.
10063     *
10064     * @ingroup Layout
10065     */
10066    EAPI Eina_Bool          elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10067
10068 /**
10069  * @def elm_layout_icon_set
10070  * Convienience macro to set the icon object in a layout that follows the
10071  * Elementary naming convention for its parts.
10072  *
10073  * @ingroup Layout
10074  */
10075 #define elm_layout_icon_set(_ly, _obj) \
10076   do { \
10077     const char *sig; \
10078     elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
10079     if ((_obj)) sig = "elm,state,icon,visible"; \
10080     else sig = "elm,state,icon,hidden"; \
10081     elm_object_signal_emit((_ly), sig, "elm"); \
10082   } while (0)
10083
10084 /**
10085  * @def elm_layout_icon_get
10086  * Convienience macro to get the icon object from a layout that follows the
10087  * Elementary naming convention for its parts.
10088  *
10089  * @ingroup Layout
10090  */
10091 #define elm_layout_icon_get(_ly) \
10092   elm_layout_content_get((_ly), "elm.swallow.icon")
10093
10094 /**
10095  * @def elm_layout_end_set
10096  * Convienience macro to set the end object in a layout that follows the
10097  * Elementary naming convention for its parts.
10098  *
10099  * @ingroup Layout
10100  */
10101 #define elm_layout_end_set(_ly, _obj) \
10102   do { \
10103     const char *sig; \
10104     elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
10105     if ((_obj)) sig = "elm,state,end,visible"; \
10106     else sig = "elm,state,end,hidden"; \
10107     elm_object_signal_emit((_ly), sig, "elm"); \
10108   } while (0)
10109
10110 /**
10111  * @def elm_layout_end_get
10112  * Convienience macro to get the end object in a layout that follows the
10113  * Elementary naming convention for its parts.
10114  *
10115  * @ingroup Layout
10116  */
10117 #define elm_layout_end_get(_ly) \
10118   elm_layout_content_get((_ly), "elm.swallow.end")
10119
10120 /**
10121  * @def elm_layout_label_set
10122  * Convienience macro to set the label in a layout that follows the
10123  * Elementary naming convention for its parts.
10124  *
10125  * @ingroup Layout
10126  * @deprecated use elm_object_text_* instead.
10127  */
10128 #define elm_layout_label_set(_ly, _txt) \
10129   elm_layout_text_set((_ly), "elm.text", (_txt))
10130
10131 /**
10132  * @def elm_layout_label_get
10133  * Convienience macro to get the label in a layout that follows the
10134  * Elementary naming convention for its parts.
10135  *
10136  * @ingroup Layout
10137  * @deprecated use elm_object_text_* instead.
10138  */
10139 #define elm_layout_label_get(_ly) \
10140   elm_layout_text_get((_ly), "elm.text")
10141
10142    /* smart callbacks called:
10143     * "theme,changed" - when elm theme is changed.
10144     */
10145
10146    /**
10147     * @defgroup Notify Notify
10148     *
10149     * @image html img/widget/notify/preview-00.png
10150     * @image latex img/widget/notify/preview-00.eps
10151     *
10152     * Display a container in a particular region of the parent(top, bottom,
10153     * etc.  A timeout can be set to automatically hide the notify. This is so
10154     * that, after an evas_object_show() on a notify object, if a timeout was set
10155     * on it, it will @b automatically get hidden after that time.
10156     *
10157     * Signals that you can add callbacks for are:
10158     * @li "timeout" - when timeout happens on notify and it's hidden
10159     * @li "block,clicked" - when a click outside of the notify happens
10160     *
10161     * @ref tutorial_notify show usage of the API.
10162     *
10163     * @{
10164     */
10165    /**
10166     * @brief Possible orient values for notify.
10167     *
10168     * This values should be used in conjunction to elm_notify_orient_set() to
10169     * set the position in which the notify should appear(relative to its parent)
10170     * and in conjunction with elm_notify_orient_get() to know where the notify
10171     * is appearing.
10172     */
10173    typedef enum _Elm_Notify_Orient
10174      {
10175         ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10176         ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10177         ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10178         ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10179         ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10180         ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10181         ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10182         ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10183         ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10184         ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10185      } Elm_Notify_Orient;
10186    /**
10187     * @brief Add a new notify to the parent
10188     *
10189     * @param parent The parent object
10190     * @return The new object or NULL if it cannot be created
10191     */
10192    EAPI Evas_Object      *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10193    /**
10194     * @brief Set the content of the notify widget
10195     *
10196     * @param obj The notify object
10197     * @param content The content will be filled in this notify object
10198     *
10199     * Once the content object is set, a previously set one will be deleted. If
10200     * you want to keep that old content object, use the
10201     * elm_notify_content_unset() function.
10202     */
10203    EAPI void              elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10204    /**
10205     * @brief Unset the content of the notify widget
10206     *
10207     * @param obj The notify object
10208     * @return The content that was being used
10209     *
10210     * Unparent and return the content object which was set for this widget
10211     *
10212     * @see elm_notify_content_set()
10213     */
10214    EAPI Evas_Object      *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10215    /**
10216     * @brief Return the content of the notify widget
10217     *
10218     * @param obj The notify object
10219     * @return The content that is being used
10220     *
10221     * @see elm_notify_content_set()
10222     */
10223    EAPI Evas_Object      *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10224    /**
10225     * @brief Set the notify parent
10226     *
10227     * @param obj The notify object
10228     * @param content The new parent
10229     *
10230     * Once the parent object is set, a previously set one will be disconnected
10231     * and replaced.
10232     */
10233    EAPI void              elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10234    /**
10235     * @brief Get the notify parent
10236     *
10237     * @param obj The notify object
10238     * @return The parent
10239     *
10240     * @see elm_notify_parent_set()
10241     */
10242    EAPI Evas_Object      *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10243    /**
10244     * @brief Set the orientation
10245     *
10246     * @param obj The notify object
10247     * @param orient The new orientation
10248     *
10249     * Sets the position in which the notify will appear in its parent.
10250     *
10251     * @see @ref Elm_Notify_Orient for possible values.
10252     */
10253    EAPI void              elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10254    /**
10255     * @brief Return the orientation
10256     * @param obj The notify object
10257     * @return The orientation of the notification
10258     *
10259     * @see elm_notify_orient_set()
10260     * @see Elm_Notify_Orient
10261     */
10262    EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10263    /**
10264     * @brief Set the time interval after which the notify window is going to be
10265     * hidden.
10266     *
10267     * @param obj The notify object
10268     * @param time The timeout in seconds
10269     *
10270     * This function sets a timeout and starts the timer controlling when the
10271     * notify is hidden. Since calling evas_object_show() on a notify restarts
10272     * the timer controlling when the notify is hidden, setting this before the
10273     * notify is shown will in effect mean starting the timer when the notify is
10274     * shown.
10275     *
10276     * @note Set a value <= 0.0 to disable a running timer.
10277     *
10278     * @note If the value > 0.0 and the notify is previously visible, the
10279     * timer will be started with this value, canceling any running timer.
10280     */
10281    EAPI void              elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10282    /**
10283     * @brief Return the timeout value (in seconds)
10284     * @param obj the notify object
10285     *
10286     * @see elm_notify_timeout_set()
10287     */
10288    EAPI double            elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10289    /**
10290     * @brief Sets whether events should be passed to by a click outside
10291     * its area.
10292     *
10293     * @param obj The notify object
10294     * @param repeats EINA_TRUE Events are repeats, else no
10295     *
10296     * When true if the user clicks outside the window the events will be caught
10297     * by the others widgets, else the events are blocked.
10298     *
10299     * @note The default value is EINA_TRUE.
10300     */
10301    EAPI void              elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10302    /**
10303     * @brief Return true if events are repeat below the notify object
10304     * @param obj the notify object
10305     *
10306     * @see elm_notify_repeat_events_set()
10307     */
10308    EAPI Eina_Bool         elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10309    /**
10310     * @}
10311     */
10312
10313    /**
10314     * @defgroup Hover Hover
10315     *
10316     * @image html img/widget/hover/preview-00.png
10317     * @image latex img/widget/hover/preview-00.eps
10318     *
10319     * A Hover object will hover over its @p parent object at the @p target
10320     * location. Anything in the background will be given a darker coloring to
10321     * indicate that the hover object is on top (at the default theme). When the
10322     * hover is clicked it is dismissed(hidden), if the contents of the hover are
10323     * clicked that @b doesn't cause the hover to be dismissed.
10324     *
10325     * @note The hover object will take up the entire space of @p target
10326     * object.
10327     *
10328     * Elementary has the following styles for the hover widget:
10329     * @li default
10330     * @li popout
10331     * @li menu
10332     * @li hoversel_vertical
10333     *
10334     * The following are the available position for content:
10335     * @li left
10336     * @li top-left
10337     * @li top
10338     * @li top-right
10339     * @li right
10340     * @li bottom-right
10341     * @li bottom
10342     * @li bottom-left
10343     * @li middle
10344     * @li smart
10345     *
10346     * Signals that you can add callbacks for are:
10347     * @li "clicked" - the user clicked the empty space in the hover to dismiss
10348     * @li "smart,changed" - a content object placed under the "smart"
10349     *                   policy was replaced to a new slot direction.
10350     *
10351     * See @ref tutorial_hover for more information.
10352     *
10353     * @{
10354     */
10355    typedef enum _Elm_Hover_Axis
10356      {
10357         ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10358         ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10359         ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10360         ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10361      } Elm_Hover_Axis;
10362    /**
10363     * @brief Adds a hover object to @p parent
10364     *
10365     * @param parent The parent object
10366     * @return The hover object or NULL if one could not be created
10367     */
10368    EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10369    /**
10370     * @brief Sets the target object for the hover.
10371     *
10372     * @param obj The hover object
10373     * @param target The object to center the hover onto. The hover
10374     *
10375     * This function will cause the hover to be centered on the target object.
10376     */
10377    EAPI void         elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10378    /**
10379     * @brief Gets the target object for the hover.
10380     *
10381     * @param obj The hover object
10382     * @param parent The object to locate the hover over.
10383     *
10384     * @see elm_hover_target_set()
10385     */
10386    EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10387    /**
10388     * @brief Sets the parent object for the hover.
10389     *
10390     * @param obj The hover object
10391     * @param parent The object to locate the hover over.
10392     *
10393     * This function will cause the hover to take up the entire space that the
10394     * parent object fills.
10395     */
10396    EAPI void         elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10397    /**
10398     * @brief Gets the parent object for the hover.
10399     *
10400     * @param obj The hover object
10401     * @return The parent object to locate the hover over.
10402     *
10403     * @see elm_hover_parent_set()
10404     */
10405    EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10406    /**
10407     * @brief Sets the content of the hover object and the direction in which it
10408     * will pop out.
10409     *
10410     * @param obj The hover object
10411     * @param swallow The direction that the object will be displayed
10412     * at. Accepted values are "left", "top-left", "top", "top-right",
10413     * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10414     * "smart".
10415     * @param content The content to place at @p swallow
10416     *
10417     * Once the content object is set for a given direction, a previously
10418     * set one (on the same direction) will be deleted. If you want to
10419     * keep that old content object, use the elm_hover_content_unset()
10420     * function.
10421     *
10422     * All directions may have contents at the same time, except for
10423     * "smart". This is a special placement hint and its use case
10424     * independs of the calculations coming from
10425     * elm_hover_best_content_location_get(). Its use is for cases when
10426     * one desires only one hover content, but with a dinamic special
10427     * placement within the hover area. The content's geometry, whenever
10428     * it changes, will be used to decide on a best location not
10429     * extrapolating the hover's parent object view to show it in (still
10430     * being the hover's target determinant of its medium part -- move and
10431     * resize it to simulate finger sizes, for example). If one of the
10432     * directions other than "smart" are used, a previously content set
10433     * using it will be deleted, and vice-versa.
10434     */
10435    EAPI void         elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10436    /**
10437     * @brief Get the content of the hover object, in a given direction.
10438     *
10439     * Return the content object which was set for this widget in the
10440     * @p swallow direction.
10441     *
10442     * @param obj The hover object
10443     * @param swallow The direction that the object was display at.
10444     * @return The content that was being used
10445     *
10446     * @see elm_hover_content_set()
10447     */
10448    EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10449    /**
10450     * @brief Unset the content of the hover object, in a given direction.
10451     *
10452     * Unparent and return the content object set at @p swallow direction.
10453     *
10454     * @param obj The hover object
10455     * @param swallow The direction that the object was display at.
10456     * @return The content that was being used.
10457     *
10458     * @see elm_hover_content_set()
10459     */
10460    EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10461    /**
10462     * @brief Returns the best swallow location for content in the hover.
10463     *
10464     * @param obj The hover object
10465     * @param pref_axis The preferred orientation axis for the hover object to use
10466     * @return The edje location to place content into the hover or @c
10467     *         NULL, on errors.
10468     *
10469     * Best is defined here as the location at which there is the most available
10470     * space.
10471     *
10472     * @p pref_axis may be one of
10473     * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10474     * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10475     * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10476     * - @c ELM_HOVER_AXIS_BOTH -- both
10477     *
10478     * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10479     * nescessarily be along the horizontal axis("left" or "right"). If
10480     * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10481     * be along the vertical axis("top" or "bottom"). Chossing
10482     * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10483     * returned position may be in either axis.
10484     *
10485     * @see elm_hover_content_set()
10486     */
10487    EAPI const char  *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10488    /**
10489     * @}
10490     */
10491
10492    /* entry */
10493    /**
10494     * @defgroup Entry Entry
10495     *
10496     * @image html img/widget/entry/preview-00.png
10497     * @image latex img/widget/entry/preview-00.eps width=\textwidth
10498     * @image html img/widget/entry/preview-01.png
10499     * @image latex img/widget/entry/preview-01.eps width=\textwidth
10500     * @image html img/widget/entry/preview-02.png
10501     * @image latex img/widget/entry/preview-02.eps width=\textwidth
10502     * @image html img/widget/entry/preview-03.png
10503     * @image latex img/widget/entry/preview-03.eps width=\textwidth
10504     *
10505     * An entry is a convenience widget which shows a box that the user can
10506     * enter text into. Entries by default don't scroll, so they grow to
10507     * accomodate the entire text, resizing the parent window as needed. This
10508     * can be changed with the elm_entry_scrollable_set() function.
10509     *
10510     * They can also be single line or multi line (the default) and when set
10511     * to multi line mode they support text wrapping in any of the modes
10512     * indicated by #Elm_Wrap_Type.
10513     *
10514     * Other features include password mode, filtering of inserted text with
10515     * elm_entry_text_filter_append() and related functions, inline "items" and
10516     * formatted markup text.
10517     *
10518     * @section entry-markup Formatted text
10519     *
10520     * The markup tags supported by the Entry are defined by the theme, but
10521     * even when writing new themes or extensions it's a good idea to stick to
10522     * a sane default, to maintain coherency and avoid application breakages.
10523     * Currently defined by the default theme are the following tags:
10524     * @li \<br\>: Inserts a line break.
10525     * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10526     * breaks.
10527     * @li \<tab\>: Inserts a tab.
10528     * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10529     * enclosed text.
10530     * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10531     * @li \<link\>...\</link\>: Underlines the enclosed text.
10532     * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10533     *
10534     * @section entry-special Special markups
10535     *
10536     * Besides those used to format text, entries support two special markup
10537     * tags used to insert clickable portions of text or items inlined within
10538     * the text.
10539     *
10540     * @subsection entry-anchors Anchors
10541     *
10542     * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10543     * \</a\> tags and an event will be generated when this text is clicked,
10544     * like this:
10545     *
10546     * @code
10547     * This text is outside <a href=anc-01>but this one is an anchor</a>
10548     * @endcode
10549     *
10550     * The @c href attribute in the opening tag gives the name that will be
10551     * used to identify the anchor and it can be any valid utf8 string.
10552     *
10553     * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10554     * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10555     * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10556     * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10557     * an anchor.
10558     *
10559     * @subsection entry-items Items
10560     *
10561     * Inlined in the text, any other @c Evas_Object can be inserted by using
10562     * \<item\> tags this way:
10563     *
10564     * @code
10565     * <item size=16x16 vsize=full href=emoticon/haha></item>
10566     * @endcode
10567     *
10568     * Just like with anchors, the @c href identifies each item, but these need,
10569     * in addition, to indicate their size, which is done using any one of
10570     * @c size, @c absize or @c relsize attributes. These attributes take their
10571     * value in the WxH format, where W is the width and H the height of the
10572     * item.
10573     *
10574     * @li absize: Absolute pixel size for the item. Whatever value is set will
10575     * be the item's size regardless of any scale value the object may have
10576     * been set to. The final line height will be adjusted to fit larger items.
10577     * @li size: Similar to @c absize, but it's adjusted to the scale value set
10578     * for the object.
10579     * @li relsize: Size is adjusted for the item to fit within the current
10580     * line height.
10581     *
10582     * Besides their size, items are specificed a @c vsize value that affects
10583     * how their final size and position are calculated. The possible values
10584     * are:
10585     * @li ascent: Item will be placed within the line's baseline and its
10586     * ascent. That is, the height between the line where all characters are
10587     * positioned and the highest point in the line. For @c size and @c absize
10588     * items, the descent value will be added to the total line height to make
10589     * them fit. @c relsize items will be adjusted to fit within this space.
10590     * @li full: Items will be placed between the descent and ascent, or the
10591     * lowest point in the line and its highest.
10592     *
10593     * The next image shows different configurations of items and how they
10594     * are the previously mentioned options affect their sizes. In all cases,
10595     * the green line indicates the ascent, blue for the baseline and red for
10596     * the descent.
10597     *
10598     * @image html entry_item.png
10599     * @image latex entry_item.eps width=\textwidth
10600     *
10601     * And another one to show how size differs from absize. In the first one,
10602     * the scale value is set to 1.0, while the second one is using one of 2.0.
10603     *
10604     * @image html entry_item_scale.png
10605     * @image latex entry_item_scale.eps width=\textwidth
10606     *
10607     * After the size for an item is calculated, the entry will request an
10608     * object to place in its space. For this, the functions set with
10609     * elm_entry_item_provider_append() and related functions will be called
10610     * in order until one of them returns a @c non-NULL value. If no providers
10611     * are available, or all of them return @c NULL, then the entry falls back
10612     * to one of the internal defaults, provided the name matches with one of
10613     * them.
10614     *
10615     * All of the following are currently supported:
10616     *
10617     * - emoticon/angry
10618     * - emoticon/angry-shout
10619     * - emoticon/crazy-laugh
10620     * - emoticon/evil-laugh
10621     * - emoticon/evil
10622     * - emoticon/goggle-smile
10623     * - emoticon/grumpy
10624     * - emoticon/grumpy-smile
10625     * - emoticon/guilty
10626     * - emoticon/guilty-smile
10627     * - emoticon/haha
10628     * - emoticon/half-smile
10629     * - emoticon/happy-panting
10630     * - emoticon/happy
10631     * - emoticon/indifferent
10632     * - emoticon/kiss
10633     * - emoticon/knowing-grin
10634     * - emoticon/laugh
10635     * - emoticon/little-bit-sorry
10636     * - emoticon/love-lots
10637     * - emoticon/love
10638     * - emoticon/minimal-smile
10639     * - emoticon/not-happy
10640     * - emoticon/not-impressed
10641     * - emoticon/omg
10642     * - emoticon/opensmile
10643     * - emoticon/smile
10644     * - emoticon/sorry
10645     * - emoticon/squint-laugh
10646     * - emoticon/surprised
10647     * - emoticon/suspicious
10648     * - emoticon/tongue-dangling
10649     * - emoticon/tongue-poke
10650     * - emoticon/uh
10651     * - emoticon/unhappy
10652     * - emoticon/very-sorry
10653     * - emoticon/what
10654     * - emoticon/wink
10655     * - emoticon/worried
10656     * - emoticon/wtf
10657     *
10658     * Alternatively, an item may reference an image by its path, using
10659     * the URI form @c file:///path/to/an/image.png and the entry will then
10660     * use that image for the item.
10661     *
10662     * @section entry-files Loading and saving files
10663     *
10664     * Entries have convinience functions to load text from a file and save
10665     * changes back to it after a short delay. The automatic saving is enabled
10666     * by default, but can be disabled with elm_entry_autosave_set() and files
10667     * can be loaded directly as plain text or have any markup in them
10668     * recognized. See elm_entry_file_set() for more details.
10669     *
10670     * @section entry-signals Emitted signals
10671     *
10672     * This widget emits the following signals:
10673     *
10674     * @li "changed": The text within the entry was changed.
10675     * @li "changed,user": The text within the entry was changed because of user interaction.
10676     * @li "activated": The enter key was pressed on a single line entry.
10677     * @li "press": A mouse button has been pressed on the entry.
10678     * @li "longpressed": A mouse button has been pressed and held for a couple
10679     * seconds.
10680     * @li "clicked": The entry has been clicked (mouse press and release).
10681     * @li "clicked,double": The entry has been double clicked.
10682     * @li "clicked,triple": The entry has been triple clicked.
10683     * @li "focused": The entry has received focus.
10684     * @li "unfocused": The entry has lost focus.
10685     * @li "selection,paste": A paste of the clipboard contents was requested.
10686     * @li "selection,copy": A copy of the selected text into the clipboard was
10687     * requested.
10688     * @li "selection,cut": A cut of the selected text into the clipboard was
10689     * requested.
10690     * @li "selection,start": A selection has begun and no previous selection
10691     * existed.
10692     * @li "selection,changed": The current selection has changed.
10693     * @li "selection,cleared": The current selection has been cleared.
10694     * @li "cursor,changed": The cursor has changed position.
10695     * @li "anchor,clicked": An anchor has been clicked. The event_info
10696     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10697     * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10698     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10699     * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10700     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10701     * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10702     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10703     * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10704     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10705     * @li "preedit,changed": The preedit string has changed.
10706     *
10707     * @section entry-examples
10708     *
10709     * An overview of the Entry API can be seen in @ref entry_example_01
10710     *
10711     * @{
10712     */
10713    /**
10714     * @typedef Elm_Entry_Anchor_Info
10715     *
10716     * The info sent in the callback for the "anchor,clicked" signals emitted
10717     * by entries.
10718     */
10719    typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10720    /**
10721     * @struct _Elm_Entry_Anchor_Info
10722     *
10723     * The info sent in the callback for the "anchor,clicked" signals emitted
10724     * by entries.
10725     */
10726    struct _Elm_Entry_Anchor_Info
10727      {
10728         const char *name; /**< The name of the anchor, as stated in its href */
10729         int         button; /**< The mouse button used to click on it */
10730         Evas_Coord  x, /**< Anchor geometry, relative to canvas */
10731                     y, /**< Anchor geometry, relative to canvas */
10732                     w, /**< Anchor geometry, relative to canvas */
10733                     h; /**< Anchor geometry, relative to canvas */
10734      };
10735    /**
10736     * @typedef Elm_Entry_Filter_Cb
10737     * This callback type is used by entry filters to modify text.
10738     * @param data The data specified as the last param when adding the filter
10739     * @param entry The entry object
10740     * @param text A pointer to the location of the text being filtered. This data can be modified,
10741     * but any additional allocations must be managed by the user.
10742     * @see elm_entry_text_filter_append
10743     * @see elm_entry_text_filter_prepend
10744     */
10745    typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
10746
10747    /**
10748     * This adds an entry to @p parent object.
10749     *
10750     * By default, entries are:
10751     * @li not scrolled
10752     * @li multi-line
10753     * @li word wrapped
10754     * @li autosave is enabled
10755     *
10756     * @param parent The parent object
10757     * @return The new object or NULL if it cannot be created
10758     */
10759    EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10760    /**
10761     * Sets the entry to single line mode.
10762     *
10763     * In single line mode, entries don't ever wrap when the text reaches the
10764     * edge, and instead they keep growing horizontally. Pressing the @c Enter
10765     * key will generate an @c "activate" event instead of adding a new line.
10766     *
10767     * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
10768     * and pressing enter will break the text into a different line
10769     * without generating any events.
10770     *
10771     * @param obj The entry object
10772     * @param single_line If true, the text in the entry
10773     * will be on a single line.
10774     */
10775    EAPI void         elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
10776    /**
10777     * Gets whether the entry is set to be single line.
10778     *
10779     * @param obj The entry object
10780     * @return single_line If true, the text in the entry is set to display
10781     * on a single line.
10782     *
10783     * @see elm_entry_single_line_set()
10784     */
10785    EAPI Eina_Bool    elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10786    /**
10787     * Sets the entry to password mode.
10788     *
10789     * In password mode, entries are implicitly single line and the display of
10790     * any text in them is replaced with asterisks (*).
10791     *
10792     * @param obj The entry object
10793     * @param password If true, password mode is enabled.
10794     */
10795    EAPI void         elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
10796    /**
10797     * Gets whether the entry is set to password mode.
10798     *
10799     * @param obj The entry object
10800     * @return If true, the entry is set to display all characters
10801     * as asterisks (*).
10802     *
10803     * @see elm_entry_password_set()
10804     */
10805    EAPI Eina_Bool    elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10806    /**
10807     * This sets the text displayed within the entry to @p entry.
10808     *
10809     * @param obj The entry object
10810     * @param entry The text to be displayed
10811     *
10812     * @deprecated Use elm_object_text_set() instead.
10813     */
10814    EAPI void         elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10815    /**
10816     * This returns the text currently shown in object @p entry.
10817     * See also elm_entry_entry_set().
10818     *
10819     * @param obj The entry object
10820     * @return The currently displayed text or NULL on failure
10821     *
10822     * @deprecated Use elm_object_text_get() instead.
10823     */
10824    EAPI const char  *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10825    /**
10826     * Appends @p entry to the text of the entry.
10827     *
10828     * Adds the text in @p entry to the end of any text already present in the
10829     * widget.
10830     *
10831     * The appended text is subject to any filters set for the widget.
10832     *
10833     * @param obj The entry object
10834     * @param entry The text to be displayed
10835     *
10836     * @see elm_entry_text_filter_append()
10837     */
10838    EAPI void         elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10839    /**
10840     * Gets whether the entry is empty.
10841     *
10842     * Empty means no text at all. If there are any markup tags, like an item
10843     * tag for which no provider finds anything, and no text is displayed, this
10844     * function still returns EINA_FALSE.
10845     *
10846     * @param obj The entry object
10847     * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
10848     */
10849    EAPI Eina_Bool    elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10850    /**
10851     * Gets any selected text within the entry.
10852     *
10853     * If there's any selected text in the entry, this function returns it as
10854     * a string in markup format. NULL is returned if no selection exists or
10855     * if an error occurred.
10856     *
10857     * The returned value points to an internal string and should not be freed
10858     * or modified in any way. If the @p entry object is deleted or its
10859     * contents are changed, the returned pointer should be considered invalid.
10860     *
10861     * @param obj The entry object
10862     * @return The selected text within the entry or NULL on failure
10863     */
10864    EAPI const char  *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10865    /**
10866     * Inserts the given text into the entry at the current cursor position.
10867     *
10868     * This inserts text at the cursor position as if it was typed
10869     * by the user (note that this also allows markup which a user
10870     * can't just "type" as it would be converted to escaped text, so this
10871     * call can be used to insert things like emoticon items or bold push/pop
10872     * tags, other font and color change tags etc.)
10873     *
10874     * If any selection exists, it will be replaced by the inserted text.
10875     *
10876     * The inserted text is subject to any filters set for the widget.
10877     *
10878     * @param obj The entry object
10879     * @param entry The text to insert
10880     *
10881     * @see elm_entry_text_filter_append()
10882     */
10883    EAPI void         elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10884    /**
10885     * Set the line wrap type to use on multi-line entries.
10886     *
10887     * Sets the wrap type used by the entry to any of the specified in
10888     * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
10889     * line (without inserting a line break or paragraph separator) when it
10890     * reaches the far edge of the widget.
10891     *
10892     * Note that this only makes sense for multi-line entries. A widget set
10893     * to be single line will never wrap.
10894     *
10895     * @param obj The entry object
10896     * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
10897     */
10898    EAPI void         elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
10899    /**
10900     * Gets the wrap mode the entry was set to use.
10901     *
10902     * @param obj The entry object
10903     * @return Wrap type
10904     *
10905     * @see also elm_entry_line_wrap_set()
10906     */
10907    EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10908    /**
10909     * Sets if the entry is to be editable or not.
10910     *
10911     * By default, entries are editable and when focused, any text input by the
10912     * user will be inserted at the current cursor position. But calling this
10913     * function with @p editable as EINA_FALSE will prevent the user from
10914     * inputting text into the entry.
10915     *
10916     * The only way to change the text of a non-editable entry is to use
10917     * elm_object_text_set(), elm_entry_entry_insert() and other related
10918     * functions.
10919     *
10920     * @param obj The entry object
10921     * @param editable If EINA_TRUE, user input will be inserted in the entry,
10922     * if not, the entry is read-only and no user input is allowed.
10923     */
10924    EAPI void         elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
10925    /**
10926     * Gets whether the entry is editable or not.
10927     *
10928     * @param obj The entry object
10929     * @return If true, the entry is editable by the user.
10930     * If false, it is not editable by the user
10931     *
10932     * @see elm_entry_editable_set()
10933     */
10934    EAPI Eina_Bool    elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10935    /**
10936     * This drops any existing text selection within the entry.
10937     *
10938     * @param obj The entry object
10939     */
10940    EAPI void         elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
10941    /**
10942     * This selects all text within the entry.
10943     *
10944     * @param obj The entry object
10945     */
10946    EAPI void         elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
10947    /**
10948     * This moves the cursor one place to the right within the entry.
10949     *
10950     * @param obj The entry object
10951     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10952     */
10953    EAPI Eina_Bool    elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
10954    /**
10955     * This moves the cursor one place to the left within the entry.
10956     *
10957     * @param obj The entry object
10958     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10959     */
10960    EAPI Eina_Bool    elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
10961    /**
10962     * This moves the cursor one line up within the entry.
10963     *
10964     * @param obj The entry object
10965     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10966     */
10967    EAPI Eina_Bool    elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
10968    /**
10969     * This moves the cursor one line down within the entry.
10970     *
10971     * @param obj The entry object
10972     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10973     */
10974    EAPI Eina_Bool    elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
10975    /**
10976     * This moves the cursor to the beginning of the entry.
10977     *
10978     * @param obj The entry object
10979     */
10980    EAPI void         elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10981    /**
10982     * This moves the cursor to the end of the entry.
10983     *
10984     * @param obj The entry object
10985     */
10986    EAPI void         elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10987    /**
10988     * This moves the cursor to the beginning of the current line.
10989     *
10990     * @param obj The entry object
10991     */
10992    EAPI void         elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10993    /**
10994     * This moves the cursor to the end of the current line.
10995     *
10996     * @param obj The entry object
10997     */
10998    EAPI void         elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10999    /**
11000     * This begins a selection within the entry as though
11001     * the user were holding down the mouse button to make a selection.
11002     *
11003     * @param obj The entry object
11004     */
11005    EAPI void         elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11006    /**
11007     * This ends a selection within the entry as though
11008     * the user had just released the mouse button while making a selection.
11009     *
11010     * @param obj The entry object
11011     */
11012    EAPI void         elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11013    /**
11014     * Gets whether a format node exists at the current cursor position.
11015     *
11016     * A format node is anything that defines how the text is rendered. It can
11017     * be a visible format node, such as a line break or a paragraph separator,
11018     * or an invisible one, such as bold begin or end tag.
11019     * This function returns whether any format node exists at the current
11020     * cursor position.
11021     *
11022     * @param obj The entry object
11023     * @return EINA_TRUE if the current cursor position contains a format node,
11024     * EINA_FALSE otherwise.
11025     *
11026     * @see elm_entry_cursor_is_visible_format_get()
11027     */
11028    EAPI Eina_Bool    elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11029    /**
11030     * Gets if the current cursor position holds a visible format node.
11031     *
11032     * @param obj The entry object
11033     * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11034     * if it's an invisible one or no format exists.
11035     *
11036     * @see elm_entry_cursor_is_format_get()
11037     */
11038    EAPI Eina_Bool    elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11039    /**
11040     * Gets the character pointed by the cursor at its current position.
11041     *
11042     * This function returns a string with the utf8 character stored at the
11043     * current cursor position.
11044     * Only the text is returned, any format that may exist will not be part
11045     * of the return value.
11046     *
11047     * @param obj The entry object
11048     * @return The text pointed by the cursors.
11049     */
11050    EAPI const char  *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11051    /**
11052     * This function returns the geometry of the cursor.
11053     *
11054     * It's useful if you want to draw something on the cursor (or where it is),
11055     * or for example in the case of scrolled entry where you want to show the
11056     * cursor.
11057     *
11058     * @param obj The entry object
11059     * @param x returned geometry
11060     * @param y returned geometry
11061     * @param w returned geometry
11062     * @param h returned geometry
11063     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11064     */
11065    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);
11066    /**
11067     * Sets the cursor position in the entry to the given value
11068     *
11069     * The value in @p pos is the index of the character position within the
11070     * contents of the string as returned by elm_entry_cursor_pos_get().
11071     *
11072     * @param obj The entry object
11073     * @param pos The position of the cursor
11074     */
11075    EAPI void         elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11076    /**
11077     * Retrieves the current position of the cursor in the entry
11078     *
11079     * @param obj The entry object
11080     * @return The cursor position
11081     */
11082    EAPI int          elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11083    /**
11084     * This executes a "cut" action on the selected text in the entry.
11085     *
11086     * @param obj The entry object
11087     */
11088    EAPI void         elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11089    /**
11090     * This executes a "copy" action on the selected text in the entry.
11091     *
11092     * @param obj The entry object
11093     */
11094    EAPI void         elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11095    /**
11096     * This executes a "paste" action in the entry.
11097     *
11098     * @param obj The entry object
11099     */
11100    EAPI void         elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11101    /**
11102     * This clears and frees the items in a entry's contextual (longpress)
11103     * menu.
11104     *
11105     * @param obj The entry object
11106     *
11107     * @see elm_entry_context_menu_item_add()
11108     */
11109    EAPI void         elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11110    /**
11111     * This adds an item to the entry's contextual menu.
11112     *
11113     * A longpress on an entry will make the contextual menu show up, if this
11114     * hasn't been disabled with elm_entry_context_menu_disabled_set().
11115     * By default, this menu provides a few options like enabling selection mode,
11116     * which is useful on embedded devices that need to be explicit about it,
11117     * and when a selection exists it also shows the copy and cut actions.
11118     *
11119     * With this function, developers can add other options to this menu to
11120     * perform any action they deem necessary.
11121     *
11122     * @param obj The entry object
11123     * @param label The item's text label
11124     * @param icon_file The item's icon file
11125     * @param icon_type The item's icon type
11126     * @param func The callback to execute when the item is clicked
11127     * @param data The data to associate with the item for related functions
11128     */
11129    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);
11130    /**
11131     * This disables the entry's contextual (longpress) menu.
11132     *
11133     * @param obj The entry object
11134     * @param disabled If true, the menu is disabled
11135     */
11136    EAPI void         elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11137    /**
11138     * This returns whether the entry's contextual (longpress) menu is
11139     * disabled.
11140     *
11141     * @param obj The entry object
11142     * @return If true, the menu is disabled
11143     */
11144    EAPI Eina_Bool    elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11145    /**
11146     * This appends a custom item provider to the list for that entry
11147     *
11148     * This appends the given callback. The list is walked from beginning to end
11149     * with each function called given the item href string in the text. If the
11150     * function returns an object handle other than NULL (it should create an
11151     * object to do this), then this object is used to replace that item. If
11152     * not the next provider is called until one provides an item object, or the
11153     * default provider in entry does.
11154     *
11155     * @param obj The entry object
11156     * @param func The function called to provide the item object
11157     * @param data The data passed to @p func
11158     *
11159     * @see @ref entry-items
11160     */
11161    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);
11162    /**
11163     * This prepends a custom item provider to the list for that entry
11164     *
11165     * This prepends the given callback. See elm_entry_item_provider_append() for
11166     * more information
11167     *
11168     * @param obj The entry object
11169     * @param func The function called to provide the item object
11170     * @param data The data passed to @p func
11171     */
11172    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);
11173    /**
11174     * This removes a custom item provider to the list for that entry
11175     *
11176     * This removes the given callback. See elm_entry_item_provider_append() for
11177     * more information
11178     *
11179     * @param obj The entry object
11180     * @param func The function called to provide the item object
11181     * @param data The data passed to @p func
11182     */
11183    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);
11184    /**
11185     * Append a filter function for text inserted in the entry
11186     *
11187     * Append the given callback to the list. This functions will be called
11188     * whenever any text is inserted into the entry, with the text to be inserted
11189     * as a parameter. The callback function is free to alter the text in any way
11190     * it wants, but it must remember to free the given pointer and update it.
11191     * If the new text is to be discarded, the function can free it and set its
11192     * text parameter to NULL. This will also prevent any following filters from
11193     * being called.
11194     *
11195     * @param obj The entry object
11196     * @param func The function to use as text filter
11197     * @param data User data to pass to @p func
11198     */
11199    EAPI void         elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11200    /**
11201     * Prepend a filter function for text insdrted in the entry
11202     *
11203     * Prepend the given callback to the list. See elm_entry_text_filter_append()
11204     * for more information
11205     *
11206     * @param obj The entry object
11207     * @param func The function to use as text filter
11208     * @param data User data to pass to @p func
11209     */
11210    EAPI void         elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11211    /**
11212     * Remove a filter from the list
11213     *
11214     * Removes the given callback from the filter list. See
11215     * elm_entry_text_filter_append() for more information.
11216     *
11217     * @param obj The entry object
11218     * @param func The filter function to remove
11219     * @param data The user data passed when adding the function
11220     */
11221    EAPI void         elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11222    /**
11223     * This converts a markup (HTML-like) string into UTF-8.
11224     *
11225     * The returned string is a malloc'ed buffer and it should be freed when
11226     * not needed anymore.
11227     *
11228     * @param s The string (in markup) to be converted
11229     * @return The converted string (in UTF-8). It should be freed.
11230     */
11231    EAPI char        *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11232    /**
11233     * This converts a UTF-8 string into markup (HTML-like).
11234     *
11235     * The returned string is a malloc'ed buffer and it should be freed when
11236     * not needed anymore.
11237     *
11238     * @param s The string (in UTF-8) to be converted
11239     * @return The converted string (in markup). It should be freed.
11240     */
11241    EAPI char        *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11242    /**
11243     * This sets the file (and implicitly loads it) for the text to display and
11244     * then edit. All changes are written back to the file after a short delay if
11245     * the entry object is set to autosave (which is the default).
11246     *
11247     * If the entry had any other file set previously, any changes made to it
11248     * will be saved if the autosave feature is enabled, otherwise, the file
11249     * will be silently discarded and any non-saved changes will be lost.
11250     *
11251     * @param obj The entry object
11252     * @param file The path to the file to load and save
11253     * @param format The file format
11254     */
11255    EAPI void         elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11256    /**
11257     * Gets the file being edited by the entry.
11258     *
11259     * This function can be used to retrieve any file set on the entry for
11260     * edition, along with the format used to load and save it.
11261     *
11262     * @param obj The entry object
11263     * @param file The path to the file to load and save
11264     * @param format The file format
11265     */
11266    EAPI void         elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11267    /**
11268     * This function writes any changes made to the file set with
11269     * elm_entry_file_set()
11270     *
11271     * @param obj The entry object
11272     */
11273    EAPI void         elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11274    /**
11275     * This sets the entry object to 'autosave' the loaded text file or not.
11276     *
11277     * @param obj The entry object
11278     * @param autosave Autosave the loaded file or not
11279     *
11280     * @see elm_entry_file_set()
11281     */
11282    EAPI void         elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11283    /**
11284     * This gets the entry object's 'autosave' status.
11285     *
11286     * @param obj The entry object
11287     * @return Autosave the loaded file or not
11288     *
11289     * @see elm_entry_file_set()
11290     */
11291    EAPI Eina_Bool    elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11292    /**
11293     * Control pasting of text and images for the widget.
11294     *
11295     * Normally the entry allows both text and images to be pasted.  By setting
11296     * textonly to be true, this prevents images from being pasted.
11297     *
11298     * Note this only changes the behaviour of text.
11299     *
11300     * @param obj The entry object
11301     * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11302     * text+image+other.
11303     */
11304    EAPI void         elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11305    /**
11306     * Getting elm_entry text paste/drop mode.
11307     *
11308     * In textonly mode, only text may be pasted or dropped into the widget.
11309     *
11310     * @param obj The entry object
11311     * @return If the widget only accepts text from pastes.
11312     */
11313    EAPI Eina_Bool    elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11314    /**
11315     * Enable or disable scrolling in entry
11316     *
11317     * Normally the entry is not scrollable unless you enable it with this call.
11318     *
11319     * @param obj The entry object
11320     * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11321     */
11322    EAPI void         elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11323    /**
11324     * Get the scrollable state of the entry
11325     *
11326     * Normally the entry is not scrollable. This gets the scrollable state
11327     * of the entry. See elm_entry_scrollable_set() for more information.
11328     *
11329     * @param obj The entry object
11330     * @return The scrollable state
11331     */
11332    EAPI Eina_Bool    elm_entry_scrollable_get(const Evas_Object *obj);
11333    /**
11334     * This sets a widget to be displayed to the left of a scrolled entry.
11335     *
11336     * @param obj The scrolled entry object
11337     * @param icon The widget to display on the left side of the scrolled
11338     * entry.
11339     *
11340     * @note A previously set widget will be destroyed.
11341     * @note If the object being set does not have minimum size hints set,
11342     * it won't get properly displayed.
11343     *
11344     * @see elm_entry_end_set()
11345     */
11346    EAPI void         elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11347    /**
11348     * Gets the leftmost widget of the scrolled entry. This object is
11349     * owned by the scrolled entry and should not be modified.
11350     *
11351     * @param obj The scrolled entry object
11352     * @return the left widget inside the scroller
11353     */
11354    EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11355    /**
11356     * Unset the leftmost widget of the scrolled entry, unparenting and
11357     * returning it.
11358     *
11359     * @param obj The scrolled entry object
11360     * @return the previously set icon sub-object of this entry, on
11361     * success.
11362     *
11363     * @see elm_entry_icon_set()
11364     */
11365    EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11366    /**
11367     * Sets the visibility of the left-side widget of the scrolled entry,
11368     * set by elm_entry_icon_set().
11369     *
11370     * @param obj The scrolled entry object
11371     * @param setting EINA_TRUE if the object should be displayed,
11372     * EINA_FALSE if not.
11373     */
11374    EAPI void         elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11375    /**
11376     * This sets a widget to be displayed to the end of a scrolled entry.
11377     *
11378     * @param obj The scrolled entry object
11379     * @param end The widget to display on the right side of the scrolled
11380     * entry.
11381     *
11382     * @note A previously set widget will be destroyed.
11383     * @note If the object being set does not have minimum size hints set,
11384     * it won't get properly displayed.
11385     *
11386     * @see elm_entry_icon_set
11387     */
11388    EAPI void         elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11389    /**
11390     * Gets the endmost widget of the scrolled entry. This object is owned
11391     * by the scrolled entry and should not be modified.
11392     *
11393     * @param obj The scrolled entry object
11394     * @return the right widget inside the scroller
11395     */
11396    EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11397    /**
11398     * Unset the endmost widget of the scrolled entry, unparenting and
11399     * returning it.
11400     *
11401     * @param obj The scrolled entry object
11402     * @return the previously set icon sub-object of this entry, on
11403     * success.
11404     *
11405     * @see elm_entry_icon_set()
11406     */
11407    EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11408    /**
11409     * Sets the visibility of the end widget of the scrolled entry, set by
11410     * elm_entry_end_set().
11411     *
11412     * @param obj The scrolled entry object
11413     * @param setting EINA_TRUE if the object should be displayed,
11414     * EINA_FALSE if not.
11415     */
11416    EAPI void         elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11417    /**
11418     * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11419     * them).
11420     *
11421     * Setting an entry to single-line mode with elm_entry_single_line_set()
11422     * will automatically disable the display of scrollbars when the entry
11423     * moves inside its scroller.
11424     *
11425     * @param obj The scrolled entry object
11426     * @param h The horizontal scrollbar policy to apply
11427     * @param v The vertical scrollbar policy to apply
11428     */
11429    EAPI void         elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11430    /**
11431     * This enables/disables bouncing within the entry.
11432     *
11433     * This function sets whether the entry will bounce when scrolling reaches
11434     * the end of the contained entry.
11435     *
11436     * @param obj The scrolled entry object
11437     * @param h The horizontal bounce state
11438     * @param v The vertical bounce state
11439     */
11440    EAPI void         elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11441    /**
11442     * Get the bounce mode
11443     *
11444     * @param obj The Entry object
11445     * @param h_bounce Allow bounce horizontally
11446     * @param v_bounce Allow bounce vertically
11447     */
11448    EAPI void         elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11449
11450    /* pre-made filters for entries */
11451    /**
11452     * @typedef Elm_Entry_Filter_Limit_Size
11453     *
11454     * Data for the elm_entry_filter_limit_size() entry filter.
11455     */
11456    typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11457    /**
11458     * @struct _Elm_Entry_Filter_Limit_Size
11459     *
11460     * Data for the elm_entry_filter_limit_size() entry filter.
11461     */
11462    struct _Elm_Entry_Filter_Limit_Size
11463      {
11464         int max_char_count; /**< The maximum number of characters allowed. */
11465         int max_byte_count; /**< The maximum number of bytes allowed*/
11466      };
11467    /**
11468     * Filter inserted text based on user defined character and byte limits
11469     *
11470     * Add this filter to an entry to limit the characters that it will accept
11471     * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11472     * The funtion works on the UTF-8 representation of the string, converting
11473     * it from the set markup, thus not accounting for any format in it.
11474     *
11475     * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11476     * it as data when setting the filter. In it, it's possible to set limits
11477     * by character count or bytes (any of them is disabled if 0), and both can
11478     * be set at the same time. In that case, it first checks for characters,
11479     * then bytes.
11480     *
11481     * The function will cut the inserted text in order to allow only the first
11482     * number of characters that are still allowed. The cut is made in
11483     * characters, even when limiting by bytes, in order to always contain
11484     * valid ones and avoid half unicode characters making it in.
11485     *
11486     * This filter, like any others, does not apply when setting the entry text
11487     * directly with elm_object_text_set() (or the deprecated
11488     * elm_entry_entry_set()).
11489     */
11490    EAPI void         elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11491    /**
11492     * @typedef Elm_Entry_Filter_Accept_Set
11493     *
11494     * Data for the elm_entry_filter_accept_set() entry filter.
11495     */
11496    typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11497    /**
11498     * @struct _Elm_Entry_Filter_Accept_Set
11499     *
11500     * Data for the elm_entry_filter_accept_set() entry filter.
11501     */
11502    struct _Elm_Entry_Filter_Accept_Set
11503      {
11504         const char *accepted; /**< Set of characters accepted in the entry. */
11505         const char *rejected; /**< Set of characters rejected from the entry. */
11506      };
11507    /**
11508     * Filter inserted text based on accepted or rejected sets of characters
11509     *
11510     * Add this filter to an entry to restrict the set of accepted characters
11511     * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11512     * This structure contains both accepted and rejected sets, but they are
11513     * mutually exclusive.
11514     *
11515     * The @c accepted set takes preference, so if it is set, the filter will
11516     * only work based on the accepted characters, ignoring anything in the
11517     * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11518     *
11519     * In both cases, the function filters by matching utf8 characters to the
11520     * raw markup text, so it can be used to remove formatting tags.
11521     *
11522     * This filter, like any others, does not apply when setting the entry text
11523     * directly with elm_object_text_set() (or the deprecated
11524     * elm_entry_entry_set()).
11525     */
11526    EAPI void         elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11527    /**
11528     * Set the input panel layout of the entry
11529     *
11530     * @param obj The entry object
11531     * @param layout layout type
11532     */
11533    EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11534    /**
11535     * Get the input panel layout of the entry
11536     *
11537     * @param obj The entry object
11538     * @return layout type
11539     *
11540     * @see elm_entry_input_panel_layout_set
11541     */
11542    EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11543    /**
11544     * @}
11545     */
11546
11547    /* composite widgets - these basically put together basic widgets above
11548     * in convenient packages that do more than basic stuff */
11549
11550    /* anchorview */
11551    /**
11552     * @defgroup Anchorview Anchorview
11553     *
11554     * @image html img/widget/anchorview/preview-00.png
11555     * @image latex img/widget/anchorview/preview-00.eps
11556     *
11557     * Anchorview is for displaying text that contains markup with anchors
11558     * like <c>\<a href=1234\>something\</\></c> in it.
11559     *
11560     * Besides being styled differently, the anchorview widget provides the
11561     * necessary functionality so that clicking on these anchors brings up a
11562     * popup with user defined content such as "call", "add to contacts" or
11563     * "open web page". This popup is provided using the @ref Hover widget.
11564     *
11565     * This widget is very similar to @ref Anchorblock, so refer to that
11566     * widget for an example. The only difference Anchorview has is that the
11567     * widget is already provided with scrolling functionality, so if the
11568     * text set to it is too large to fit in the given space, it will scroll,
11569     * whereas the @ref Anchorblock widget will keep growing to ensure all the
11570     * text can be displayed.
11571     *
11572     * This widget emits the following signals:
11573     * @li "anchor,clicked": will be called when an anchor is clicked. The
11574     * @p event_info parameter on the callback will be a pointer of type
11575     * ::Elm_Entry_Anchorview_Info.
11576     *
11577     * See @ref Anchorblock for an example on how to use both of them.
11578     *
11579     * @see Anchorblock
11580     * @see Entry
11581     * @see Hover
11582     *
11583     * @{
11584     */
11585    /**
11586     * @typedef Elm_Entry_Anchorview_Info
11587     *
11588     * The info sent in the callback for "anchor,clicked" signals emitted by
11589     * the Anchorview widget.
11590     */
11591    typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11592    /**
11593     * @struct _Elm_Entry_Anchorview_Info
11594     *
11595     * The info sent in the callback for "anchor,clicked" signals emitted by
11596     * the Anchorview widget.
11597     */
11598    struct _Elm_Entry_Anchorview_Info
11599      {
11600         const char     *name; /**< Name of the anchor, as indicated in its href
11601                                    attribute */
11602         int             button; /**< The mouse button used to click on it */
11603         Evas_Object    *hover; /**< The hover object to use for the popup */
11604         struct {
11605              Evas_Coord    x, y, w, h;
11606         } anchor, /**< Geometry selection of text used as anchor */
11607           hover_parent; /**< Geometry of the object used as parent by the
11608                              hover */
11609         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
11610                                              for content on the left side of
11611                                              the hover. Before calling the
11612                                              callback, the widget will make the
11613                                              necessary calculations to check
11614                                              which sides are fit to be set with
11615                                              content, based on the position the
11616                                              hover is activated and its distance
11617                                              to the edges of its parent object
11618                                              */
11619         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
11620                                               the right side of the hover.
11621                                               See @ref hover_left */
11622         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
11623                                             of the hover. See @ref hover_left */
11624         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
11625                                                below the hover. See @ref
11626                                                hover_left */
11627      };
11628    /**
11629     * Add a new Anchorview object
11630     *
11631     * @param parent The parent object
11632     * @return The new object or NULL if it cannot be created
11633     */
11634    EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11635    /**
11636     * Set the text to show in the anchorview
11637     *
11638     * Sets the text of the anchorview to @p text. This text can include markup
11639     * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11640     * text that will be specially styled and react to click events, ended with
11641     * either of \</a\> or \</\>. When clicked, the anchor will emit an
11642     * "anchor,clicked" signal that you can attach a callback to with
11643     * evas_object_smart_callback_add(). The name of the anchor given in the
11644     * event info struct will be the one set in the href attribute, in this
11645     * case, anchorname.
11646     *
11647     * Other markup can be used to style the text in different ways, but it's
11648     * up to the style defined in the theme which tags do what.
11649     * @deprecated use elm_object_text_set() instead.
11650     */
11651    EINA_DEPRECATED EAPI void         elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11652    /**
11653     * Get the markup text set for the anchorview
11654     *
11655     * Retrieves the text set on the anchorview, with markup tags included.
11656     *
11657     * @param obj The anchorview object
11658     * @return The markup text set or @c NULL if nothing was set or an error
11659     * occurred
11660     * @deprecated use elm_object_text_set() instead.
11661     */
11662    EINA_DEPRECATED EAPI const char  *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11663    /**
11664     * Set the parent of the hover popup
11665     *
11666     * Sets the parent object to use by the hover created by the anchorview
11667     * when an anchor is clicked. See @ref Hover for more details on this.
11668     * If no parent is set, the same anchorview object will be used.
11669     *
11670     * @param obj The anchorview object
11671     * @param parent The object to use as parent for the hover
11672     */
11673    EAPI void         elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11674    /**
11675     * Get the parent of the hover popup
11676     *
11677     * Get the object used as parent for the hover created by the anchorview
11678     * widget. See @ref Hover for more details on this.
11679     *
11680     * @param obj The anchorview object
11681     * @return The object used as parent for the hover, NULL if none is set.
11682     */
11683    EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11684    /**
11685     * Set the style that the hover should use
11686     *
11687     * When creating the popup hover, anchorview will request that it's
11688     * themed according to @p style.
11689     *
11690     * @param obj The anchorview object
11691     * @param style The style to use for the underlying hover
11692     *
11693     * @see elm_object_style_set()
11694     */
11695    EAPI void         elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11696    /**
11697     * Get the style that the hover should use
11698     *
11699     * Get the style the hover created by anchorview will use.
11700     *
11701     * @param obj The anchorview object
11702     * @return The style to use by the hover. NULL means the default is used.
11703     *
11704     * @see elm_object_style_set()
11705     */
11706    EAPI const char  *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11707    /**
11708     * Ends the hover popup in the anchorview
11709     *
11710     * When an anchor is clicked, the anchorview widget will create a hover
11711     * object to use as a popup with user provided content. This function
11712     * terminates this popup, returning the anchorview to its normal state.
11713     *
11714     * @param obj The anchorview object
11715     */
11716    EAPI void         elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11717    /**
11718     * Set bouncing behaviour when the scrolled content reaches an edge
11719     *
11720     * Tell the internal scroller object whether it should bounce or not
11721     * when it reaches the respective edges for each axis.
11722     *
11723     * @param obj The anchorview object
11724     * @param h_bounce Whether to bounce or not in the horizontal axis
11725     * @param v_bounce Whether to bounce or not in the vertical axis
11726     *
11727     * @see elm_scroller_bounce_set()
11728     */
11729    EAPI void         elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
11730    /**
11731     * Get the set bouncing behaviour of the internal scroller
11732     *
11733     * Get whether the internal scroller should bounce when the edge of each
11734     * axis is reached scrolling.
11735     *
11736     * @param obj The anchorview object
11737     * @param h_bounce Pointer where to store the bounce state of the horizontal
11738     *                 axis
11739     * @param v_bounce Pointer where to store the bounce state of the vertical
11740     *                 axis
11741     *
11742     * @see elm_scroller_bounce_get()
11743     */
11744    EAPI void         elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
11745    /**
11746     * Appends a custom item provider to the given anchorview
11747     *
11748     * Appends the given function to the list of items providers. This list is
11749     * called, one function at a time, with the given @p data pointer, the
11750     * anchorview object and, in the @p item parameter, the item name as
11751     * referenced in its href string. Following functions in the list will be
11752     * called in order until one of them returns something different to NULL,
11753     * which should be an Evas_Object which will be used in place of the item
11754     * element.
11755     *
11756     * Items in the markup text take the form \<item relsize=16x16 vsize=full
11757     * href=item/name\>\</item\>
11758     *
11759     * @param obj The anchorview object
11760     * @param func The function to add to the list of providers
11761     * @param data User data that will be passed to the callback function
11762     *
11763     * @see elm_entry_item_provider_append()
11764     */
11765    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);
11766    /**
11767     * Prepend a custom item provider to the given anchorview
11768     *
11769     * Like elm_anchorview_item_provider_append(), but it adds the function
11770     * @p func to the beginning of the list, instead of the end.
11771     *
11772     * @param obj The anchorview object
11773     * @param func The function to add to the list of providers
11774     * @param data User data that will be passed to the callback function
11775     */
11776    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);
11777    /**
11778     * Remove a custom item provider from the list of the given anchorview
11779     *
11780     * Removes the function and data pairing that matches @p func and @p data.
11781     * That is, unless the same function and same user data are given, the
11782     * function will not be removed from the list. This allows us to add the
11783     * same callback several times, with different @p data pointers and be
11784     * able to remove them later without conflicts.
11785     *
11786     * @param obj The anchorview object
11787     * @param func The function to remove from the list
11788     * @param data The data matching the function to remove from the list
11789     */
11790    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);
11791    /**
11792     * @}
11793     */
11794
11795    /* anchorblock */
11796    /**
11797     * @defgroup Anchorblock Anchorblock
11798     *
11799     * @image html img/widget/anchorblock/preview-00.png
11800     * @image latex img/widget/anchorblock/preview-00.eps
11801     *
11802     * Anchorblock is for displaying text that contains markup with anchors
11803     * like <c>\<a href=1234\>something\</\></c> in it.
11804     *
11805     * Besides being styled differently, the anchorblock widget provides the
11806     * necessary functionality so that clicking on these anchors brings up a
11807     * popup with user defined content such as "call", "add to contacts" or
11808     * "open web page". This popup is provided using the @ref Hover widget.
11809     *
11810     * This widget emits the following signals:
11811     * @li "anchor,clicked": will be called when an anchor is clicked. The
11812     * @p event_info parameter on the callback will be a pointer of type
11813     * ::Elm_Entry_Anchorblock_Info.
11814     *
11815     * @see Anchorview
11816     * @see Entry
11817     * @see Hover
11818     *
11819     * Since examples are usually better than plain words, we might as well
11820     * try @ref tutorial_anchorblock_example "one".
11821     */
11822    /**
11823     * @addtogroup Anchorblock
11824     * @{
11825     */
11826    /**
11827     * @typedef Elm_Entry_Anchorblock_Info
11828     *
11829     * The info sent in the callback for "anchor,clicked" signals emitted by
11830     * the Anchorblock widget.
11831     */
11832    typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
11833    /**
11834     * @struct _Elm_Entry_Anchorblock_Info
11835     *
11836     * The info sent in the callback for "anchor,clicked" signals emitted by
11837     * the Anchorblock widget.
11838     */
11839    struct _Elm_Entry_Anchorblock_Info
11840      {
11841         const char     *name; /**< Name of the anchor, as indicated in its href
11842                                    attribute */
11843         int             button; /**< The mouse button used to click on it */
11844         Evas_Object    *hover; /**< The hover object to use for the popup */
11845         struct {
11846              Evas_Coord    x, y, w, h;
11847         } anchor, /**< Geometry selection of text used as anchor */
11848           hover_parent; /**< Geometry of the object used as parent by the
11849                              hover */
11850         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
11851                                              for content on the left side of
11852                                              the hover. Before calling the
11853                                              callback, the widget will make the
11854                                              necessary calculations to check
11855                                              which sides are fit to be set with
11856                                              content, based on the position the
11857                                              hover is activated and its distance
11858                                              to the edges of its parent object
11859                                              */
11860         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
11861                                               the right side of the hover.
11862                                               See @ref hover_left */
11863         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
11864                                             of the hover. See @ref hover_left */
11865         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
11866                                                below the hover. See @ref
11867                                                hover_left */
11868      };
11869    /**
11870     * Add a new Anchorblock object
11871     *
11872     * @param parent The parent object
11873     * @return The new object or NULL if it cannot be created
11874     */
11875    EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11876    /**
11877     * Set the text to show in the anchorblock
11878     *
11879     * Sets the text of the anchorblock to @p text. This text can include markup
11880     * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
11881     * of text that will be specially styled and react to click events, ended
11882     * with either of \</a\> or \</\>. When clicked, the anchor will emit an
11883     * "anchor,clicked" signal that you can attach a callback to with
11884     * evas_object_smart_callback_add(). The name of the anchor given in the
11885     * event info struct will be the one set in the href attribute, in this
11886     * case, anchorname.
11887     *
11888     * Other markup can be used to style the text in different ways, but it's
11889     * up to the style defined in the theme which tags do what.
11890     * @deprecated use elm_object_text_set() instead.
11891     */
11892    EINA_DEPRECATED EAPI void         elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11893    /**
11894     * Get the markup text set for the anchorblock
11895     *
11896     * Retrieves the text set on the anchorblock, with markup tags included.
11897     *
11898     * @param obj The anchorblock object
11899     * @return The markup text set or @c NULL if nothing was set or an error
11900     * occurred
11901     * @deprecated use elm_object_text_set() instead.
11902     */
11903    EINA_DEPRECATED EAPI const char  *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11904    /**
11905     * Set the parent of the hover popup
11906     *
11907     * Sets the parent object to use by the hover created by the anchorblock
11908     * when an anchor is clicked. See @ref Hover for more details on this.
11909     *
11910     * @param obj The anchorblock object
11911     * @param parent The object to use as parent for the hover
11912     */
11913    EAPI void         elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11914    /**
11915     * Get the parent of the hover popup
11916     *
11917     * Get the object used as parent for the hover created by the anchorblock
11918     * widget. See @ref Hover for more details on this.
11919     * If no parent is set, the same anchorblock object will be used.
11920     *
11921     * @param obj The anchorblock object
11922     * @return The object used as parent for the hover, NULL if none is set.
11923     */
11924    EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11925    /**
11926     * Set the style that the hover should use
11927     *
11928     * When creating the popup hover, anchorblock will request that it's
11929     * themed according to @p style.
11930     *
11931     * @param obj The anchorblock object
11932     * @param style The style to use for the underlying hover
11933     *
11934     * @see elm_object_style_set()
11935     */
11936    EAPI void         elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11937    /**
11938     * Get the style that the hover should use
11939     *
11940     * Get the style the hover created by anchorblock will use.
11941     *
11942     * @param obj The anchorblock object
11943     * @return The style to use by the hover. NULL means the default is used.
11944     *
11945     * @see elm_object_style_set()
11946     */
11947    EAPI const char  *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11948    /**
11949     * Ends the hover popup in the anchorblock
11950     *
11951     * When an anchor is clicked, the anchorblock widget will create a hover
11952     * object to use as a popup with user provided content. This function
11953     * terminates this popup, returning the anchorblock to its normal state.
11954     *
11955     * @param obj The anchorblock object
11956     */
11957    EAPI void         elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11958    /**
11959     * Appends a custom item provider to the given anchorblock
11960     *
11961     * Appends the given function to the list of items providers. This list is
11962     * called, one function at a time, with the given @p data pointer, the
11963     * anchorblock object and, in the @p item parameter, the item name as
11964     * referenced in its href string. Following functions in the list will be
11965     * called in order until one of them returns something different to NULL,
11966     * which should be an Evas_Object which will be used in place of the item
11967     * element.
11968     *
11969     * Items in the markup text take the form \<item relsize=16x16 vsize=full
11970     * href=item/name\>\</item\>
11971     *
11972     * @param obj The anchorblock object
11973     * @param func The function to add to the list of providers
11974     * @param data User data that will be passed to the callback function
11975     *
11976     * @see elm_entry_item_provider_append()
11977     */
11978    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);
11979    /**
11980     * Prepend a custom item provider to the given anchorblock
11981     *
11982     * Like elm_anchorblock_item_provider_append(), but it adds the function
11983     * @p func to the beginning of the list, instead of the end.
11984     *
11985     * @param obj The anchorblock object
11986     * @param func The function to add to the list of providers
11987     * @param data User data that will be passed to the callback function
11988     */
11989    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);
11990    /**
11991     * Remove a custom item provider from the list of the given anchorblock
11992     *
11993     * Removes the function and data pairing that matches @p func and @p data.
11994     * That is, unless the same function and same user data are given, the
11995     * function will not be removed from the list. This allows us to add the
11996     * same callback several times, with different @p data pointers and be
11997     * able to remove them later without conflicts.
11998     *
11999     * @param obj The anchorblock object
12000     * @param func The function to remove from the list
12001     * @param data The data matching the function to remove from the list
12002     */
12003    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);
12004    /**
12005     * @}
12006     */
12007
12008    /**
12009     * @defgroup Bubble Bubble
12010     *
12011     * @image html img/widget/bubble/preview-00.png
12012     * @image latex img/widget/bubble/preview-00.eps
12013     * @image html img/widget/bubble/preview-01.png
12014     * @image latex img/widget/bubble/preview-01.eps
12015     * @image html img/widget/bubble/preview-02.png
12016     * @image latex img/widget/bubble/preview-02.eps
12017     *
12018     * @brief The Bubble is a widget to show text similarly to how speech is
12019     * represented in comics.
12020     *
12021     * The bubble widget contains 5 important visual elements:
12022     * @li The frame is a rectangle with rounded rectangles and an "arrow".
12023     * @li The @p icon is an image to which the frame's arrow points to.
12024     * @li The @p label is a text which appears to the right of the icon if the
12025     * corner is "top_left" or "bottom_left" and is right aligned to the frame
12026     * otherwise.
12027     * @li The @p info is a text which appears to the right of the label. Info's
12028     * font is of a ligther color than label.
12029     * @li The @p content is an evas object that is shown inside the frame.
12030     *
12031     * The position of the arrow, icon, label and info depends on which corner is
12032     * selected. The four available corners are:
12033     * @li "top_left" - Default
12034     * @li "top_right"
12035     * @li "bottom_left"
12036     * @li "bottom_right"
12037     *
12038     * Signals that you can add callbacks for are:
12039     * @li "clicked" - This is called when a user has clicked the bubble.
12040     *
12041     * For an example of using a buble see @ref bubble_01_example_page "this".
12042     *
12043     * @{
12044     */
12045    /**
12046     * Add a new bubble to the parent
12047     *
12048     * @param parent The parent object
12049     * @return The new object or NULL if it cannot be created
12050     *
12051     * This function adds a text bubble to the given parent evas object.
12052     */
12053    EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12054    /**
12055     * Set the label of the bubble
12056     *
12057     * @param obj The bubble object
12058     * @param label The string to set in the label
12059     *
12060     * This function sets the title of the bubble. Where this appears depends on
12061     * the selected corner.
12062     * @deprecated use elm_object_text_set() instead.
12063     */
12064    EINA_DEPRECATED EAPI void         elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12065    /**
12066     * Get the label of the bubble
12067     *
12068     * @param obj The bubble object
12069     * @return The string of set in the label
12070     *
12071     * This function gets the title of the bubble.
12072     * @deprecated use elm_object_text_get() instead.
12073     */
12074    EINA_DEPRECATED EAPI const char  *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12075    /**
12076     * Set the info of the bubble
12077     *
12078     * @param obj The bubble object
12079     * @param info The given info about the bubble
12080     *
12081     * This function sets the info of the bubble. Where this appears depends on
12082     * the selected corner.
12083     * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
12084     */
12085    EINA_DEPRECATED EAPI void         elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12086    /**
12087     * Get the info of the bubble
12088     *
12089     * @param obj The bubble object
12090     *
12091     * @return The "info" string of the bubble
12092     *
12093     * This function gets the info text.
12094     * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
12095     */
12096    EINA_DEPRECATED EAPI const char  *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12097    /**
12098     * Set the content to be shown in the bubble
12099     *
12100     * Once the content object is set, a previously set one will be deleted.
12101     * If you want to keep the old content object, use the
12102     * elm_bubble_content_unset() function.
12103     *
12104     * @param obj The bubble object
12105     * @param content The given content of the bubble
12106     *
12107     * This function sets the content shown on the middle of the bubble.
12108     */
12109    EAPI void         elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12110    /**
12111     * Get the content shown in the bubble
12112     *
12113     * Return the content object which is set for this widget.
12114     *
12115     * @param obj The bubble object
12116     * @return The content that is being used
12117     */
12118    EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12119    /**
12120     * Unset the content shown in the bubble
12121     *
12122     * Unparent and return the content object which was set for this widget.
12123     *
12124     * @param obj The bubble object
12125     * @return The content that was being used
12126     */
12127    EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12128    /**
12129     * Set the icon of the bubble
12130     *
12131     * Once the icon object is set, a previously set one will be deleted.
12132     * If you want to keep the old content object, use the
12133     * elm_icon_content_unset() function.
12134     *
12135     * @param obj The bubble object
12136     * @param icon The given icon for the bubble
12137     */
12138    EAPI void         elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12139    /**
12140     * Get the icon of the bubble
12141     *
12142     * @param obj The bubble object
12143     * @return The icon for the bubble
12144     *
12145     * This function gets the icon shown on the top left of bubble.
12146     */
12147    EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12148    /**
12149     * Unset the icon of the bubble
12150     *
12151     * Unparent and return the icon object which was set for this widget.
12152     *
12153     * @param obj The bubble object
12154     * @return The icon that was being used
12155     */
12156    EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12157    /**
12158     * Set the corner of the bubble
12159     *
12160     * @param obj The bubble object.
12161     * @param corner The given corner for the bubble.
12162     *
12163     * This function sets the corner of the bubble. The corner will be used to
12164     * determine where the arrow in the frame points to and where label, icon and
12165     * info arre shown.
12166     *
12167     * Possible values for corner are:
12168     * @li "top_left" - Default
12169     * @li "top_right"
12170     * @li "bottom_left"
12171     * @li "bottom_right"
12172     */
12173    EAPI void         elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12174    /**
12175     * Get the corner of the bubble
12176     *
12177     * @param obj The bubble object.
12178     * @return The given corner for the bubble.
12179     *
12180     * This function gets the selected corner of the bubble.
12181     */
12182    EAPI const char  *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12183    /**
12184     * @}
12185     */
12186
12187    /**
12188     * @defgroup Photo Photo
12189     *
12190     * For displaying the photo of a person (contact). Simple yet
12191     * with a very specific purpose.
12192     *
12193     * Signals that you can add callbacks for are:
12194     *
12195     * "clicked" - This is called when a user has clicked the photo
12196     * "drag,start" - Someone started dragging the image out of the object
12197     * "drag,end" - Dragged item was dropped (somewhere)
12198     *
12199     * @{
12200     */
12201
12202    /**
12203     * Add a new photo to the parent
12204     *
12205     * @param parent The parent object
12206     * @return The new object or NULL if it cannot be created
12207     *
12208     * @ingroup Photo
12209     */
12210    EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12211
12212    /**
12213     * Set the file that will be used as photo
12214     *
12215     * @param obj The photo object
12216     * @param file The path to file that will be used as photo
12217     *
12218     * @return (1 = success, 0 = error)
12219     *
12220     * @ingroup Photo
12221     */
12222    EAPI Eina_Bool    elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12223
12224     /**
12225     * Set the file that will be used as thumbnail in the photo.
12226     *
12227     * @param obj The photo object.
12228     * @param file The path to file that will be used as thumb.
12229     * @param group The key used in case of an EET file.
12230     *
12231     * @ingroup Photo
12232     */
12233    EAPI void         elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12234
12235    /**
12236     * Set the size that will be used on the photo
12237     *
12238     * @param obj The photo object
12239     * @param size The size that the photo will be
12240     *
12241     * @ingroup Photo
12242     */
12243    EAPI void         elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12244
12245    /**
12246     * Set if the photo should be completely visible or not.
12247     *
12248     * @param obj The photo object
12249     * @param fill if true the photo will be completely visible
12250     *
12251     * @ingroup Photo
12252     */
12253    EAPI void         elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12254
12255    /**
12256     * Set editability of the photo.
12257     *
12258     * An editable photo can be dragged to or from, and can be cut or
12259     * pasted too.  Note that pasting an image or dropping an item on
12260     * the image will delete the existing content.
12261     *
12262     * @param obj The photo object.
12263     * @param set To set of clear editablity.
12264     */
12265    EAPI void         elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12266
12267    /**
12268     * @}
12269     */
12270
12271    /* gesture layer */
12272    /**
12273     * @defgroup Elm_Gesture_Layer Gesture Layer
12274     * Gesture Layer Usage:
12275     *
12276     * Use Gesture Layer to detect gestures.
12277     * The advantage is that you don't have to implement
12278     * gesture detection, just set callbacks of gesture state.
12279     * By using gesture layer we make standard interface.
12280     *
12281     * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12282     * with a parent object parameter.
12283     * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12284     * call. Usually with same object as target (2nd parameter).
12285     *
12286     * Now you need to tell gesture layer what gestures you follow.
12287     * This is done with @ref elm_gesture_layer_cb_set call.
12288     * By setting the callback you actually saying to gesture layer:
12289     * I would like to know when the gesture @ref Elm_Gesture_Types
12290     * switches to state @ref Elm_Gesture_State.
12291     *
12292     * Next, you need to implement the actual action that follows the input
12293     * in your callback.
12294     *
12295     * Note that if you like to stop being reported about a gesture, just set
12296     * all callbacks referring this gesture to NULL.
12297     * (again with @ref elm_gesture_layer_cb_set)
12298     *
12299     * The information reported by gesture layer to your callback is depending
12300     * on @ref Elm_Gesture_Types:
12301     * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12302     * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12303     * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12304     *
12305     * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12306     * @ref ELM_GESTURE_MOMENTUM.
12307     *
12308     * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12309     * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12310     * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12311     * Note that we consider a flick as a line-gesture that should be completed
12312     * in flick-time-limit as defined in @ref Config.
12313     *
12314     * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12315     *
12316     * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12317     *
12318     *
12319     * Gesture Layer Tweaks:
12320     *
12321     * Note that line, flick, gestures can start without the need to remove fingers from surface.
12322     * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12323     *
12324     * Setting glayer_continues_enable to false in @ref Config will change this behavior
12325     * so gesture starts when user touches (a *DOWN event) touch-surface
12326     * and ends when no fingers touches surface (a *UP event).
12327     */
12328
12329    /**
12330     * @enum _Elm_Gesture_Types
12331     * Enum of supported gesture types.
12332     * @ingroup Elm_Gesture_Layer
12333     */
12334    enum _Elm_Gesture_Types
12335      {
12336         ELM_GESTURE_FIRST = 0,
12337
12338         ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12339         ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12340         ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12341         ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12342
12343         ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12344
12345         ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12346         ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12347
12348         ELM_GESTURE_ZOOM, /**< Zoom */
12349         ELM_GESTURE_ROTATE, /**< Rotate */
12350
12351         ELM_GESTURE_LAST
12352      };
12353
12354    /**
12355     * @typedef Elm_Gesture_Types
12356     * gesture types enum
12357     * @ingroup Elm_Gesture_Layer
12358     */
12359    typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12360
12361    /**
12362     * @enum _Elm_Gesture_State
12363     * Enum of gesture states.
12364     * @ingroup Elm_Gesture_Layer
12365     */
12366    enum _Elm_Gesture_State
12367      {
12368         ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12369         ELM_GESTURE_STATE_START,          /**< Gesture STARTed     */
12370         ELM_GESTURE_STATE_MOVE,           /**< Gesture is ongoing  */
12371         ELM_GESTURE_STATE_END,            /**< Gesture completed   */
12372         ELM_GESTURE_STATE_ABORT    /**< Onging gesture was ABORTed */
12373      };
12374
12375    /**
12376     * @typedef Elm_Gesture_State
12377     * gesture states enum
12378     * @ingroup Elm_Gesture_Layer
12379     */
12380    typedef enum _Elm_Gesture_State Elm_Gesture_State;
12381
12382    /**
12383     * @struct _Elm_Gesture_Taps_Info
12384     * Struct holds taps info for user
12385     * @ingroup Elm_Gesture_Layer
12386     */
12387    struct _Elm_Gesture_Taps_Info
12388      {
12389         Evas_Coord x, y;         /**< Holds center point between fingers */
12390         unsigned int n;          /**< Number of fingers tapped           */
12391         unsigned int timestamp;  /**< event timestamp       */
12392      };
12393
12394    /**
12395     * @typedef Elm_Gesture_Taps_Info
12396     * holds taps info for user
12397     * @ingroup Elm_Gesture_Layer
12398     */
12399    typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12400
12401    /**
12402     * @struct _Elm_Gesture_Momentum_Info
12403     * Struct holds momentum info for user
12404     * x1 and y1 are not necessarily in sync
12405     * x1 holds x value of x direction starting point
12406     * and same holds for y1.
12407     * This is noticeable when doing V-shape movement
12408     * @ingroup Elm_Gesture_Layer
12409     */
12410    struct _Elm_Gesture_Momentum_Info
12411      {  /* Report line ends, timestamps, and momentum computed        */
12412         Evas_Coord x1; /**< Final-swipe direction starting point on X */
12413         Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12414         Evas_Coord x2; /**< Final-swipe direction ending point on X   */
12415         Evas_Coord y2; /**< Final-swipe direction ending point on Y   */
12416
12417         unsigned int tx; /**< Timestamp of start of final x-swipe */
12418         unsigned int ty; /**< Timestamp of start of final y-swipe */
12419
12420         Evas_Coord mx; /**< Momentum on X */
12421         Evas_Coord my; /**< Momentum on Y */
12422      };
12423
12424    /**
12425     * @typedef Elm_Gesture_Momentum_Info
12426     * holds momentum info for user
12427     * @ingroup Elm_Gesture_Layer
12428     */
12429     typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12430
12431    /**
12432     * @struct _Elm_Gesture_Line_Info
12433     * Struct holds line info for user
12434     * @ingroup Elm_Gesture_Layer
12435     */
12436    struct _Elm_Gesture_Line_Info
12437      {  /* Report line ends, timestamps, and momentum computed      */
12438         Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12439         unsigned int n;            /**< Number of fingers (lines)   */
12440         /* FIXME should be radians, bot degrees */
12441         double angle;              /**< Angle (direction) of lines  */
12442      };
12443
12444    /**
12445     * @typedef Elm_Gesture_Line_Info
12446     * Holds line info for user
12447     * @ingroup Elm_Gesture_Layer
12448     */
12449     typedef struct  _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12450
12451    /**
12452     * @struct _Elm_Gesture_Zoom_Info
12453     * Struct holds zoom info for user
12454     * @ingroup Elm_Gesture_Layer
12455     */
12456    struct _Elm_Gesture_Zoom_Info
12457      {
12458         Evas_Coord x, y;       /**< Holds zoom center point reported to user  */
12459         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12460         double zoom;            /**< Zoom value: 1.0 means no zoom             */
12461         double momentum;        /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12462      };
12463
12464    /**
12465     * @typedef Elm_Gesture_Zoom_Info
12466     * Holds zoom info for user
12467     * @ingroup Elm_Gesture_Layer
12468     */
12469    typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12470
12471    /**
12472     * @struct _Elm_Gesture_Rotate_Info
12473     * Struct holds rotation info for user
12474     * @ingroup Elm_Gesture_Layer
12475     */
12476    struct _Elm_Gesture_Rotate_Info
12477      {
12478         Evas_Coord x, y;   /**< Holds zoom center point reported to user      */
12479         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12480         double base_angle; /**< Holds start-angle */
12481         double angle;      /**< Rotation value: 0.0 means no rotation         */
12482         double momentum;   /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12483      };
12484
12485    /**
12486     * @typedef Elm_Gesture_Rotate_Info
12487     * Holds rotation info for user
12488     * @ingroup Elm_Gesture_Layer
12489     */
12490    typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12491
12492    /**
12493     * @typedef Elm_Gesture_Event_Cb
12494     * User callback used to stream gesture info from gesture layer
12495     * @param data user data
12496     * @param event_info gesture report info
12497     * Returns a flag field to be applied on the causing event.
12498     * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12499     * upon the event, in an irreversible way.
12500     *
12501     * @ingroup Elm_Gesture_Layer
12502     */
12503    typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12504
12505    /**
12506     * Use function to set callbacks to be notified about
12507     * change of state of gesture.
12508     * When a user registers a callback with this function
12509     * this means this gesture has to be tested.
12510     *
12511     * When ALL callbacks for a gesture are set to NULL
12512     * it means user isn't interested in gesture-state
12513     * and it will not be tested.
12514     *
12515     * @param obj Pointer to gesture-layer.
12516     * @param idx The gesture you would like to track its state.
12517     * @param cb callback function pointer.
12518     * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12519     * @param data user info to be sent to callback (usually, Smart Data)
12520     *
12521     * @ingroup Elm_Gesture_Layer
12522     */
12523    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);
12524
12525    /**
12526     * Call this function to get repeat-events settings.
12527     *
12528     * @param obj Pointer to gesture-layer.
12529     *
12530     * @return repeat events settings.
12531     * @see elm_gesture_layer_hold_events_set()
12532     * @ingroup Elm_Gesture_Layer
12533     */
12534    EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12535
12536    /**
12537     * This function called in order to make gesture-layer repeat events.
12538     * Set this of you like to get the raw events only if gestures were not detected.
12539     * Clear this if you like gesture layer to fwd events as testing gestures.
12540     *
12541     * @param obj Pointer to gesture-layer.
12542     * @param r Repeat: TRUE/FALSE
12543     *
12544     * @ingroup Elm_Gesture_Layer
12545     */
12546    EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12547
12548    /**
12549     * This function sets step-value for zoom action.
12550     * Set step to any positive value.
12551     * Cancel step setting by setting to 0.0
12552     *
12553     * @param obj Pointer to gesture-layer.
12554     * @param s new zoom step value.
12555     *
12556     * @ingroup Elm_Gesture_Layer
12557     */
12558    EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12559
12560    /**
12561     * This function sets step-value for rotate action.
12562     * Set step to any positive value.
12563     * Cancel step setting by setting to 0.0
12564     *
12565     * @param obj Pointer to gesture-layer.
12566     * @param s new roatate step value.
12567     *
12568     * @ingroup Elm_Gesture_Layer
12569     */
12570    EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12571
12572    /**
12573     * This function called to attach gesture-layer to an Evas_Object.
12574     * @param obj Pointer to gesture-layer.
12575     * @param t Pointer to underlying object (AKA Target)
12576     *
12577     * @return TRUE, FALSE on success, failure.
12578     *
12579     * @ingroup Elm_Gesture_Layer
12580     */
12581    EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12582
12583    /**
12584     * Call this function to construct a new gesture-layer object.
12585     * This does not activate the gesture layer. You have to
12586     * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12587     *
12588     * @param parent the parent object.
12589     *
12590     * @return Pointer to new gesture-layer object.
12591     *
12592     * @ingroup Elm_Gesture_Layer
12593     */
12594    EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12595
12596    /**
12597     * @defgroup Thumb Thumb
12598     *
12599     * @image html img/widget/thumb/preview-00.png
12600     * @image latex img/widget/thumb/preview-00.eps
12601     *
12602     * A thumb object is used for displaying the thumbnail of an image or video.
12603     * You must have compiled Elementary with Ethumb_Client support and the DBus
12604     * service must be present and auto-activated in order to have thumbnails to
12605     * be generated.
12606     *
12607     * Once the thumbnail object becomes visible, it will check if there is a
12608     * previously generated thumbnail image for the file set on it. If not, it
12609     * will start generating this thumbnail.
12610     *
12611     * Different config settings will cause different thumbnails to be generated
12612     * even on the same file.
12613     *
12614     * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12615     * Ethumb documentation to change this path, and to see other configuration
12616     * options.
12617     *
12618     * Signals that you can add callbacks for are:
12619     *
12620     * - "clicked" - This is called when a user has clicked the thumb without dragging
12621     *             around.
12622     * - "clicked,double" - This is called when a user has double-clicked the thumb.
12623     * - "press" - This is called when a user has pressed down the thumb.
12624     * - "generate,start" - The thumbnail generation started.
12625     * - "generate,stop" - The generation process stopped.
12626     * - "generate,error" - The generation failed.
12627     * - "load,error" - The thumbnail image loading failed.
12628     *
12629     * available styles:
12630     * - default
12631     * - noframe
12632     *
12633     * An example of use of thumbnail:
12634     *
12635     * - @ref thumb_example_01
12636     */
12637
12638    /**
12639     * @addtogroup Thumb
12640     * @{
12641     */
12642
12643    /**
12644     * @enum _Elm_Thumb_Animation_Setting
12645     * @typedef Elm_Thumb_Animation_Setting
12646     *
12647     * Used to set if a video thumbnail is animating or not.
12648     *
12649     * @ingroup Thumb
12650     */
12651    typedef enum _Elm_Thumb_Animation_Setting
12652      {
12653         ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12654         ELM_THUMB_ANIMATION_LOOP,      /**< Keep playing animation until stop is requested */
12655         ELM_THUMB_ANIMATION_STOP,      /**< Stop playing the animation */
12656         ELM_THUMB_ANIMATION_LAST
12657      } Elm_Thumb_Animation_Setting;
12658
12659    /**
12660     * Add a new thumb object to the parent.
12661     *
12662     * @param parent The parent object.
12663     * @return The new object or NULL if it cannot be created.
12664     *
12665     * @see elm_thumb_file_set()
12666     * @see elm_thumb_ethumb_client_get()
12667     *
12668     * @ingroup Thumb
12669     */
12670    EAPI Evas_Object                 *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12671    /**
12672     * Reload thumbnail if it was generated before.
12673     *
12674     * @param obj The thumb object to reload
12675     *
12676     * This is useful if the ethumb client configuration changed, like its
12677     * size, aspect or any other property one set in the handle returned
12678     * by elm_thumb_ethumb_client_get().
12679     *
12680     * If the options didn't change, the thumbnail won't be generated again, but
12681     * the old one will still be used.
12682     *
12683     * @see elm_thumb_file_set()
12684     *
12685     * @ingroup Thumb
12686     */
12687    EAPI void                         elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
12688    /**
12689     * Set the file that will be used as thumbnail.
12690     *
12691     * @param obj The thumb object.
12692     * @param file The path to file that will be used as thumb.
12693     * @param key The key used in case of an EET file.
12694     *
12695     * The file can be an image or a video (in that case, acceptable extensions are:
12696     * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
12697     * function elm_thumb_animate().
12698     *
12699     * @see elm_thumb_file_get()
12700     * @see elm_thumb_reload()
12701     * @see elm_thumb_animate()
12702     *
12703     * @ingroup Thumb
12704     */
12705    EAPI void                         elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
12706    /**
12707     * Get the image or video path and key used to generate the thumbnail.
12708     *
12709     * @param obj The thumb object.
12710     * @param file Pointer to filename.
12711     * @param key Pointer to key.
12712     *
12713     * @see elm_thumb_file_set()
12714     * @see elm_thumb_path_get()
12715     *
12716     * @ingroup Thumb
12717     */
12718    EAPI void                         elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12719    /**
12720     * Get the path and key to the image or video generated by ethumb.
12721     *
12722     * One just need to make sure that the thumbnail was generated before getting
12723     * its path; otherwise, the path will be NULL. One way to do that is by asking
12724     * for the path when/after the "generate,stop" smart callback is called.
12725     *
12726     * @param obj The thumb object.
12727     * @param file Pointer to thumb path.
12728     * @param key Pointer to thumb key.
12729     *
12730     * @see elm_thumb_file_get()
12731     *
12732     * @ingroup Thumb
12733     */
12734    EAPI void                         elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12735    /**
12736     * Set the animation state for the thumb object. If its content is an animated
12737     * video, you may start/stop the animation or tell it to play continuously and
12738     * looping.
12739     *
12740     * @param obj The thumb object.
12741     * @param setting The animation setting.
12742     *
12743     * @see elm_thumb_file_set()
12744     *
12745     * @ingroup Thumb
12746     */
12747    EAPI void                         elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
12748    /**
12749     * Get the animation state for the thumb object.
12750     *
12751     * @param obj The thumb object.
12752     * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
12753     * on errors.
12754     *
12755     * @see elm_thumb_animate_set()
12756     *
12757     * @ingroup Thumb
12758     */
12759    EAPI Elm_Thumb_Animation_Setting  elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12760    /**
12761     * Get the ethumb_client handle so custom configuration can be made.
12762     *
12763     * @return Ethumb_Client instance or NULL.
12764     *
12765     * This must be called before the objects are created to be sure no object is
12766     * visible and no generation started.
12767     *
12768     * Example of usage:
12769     *
12770     * @code
12771     * #include <Elementary.h>
12772     * #ifndef ELM_LIB_QUICKLAUNCH
12773     * EAPI_MAIN int
12774     * elm_main(int argc, char **argv)
12775     * {
12776     *    Ethumb_Client *client;
12777     *
12778     *    elm_need_ethumb();
12779     *
12780     *    // ... your code
12781     *
12782     *    client = elm_thumb_ethumb_client_get();
12783     *    if (!client)
12784     *      {
12785     *         ERR("could not get ethumb_client");
12786     *         return 1;
12787     *      }
12788     *    ethumb_client_size_set(client, 100, 100);
12789     *    ethumb_client_crop_align_set(client, 0.5, 0.5);
12790     *    // ... your code
12791     *
12792     *    // Create elm_thumb objects here
12793     *
12794     *    elm_run();
12795     *    elm_shutdown();
12796     *    return 0;
12797     * }
12798     * #endif
12799     * ELM_MAIN()
12800     * @endcode
12801     *
12802     * @note There's only one client handle for Ethumb, so once a configuration
12803     * change is done to it, any other request for thumbnails (for any thumbnail
12804     * object) will use that configuration. Thus, this configuration is global.
12805     *
12806     * @ingroup Thumb
12807     */
12808    EAPI void                        *elm_thumb_ethumb_client_get(void);
12809    /**
12810     * Get the ethumb_client connection state.
12811     *
12812     * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
12813     * otherwise.
12814     */
12815    EAPI Eina_Bool                    elm_thumb_ethumb_client_connected(void);
12816    /**
12817     * Make the thumbnail 'editable'.
12818     *
12819     * @param obj Thumb object.
12820     * @param set Turn on or off editability. Default is @c EINA_FALSE.
12821     *
12822     * This means the thumbnail is a valid drag target for drag and drop, and can be
12823     * cut or pasted too.
12824     *
12825     * @see elm_thumb_editable_get()
12826     *
12827     * @ingroup Thumb
12828     */
12829    EAPI Eina_Bool                    elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
12830    /**
12831     * Make the thumbnail 'editable'.
12832     *
12833     * @param obj Thumb object.
12834     * @return Editability.
12835     *
12836     * This means the thumbnail is a valid drag target for drag and drop, and can be
12837     * cut or pasted too.
12838     *
12839     * @see elm_thumb_editable_set()
12840     *
12841     * @ingroup Thumb
12842     */
12843    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12844
12845    /**
12846     * @}
12847     */
12848
12849    /**
12850     * @defgroup Hoversel Hoversel
12851     *
12852     * @image html img/widget/hoversel/preview-00.png
12853     * @image latex img/widget/hoversel/preview-00.eps
12854     *
12855     * A hoversel is a button that pops up a list of items (automatically
12856     * choosing the direction to display) that have a label and, optionally, an
12857     * icon to select from. It is a convenience widget to avoid the need to do
12858     * all the piecing together yourself. It is intended for a small number of
12859     * items in the hoversel menu (no more than 8), though is capable of many
12860     * more.
12861     *
12862     * Signals that you can add callbacks for are:
12863     * "clicked" - the user clicked the hoversel button and popped up the sel
12864     * "selected" - an item in the hoversel list is selected. event_info is the item
12865     * "dismissed" - the hover is dismissed
12866     *
12867     * See @ref tutorial_hoversel for an example.
12868     * @{
12869     */
12870    typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
12871    /**
12872     * @brief Add a new Hoversel object
12873     *
12874     * @param parent The parent object
12875     * @return The new object or NULL if it cannot be created
12876     */
12877    EAPI Evas_Object       *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12878    /**
12879     * @brief This sets the hoversel to expand horizontally.
12880     *
12881     * @param obj The hoversel object
12882     * @param horizontal If true, the hover will expand horizontally to the
12883     * right.
12884     *
12885     * @note The initial button will display horizontally regardless of this
12886     * setting.
12887     */
12888    EAPI void               elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
12889    /**
12890     * @brief This returns whether the hoversel is set to expand horizontally.
12891     *
12892     * @param obj The hoversel object
12893     * @return If true, the hover will expand horizontally to the right.
12894     *
12895     * @see elm_hoversel_horizontal_set()
12896     */
12897    EAPI Eina_Bool          elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12898    /**
12899     * @brief Set the Hover parent
12900     *
12901     * @param obj The hoversel object
12902     * @param parent The parent to use
12903     *
12904     * Sets the hover parent object, the area that will be darkened when the
12905     * hoversel is clicked. Should probably be the window that the hoversel is
12906     * in. See @ref Hover objects for more information.
12907     */
12908    EAPI void               elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12909    /**
12910     * @brief Get the Hover parent
12911     *
12912     * @param obj The hoversel object
12913     * @return The used parent
12914     *
12915     * Gets the hover parent object.
12916     *
12917     * @see elm_hoversel_hover_parent_set()
12918     */
12919    EAPI Evas_Object       *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12920    /**
12921     * @brief Set the hoversel button label
12922     *
12923     * @param obj The hoversel object
12924     * @param label The label text.
12925     *
12926     * This sets the label of the button that is always visible (before it is
12927     * clicked and expanded).
12928     *
12929     * @deprecated elm_object_text_set()
12930     */
12931    EINA_DEPRECATED EAPI void               elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12932    /**
12933     * @brief Get the hoversel button label
12934     *
12935     * @param obj The hoversel object
12936     * @return The label text.
12937     *
12938     * @deprecated elm_object_text_get()
12939     */
12940    EINA_DEPRECATED EAPI const char        *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12941    /**
12942     * @brief Set the icon of the hoversel button
12943     *
12944     * @param obj The hoversel object
12945     * @param icon The icon object
12946     *
12947     * Sets the icon of the button that is always visible (before it is clicked
12948     * and expanded).  Once the icon object is set, a previously set one will be
12949     * deleted, if you want to keep that old content object, use the
12950     * elm_hoversel_icon_unset() function.
12951     *
12952     * @see elm_button_icon_set()
12953     */
12954    EAPI void               elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12955    /**
12956     * @brief Get the icon of the hoversel button
12957     *
12958     * @param obj The hoversel object
12959     * @return The icon object
12960     *
12961     * Get the icon of the button that is always visible (before it is clicked
12962     * and expanded). Also see elm_button_icon_get().
12963     *
12964     * @see elm_hoversel_icon_set()
12965     */
12966    EAPI Evas_Object       *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12967    /**
12968     * @brief Get and unparent the icon of the hoversel button
12969     *
12970     * @param obj The hoversel object
12971     * @return The icon object that was being used
12972     *
12973     * Unparent and return the icon of the button that is always visible
12974     * (before it is clicked and expanded).
12975     *
12976     * @see elm_hoversel_icon_set()
12977     * @see elm_button_icon_unset()
12978     */
12979    EAPI Evas_Object       *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12980    /**
12981     * @brief This triggers the hoversel popup from code, the same as if the user
12982     * had clicked the button.
12983     *
12984     * @param obj The hoversel object
12985     */
12986    EAPI void               elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
12987    /**
12988     * @brief This dismisses the hoversel popup as if the user had clicked
12989     * outside the hover.
12990     *
12991     * @param obj The hoversel object
12992     */
12993    EAPI void               elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12994    /**
12995     * @brief Returns whether the hoversel is expanded.
12996     *
12997     * @param obj The hoversel object
12998     * @return  This will return EINA_TRUE if the hoversel is expanded or
12999     * EINA_FALSE if it is not expanded.
13000     */
13001    EAPI Eina_Bool          elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13002    /**
13003     * @brief This will remove all the children items from the hoversel.
13004     *
13005     * @param obj The hoversel object
13006     *
13007     * @warning Should @b not be called while the hoversel is active; use
13008     * elm_hoversel_expanded_get() to check first.
13009     *
13010     * @see elm_hoversel_item_del_cb_set()
13011     * @see elm_hoversel_item_del()
13012     */
13013    EAPI void               elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
13014    /**
13015     * @brief Get the list of items within the given hoversel.
13016     *
13017     * @param obj The hoversel object
13018     * @return Returns a list of Elm_Hoversel_Item*
13019     *
13020     * @see elm_hoversel_item_add()
13021     */
13022    EAPI const Eina_List   *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13023    /**
13024     * @brief Add an item to the hoversel button
13025     *
13026     * @param obj The hoversel object
13027     * @param label The text label to use for the item (NULL if not desired)
13028     * @param icon_file An image file path on disk to use for the icon or standard
13029     * icon name (NULL if not desired)
13030     * @param icon_type The icon type if relevant
13031     * @param func Convenience function to call when this item is selected
13032     * @param data Data to pass to item-related functions
13033     * @return A handle to the item added.
13034     *
13035     * This adds an item to the hoversel to show when it is clicked. Note: if you
13036     * need to use an icon from an edje file then use
13037     * elm_hoversel_item_icon_set() right after the this function, and set
13038     * icon_file to NULL here.
13039     *
13040     * For more information on what @p icon_file and @p icon_type are see the
13041     * @ref Icon "icon documentation".
13042     */
13043    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);
13044    /**
13045     * @brief Delete an item from the hoversel
13046     *
13047     * @param item The item to delete
13048     *
13049     * This deletes the item from the hoversel (should not be called while the
13050     * hoversel is active; use elm_hoversel_expanded_get() to check first).
13051     *
13052     * @see elm_hoversel_item_add()
13053     * @see elm_hoversel_item_del_cb_set()
13054     */
13055    EAPI void               elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
13056    /**
13057     * @brief Set the function to be called when an item from the hoversel is
13058     * freed.
13059     *
13060     * @param item The item to set the callback on
13061     * @param func The function called
13062     *
13063     * That function will receive these parameters:
13064     * @li void *item_data
13065     * @li Evas_Object *the_item_object
13066     * @li Elm_Hoversel_Item *the_object_struct
13067     *
13068     * @see elm_hoversel_item_add()
13069     */
13070    EAPI void               elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
13071    /**
13072     * @brief This returns the data pointer supplied with elm_hoversel_item_add()
13073     * that will be passed to associated function callbacks.
13074     *
13075     * @param item The item to get the data from
13076     * @return The data pointer set with elm_hoversel_item_add()
13077     *
13078     * @see elm_hoversel_item_add()
13079     */
13080    EAPI void              *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
13081    /**
13082     * @brief This returns the label text of the given hoversel item.
13083     *
13084     * @param item The item to get the label
13085     * @return The label text of the hoversel item
13086     *
13087     * @see elm_hoversel_item_add()
13088     */
13089    EAPI const char        *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
13090    /**
13091     * @brief This sets the icon for the given hoversel item.
13092     *
13093     * @param item The item to set the icon
13094     * @param icon_file An image file path on disk to use for the icon or standard
13095     * icon name
13096     * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
13097     * to NULL if the icon is not an edje file
13098     * @param icon_type The icon type
13099     *
13100     * The icon can be loaded from the standard set, from an image file, or from
13101     * an edje file.
13102     *
13103     * @see elm_hoversel_item_add()
13104     */
13105    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);
13106    /**
13107     * @brief Get the icon object of the hoversel item
13108     *
13109     * @param item The item to get the icon from
13110     * @param icon_file The image file path on disk used for the icon or standard
13111     * icon name
13112     * @param icon_group The edje group used if @p icon_file is an edje file. NULL
13113     * if the icon is not an edje file
13114     * @param icon_type The icon type
13115     *
13116     * @see elm_hoversel_item_icon_set()
13117     * @see elm_hoversel_item_add()
13118     */
13119    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);
13120    /**
13121     * @}
13122     */
13123
13124    /**
13125     * @defgroup Toolbar Toolbar
13126     * @ingroup Elementary
13127     *
13128     * @image html img/widget/toolbar/preview-00.png
13129     * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
13130     *
13131     * @image html img/toolbar.png
13132     * @image latex img/toolbar.eps width=\textwidth
13133     *
13134     * A toolbar is a widget that displays a list of items inside
13135     * a box. It can be scrollable, show a menu with items that don't fit
13136     * to toolbar size or even crop them.
13137     *
13138     * Only one item can be selected at a time.
13139     *
13140     * Items can have multiple states, or show menus when selected by the user.
13141     *
13142     * Smart callbacks one can listen to:
13143     * - "clicked" - when the user clicks on a toolbar item and becomes selected.
13144     *
13145     * Available styles for it:
13146     * - @c "default"
13147     * - @c "transparent" - no background or shadow, just show the content
13148     *
13149     * List of examples:
13150     * @li @ref toolbar_example_01
13151     * @li @ref toolbar_example_02
13152     * @li @ref toolbar_example_03
13153     */
13154
13155    /**
13156     * @addtogroup Toolbar
13157     * @{
13158     */
13159
13160    /**
13161     * @enum _Elm_Toolbar_Shrink_Mode
13162     * @typedef Elm_Toolbar_Shrink_Mode
13163     *
13164     * Set toolbar's items display behavior, it can be scrollabel,
13165     * show a menu with exceeding items, or simply hide them.
13166     *
13167     * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
13168     * from elm config.
13169     *
13170     * Values <b> don't </b> work as bitmask, only one can be choosen.
13171     *
13172     * @see elm_toolbar_mode_shrink_set()
13173     * @see elm_toolbar_mode_shrink_get()
13174     *
13175     * @ingroup Toolbar
13176     */
13177    typedef enum _Elm_Toolbar_Shrink_Mode
13178      {
13179         ELM_TOOLBAR_SHRINK_NONE,   /**< Set toolbar minimun size to fit all the items. */
13180         ELM_TOOLBAR_SHRINK_HIDE,   /**< Hide exceeding items. */
13181         ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
13182         ELM_TOOLBAR_SHRINK_MENU    /**< Inserts a button to pop up a menu with exceeding items. */
13183      } Elm_Toolbar_Shrink_Mode;
13184
13185    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(). */
13186
13187    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(). */
13188
13189    /**
13190     * Add a new toolbar widget to the given parent Elementary
13191     * (container) object.
13192     *
13193     * @param parent The parent object.
13194     * @return a new toolbar widget handle or @c NULL, on errors.
13195     *
13196     * This function inserts a new toolbar widget on the canvas.
13197     *
13198     * @ingroup Toolbar
13199     */
13200    EAPI Evas_Object            *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13201
13202    /**
13203     * Set the icon size, in pixels, to be used by toolbar items.
13204     *
13205     * @param obj The toolbar object
13206     * @param icon_size The icon size in pixels
13207     *
13208     * @note Default value is @c 32. It reads value from elm config.
13209     *
13210     * @see elm_toolbar_icon_size_get()
13211     *
13212     * @ingroup Toolbar
13213     */
13214    EAPI void                    elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
13215
13216    /**
13217     * Get the icon size, in pixels, to be used by toolbar items.
13218     *
13219     * @param obj The toolbar object.
13220     * @return The icon size in pixels.
13221     *
13222     * @see elm_toolbar_icon_size_set() for details.
13223     *
13224     * @ingroup Toolbar
13225     */
13226    EAPI int                     elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13227
13228    /**
13229     * Sets icon lookup order, for toolbar items' icons.
13230     *
13231     * @param obj The toolbar object.
13232     * @param order The icon lookup order.
13233     *
13234     * Icons added before calling this function will not be affected.
13235     * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
13236     *
13237     * @see elm_toolbar_icon_order_lookup_get()
13238     *
13239     * @ingroup Toolbar
13240     */
13241    EAPI void                    elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
13242
13243    /**
13244     * Gets the icon lookup order.
13245     *
13246     * @param obj The toolbar object.
13247     * @return The icon lookup order.
13248     *
13249     * @see elm_toolbar_icon_order_lookup_set() for details.
13250     *
13251     * @ingroup Toolbar
13252     */
13253    EAPI Elm_Icon_Lookup_Order   elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13254
13255    /**
13256     * Set whether the toolbar items' should be selected by the user or not.
13257     *
13258     * @param obj The toolbar object.
13259     * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
13260     * enable it.
13261     *
13262     * This will turn off the ability to select items entirely and they will
13263     * neither appear selected nor emit selected signals. The clicked
13264     * callback function will still be called.
13265     *
13266     * Selection is enabled by default.
13267     *
13268     * @see elm_toolbar_no_select_mode_get().
13269     *
13270     * @ingroup Toolbar
13271     */
13272    EAPI void                    elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
13273
13274    /**
13275     * Set whether the toolbar items' should be selected by the user or not.
13276     *
13277     * @param obj The toolbar object.
13278     * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
13279     * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
13280     *
13281     * @see elm_toolbar_no_select_mode_set() for details.
13282     *
13283     * @ingroup Toolbar
13284     */
13285    EAPI Eina_Bool               elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13286
13287    /**
13288     * Append item to the toolbar.
13289     *
13290     * @param obj The toolbar object.
13291     * @param icon A string with icon name or the absolute path of an image file.
13292     * @param label The label of the item.
13293     * @param func The function to call when the item is clicked.
13294     * @param data The data to associate with the item for related callbacks.
13295     * @return The created item or @c NULL upon failure.
13296     *
13297     * A new item will be created and appended to the toolbar, i.e., will
13298     * be set as @b last item.
13299     *
13300     * Items created with this method can be deleted with
13301     * elm_toolbar_item_del().
13302     *
13303     * Associated @p data can be properly freed when item is deleted if a
13304     * callback function is set with elm_toolbar_item_del_cb_set().
13305     *
13306     * If a function is passed as argument, it will be called everytime this item
13307     * is selected, i.e., the user clicks over an unselected item.
13308     * If such function isn't needed, just passing
13309     * @c NULL as @p func is enough. The same should be done for @p data.
13310     *
13311     * Toolbar will load icon image from fdo or current theme.
13312     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13313     * If an absolute path is provided it will load it direct from a file.
13314     *
13315     * @see elm_toolbar_item_icon_set()
13316     * @see elm_toolbar_item_del()
13317     * @see elm_toolbar_item_del_cb_set()
13318     *
13319     * @ingroup Toolbar
13320     */
13321    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);
13322
13323    /**
13324     * Prepend item to the toolbar.
13325     *
13326     * @param obj The toolbar object.
13327     * @param icon A string with icon name or the absolute path of an image file.
13328     * @param label The label of the item.
13329     * @param func The function to call when the item is clicked.
13330     * @param data The data to associate with the item for related callbacks.
13331     * @return The created item or @c NULL upon failure.
13332     *
13333     * A new item will be created and prepended to the toolbar, i.e., will
13334     * be set as @b first item.
13335     *
13336     * Items created with this method can be deleted with
13337     * elm_toolbar_item_del().
13338     *
13339     * Associated @p data can be properly freed when item is deleted if a
13340     * callback function is set with elm_toolbar_item_del_cb_set().
13341     *
13342     * If a function is passed as argument, it will be called everytime this item
13343     * is selected, i.e., the user clicks over an unselected item.
13344     * If such function isn't needed, just passing
13345     * @c NULL as @p func is enough. The same should be done for @p data.
13346     *
13347     * Toolbar will load icon image from fdo or current theme.
13348     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13349     * If an absolute path is provided it will load it direct from a file.
13350     *
13351     * @see elm_toolbar_item_icon_set()
13352     * @see elm_toolbar_item_del()
13353     * @see elm_toolbar_item_del_cb_set()
13354     *
13355     * @ingroup Toolbar
13356     */
13357    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);
13358
13359    /**
13360     * Insert a new item into the toolbar object before item @p before.
13361     *
13362     * @param obj The toolbar object.
13363     * @param before The toolbar item to insert before.
13364     * @param icon A string with icon name or the absolute path of an image file.
13365     * @param label The label of the item.
13366     * @param func The function to call when the item is clicked.
13367     * @param data The data to associate with the item for related callbacks.
13368     * @return The created item or @c NULL upon failure.
13369     *
13370     * A new item will be created and added to the toolbar. Its position in
13371     * this toolbar will be just before item @p before.
13372     *
13373     * Items created with this method can be deleted with
13374     * elm_toolbar_item_del().
13375     *
13376     * Associated @p data can be properly freed when item is deleted if a
13377     * callback function is set with elm_toolbar_item_del_cb_set().
13378     *
13379     * If a function is passed as argument, it will be called everytime this item
13380     * is selected, i.e., the user clicks over an unselected item.
13381     * If such function isn't needed, just passing
13382     * @c NULL as @p func is enough. The same should be done for @p data.
13383     *
13384     * Toolbar will load icon image from fdo or current theme.
13385     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13386     * If an absolute path is provided it will load it direct from a file.
13387     *
13388     * @see elm_toolbar_item_icon_set()
13389     * @see elm_toolbar_item_del()
13390     * @see elm_toolbar_item_del_cb_set()
13391     *
13392     * @ingroup Toolbar
13393     */
13394    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);
13395
13396    /**
13397     * Insert a new item into the toolbar object after item @p after.
13398     *
13399     * @param obj The toolbar object.
13400     * @param before The toolbar item to insert before.
13401     * @param icon A string with icon name or the absolute path of an image file.
13402     * @param label The label of the item.
13403     * @param func The function to call when the item is clicked.
13404     * @param data The data to associate with the item for related callbacks.
13405     * @return The created item or @c NULL upon failure.
13406     *
13407     * A new item will be created and added to the toolbar. Its position in
13408     * this toolbar will be just after item @p after.
13409     *
13410     * Items created with this method can be deleted with
13411     * elm_toolbar_item_del().
13412     *
13413     * Associated @p data can be properly freed when item is deleted if a
13414     * callback function is set with elm_toolbar_item_del_cb_set().
13415     *
13416     * If a function is passed as argument, it will be called everytime this item
13417     * is selected, i.e., the user clicks over an unselected item.
13418     * If such function isn't needed, just passing
13419     * @c NULL as @p func is enough. The same should be done for @p data.
13420     *
13421     * Toolbar will load icon image from fdo or current theme.
13422     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13423     * If an absolute path is provided it will load it direct from a file.
13424     *
13425     * @see elm_toolbar_item_icon_set()
13426     * @see elm_toolbar_item_del()
13427     * @see elm_toolbar_item_del_cb_set()
13428     *
13429     * @ingroup Toolbar
13430     */
13431    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);
13432
13433    /**
13434     * Get the first item in the given toolbar widget's list of
13435     * items.
13436     *
13437     * @param obj The toolbar object
13438     * @return The first item or @c NULL, if it has no items (and on
13439     * errors)
13440     *
13441     * @see elm_toolbar_item_append()
13442     * @see elm_toolbar_last_item_get()
13443     *
13444     * @ingroup Toolbar
13445     */
13446    EAPI Elm_Toolbar_Item       *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13447
13448    /**
13449     * Get the last item in the given toolbar widget's list of
13450     * items.
13451     *
13452     * @param obj The toolbar object
13453     * @return The last item or @c NULL, if it has no items (and on
13454     * errors)
13455     *
13456     * @see elm_toolbar_item_prepend()
13457     * @see elm_toolbar_first_item_get()
13458     *
13459     * @ingroup Toolbar
13460     */
13461    EAPI Elm_Toolbar_Item       *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13462
13463    /**
13464     * Get the item after @p item in toolbar.
13465     *
13466     * @param item The toolbar item.
13467     * @return The item after @p item, or @c NULL if none or on failure.
13468     *
13469     * @note If it is the last item, @c NULL will be returned.
13470     *
13471     * @see elm_toolbar_item_append()
13472     *
13473     * @ingroup Toolbar
13474     */
13475    EAPI Elm_Toolbar_Item       *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13476
13477    /**
13478     * Get the item before @p item in toolbar.
13479     *
13480     * @param item The toolbar item.
13481     * @return The item before @p item, or @c NULL if none or on failure.
13482     *
13483     * @note If it is the first item, @c NULL will be returned.
13484     *
13485     * @see elm_toolbar_item_prepend()
13486     *
13487     * @ingroup Toolbar
13488     */
13489    EAPI Elm_Toolbar_Item       *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13490
13491    /**
13492     * Get the toolbar object from an item.
13493     *
13494     * @param item The item.
13495     * @return The toolbar object.
13496     *
13497     * This returns the toolbar object itself that an item belongs to.
13498     *
13499     * @ingroup Toolbar
13500     */
13501    EAPI Evas_Object            *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13502
13503    /**
13504     * Set the priority of a toolbar item.
13505     *
13506     * @param item The toolbar item.
13507     * @param priority The item priority. The default is zero.
13508     *
13509     * This is used only when the toolbar shrink mode is set to
13510     * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
13511     * When space is less than required, items with low priority
13512     * will be removed from the toolbar and added to a dynamically-created menu,
13513     * while items with higher priority will remain on the toolbar,
13514     * with the same order they were added.
13515     *
13516     * @see elm_toolbar_item_priority_get()
13517     *
13518     * @ingroup Toolbar
13519     */
13520    EAPI void                    elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
13521
13522    /**
13523     * Get the priority of a toolbar item.
13524     *
13525     * @param item The toolbar item.
13526     * @return The @p item priority, or @c 0 on failure.
13527     *
13528     * @see elm_toolbar_item_priority_set() for details.
13529     *
13530     * @ingroup Toolbar
13531     */
13532    EAPI int                     elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13533
13534    /**
13535     * Get the label of item.
13536     *
13537     * @param item The item of toolbar.
13538     * @return The label of item.
13539     *
13540     * The return value is a pointer to the label associated to @p item when
13541     * it was created, with function elm_toolbar_item_append() or similar,
13542     * or later,
13543     * with function elm_toolbar_item_label_set. If no label
13544     * was passed as argument, it will return @c NULL.
13545     *
13546     * @see elm_toolbar_item_label_set() for more details.
13547     * @see elm_toolbar_item_append()
13548     *
13549     * @ingroup Toolbar
13550     */
13551    EAPI const char             *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13552
13553    /**
13554     * Set the label of item.
13555     *
13556     * @param item The item of toolbar.
13557     * @param text The label of item.
13558     *
13559     * The label to be displayed by the item.
13560     * Label will be placed at icons bottom (if set).
13561     *
13562     * If a label was passed as argument on item creation, with function
13563     * elm_toolbar_item_append() or similar, it will be already
13564     * displayed by the item.
13565     *
13566     * @see elm_toolbar_item_label_get()
13567     * @see elm_toolbar_item_append()
13568     *
13569     * @ingroup Toolbar
13570     */
13571    EAPI void                    elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
13572
13573    /**
13574     * Return the data associated with a given toolbar widget item.
13575     *
13576     * @param item The toolbar widget item handle.
13577     * @return The data associated with @p item.
13578     *
13579     * @see elm_toolbar_item_data_set()
13580     *
13581     * @ingroup Toolbar
13582     */
13583    EAPI void                   *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13584
13585    /**
13586     * Set the data associated with a given toolbar widget item.
13587     *
13588     * @param item The toolbar widget item handle.
13589     * @param data The new data pointer to set to @p item.
13590     *
13591     * This sets new item data on @p item.
13592     *
13593     * @warning The old data pointer won't be touched by this function, so
13594     * the user had better to free that old data himself/herself.
13595     *
13596     * @ingroup Toolbar
13597     */
13598    EAPI void                    elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
13599
13600    /**
13601     * Returns a pointer to a toolbar item by its label.
13602     *
13603     * @param obj The toolbar object.
13604     * @param label The label of the item to find.
13605     *
13606     * @return The pointer to the toolbar item matching @p label or @c NULL
13607     * on failure.
13608     *
13609     * @ingroup Toolbar
13610     */
13611    EAPI Elm_Toolbar_Item       *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13612
13613    /*
13614     * Get whether the @p item is selected or not.
13615     *
13616     * @param item The toolbar item.
13617     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
13618     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
13619     *
13620     * @see elm_toolbar_selected_item_set() for details.
13621     * @see elm_toolbar_item_selected_get()
13622     *
13623     * @ingroup Toolbar
13624     */
13625    EAPI Eina_Bool               elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13626
13627    /**
13628     * Set the selected state of an item.
13629     *
13630     * @param item The toolbar item
13631     * @param selected The selected state
13632     *
13633     * This sets the selected state of the given item @p it.
13634     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
13635     *
13636     * If a new item is selected the previosly selected will be unselected.
13637     * Previoulsy selected item can be get with function
13638     * elm_toolbar_selected_item_get().
13639     *
13640     * Selected items will be highlighted.
13641     *
13642     * @see elm_toolbar_item_selected_get()
13643     * @see elm_toolbar_selected_item_get()
13644     *
13645     * @ingroup Toolbar
13646     */
13647    EAPI void                    elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
13648
13649    /**
13650     * Get the selected item.
13651     *
13652     * @param obj The toolbar object.
13653     * @return The selected toolbar item.
13654     *
13655     * The selected item can be unselected with function
13656     * elm_toolbar_item_selected_set().
13657     *
13658     * The selected item always will be highlighted on toolbar.
13659     *
13660     * @see elm_toolbar_selected_items_get()
13661     *
13662     * @ingroup Toolbar
13663     */
13664    EAPI Elm_Toolbar_Item       *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13665
13666    /**
13667     * Set the icon associated with @p item.
13668     *
13669     * @param obj The parent of this item.
13670     * @param item The toolbar item.
13671     * @param icon A string with icon name or the absolute path of an image file.
13672     *
13673     * Toolbar will load icon image from fdo or current theme.
13674     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13675     * If an absolute path is provided it will load it direct from a file.
13676     *
13677     * @see elm_toolbar_icon_order_lookup_set()
13678     * @see elm_toolbar_icon_order_lookup_get()
13679     *
13680     * @ingroup Toolbar
13681     */
13682    EAPI void                    elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
13683
13684    /**
13685     * Get the string used to set the icon of @p item.
13686     *
13687     * @param item The toolbar item.
13688     * @return The string associated with the icon object.
13689     *
13690     * @see elm_toolbar_item_icon_set() for details.
13691     *
13692     * @ingroup Toolbar
13693     */
13694    EAPI const char             *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13695
13696    /**
13697     * Get the icon object of @p item.
13698     *
13699     * @param item The toolbar item.
13700     * @return The icon object
13701     *
13702     * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
13703     *
13704     * @ingroup Toolbar
13705     */
13706    EAPI Evas_Object            *elm_toolbar_item_icon_object_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13707
13708    /**
13709     * Set the icon associated with @p item to an image in a binary buffer.
13710     *
13711     * @param item The toolbar item.
13712     * @param img The binary data that will be used as an image
13713     * @param size The size of binary data @p img
13714     * @param format Optional format of @p img to pass to the image loader
13715     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
13716     *
13717     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
13718     *
13719     * @note The icon image set by this function can be changed by
13720     * elm_toolbar_item_icon_set().
13721     * 
13722     * @ingroup Toolbar
13723     */
13724    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);
13725
13726    /**
13727     * Delete them item from the toolbar.
13728     *
13729     * @param item The item of toolbar to be deleted.
13730     *
13731     * @see elm_toolbar_item_append()
13732     * @see elm_toolbar_item_del_cb_set()
13733     *
13734     * @ingroup Toolbar
13735     */
13736    EAPI void                    elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13737
13738    /**
13739     * Set the function called when a toolbar item is freed.
13740     *
13741     * @param item The item to set the callback on.
13742     * @param func The function called.
13743     *
13744     * If there is a @p func, then it will be called prior item's memory release.
13745     * That will be called with the following arguments:
13746     * @li item's data;
13747     * @li item's Evas object;
13748     * @li item itself;
13749     *
13750     * This way, a data associated to a toolbar item could be properly freed.
13751     *
13752     * @ingroup Toolbar
13753     */
13754    EAPI void                    elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
13755
13756    /**
13757     * Get a value whether toolbar item is disabled or not.
13758     *
13759     * @param item The item.
13760     * @return The disabled state.
13761     *
13762     * @see elm_toolbar_item_disabled_set() for more details.
13763     *
13764     * @ingroup Toolbar
13765     */
13766    EAPI Eina_Bool               elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13767
13768    /**
13769     * Sets the disabled/enabled state of a toolbar item.
13770     *
13771     * @param item The item.
13772     * @param disabled The disabled state.
13773     *
13774     * A disabled item cannot be selected or unselected. It will also
13775     * change its appearance (generally greyed out). This sets the
13776     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
13777     * enabled).
13778     *
13779     * @ingroup Toolbar
13780     */
13781    EAPI void                    elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
13782
13783    /**
13784     * Set or unset item as a separator.
13785     *
13786     * @param item The toolbar item.
13787     * @param setting @c EINA_TRUE to set item @p item as separator or
13788     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
13789     *
13790     * Items aren't set as separator by default.
13791     *
13792     * If set as separator it will display separator theme, so won't display
13793     * icons or label.
13794     *
13795     * @see elm_toolbar_item_separator_get()
13796     *
13797     * @ingroup Toolbar
13798     */
13799    EAPI void                    elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
13800
13801    /**
13802     * Get a value whether item is a separator or not.
13803     *
13804     * @param item The toolbar item.
13805     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
13806     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
13807     *
13808     * @see elm_toolbar_item_separator_set() for details.
13809     *
13810     * @ingroup Toolbar
13811     */
13812    EAPI Eina_Bool               elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13813
13814    /**
13815     * Set the shrink state of toolbar @p obj.
13816     *
13817     * @param obj The toolbar object.
13818     * @param shrink_mode Toolbar's items display behavior.
13819     *
13820     * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
13821     * but will enforce a minimun size so all the items will fit, won't scroll
13822     * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
13823     * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
13824     * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
13825     *
13826     * @ingroup Toolbar
13827     */
13828    EAPI void                    elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
13829
13830    /**
13831     * Get the shrink mode of toolbar @p obj.
13832     *
13833     * @param obj The toolbar object.
13834     * @return Toolbar's items display behavior.
13835     *
13836     * @see elm_toolbar_mode_shrink_set() for details.
13837     *
13838     * @ingroup Toolbar
13839     */
13840    EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13841
13842    /**
13843     * Enable/disable homogenous mode.
13844     *
13845     * @param obj The toolbar object
13846     * @param homogeneous Assume the items within the toolbar are of the
13847     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
13848     *
13849     * This will enable the homogeneous mode where items are of the same size.
13850     * @see elm_toolbar_homogeneous_get()
13851     *
13852     * @ingroup Toolbar
13853     */
13854    EAPI void                    elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
13855
13856    /**
13857     * Get whether the homogenous mode is enabled.
13858     *
13859     * @param obj The toolbar object.
13860     * @return Assume the items within the toolbar are of the same height
13861     * and width (EINA_TRUE = on, EINA_FALSE = off).
13862     *
13863     * @see elm_toolbar_homogeneous_set()
13864     *
13865     * @ingroup Toolbar
13866     */
13867    EAPI Eina_Bool               elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13868
13869    /**
13870     * Enable/disable homogenous mode.
13871     *
13872     * @param obj The toolbar object
13873     * @param homogeneous Assume the items within the toolbar are of the
13874     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
13875     *
13876     * This will enable the homogeneous mode where items are of the same size.
13877     * @see elm_toolbar_homogeneous_get()
13878     *
13879     * @deprecated use elm_toolbar_homogeneous_set() instead.
13880     *
13881     * @ingroup Toolbar
13882     */
13883    EINA_DEPRECATED EAPI void    elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
13884
13885    /**
13886     * Get whether the homogenous mode is enabled.
13887     *
13888     * @param obj The toolbar object.
13889     * @return Assume the items within the toolbar are of the same height
13890     * and width (EINA_TRUE = on, EINA_FALSE = off).
13891     *
13892     * @see elm_toolbar_homogeneous_set()
13893     * @deprecated use elm_toolbar_homogeneous_get() instead.
13894     *
13895     * @ingroup Toolbar
13896     */
13897    EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13898
13899    /**
13900     * Set the parent object of the toolbar items' menus.
13901     *
13902     * @param obj The toolbar object.
13903     * @param parent The parent of the menu objects.
13904     *
13905     * Each item can be set as item menu, with elm_toolbar_item_menu_set().
13906     *
13907     * For more details about setting the parent for toolbar menus, see
13908     * elm_menu_parent_set().
13909     *
13910     * @see elm_menu_parent_set() for details.
13911     * @see elm_toolbar_item_menu_set() for details.
13912     *
13913     * @ingroup Toolbar
13914     */
13915    EAPI void                    elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
13916
13917    /**
13918     * Get the parent object of the toolbar items' menus.
13919     *
13920     * @param obj The toolbar object.
13921     * @return The parent of the menu objects.
13922     *
13923     * @see elm_toolbar_menu_parent_set() for details.
13924     *
13925     * @ingroup Toolbar
13926     */
13927    EAPI Evas_Object            *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13928
13929    /**
13930     * Set the alignment of the items.
13931     *
13932     * @param obj The toolbar object.
13933     * @param align The new alignment, a float between <tt> 0.0 </tt>
13934     * and <tt> 1.0 </tt>.
13935     *
13936     * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
13937     * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
13938     * items.
13939     *
13940     * Centered items by default.
13941     *
13942     * @see elm_toolbar_align_get()
13943     *
13944     * @ingroup Toolbar
13945     */
13946    EAPI void                    elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
13947
13948    /**
13949     * Get the alignment of the items.
13950     *
13951     * @param obj The toolbar object.
13952     * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
13953     * <tt> 1.0 </tt>.
13954     *
13955     * @see elm_toolbar_align_set() for details.
13956     *
13957     * @ingroup Toolbar
13958     */
13959    EAPI double                  elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13960
13961    /**
13962     * Set whether the toolbar item opens a menu.
13963     *
13964     * @param item The toolbar item.
13965     * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
13966     *
13967     * A toolbar item can be set to be a menu, using this function.
13968     *
13969     * Once it is set to be a menu, it can be manipulated through the
13970     * menu-like function elm_toolbar_menu_parent_set() and the other
13971     * elm_menu functions, using the Evas_Object @c menu returned by
13972     * elm_toolbar_item_menu_get().
13973     *
13974     * So, items to be displayed in this item's menu should be added with
13975     * elm_menu_item_add().
13976     *
13977     * The following code exemplifies the most basic usage:
13978     * @code
13979     * tb = elm_toolbar_add(win)
13980     * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
13981     * elm_toolbar_item_menu_set(item, EINA_TRUE);
13982     * elm_toolbar_menu_parent_set(tb, win);
13983     * menu = elm_toolbar_item_menu_get(item);
13984     * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
13985     * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
13986     * NULL);
13987     * @endcode
13988     *
13989     * @see elm_toolbar_item_menu_get()
13990     *
13991     * @ingroup Toolbar
13992     */
13993    EAPI void                    elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
13994
13995    /**
13996     * Get toolbar item's menu.
13997     *
13998     * @param item The toolbar item.
13999     * @return Item's menu object or @c NULL on failure.
14000     *
14001     * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
14002     * this function will set it.
14003     *
14004     * @see elm_toolbar_item_menu_set() for details.
14005     *
14006     * @ingroup Toolbar
14007     */
14008    EAPI Evas_Object            *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14009
14010    /**
14011     * Add a new state to @p item.
14012     *
14013     * @param item The item.
14014     * @param icon A string with icon name or the absolute path of an image file.
14015     * @param label The label of the new state.
14016     * @param func The function to call when the item is clicked when this
14017     * state is selected.
14018     * @param data The data to associate with the state.
14019     * @return The toolbar item state, or @c NULL upon failure.
14020     *
14021     * Toolbar will load icon image from fdo or current theme.
14022     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14023     * If an absolute path is provided it will load it direct from a file.
14024     *
14025     * States created with this function can be removed with
14026     * elm_toolbar_item_state_del().
14027     *
14028     * @see elm_toolbar_item_state_del()
14029     * @see elm_toolbar_item_state_sel()
14030     * @see elm_toolbar_item_state_get()
14031     *
14032     * @ingroup Toolbar
14033     */
14034    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);
14035
14036    /**
14037     * Delete a previoulsy added state to @p item.
14038     *
14039     * @param item The toolbar item.
14040     * @param state The state to be deleted.
14041     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
14042     *
14043     * @see elm_toolbar_item_state_add()
14044     */
14045    EAPI Eina_Bool               elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
14046
14047    /**
14048     * Set @p state as the current state of @p it.
14049     *
14050     * @param it The item.
14051     * @param state The state to use.
14052     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
14053     *
14054     * If @p state is @c NULL, it won't select any state and the default item's
14055     * icon and label will be used. It's the same behaviour than
14056     * elm_toolbar_item_state_unser().
14057     *
14058     * @see elm_toolbar_item_state_unset()
14059     *
14060     * @ingroup Toolbar
14061     */
14062    EAPI Eina_Bool               elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
14063
14064    /**
14065     * Unset the state of @p it.
14066     *
14067     * @param it The item.
14068     *
14069     * The default icon and label from this item will be displayed.
14070     *
14071     * @see elm_toolbar_item_state_set() for more details.
14072     *
14073     * @ingroup Toolbar
14074     */
14075    EAPI void                    elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
14076
14077    /**
14078     * Get the current state of @p it.
14079     *
14080     * @param item The item.
14081     * @return The selected state or @c NULL if none is selected or on failure.
14082     *
14083     * @see elm_toolbar_item_state_set() for details.
14084     * @see elm_toolbar_item_state_unset()
14085     * @see elm_toolbar_item_state_add()
14086     *
14087     * @ingroup Toolbar
14088     */
14089    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
14090
14091    /**
14092     * Get the state after selected state in toolbar's @p item.
14093     *
14094     * @param it The toolbar item to change state.
14095     * @return The state after current state, or @c NULL on failure.
14096     *
14097     * If last state is selected, this function will return first state.
14098     *
14099     * @see elm_toolbar_item_state_set()
14100     * @see elm_toolbar_item_state_add()
14101     *
14102     * @ingroup Toolbar
14103     */
14104    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
14105
14106    /**
14107     * Get the state before selected state in toolbar's @p item.
14108     *
14109     * @param it The toolbar item to change state.
14110     * @return The state before current state, or @c NULL on failure.
14111     *
14112     * If first state is selected, this function will return last state.
14113     *
14114     * @see elm_toolbar_item_state_set()
14115     * @see elm_toolbar_item_state_add()
14116     *
14117     * @ingroup Toolbar
14118     */
14119    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
14120
14121    /**
14122     * Set the text to be shown in a given toolbar item's tooltips.
14123     *
14124     * @param item Target item.
14125     * @param text The text to set in the content.
14126     *
14127     * Setup the text as tooltip to object. The item can have only one tooltip,
14128     * so any previous tooltip data - set with this function or
14129     * elm_toolbar_item_tooltip_content_cb_set() - is removed.
14130     *
14131     * @see elm_object_tooltip_text_set() for more details.
14132     *
14133     * @ingroup Toolbar
14134     */
14135    EAPI void             elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
14136
14137    /**
14138     * Set the content to be shown in the tooltip item.
14139     *
14140     * Setup the tooltip to item. The item can have only one tooltip,
14141     * so any previous tooltip data is removed. @p func(with @p data) will
14142     * be called every time that need show the tooltip and it should
14143     * return a valid Evas_Object. This object is then managed fully by
14144     * tooltip system and is deleted when the tooltip is gone.
14145     *
14146     * @param item the toolbar item being attached a tooltip.
14147     * @param func the function used to create the tooltip contents.
14148     * @param data what to provide to @a func as callback data/context.
14149     * @param del_cb called when data is not needed anymore, either when
14150     *        another callback replaces @a func, the tooltip is unset with
14151     *        elm_toolbar_item_tooltip_unset() or the owner @a item
14152     *        dies. This callback receives as the first parameter the
14153     *        given @a data, and @c event_info is the item.
14154     *
14155     * @see elm_object_tooltip_content_cb_set() for more details.
14156     *
14157     * @ingroup Toolbar
14158     */
14159    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);
14160
14161    /**
14162     * Unset tooltip from item.
14163     *
14164     * @param item toolbar item to remove previously set tooltip.
14165     *
14166     * Remove tooltip from item. The callback provided as del_cb to
14167     * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
14168     * it is not used anymore.
14169     *
14170     * @see elm_object_tooltip_unset() for more details.
14171     * @see elm_toolbar_item_tooltip_content_cb_set()
14172     *
14173     * @ingroup Toolbar
14174     */
14175    EAPI void             elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14176
14177    /**
14178     * Sets a different style for this item tooltip.
14179     *
14180     * @note before you set a style you should define a tooltip with
14181     *       elm_toolbar_item_tooltip_content_cb_set() or
14182     *       elm_toolbar_item_tooltip_text_set()
14183     *
14184     * @param item toolbar item with tooltip already set.
14185     * @param style the theme style to use (default, transparent, ...)
14186     *
14187     * @see elm_object_tooltip_style_set() for more details.
14188     *
14189     * @ingroup Toolbar
14190     */
14191    EAPI void             elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
14192
14193    /**
14194     * Get the style for this item tooltip.
14195     *
14196     * @param item toolbar item with tooltip already set.
14197     * @return style the theme style in use, defaults to "default". If the
14198     *         object does not have a tooltip set, then NULL is returned.
14199     *
14200     * @see elm_object_tooltip_style_get() for more details.
14201     * @see elm_toolbar_item_tooltip_style_set()
14202     *
14203     * @ingroup Toolbar
14204     */
14205    EAPI const char      *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14206
14207    /**
14208     * Set the type of mouse pointer/cursor decoration to be shown,
14209     * when the mouse pointer is over the given toolbar widget item
14210     *
14211     * @param item toolbar item to customize cursor on
14212     * @param cursor the cursor type's name
14213     *
14214     * This function works analogously as elm_object_cursor_set(), but
14215     * here the cursor's changing area is restricted to the item's
14216     * area, and not the whole widget's. Note that that item cursors
14217     * have precedence over widget cursors, so that a mouse over an
14218     * item with custom cursor set will always show @b that cursor.
14219     *
14220     * If this function is called twice for an object, a previously set
14221     * cursor will be unset on the second call.
14222     *
14223     * @see elm_object_cursor_set()
14224     * @see elm_toolbar_item_cursor_get()
14225     * @see elm_toolbar_item_cursor_unset()
14226     *
14227     * @ingroup Toolbar
14228     */
14229    EAPI void             elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
14230
14231    /*
14232     * Get the type of mouse pointer/cursor decoration set to be shown,
14233     * when the mouse pointer is over the given toolbar widget item
14234     *
14235     * @param item toolbar item with custom cursor set
14236     * @return the cursor type's name or @c NULL, if no custom cursors
14237     * were set to @p item (and on errors)
14238     *
14239     * @see elm_object_cursor_get()
14240     * @see elm_toolbar_item_cursor_set()
14241     * @see elm_toolbar_item_cursor_unset()
14242     *
14243     * @ingroup Toolbar
14244     */
14245    EAPI const char      *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14246
14247    /**
14248     * Unset any custom mouse pointer/cursor decoration set to be
14249     * shown, when the mouse pointer is over the given toolbar widget
14250     * item, thus making it show the @b default cursor again.
14251     *
14252     * @param item a toolbar item
14253     *
14254     * Use this call to undo any custom settings on this item's cursor
14255     * decoration, bringing it back to defaults (no custom style set).
14256     *
14257     * @see elm_object_cursor_unset()
14258     * @see elm_toolbar_item_cursor_set()
14259     *
14260     * @ingroup Toolbar
14261     */
14262    EAPI void             elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14263
14264    /**
14265     * Set a different @b style for a given custom cursor set for a
14266     * toolbar item.
14267     *
14268     * @param item toolbar item with custom cursor set
14269     * @param style the <b>theme style</b> to use (e.g. @c "default",
14270     * @c "transparent", etc)
14271     *
14272     * This function only makes sense when one is using custom mouse
14273     * cursor decorations <b>defined in a theme file</b>, which can have,
14274     * given a cursor name/type, <b>alternate styles</b> on it. It
14275     * works analogously as elm_object_cursor_style_set(), but here
14276     * applyed only to toolbar item objects.
14277     *
14278     * @warning Before you set a cursor style you should have definen a
14279     *       custom cursor previously on the item, with
14280     *       elm_toolbar_item_cursor_set()
14281     *
14282     * @see elm_toolbar_item_cursor_engine_only_set()
14283     * @see elm_toolbar_item_cursor_style_get()
14284     *
14285     * @ingroup Toolbar
14286     */
14287    EAPI void             elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
14288
14289    /**
14290     * Get the current @b style set for a given toolbar item's custom
14291     * cursor
14292     *
14293     * @param item toolbar item with custom cursor set.
14294     * @return style the cursor style in use. If the object does not
14295     *         have a cursor set, then @c NULL is returned.
14296     *
14297     * @see elm_toolbar_item_cursor_style_set() for more details
14298     *
14299     * @ingroup Toolbar
14300     */
14301    EAPI const char      *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14302
14303    /**
14304     * Set if the (custom)cursor for a given toolbar item should be
14305     * searched in its theme, also, or should only rely on the
14306     * rendering engine.
14307     *
14308     * @param item item with custom (custom) cursor already set on
14309     * @param engine_only Use @c EINA_TRUE to have cursors looked for
14310     * only on those provided by the rendering engine, @c EINA_FALSE to
14311     * have them searched on the widget's theme, as well.
14312     *
14313     * @note This call is of use only if you've set a custom cursor
14314     * for toolbar items, with elm_toolbar_item_cursor_set().
14315     *
14316     * @note By default, cursors will only be looked for between those
14317     * provided by the rendering engine.
14318     *
14319     * @ingroup Toolbar
14320     */
14321    EAPI void             elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
14322
14323    /**
14324     * Get if the (custom) cursor for a given toolbar item is being
14325     * searched in its theme, also, or is only relying on the rendering
14326     * engine.
14327     *
14328     * @param item a toolbar item
14329     * @return @c EINA_TRUE, if cursors are being looked for only on
14330     * those provided by the rendering engine, @c EINA_FALSE if they
14331     * are being searched on the widget's theme, as well.
14332     *
14333     * @see elm_toolbar_item_cursor_engine_only_set(), for more details
14334     *
14335     * @ingroup Toolbar
14336     */
14337    EAPI Eina_Bool        elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14338
14339    /**
14340     * Change a toolbar's orientation
14341     * @param obj The toolbar object
14342     * @param vertical If @c EINA_TRUE, the toolbar is vertical
14343     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
14344     * @ingroup Toolbar
14345     */
14346    EAPI void             elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
14347
14348    /**
14349     * Get a toolbar's orientation
14350     * @param obj The toolbar object
14351     * @return If @c EINA_TRUE, the toolbar is vertical
14352     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
14353     * @ingroup Toolbar
14354     */
14355    EAPI Eina_Bool        elm_toolbar_orientation_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
14356
14357    /**
14358     * @}
14359     */
14360
14361    /**
14362     * @defgroup Tooltips Tooltips
14363     *
14364     * The Tooltip is an (internal, for now) smart object used to show a
14365     * content in a frame on mouse hover of objects(or widgets), with
14366     * tips/information about them.
14367     *
14368     * @{
14369     */
14370
14371    EAPI double       elm_tooltip_delay_get(void);
14372    EAPI Eina_Bool    elm_tooltip_delay_set(double delay);
14373    EAPI void         elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
14374    EAPI void         elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
14375    EAPI void         elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
14376    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);
14377    EAPI void         elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14378    EAPI void         elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
14379    EAPI const char  *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14380    EAPI Eina_Bool    elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
14381    EAPI Eina_Bool    elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
14382
14383    /**
14384     * @}
14385     */
14386
14387    /**
14388     * @defgroup Cursors Cursors
14389     *
14390     * The Elementary cursor is an internal smart object used to
14391     * customize the mouse cursor displayed over objects (or
14392     * widgets). In the most common scenario, the cursor decoration
14393     * comes from the graphical @b engine Elementary is running
14394     * on. Those engines may provide different decorations for cursors,
14395     * and Elementary provides functions to choose them (think of X11
14396     * cursors, as an example).
14397     *
14398     * There's also the possibility of, besides using engine provided
14399     * cursors, also use ones coming from Edje theming files. Both
14400     * globally and per widget, Elementary makes it possible for one to
14401     * make the cursors lookup to be held on engines only or on
14402     * Elementary's theme file, too.
14403     *
14404     * @{
14405     */
14406
14407    /**
14408     * Set the cursor to be shown when mouse is over the object
14409     *
14410     * Set the cursor that will be displayed when mouse is over the
14411     * object. The object can have only one cursor set to it, so if
14412     * this function is called twice for an object, the previous set
14413     * will be unset.
14414     * If using X cursors, a definition of all the valid cursor names
14415     * is listed on Elementary_Cursors.h. If an invalid name is set
14416     * the default cursor will be used.
14417     *
14418     * @param obj the object being set a cursor.
14419     * @param cursor the cursor name to be used.
14420     *
14421     * @ingroup Cursors
14422     */
14423    EAPI void         elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
14424
14425    /**
14426     * Get the cursor to be shown when mouse is over the object
14427     *
14428     * @param obj an object with cursor already set.
14429     * @return the cursor name.
14430     *
14431     * @ingroup Cursors
14432     */
14433    EAPI const char  *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14434
14435    /**
14436     * Unset cursor for object
14437     *
14438     * Unset cursor for object, and set the cursor to default if the mouse
14439     * was over this object.
14440     *
14441     * @param obj Target object
14442     * @see elm_object_cursor_set()
14443     *
14444     * @ingroup Cursors
14445     */
14446    EAPI void         elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14447
14448    /**
14449     * Sets a different style for this object cursor.
14450     *
14451     * @note before you set a style you should define a cursor with
14452     *       elm_object_cursor_set()
14453     *
14454     * @param obj an object with cursor already set.
14455     * @param style the theme style to use (default, transparent, ...)
14456     *
14457     * @ingroup Cursors
14458     */
14459    EAPI void         elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
14460
14461    /**
14462     * Get the style for this object cursor.
14463     *
14464     * @param obj an object with cursor already set.
14465     * @return style the theme style in use, defaults to "default". If the
14466     *         object does not have a cursor set, then NULL is returned.
14467     *
14468     * @ingroup Cursors
14469     */
14470    EAPI const char  *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14471
14472    /**
14473     * Set if the cursor set should be searched on the theme or should use
14474     * the provided by the engine, only.
14475     *
14476     * @note before you set if should look on theme you should define a cursor
14477     * with elm_object_cursor_set(). By default it will only look for cursors
14478     * provided by the engine.
14479     *
14480     * @param obj an object with cursor already set.
14481     * @param engine_only boolean to define it cursors should be looked only
14482     * between the provided by the engine or searched on widget's theme as well.
14483     *
14484     * @ingroup Cursors
14485     */
14486    EAPI void         elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
14487
14488    /**
14489     * Get the cursor engine only usage for this object cursor.
14490     *
14491     * @param obj an object with cursor already set.
14492     * @return engine_only boolean to define it cursors should be
14493     * looked only between the provided by the engine or searched on
14494     * widget's theme as well. If the object does not have a cursor
14495     * set, then EINA_FALSE is returned.
14496     *
14497     * @ingroup Cursors
14498     */
14499    EAPI Eina_Bool    elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14500
14501    /**
14502     * Get the configured cursor engine only usage
14503     *
14504     * This gets the globally configured exclusive usage of engine cursors.
14505     *
14506     * @return 1 if only engine cursors should be used
14507     * @ingroup Cursors
14508     */
14509    EAPI int          elm_cursor_engine_only_get(void);
14510
14511    /**
14512     * Set the configured cursor engine only usage
14513     *
14514     * This sets the globally configured exclusive usage of engine cursors.
14515     * It won't affect cursors set before changing this value.
14516     *
14517     * @param engine_only If 1 only engine cursors will be enabled, if 0 will
14518     * look for them on theme before.
14519     * @return EINA_TRUE if value is valid and setted (0 or 1)
14520     * @ingroup Cursors
14521     */
14522    EAPI Eina_Bool    elm_cursor_engine_only_set(int engine_only);
14523
14524    /**
14525     * @}
14526     */
14527
14528    /**
14529     * @defgroup Menu Menu
14530     *
14531     * @image html img/widget/menu/preview-00.png
14532     * @image latex img/widget/menu/preview-00.eps
14533     *
14534     * A menu is a list of items displayed above its parent. When the menu is
14535     * showing its parent is darkened. Each item can have a sub-menu. The menu
14536     * object can be used to display a menu on a right click event, in a toolbar,
14537     * anywhere.
14538     *
14539     * Signals that you can add callbacks for are:
14540     * @li "clicked" - the user clicked the empty space in the menu to dismiss.
14541     *             event_info is NULL.
14542     *
14543     * @see @ref tutorial_menu
14544     * @{
14545     */
14546    typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
14547    /**
14548     * @brief Add a new menu to the parent
14549     *
14550     * @param parent The parent object.
14551     * @return The new object or NULL if it cannot be created.
14552     */
14553    EAPI Evas_Object       *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14554    /**
14555     * @brief Set the parent for the given menu widget
14556     *
14557     * @param obj The menu object.
14558     * @param parent The new parent.
14559     */
14560    EAPI void               elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14561    /**
14562     * @brief Get the parent for the given menu widget
14563     *
14564     * @param obj The menu object.
14565     * @return The parent.
14566     *
14567     * @see elm_menu_parent_set()
14568     */
14569    EAPI Evas_Object       *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14570    /**
14571     * @brief Move the menu to a new position
14572     *
14573     * @param obj The menu object.
14574     * @param x The new position.
14575     * @param y The new position.
14576     *
14577     * Sets the top-left position of the menu to (@p x,@p y).
14578     *
14579     * @note @p x and @p y coordinates are relative to parent.
14580     */
14581    EAPI void               elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
14582    /**
14583     * @brief Close a opened menu
14584     *
14585     * @param obj the menu object
14586     * @return void
14587     *
14588     * Hides the menu and all it's sub-menus.
14589     */
14590    EAPI void               elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
14591    /**
14592     * @brief Returns a list of @p item's items.
14593     *
14594     * @param obj The menu object
14595     * @return An Eina_List* of @p item's items
14596     */
14597    EAPI const Eina_List   *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14598    /**
14599     * @brief Get the Evas_Object of an Elm_Menu_Item
14600     *
14601     * @param item The menu item object.
14602     * @return The edje object containing the swallowed content
14603     *
14604     * @warning Don't manipulate this object!
14605     */
14606    EAPI Evas_Object       *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14607    /**
14608     * @brief Add an item at the end of the given menu widget
14609     *
14610     * @param obj The menu object.
14611     * @param parent The parent menu item (optional)
14612     * @param icon A icon display on the item. The icon will be destryed by the menu.
14613     * @param label The label of the item.
14614     * @param func Function called when the user select the item.
14615     * @param data Data sent by the callback.
14616     * @return Returns the new item.
14617     */
14618    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);
14619    /**
14620     * @brief Add an object swallowed in an item at the end of the given menu
14621     * widget
14622     *
14623     * @param obj The menu object.
14624     * @param parent The parent menu item (optional)
14625     * @param subobj The object to swallow
14626     * @param func Function called when the user select the item.
14627     * @param data Data sent by the callback.
14628     * @return Returns the new item.
14629     *
14630     * Add an evas object as an item to the menu.
14631     */
14632    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);
14633    /**
14634     * @brief Set the label of a menu item
14635     *
14636     * @param item The menu item object.
14637     * @param label The label to set for @p item
14638     *
14639     * @warning Don't use this funcion on items created with
14640     * elm_menu_item_add_object() or elm_menu_item_separator_add().
14641     */
14642    EAPI void               elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
14643    /**
14644     * @brief Get the label of a menu item
14645     *
14646     * @param item The menu item object.
14647     * @return The label of @p item
14648     */
14649    EAPI const char        *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14650    /**
14651     * @brief Set the icon of a menu item to the standard icon with name @p icon
14652     *
14653     * @param item The menu item object.
14654     * @param icon The icon object to set for the content of @p item
14655     *
14656     * Once this icon is set, any previously set icon will be deleted.
14657     */
14658    EAPI void               elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
14659    /**
14660     * @brief Get the string representation from the icon of a menu item
14661     *
14662     * @param item The menu item object.
14663     * @return The string representation of @p item's icon or NULL
14664     *
14665     * @see elm_menu_item_object_icon_name_set()
14666     */
14667    EAPI const char        *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14668    /**
14669     * @brief Set the content object of a menu item
14670     *
14671     * @param item The menu item object
14672     * @param The content object or NULL
14673     * @return EINA_TRUE on success, else EINA_FALSE
14674     *
14675     * Use this function to change the object swallowed by a menu item, deleting
14676     * any previously swallowed object.
14677     */
14678    EAPI Eina_Bool          elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
14679    /**
14680     * @brief Get the content object of a menu item
14681     *
14682     * @param item The menu item object
14683     * @return The content object or NULL
14684     * @note If @p item was added with elm_menu_item_add_object, this
14685     * function will return the object passed, else it will return the
14686     * icon object.
14687     *
14688     * @see elm_menu_item_object_content_set()
14689     */
14690    EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14691    /**
14692     * @brief Set the selected state of @p item.
14693     *
14694     * @param item The menu item object.
14695     * @param selected The selected/unselected state of the item
14696     */
14697    EAPI void               elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14698    /**
14699     * @brief Get the selected state of @p item.
14700     *
14701     * @param item The menu item object.
14702     * @return The selected/unselected state of the item
14703     *
14704     * @see elm_menu_item_selected_set()
14705     */
14706    EAPI Eina_Bool          elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14707    /**
14708     * @brief Set the disabled state of @p item.
14709     *
14710     * @param item The menu item object.
14711     * @param disabled The enabled/disabled state of the item
14712     */
14713    EAPI void               elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14714    /**
14715     * @brief Get the disabled state of @p item.
14716     *
14717     * @param item The menu item object.
14718     * @return The enabled/disabled state of the item
14719     *
14720     * @see elm_menu_item_disabled_set()
14721     */
14722    EAPI Eina_Bool          elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14723    /**
14724     * @brief Add a separator item to menu @p obj under @p parent.
14725     *
14726     * @param obj The menu object
14727     * @param parent The item to add the separator under
14728     * @return The created item or NULL on failure
14729     *
14730     * This is item is a @ref Separator.
14731     */
14732    EAPI Elm_Menu_Item     *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
14733    /**
14734     * @brief Returns whether @p item is a separator.
14735     *
14736     * @param item The item to check
14737     * @return If true, @p item is a separator
14738     *
14739     * @see elm_menu_item_separator_add()
14740     */
14741    EAPI Eina_Bool          elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14742    /**
14743     * @brief Deletes an item from the menu.
14744     *
14745     * @param item The item to delete.
14746     *
14747     * @see elm_menu_item_add()
14748     */
14749    EAPI void               elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14750    /**
14751     * @brief Set the function called when a menu item is deleted.
14752     *
14753     * @param item The item to set the callback on
14754     * @param func The function called
14755     *
14756     * @see elm_menu_item_add()
14757     * @see elm_menu_item_del()
14758     */
14759    EAPI void               elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14760    /**
14761     * @brief Returns the data associated with menu item @p item.
14762     *
14763     * @param item The item
14764     * @return The data associated with @p item or NULL if none was set.
14765     *
14766     * This is the data set with elm_menu_add() or elm_menu_item_data_set().
14767     */
14768    EAPI void              *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14769    /**
14770     * @brief Sets the data to be associated with menu item @p item.
14771     *
14772     * @param item The item
14773     * @param data The data to be associated with @p item
14774     */
14775    EAPI void               elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
14776    /**
14777     * @brief Returns a list of @p item's subitems.
14778     *
14779     * @param item The item
14780     * @return An Eina_List* of @p item's subitems
14781     *
14782     * @see elm_menu_add()
14783     */
14784    EAPI const Eina_List   *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14785    /**
14786     * @brief Get the position of a menu item
14787     *
14788     * @param item The menu item
14789     * @return The item's index
14790     *
14791     * This function returns the index position of a menu item in a menu.
14792     * For a sub-menu, this number is relative to the first item in the sub-menu.
14793     *
14794     * @note Index values begin with 0
14795     */
14796    EAPI unsigned int       elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
14797    /**
14798     * @brief @brief Return a menu item's owner menu
14799     *
14800     * @param item The menu item
14801     * @return The menu object owning @p item, or NULL on failure
14802     *
14803     * Use this function to get the menu object owning an item.
14804     */
14805    EAPI Evas_Object       *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
14806    /**
14807     * @brief Get the selected item in the menu
14808     *
14809     * @param obj The menu object
14810     * @return The selected item, or NULL if none
14811     *
14812     * @see elm_menu_item_selected_get()
14813     * @see elm_menu_item_selected_set()
14814     */
14815    EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14816    /**
14817     * @brief Get the last item in the menu
14818     *
14819     * @param obj The menu object
14820     * @return The last item, or NULL if none
14821     */
14822    EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14823    /**
14824     * @brief Get the first item in the menu
14825     *
14826     * @param obj The menu object
14827     * @return The first item, or NULL if none
14828     */
14829    EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14830    /**
14831     * @brief Get the next item in the menu.
14832     *
14833     * @param item The menu item object.
14834     * @return The item after it, or NULL if none
14835     */
14836    EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14837    /**
14838     * @brief Get the previous item in the menu.
14839     *
14840     * @param item The menu item object.
14841     * @return The item before it, or NULL if none
14842     */
14843    EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14844    /**
14845     * @}
14846     */
14847
14848    /**
14849     * @defgroup List List
14850     * @ingroup Elementary
14851     *
14852     * @image html img/widget/list/preview-00.png
14853     * @image latex img/widget/list/preview-00.eps width=\textwidth
14854     *
14855     * @image html img/list.png
14856     * @image latex img/list.eps width=\textwidth
14857     *
14858     * A list widget is a container whose children are displayed vertically or
14859     * horizontally, in order, and can be selected.
14860     * The list can accept only one or multiple items selection. Also has many
14861     * modes of items displaying.
14862     *
14863     * A list is a very simple type of list widget.  For more robust
14864     * lists, @ref Genlist should probably be used.
14865     *
14866     * Smart callbacks one can listen to:
14867     * - @c "activated" - The user has double-clicked or pressed
14868     *   (enter|return|spacebar) on an item. The @c event_info parameter
14869     *   is the item that was activated.
14870     * - @c "clicked,double" - The user has double-clicked an item.
14871     *   The @c event_info parameter is the item that was double-clicked.
14872     * - "selected" - when the user selected an item
14873     * - "unselected" - when the user unselected an item
14874     * - "longpressed" - an item in the list is long-pressed
14875     * - "scroll,edge,top" - the list is scrolled until the top edge
14876     * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
14877     * - "scroll,edge,left" - the list is scrolled until the left edge
14878     * - "scroll,edge,right" - the list is scrolled until the right edge
14879     *
14880     * Available styles for it:
14881     * - @c "default"
14882     *
14883     * List of examples:
14884     * @li @ref list_example_01
14885     * @li @ref list_example_02
14886     * @li @ref list_example_03
14887     */
14888
14889    /**
14890     * @addtogroup List
14891     * @{
14892     */
14893
14894    /**
14895     * @enum _Elm_List_Mode
14896     * @typedef Elm_List_Mode
14897     *
14898     * Set list's resize behavior, transverse axis scroll and
14899     * items cropping. See each mode's description for more details.
14900     *
14901     * @note Default value is #ELM_LIST_SCROLL.
14902     *
14903     * Values <b> don't </b> work as bitmask, only one can be choosen.
14904     *
14905     * @see elm_list_mode_set()
14906     * @see elm_list_mode_get()
14907     *
14908     * @ingroup List
14909     */
14910    typedef enum _Elm_List_Mode
14911      {
14912         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. */
14913         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). */
14914         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. */
14915         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. */
14916         ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
14917      } Elm_List_Mode;
14918
14919    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().  */
14920
14921    /**
14922     * Add a new list widget to the given parent Elementary
14923     * (container) object.
14924     *
14925     * @param parent The parent object.
14926     * @return a new list widget handle or @c NULL, on errors.
14927     *
14928     * This function inserts a new list widget on the canvas.
14929     *
14930     * @ingroup List
14931     */
14932    EAPI Evas_Object     *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14933
14934    /**
14935     * Starts the list.
14936     *
14937     * @param obj The list object
14938     *
14939     * @note Call before running show() on the list object.
14940     * @warning If not called, it won't display the list properly.
14941     *
14942     * @code
14943     * li = elm_list_add(win);
14944     * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
14945     * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
14946     * elm_list_go(li);
14947     * evas_object_show(li);
14948     * @endcode
14949     *
14950     * @ingroup List
14951     */
14952    EAPI void             elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
14953
14954    /**
14955     * Enable or disable multiple items selection on the list object.
14956     *
14957     * @param obj The list object
14958     * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
14959     * disable it.
14960     *
14961     * Disabled by default. If disabled, the user can select a single item of
14962     * the list each time. Selected items are highlighted on list.
14963     * If enabled, many items can be selected.
14964     *
14965     * If a selected item is selected again, it will be unselected.
14966     *
14967     * @see elm_list_multi_select_get()
14968     *
14969     * @ingroup List
14970     */
14971    EAPI void             elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
14972
14973    /**
14974     * Get a value whether multiple items selection is enabled or not.
14975     *
14976     * @see elm_list_multi_select_set() for details.
14977     *
14978     * @param obj The list object.
14979     * @return @c EINA_TRUE means multiple items selection is enabled.
14980     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14981     * @c EINA_FALSE is returned.
14982     *
14983     * @ingroup List
14984     */
14985    EAPI Eina_Bool        elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14986
14987    /**
14988     * Set which mode to use for the list object.
14989     *
14990     * @param obj The list object
14991     * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
14992     * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
14993     *
14994     * Set list's resize behavior, transverse axis scroll and
14995     * items cropping. See each mode's description for more details.
14996     *
14997     * @note Default value is #ELM_LIST_SCROLL.
14998     *
14999     * Only one can be set, if a previous one was set, it will be changed
15000     * by the new mode set. Bitmask won't work as well.
15001     *
15002     * @see elm_list_mode_get()
15003     *
15004     * @ingroup List
15005     */
15006    EAPI void             elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
15007
15008    /**
15009     * Get the mode the list is at.
15010     *
15011     * @param obj The list object
15012     * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
15013     * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
15014     *
15015     * @note see elm_list_mode_set() for more information.
15016     *
15017     * @ingroup List
15018     */
15019    EAPI Elm_List_Mode    elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15020
15021    /**
15022     * Enable or disable horizontal mode on the list object.
15023     *
15024     * @param obj The list object.
15025     * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
15026     * disable it, i.e., to enable vertical mode.
15027     *
15028     * @note Vertical mode is set by default.
15029     *
15030     * On horizontal mode items are displayed on list from left to right,
15031     * instead of from top to bottom. Also, the list will scroll horizontally.
15032     * Each item will presents left icon on top and right icon, or end, at
15033     * the bottom.
15034     *
15035     * @see elm_list_horizontal_get()
15036     *
15037     * @ingroup List
15038     */
15039    EAPI void             elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15040
15041    /**
15042     * Get a value whether horizontal mode is enabled or not.
15043     *
15044     * @param obj The list object.
15045     * @return @c EINA_TRUE means horizontal mode selection is enabled.
15046     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
15047     * @c EINA_FALSE is returned.
15048     *
15049     * @see elm_list_horizontal_set() for details.
15050     *
15051     * @ingroup List
15052     */
15053    EAPI Eina_Bool        elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15054
15055    /**
15056     * Enable or disable always select mode on the list object.
15057     *
15058     * @param obj The list object
15059     * @param always_select @c EINA_TRUE to enable always select mode or
15060     * @c EINA_FALSE to disable it.
15061     *
15062     * @note Always select mode is disabled by default.
15063     *
15064     * Default behavior of list items is to only call its callback function
15065     * the first time it's pressed, i.e., when it is selected. If a selected
15066     * item is pressed again, and multi-select is disabled, it won't call
15067     * this function (if multi-select is enabled it will unselect the item).
15068     *
15069     * If always select is enabled, it will call the callback function
15070     * everytime a item is pressed, so it will call when the item is selected,
15071     * and again when a selected item is pressed.
15072     *
15073     * @see elm_list_always_select_mode_get()
15074     * @see elm_list_multi_select_set()
15075     *
15076     * @ingroup List
15077     */
15078    EAPI void             elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
15079
15080    /**
15081     * Get a value whether always select mode is enabled or not, meaning that
15082     * an item will always call its callback function, even if already selected.
15083     *
15084     * @param obj The list object
15085     * @return @c EINA_TRUE means horizontal mode selection is enabled.
15086     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
15087     * @c EINA_FALSE is returned.
15088     *
15089     * @see elm_list_always_select_mode_set() for details.
15090     *
15091     * @ingroup List
15092     */
15093    EAPI Eina_Bool        elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15094
15095    /**
15096     * Set bouncing behaviour when the scrolled content reaches an edge.
15097     *
15098     * Tell the internal scroller object whether it should bounce or not
15099     * when it reaches the respective edges for each axis.
15100     *
15101     * @param obj The list object
15102     * @param h_bounce Whether to bounce or not in the horizontal axis.
15103     * @param v_bounce Whether to bounce or not in the vertical axis.
15104     *
15105     * @see elm_scroller_bounce_set()
15106     *
15107     * @ingroup List
15108     */
15109    EAPI void             elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
15110
15111    /**
15112     * Get the bouncing behaviour of the internal scroller.
15113     *
15114     * Get whether the internal scroller should bounce when the edge of each
15115     * axis is reached scrolling.
15116     *
15117     * @param obj The list object.
15118     * @param h_bounce Pointer where to store the bounce state of the horizontal
15119     * axis.
15120     * @param v_bounce Pointer where to store the bounce state of the vertical
15121     * axis.
15122     *
15123     * @see elm_scroller_bounce_get()
15124     * @see elm_list_bounce_set()
15125     *
15126     * @ingroup List
15127     */
15128    EAPI void             elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
15129
15130    /**
15131     * Set the scrollbar policy.
15132     *
15133     * @param obj The list object
15134     * @param policy_h Horizontal scrollbar policy.
15135     * @param policy_v Vertical scrollbar policy.
15136     *
15137     * This sets the scrollbar visibility policy for the given scroller.
15138     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
15139     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
15140     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
15141     * This applies respectively for the horizontal and vertical scrollbars.
15142     *
15143     * The both are disabled by default, i.e., are set to
15144     * #ELM_SCROLLER_POLICY_OFF.
15145     *
15146     * @ingroup List
15147     */
15148    EAPI void             elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
15149
15150    /**
15151     * Get the scrollbar policy.
15152     *
15153     * @see elm_list_scroller_policy_get() for details.
15154     *
15155     * @param obj The list object.
15156     * @param policy_h Pointer where to store horizontal scrollbar policy.
15157     * @param policy_v Pointer where to store vertical scrollbar policy.
15158     *
15159     * @ingroup List
15160     */
15161    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);
15162
15163    /**
15164     * Append a new item to the list object.
15165     *
15166     * @param obj The list object.
15167     * @param label The label of the list item.
15168     * @param icon The icon object to use for the left side of the item. An
15169     * icon can be any Evas object, but usually it is an icon created
15170     * with elm_icon_add().
15171     * @param end The icon object to use for the right side of the item. An
15172     * icon can be any Evas object.
15173     * @param func The function to call when the item is clicked.
15174     * @param data The data to associate with the item for related callbacks.
15175     *
15176     * @return The created item or @c NULL upon failure.
15177     *
15178     * A new item will be created and appended to the list, i.e., will
15179     * be set as @b last item.
15180     *
15181     * Items created with this method can be deleted with
15182     * elm_list_item_del().
15183     *
15184     * Associated @p data can be properly freed when item is deleted if a
15185     * callback function is set with elm_list_item_del_cb_set().
15186     *
15187     * If a function is passed as argument, it will be called everytime this item
15188     * is selected, i.e., the user clicks over an unselected item.
15189     * If always select is enabled it will call this function every time
15190     * user clicks over an item (already selected or not).
15191     * If such function isn't needed, just passing
15192     * @c NULL as @p func is enough. The same should be done for @p data.
15193     *
15194     * Simple example (with no function callback or data associated):
15195     * @code
15196     * li = elm_list_add(win);
15197     * ic = elm_icon_add(win);
15198     * elm_icon_file_set(ic, "path/to/image", NULL);
15199     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
15200     * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
15201     * elm_list_go(li);
15202     * evas_object_show(li);
15203     * @endcode
15204     *
15205     * @see elm_list_always_select_mode_set()
15206     * @see elm_list_item_del()
15207     * @see elm_list_item_del_cb_set()
15208     * @see elm_list_clear()
15209     * @see elm_icon_add()
15210     *
15211     * @ingroup List
15212     */
15213    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);
15214
15215    /**
15216     * Prepend a new item to the list object.
15217     *
15218     * @param obj The list object.
15219     * @param label The label of the list item.
15220     * @param icon The icon object to use for the left side of the item. An
15221     * icon can be any Evas object, but usually it is an icon created
15222     * with elm_icon_add().
15223     * @param end The icon object to use for the right side of the item. An
15224     * icon can be any Evas object.
15225     * @param func The function to call when the item is clicked.
15226     * @param data The data to associate with the item for related callbacks.
15227     *
15228     * @return The created item or @c NULL upon failure.
15229     *
15230     * A new item will be created and prepended to the list, i.e., will
15231     * be set as @b first item.
15232     *
15233     * Items created with this method can be deleted with
15234     * elm_list_item_del().
15235     *
15236     * Associated @p data can be properly freed when item is deleted if a
15237     * callback function is set with elm_list_item_del_cb_set().
15238     *
15239     * If a function is passed as argument, it will be called everytime this item
15240     * is selected, i.e., the user clicks over an unselected item.
15241     * If always select is enabled it will call this function every time
15242     * user clicks over an item (already selected or not).
15243     * If such function isn't needed, just passing
15244     * @c NULL as @p func is enough. The same should be done for @p data.
15245     *
15246     * @see elm_list_item_append() for a simple code example.
15247     * @see elm_list_always_select_mode_set()
15248     * @see elm_list_item_del()
15249     * @see elm_list_item_del_cb_set()
15250     * @see elm_list_clear()
15251     * @see elm_icon_add()
15252     *
15253     * @ingroup List
15254     */
15255    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);
15256
15257    /**
15258     * Insert a new item into the list object before item @p before.
15259     *
15260     * @param obj The list object.
15261     * @param before The list item to insert before.
15262     * @param label The label of the list item.
15263     * @param icon The icon object to use for the left side of the item. An
15264     * icon can be any Evas object, but usually it is an icon created
15265     * with elm_icon_add().
15266     * @param end The icon object to use for the right side of the item. An
15267     * icon can be any Evas object.
15268     * @param func The function to call when the item is clicked.
15269     * @param data The data to associate with the item for related callbacks.
15270     *
15271     * @return The created item or @c NULL upon failure.
15272     *
15273     * A new item will be created and added to the list. Its position in
15274     * this list will be just before item @p before.
15275     *
15276     * Items created with this method can be deleted with
15277     * elm_list_item_del().
15278     *
15279     * Associated @p data can be properly freed when item is deleted if a
15280     * callback function is set with elm_list_item_del_cb_set().
15281     *
15282     * If a function is passed as argument, it will be called everytime this item
15283     * is selected, i.e., the user clicks over an unselected item.
15284     * If always select is enabled it will call this function every time
15285     * user clicks over an item (already selected or not).
15286     * If such function isn't needed, just passing
15287     * @c NULL as @p func is enough. The same should be done for @p data.
15288     *
15289     * @see elm_list_item_append() for a simple code example.
15290     * @see elm_list_always_select_mode_set()
15291     * @see elm_list_item_del()
15292     * @see elm_list_item_del_cb_set()
15293     * @see elm_list_clear()
15294     * @see elm_icon_add()
15295     *
15296     * @ingroup List
15297     */
15298    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);
15299
15300    /**
15301     * Insert a new item into the list object after item @p after.
15302     *
15303     * @param obj The list object.
15304     * @param after The list item to insert after.
15305     * @param label The label of the list item.
15306     * @param icon The icon object to use for the left side of the item. An
15307     * icon can be any Evas object, but usually it is an icon created
15308     * with elm_icon_add().
15309     * @param end The icon object to use for the right side of the item. An
15310     * icon can be any Evas object.
15311     * @param func The function to call when the item is clicked.
15312     * @param data The data to associate with the item for related callbacks.
15313     *
15314     * @return The created item or @c NULL upon failure.
15315     *
15316     * A new item will be created and added to the list. Its position in
15317     * this list will be just after item @p after.
15318     *
15319     * Items created with this method can be deleted with
15320     * elm_list_item_del().
15321     *
15322     * Associated @p data can be properly freed when item is deleted if a
15323     * callback function is set with elm_list_item_del_cb_set().
15324     *
15325     * If a function is passed as argument, it will be called everytime this item
15326     * is selected, i.e., the user clicks over an unselected item.
15327     * If always select is enabled it will call this function every time
15328     * user clicks over an item (already selected or not).
15329     * If such function isn't needed, just passing
15330     * @c NULL as @p func is enough. The same should be done for @p data.
15331     *
15332     * @see elm_list_item_append() for a simple code example.
15333     * @see elm_list_always_select_mode_set()
15334     * @see elm_list_item_del()
15335     * @see elm_list_item_del_cb_set()
15336     * @see elm_list_clear()
15337     * @see elm_icon_add()
15338     *
15339     * @ingroup List
15340     */
15341    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);
15342
15343    /**
15344     * Insert a new item into the sorted list object.
15345     *
15346     * @param obj The list object.
15347     * @param label The label of the list item.
15348     * @param icon The icon object to use for the left side of the item. An
15349     * icon can be any Evas object, but usually it is an icon created
15350     * with elm_icon_add().
15351     * @param end The icon object to use for the right side of the item. An
15352     * icon can be any Evas object.
15353     * @param func The function to call when the item is clicked.
15354     * @param data The data to associate with the item for related callbacks.
15355     * @param cmp_func The comparing function to be used to sort list
15356     * items <b>by #Elm_List_Item item handles</b>. This function will
15357     * receive two items and compare them, returning a non-negative integer
15358     * if the second item should be place after the first, or negative value
15359     * if should be placed before.
15360     *
15361     * @return The created item or @c NULL upon failure.
15362     *
15363     * @note This function inserts values into a list object assuming it was
15364     * sorted and the result will be sorted.
15365     *
15366     * A new item will be created and added to the list. Its position in
15367     * this list will be found comparing the new item with previously inserted
15368     * items using function @p cmp_func.
15369     *
15370     * Items created with this method can be deleted with
15371     * elm_list_item_del().
15372     *
15373     * Associated @p data can be properly freed when item is deleted if a
15374     * callback function is set with elm_list_item_del_cb_set().
15375     *
15376     * If a function is passed as argument, it will be called everytime this item
15377     * is selected, i.e., the user clicks over an unselected item.
15378     * If always select is enabled it will call this function every time
15379     * user clicks over an item (already selected or not).
15380     * If such function isn't needed, just passing
15381     * @c NULL as @p func is enough. The same should be done for @p data.
15382     *
15383     * @see elm_list_item_append() for a simple code example.
15384     * @see elm_list_always_select_mode_set()
15385     * @see elm_list_item_del()
15386     * @see elm_list_item_del_cb_set()
15387     * @see elm_list_clear()
15388     * @see elm_icon_add()
15389     *
15390     * @ingroup List
15391     */
15392    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);
15393
15394    /**
15395     * Remove all list's items.
15396     *
15397     * @param obj The list object
15398     *
15399     * @see elm_list_item_del()
15400     * @see elm_list_item_append()
15401     *
15402     * @ingroup List
15403     */
15404    EAPI void             elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
15405
15406    /**
15407     * Get a list of all the list items.
15408     *
15409     * @param obj The list object
15410     * @return An @c Eina_List of list items, #Elm_List_Item,
15411     * or @c NULL on failure.
15412     *
15413     * @see elm_list_item_append()
15414     * @see elm_list_item_del()
15415     * @see elm_list_clear()
15416     *
15417     * @ingroup List
15418     */
15419    EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15420
15421    /**
15422     * Get the selected item.
15423     *
15424     * @param obj The list object.
15425     * @return The selected list item.
15426     *
15427     * The selected item can be unselected with function
15428     * elm_list_item_selected_set().
15429     *
15430     * The selected item always will be highlighted on list.
15431     *
15432     * @see elm_list_selected_items_get()
15433     *
15434     * @ingroup List
15435     */
15436    EAPI Elm_List_Item   *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15437
15438    /**
15439     * Return a list of the currently selected list items.
15440     *
15441     * @param obj The list object.
15442     * @return An @c Eina_List of list items, #Elm_List_Item,
15443     * or @c NULL on failure.
15444     *
15445     * Multiple items can be selected if multi select is enabled. It can be
15446     * done with elm_list_multi_select_set().
15447     *
15448     * @see elm_list_selected_item_get()
15449     * @see elm_list_multi_select_set()
15450     *
15451     * @ingroup List
15452     */
15453    EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15454
15455    /**
15456     * Set the selected state of an item.
15457     *
15458     * @param item The list item
15459     * @param selected The selected state
15460     *
15461     * This sets the selected state of the given item @p it.
15462     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
15463     *
15464     * If a new item is selected the previosly selected will be unselected,
15465     * unless multiple selection is enabled with elm_list_multi_select_set().
15466     * Previoulsy selected item can be get with function
15467     * elm_list_selected_item_get().
15468     *
15469     * Selected items will be highlighted.
15470     *
15471     * @see elm_list_item_selected_get()
15472     * @see elm_list_selected_item_get()
15473     * @see elm_list_multi_select_set()
15474     *
15475     * @ingroup List
15476     */
15477    EAPI void             elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15478
15479    /*
15480     * Get whether the @p item is selected or not.
15481     *
15482     * @param item The list item.
15483     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
15484     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
15485     *
15486     * @see elm_list_selected_item_set() for details.
15487     * @see elm_list_item_selected_get()
15488     *
15489     * @ingroup List
15490     */
15491    EAPI Eina_Bool        elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15492
15493    /**
15494     * Set or unset item as a separator.
15495     *
15496     * @param it The list item.
15497     * @param setting @c EINA_TRUE to set item @p it as separator or
15498     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15499     *
15500     * Items aren't set as separator by default.
15501     *
15502     * If set as separator it will display separator theme, so won't display
15503     * icons or label.
15504     *
15505     * @see elm_list_item_separator_get()
15506     *
15507     * @ingroup List
15508     */
15509    EAPI void             elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
15510
15511    /**
15512     * Get a value whether item is a separator or not.
15513     *
15514     * @see elm_list_item_separator_set() for details.
15515     *
15516     * @param it The list item.
15517     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15518     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15519     *
15520     * @ingroup List
15521     */
15522    EAPI Eina_Bool        elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15523
15524    /**
15525     * Show @p item in the list view.
15526     *
15527     * @param item The list item to be shown.
15528     *
15529     * It won't animate list until item is visible. If such behavior is wanted,
15530     * use elm_list_bring_in() intead.
15531     *
15532     * @ingroup List
15533     */
15534    EAPI void             elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15535
15536    /**
15537     * Bring in the given item to list view.
15538     *
15539     * @param item The item.
15540     *
15541     * This causes list to jump to the given item @p item and show it
15542     * (by scrolling), if it is not fully visible.
15543     *
15544     * This may use animation to do so and take a period of time.
15545     *
15546     * If animation isn't wanted, elm_list_item_show() can be used.
15547     *
15548     * @ingroup List
15549     */
15550    EAPI void             elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15551
15552    /**
15553     * Delete them item from the list.
15554     *
15555     * @param item The item of list to be deleted.
15556     *
15557     * If deleting all list items is required, elm_list_clear()
15558     * should be used instead of getting items list and deleting each one.
15559     *
15560     * @see elm_list_clear()
15561     * @see elm_list_item_append()
15562     * @see elm_list_item_del_cb_set()
15563     *
15564     * @ingroup List
15565     */
15566    EAPI void             elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15567
15568    /**
15569     * Set the function called when a list item is freed.
15570     *
15571     * @param item The item to set the callback on
15572     * @param func The function called
15573     *
15574     * If there is a @p func, then it will be called prior item's memory release.
15575     * That will be called with the following arguments:
15576     * @li item's data;
15577     * @li item's Evas object;
15578     * @li item itself;
15579     *
15580     * This way, a data associated to a list item could be properly freed.
15581     *
15582     * @ingroup List
15583     */
15584    EAPI void             elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15585
15586    /**
15587     * Get the data associated to the item.
15588     *
15589     * @param item The list item
15590     * @return The data associated to @p item
15591     *
15592     * The return value is a pointer to data associated to @p item when it was
15593     * created, with function elm_list_item_append() or similar. If no data
15594     * was passed as argument, it will return @c NULL.
15595     *
15596     * @see elm_list_item_append()
15597     *
15598     * @ingroup List
15599     */
15600    EAPI void            *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15601
15602    /**
15603     * Get the left side icon associated to the item.
15604     *
15605     * @param item The list item
15606     * @return The left side icon associated to @p item
15607     *
15608     * The return value is a pointer to the icon associated to @p item when
15609     * it was
15610     * created, with function elm_list_item_append() or similar, or later
15611     * with function elm_list_item_icon_set(). If no icon
15612     * was passed as argument, it will return @c NULL.
15613     *
15614     * @see elm_list_item_append()
15615     * @see elm_list_item_icon_set()
15616     *
15617     * @ingroup List
15618     */
15619    EAPI Evas_Object     *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15620
15621    /**
15622     * Set the left side icon associated to the item.
15623     *
15624     * @param item The list item
15625     * @param icon The left side icon object to associate with @p item
15626     *
15627     * The icon object to use at left side of the item. An
15628     * icon can be any Evas object, but usually it is an icon created
15629     * with elm_icon_add().
15630     *
15631     * Once the icon object is set, a previously set one will be deleted.
15632     * @warning Setting the same icon for two items will cause the icon to
15633     * dissapear from the first item.
15634     *
15635     * If an icon was passed as argument on item creation, with function
15636     * elm_list_item_append() or similar, it will be already
15637     * associated to the item.
15638     *
15639     * @see elm_list_item_append()
15640     * @see elm_list_item_icon_get()
15641     *
15642     * @ingroup List
15643     */
15644    EAPI void             elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
15645
15646    /**
15647     * Get the right side icon associated to the item.
15648     *
15649     * @param item The list item
15650     * @return The right side icon associated to @p item
15651     *
15652     * The return value is a pointer to the icon associated to @p item when
15653     * it was
15654     * created, with function elm_list_item_append() or similar, or later
15655     * with function elm_list_item_icon_set(). If no icon
15656     * was passed as argument, it will return @c NULL.
15657     *
15658     * @see elm_list_item_append()
15659     * @see elm_list_item_icon_set()
15660     *
15661     * @ingroup List
15662     */
15663    EAPI Evas_Object     *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15664
15665    /**
15666     * Set the right side icon associated to the item.
15667     *
15668     * @param item The list item
15669     * @param end The right side icon object to associate with @p item
15670     *
15671     * The icon object to use at right side of the item. An
15672     * icon can be any Evas object, but usually it is an icon created
15673     * with elm_icon_add().
15674     *
15675     * Once the icon object is set, a previously set one will be deleted.
15676     * @warning Setting the same icon for two items will cause the icon to
15677     * dissapear from the first item.
15678     *
15679     * If an icon was passed as argument on item creation, with function
15680     * elm_list_item_append() or similar, it will be already
15681     * associated to the item.
15682     *
15683     * @see elm_list_item_append()
15684     * @see elm_list_item_end_get()
15685     *
15686     * @ingroup List
15687     */
15688    EAPI void             elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
15689
15690    /**
15691     * Gets the base object of the item.
15692     *
15693     * @param item The list item
15694     * @return The base object associated with @p item
15695     *
15696     * Base object is the @c Evas_Object that represents that item.
15697     *
15698     * @ingroup List
15699     */
15700    EAPI Evas_Object     *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15701    EINA_DEPRECATED EAPI Evas_Object     *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15702
15703    /**
15704     * Get the label of item.
15705     *
15706     * @param item The item of list.
15707     * @return The label of item.
15708     *
15709     * The return value is a pointer to the label associated to @p item when
15710     * it was created, with function elm_list_item_append(), or later
15711     * with function elm_list_item_label_set. If no label
15712     * was passed as argument, it will return @c NULL.
15713     *
15714     * @see elm_list_item_label_set() for more details.
15715     * @see elm_list_item_append()
15716     *
15717     * @ingroup List
15718     */
15719    EAPI const char      *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15720
15721    /**
15722     * Set the label of item.
15723     *
15724     * @param item The item of list.
15725     * @param text The label of item.
15726     *
15727     * The label to be displayed by the item.
15728     * Label will be placed between left and right side icons (if set).
15729     *
15730     * If a label was passed as argument on item creation, with function
15731     * elm_list_item_append() or similar, it will be already
15732     * displayed by the item.
15733     *
15734     * @see elm_list_item_label_get()
15735     * @see elm_list_item_append()
15736     *
15737     * @ingroup List
15738     */
15739    EAPI void             elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
15740
15741
15742    /**
15743     * Get the item before @p it in list.
15744     *
15745     * @param it The list item.
15746     * @return The item before @p it, or @c NULL if none or on failure.
15747     *
15748     * @note If it is the first item, @c NULL will be returned.
15749     *
15750     * @see elm_list_item_append()
15751     * @see elm_list_items_get()
15752     *
15753     * @ingroup List
15754     */
15755    EAPI Elm_List_Item   *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15756
15757    /**
15758     * Get the item after @p it in list.
15759     *
15760     * @param it The list item.
15761     * @return The item after @p it, or @c NULL if none or on failure.
15762     *
15763     * @note If it is the last item, @c NULL will be returned.
15764     *
15765     * @see elm_list_item_append()
15766     * @see elm_list_items_get()
15767     *
15768     * @ingroup List
15769     */
15770    EAPI Elm_List_Item   *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15771
15772    /**
15773     * Sets the disabled/enabled state of a list item.
15774     *
15775     * @param it The item.
15776     * @param disabled The disabled state.
15777     *
15778     * A disabled item cannot be selected or unselected. It will also
15779     * change its appearance (generally greyed out). This sets the
15780     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15781     * enabled).
15782     *
15783     * @ingroup List
15784     */
15785    EAPI void             elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15786
15787    /**
15788     * Get a value whether list item is disabled or not.
15789     *
15790     * @param it The item.
15791     * @return The disabled state.
15792     *
15793     * @see elm_list_item_disabled_set() for more details.
15794     *
15795     * @ingroup List
15796     */
15797    EAPI Eina_Bool        elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15798
15799    /**
15800     * Set the text to be shown in a given list item's tooltips.
15801     *
15802     * @param item Target item.
15803     * @param text The text to set in the content.
15804     *
15805     * Setup the text as tooltip to object. The item can have only one tooltip,
15806     * so any previous tooltip data - set with this function or
15807     * elm_list_item_tooltip_content_cb_set() - is removed.
15808     *
15809     * @see elm_object_tooltip_text_set() for more details.
15810     *
15811     * @ingroup List
15812     */
15813    EAPI void             elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
15814
15815
15816    /**
15817     * @brief Disable size restrictions on an object's tooltip
15818     * @param item The tooltip's anchor object
15819     * @param disable If EINA_TRUE, size restrictions are disabled
15820     * @return EINA_FALSE on failure, EINA_TRUE on success
15821     *
15822     * This function allows a tooltip to expand beyond its parant window's canvas.
15823     * It will instead be limited only by the size of the display.
15824     */
15825    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
15826    /**
15827     * @brief Retrieve size restriction state of an object's tooltip
15828     * @param obj The tooltip's anchor object
15829     * @return If EINA_TRUE, size restrictions are disabled
15830     *
15831     * This function returns whether a tooltip is allowed to expand beyond
15832     * its parant window's canvas.
15833     * It will instead be limited only by the size of the display.
15834     */
15835    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15836
15837    /**
15838     * Set the content to be shown in the tooltip item.
15839     *
15840     * Setup the tooltip to item. The item can have only one tooltip,
15841     * so any previous tooltip data is removed. @p func(with @p data) will
15842     * be called every time that need show the tooltip and it should
15843     * return a valid Evas_Object. This object is then managed fully by
15844     * tooltip system and is deleted when the tooltip is gone.
15845     *
15846     * @param item the list item being attached a tooltip.
15847     * @param func the function used to create the tooltip contents.
15848     * @param data what to provide to @a func as callback data/context.
15849     * @param del_cb called when data is not needed anymore, either when
15850     *        another callback replaces @a func, the tooltip is unset with
15851     *        elm_list_item_tooltip_unset() or the owner @a item
15852     *        dies. This callback receives as the first parameter the
15853     *        given @a data, and @c event_info is the item.
15854     *
15855     * @see elm_object_tooltip_content_cb_set() for more details.
15856     *
15857     * @ingroup List
15858     */
15859    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);
15860
15861    /**
15862     * Unset tooltip from item.
15863     *
15864     * @param item list item to remove previously set tooltip.
15865     *
15866     * Remove tooltip from item. The callback provided as del_cb to
15867     * elm_list_item_tooltip_content_cb_set() will be called to notify
15868     * it is not used anymore.
15869     *
15870     * @see elm_object_tooltip_unset() for more details.
15871     * @see elm_list_item_tooltip_content_cb_set()
15872     *
15873     * @ingroup List
15874     */
15875    EAPI void             elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15876
15877    /**
15878     * Sets a different style for this item tooltip.
15879     *
15880     * @note before you set a style you should define a tooltip with
15881     *       elm_list_item_tooltip_content_cb_set() or
15882     *       elm_list_item_tooltip_text_set()
15883     *
15884     * @param item list item with tooltip already set.
15885     * @param style the theme style to use (default, transparent, ...)
15886     *
15887     * @see elm_object_tooltip_style_set() for more details.
15888     *
15889     * @ingroup List
15890     */
15891    EAPI void             elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
15892
15893    /**
15894     * Get the style for this item tooltip.
15895     *
15896     * @param item list item with tooltip already set.
15897     * @return style the theme style in use, defaults to "default". If the
15898     *         object does not have a tooltip set, then NULL is returned.
15899     *
15900     * @see elm_object_tooltip_style_get() for more details.
15901     * @see elm_list_item_tooltip_style_set()
15902     *
15903     * @ingroup List
15904     */
15905    EAPI const char      *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15906
15907    /**
15908     * Set the type of mouse pointer/cursor decoration to be shown,
15909     * when the mouse pointer is over the given list widget item
15910     *
15911     * @param item list item to customize cursor on
15912     * @param cursor the cursor type's name
15913     *
15914     * This function works analogously as elm_object_cursor_set(), but
15915     * here the cursor's changing area is restricted to the item's
15916     * area, and not the whole widget's. Note that that item cursors
15917     * have precedence over widget cursors, so that a mouse over an
15918     * item with custom cursor set will always show @b that cursor.
15919     *
15920     * If this function is called twice for an object, a previously set
15921     * cursor will be unset on the second call.
15922     *
15923     * @see elm_object_cursor_set()
15924     * @see elm_list_item_cursor_get()
15925     * @see elm_list_item_cursor_unset()
15926     *
15927     * @ingroup List
15928     */
15929    EAPI void             elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15930
15931    /*
15932     * Get the type of mouse pointer/cursor decoration set to be shown,
15933     * when the mouse pointer is over the given list widget item
15934     *
15935     * @param item list item with custom cursor set
15936     * @return the cursor type's name or @c NULL, if no custom cursors
15937     * were set to @p item (and on errors)
15938     *
15939     * @see elm_object_cursor_get()
15940     * @see elm_list_item_cursor_set()
15941     * @see elm_list_item_cursor_unset()
15942     *
15943     * @ingroup List
15944     */
15945    EAPI const char      *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15946
15947    /**
15948     * Unset any custom mouse pointer/cursor decoration set to be
15949     * shown, when the mouse pointer is over the given list widget
15950     * item, thus making it show the @b default cursor again.
15951     *
15952     * @param item a list item
15953     *
15954     * Use this call to undo any custom settings on this item's cursor
15955     * decoration, bringing it back to defaults (no custom style set).
15956     *
15957     * @see elm_object_cursor_unset()
15958     * @see elm_list_item_cursor_set()
15959     *
15960     * @ingroup List
15961     */
15962    EAPI void             elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15963
15964    /**
15965     * Set a different @b style for a given custom cursor set for a
15966     * list item.
15967     *
15968     * @param item list item with custom cursor set
15969     * @param style the <b>theme style</b> to use (e.g. @c "default",
15970     * @c "transparent", etc)
15971     *
15972     * This function only makes sense when one is using custom mouse
15973     * cursor decorations <b>defined in a theme file</b>, which can have,
15974     * given a cursor name/type, <b>alternate styles</b> on it. It
15975     * works analogously as elm_object_cursor_style_set(), but here
15976     * applyed only to list item objects.
15977     *
15978     * @warning Before you set a cursor style you should have definen a
15979     *       custom cursor previously on the item, with
15980     *       elm_list_item_cursor_set()
15981     *
15982     * @see elm_list_item_cursor_engine_only_set()
15983     * @see elm_list_item_cursor_style_get()
15984     *
15985     * @ingroup List
15986     */
15987    EAPI void             elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
15988
15989    /**
15990     * Get the current @b style set for a given list item's custom
15991     * cursor
15992     *
15993     * @param item list item with custom cursor set.
15994     * @return style the cursor style in use. If the object does not
15995     *         have a cursor set, then @c NULL is returned.
15996     *
15997     * @see elm_list_item_cursor_style_set() for more details
15998     *
15999     * @ingroup List
16000     */
16001    EAPI const char      *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16002
16003    /**
16004     * Set if the (custom)cursor for a given list item should be
16005     * searched in its theme, also, or should only rely on the
16006     * rendering engine.
16007     *
16008     * @param item item with custom (custom) cursor already set on
16009     * @param engine_only Use @c EINA_TRUE to have cursors looked for
16010     * only on those provided by the rendering engine, @c EINA_FALSE to
16011     * have them searched on the widget's theme, as well.
16012     *
16013     * @note This call is of use only if you've set a custom cursor
16014     * for list items, with elm_list_item_cursor_set().
16015     *
16016     * @note By default, cursors will only be looked for between those
16017     * provided by the rendering engine.
16018     *
16019     * @ingroup List
16020     */
16021    EAPI void             elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
16022
16023    /**
16024     * Get if the (custom) cursor for a given list item is being
16025     * searched in its theme, also, or is only relying on the rendering
16026     * engine.
16027     *
16028     * @param item a list item
16029     * @return @c EINA_TRUE, if cursors are being looked for only on
16030     * those provided by the rendering engine, @c EINA_FALSE if they
16031     * are being searched on the widget's theme, as well.
16032     *
16033     * @see elm_list_item_cursor_engine_only_set(), for more details
16034     *
16035     * @ingroup List
16036     */
16037    EAPI Eina_Bool        elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16038
16039    /**
16040     * @}
16041     */
16042
16043    /**
16044     * @defgroup Slider Slider
16045     * @ingroup Elementary
16046     *
16047     * @image html img/widget/slider/preview-00.png
16048     * @image latex img/widget/slider/preview-00.eps width=\textwidth
16049     *
16050     * The slider adds a dragable “slider” widget for selecting the value of
16051     * something within a range.
16052     *
16053     * A slider can be horizontal or vertical. It can contain an Icon and has a
16054     * primary label as well as a units label (that is formatted with floating
16055     * point values and thus accepts a printf-style format string, like
16056     * “%1.2f units”. There is also an indicator string that may be somewhere
16057     * else (like on the slider itself) that also accepts a format string like
16058     * units. Label, Icon Unit and Indicator strings/objects are optional.
16059     *
16060     * A slider may be inverted which means values invert, with high vales being
16061     * on the left or top and low values on the right or bottom (as opposed to
16062     * normally being low on the left or top and high on the bottom and right).
16063     *
16064     * The slider should have its minimum and maximum values set by the
16065     * application with  elm_slider_min_max_set() and value should also be set by
16066     * the application before use with  elm_slider_value_set(). The span of the
16067     * slider is its length (horizontally or vertically). This will be scaled by
16068     * the object or applications scaling factor. At any point code can query the
16069     * slider for its value with elm_slider_value_get().
16070     *
16071     * Smart callbacks one can listen to:
16072     * - "changed" - Whenever the slider value is changed by the user.
16073     * - "slider,drag,start" - dragging the slider indicator around has started.
16074     * - "slider,drag,stop" - dragging the slider indicator around has stopped.
16075     * - "delay,changed" - A short time after the value is changed by the user.
16076     * This will be called only when the user stops dragging for
16077     * a very short period or when they release their
16078     * finger/mouse, so it avoids possibly expensive reactions to
16079     * the value change.
16080     *
16081     * Available styles for it:
16082     * - @c "default"
16083     *
16084     * Here is an example on its usage:
16085     * @li @ref slider_example
16086     */
16087
16088    /**
16089     * @addtogroup Slider
16090     * @{
16091     */
16092
16093    /**
16094     * Add a new slider widget to the given parent Elementary
16095     * (container) object.
16096     *
16097     * @param parent The parent object.
16098     * @return a new slider widget handle or @c NULL, on errors.
16099     *
16100     * This function inserts a new slider widget on the canvas.
16101     *
16102     * @ingroup Slider
16103     */
16104    EAPI Evas_Object       *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16105
16106    /**
16107     * Set the label of a given slider widget
16108     *
16109     * @param obj The progress bar object
16110     * @param label The text label string, in UTF-8
16111     *
16112     * @ingroup Slider
16113     * @deprecated use elm_object_text_set() instead.
16114     */
16115    EINA_DEPRECATED EAPI void               elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
16116
16117    /**
16118     * Get the label of a given slider widget
16119     *
16120     * @param obj The progressbar object
16121     * @return The text label string, in UTF-8
16122     *
16123     * @ingroup Slider
16124     * @deprecated use elm_object_text_get() instead.
16125     */
16126    EINA_DEPRECATED EAPI const char        *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16127
16128    /**
16129     * Set the icon object of the slider object.
16130     *
16131     * @param obj The slider object.
16132     * @param icon The icon object.
16133     *
16134     * On horizontal mode, icon is placed at left, and on vertical mode,
16135     * placed at top.
16136     *
16137     * @note Once the icon object is set, a previously set one will be deleted.
16138     * If you want to keep that old content object, use the
16139     * elm_slider_icon_unset() function.
16140     *
16141     * @warning If the object being set does not have minimum size hints set,
16142     * it won't get properly displayed.
16143     *
16144     * @ingroup Slider
16145     */
16146    EAPI void               elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
16147
16148    /**
16149     * Unset an icon set on a given slider widget.
16150     *
16151     * @param obj The slider object.
16152     * @return The icon object that was being used, if any was set, or
16153     * @c NULL, otherwise (and on errors).
16154     *
16155     * On horizontal mode, icon is placed at left, and on vertical mode,
16156     * placed at top.
16157     *
16158     * This call will unparent and return the icon object which was set
16159     * for this widget, previously, on success.
16160     *
16161     * @see elm_slider_icon_set() for more details
16162     * @see elm_slider_icon_get()
16163     *
16164     * @ingroup Slider
16165     */
16166    EAPI Evas_Object       *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16167
16168    /**
16169     * Retrieve the icon object set for a given slider widget.
16170     *
16171     * @param obj The slider object.
16172     * @return The icon object's handle, if @p obj had one set, or @c NULL,
16173     * otherwise (and on errors).
16174     *
16175     * On horizontal mode, icon is placed at left, and on vertical mode,
16176     * placed at top.
16177     *
16178     * @see elm_slider_icon_set() for more details
16179     * @see elm_slider_icon_unset()
16180     *
16181     * @ingroup Slider
16182     */
16183    EAPI Evas_Object       *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16184
16185    /**
16186     * Set the end object of the slider object.
16187     *
16188     * @param obj The slider object.
16189     * @param end The end object.
16190     *
16191     * On horizontal mode, end is placed at left, and on vertical mode,
16192     * placed at bottom.
16193     *
16194     * @note Once the icon object is set, a previously set one will be deleted.
16195     * If you want to keep that old content object, use the
16196     * elm_slider_end_unset() function.
16197     *
16198     * @warning If the object being set does not have minimum size hints set,
16199     * it won't get properly displayed.
16200     *
16201     * @ingroup Slider
16202     */
16203    EAPI void               elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
16204
16205    /**
16206     * Unset an end object set on a given slider widget.
16207     *
16208     * @param obj The slider object.
16209     * @return The end object that was being used, if any was set, or
16210     * @c NULL, otherwise (and on errors).
16211     *
16212     * On horizontal mode, end is placed at left, and on vertical mode,
16213     * placed at bottom.
16214     *
16215     * This call will unparent and return the icon object which was set
16216     * for this widget, previously, on success.
16217     *
16218     * @see elm_slider_end_set() for more details.
16219     * @see elm_slider_end_get()
16220     *
16221     * @ingroup Slider
16222     */
16223    EAPI Evas_Object       *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16224
16225    /**
16226     * Retrieve the end object set for a given slider widget.
16227     *
16228     * @param obj The slider object.
16229     * @return The end object's handle, if @p obj had one set, or @c NULL,
16230     * otherwise (and on errors).
16231     *
16232     * On horizontal mode, icon is placed at right, and on vertical mode,
16233     * placed at bottom.
16234     *
16235     * @see elm_slider_end_set() for more details.
16236     * @see elm_slider_end_unset()
16237     *
16238     * @ingroup Slider
16239     */
16240    EAPI Evas_Object       *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16241
16242    /**
16243     * Set the (exact) length of the bar region of a given slider widget.
16244     *
16245     * @param obj The slider object.
16246     * @param size The length of the slider's bar region.
16247     *
16248     * This sets the minimum width (when in horizontal mode) or height
16249     * (when in vertical mode) of the actual bar area of the slider
16250     * @p obj. This in turn affects the object's minimum size. Use
16251     * this when you're not setting other size hints expanding on the
16252     * given direction (like weight and alignment hints) and you would
16253     * like it to have a specific size.
16254     *
16255     * @note Icon, end, label, indicator and unit text around @p obj
16256     * will require their
16257     * own space, which will make @p obj to require more the @p size,
16258     * actually.
16259     *
16260     * @see elm_slider_span_size_get()
16261     *
16262     * @ingroup Slider
16263     */
16264    EAPI void               elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
16265
16266    /**
16267     * Get the length set for the bar region of a given slider widget
16268     *
16269     * @param obj The slider object.
16270     * @return The length of the slider's bar region.
16271     *
16272     * If that size was not set previously, with
16273     * elm_slider_span_size_set(), this call will return @c 0.
16274     *
16275     * @ingroup Slider
16276     */
16277    EAPI Evas_Coord         elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16278
16279    /**
16280     * Set the format string for the unit label.
16281     *
16282     * @param obj The slider object.
16283     * @param format The format string for the unit display.
16284     *
16285     * Unit label is displayed all the time, if set, after slider's bar.
16286     * In horizontal mode, at right and in vertical mode, at bottom.
16287     *
16288     * If @c NULL, unit label won't be visible. If not it sets the format
16289     * string for the label text. To the label text is provided a floating point
16290     * value, so the label text can display up to 1 floating point value.
16291     * Note that this is optional.
16292     *
16293     * Use a format string such as "%1.2f meters" for example, and it will
16294     * display values like: "3.14 meters" for a value equal to 3.14159.
16295     *
16296     * Default is unit label disabled.
16297     *
16298     * @see elm_slider_indicator_format_get()
16299     *
16300     * @ingroup Slider
16301     */
16302    EAPI void               elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
16303
16304    /**
16305     * Get the unit label format of the slider.
16306     *
16307     * @param obj The slider object.
16308     * @return The unit label format string in UTF-8.
16309     *
16310     * Unit label is displayed all the time, if set, after slider's bar.
16311     * In horizontal mode, at right and in vertical mode, at bottom.
16312     *
16313     * @see elm_slider_unit_format_set() for more
16314     * information on how this works.
16315     *
16316     * @ingroup Slider
16317     */
16318    EAPI const char        *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16319
16320    /**
16321     * Set the format string for the indicator label.
16322     *
16323     * @param obj The slider object.
16324     * @param indicator The format string for the indicator display.
16325     *
16326     * The slider may display its value somewhere else then unit label,
16327     * for example, above the slider knob that is dragged around. This function
16328     * sets the format string used for this.
16329     *
16330     * If @c NULL, indicator label won't be visible. If not it sets the format
16331     * string for the label text. To the label text is provided a floating point
16332     * value, so the label text can display up to 1 floating point value.
16333     * Note that this is optional.
16334     *
16335     * Use a format string such as "%1.2f meters" for example, and it will
16336     * display values like: "3.14 meters" for a value equal to 3.14159.
16337     *
16338     * Default is indicator label disabled.
16339     *
16340     * @see elm_slider_indicator_format_get()
16341     *
16342     * @ingroup Slider
16343     */
16344    EAPI void               elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
16345
16346    /**
16347     * Get the indicator label format of the slider.
16348     *
16349     * @param obj The slider object.
16350     * @return The indicator label format string in UTF-8.
16351     *
16352     * The slider may display its value somewhere else then unit label,
16353     * for example, above the slider knob that is dragged around. This function
16354     * gets the format string used for this.
16355     *
16356     * @see elm_slider_indicator_format_set() for more
16357     * information on how this works.
16358     *
16359     * @ingroup Slider
16360     */
16361    EAPI const char        *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16362
16363    /**
16364     * Set the format function pointer for the indicator label
16365     *
16366     * @param obj The slider object.
16367     * @param func The indicator format function.
16368     * @param free_func The freeing function for the format string.
16369     *
16370     * Set the callback function to format the indicator string.
16371     *
16372     * @see elm_slider_indicator_format_set() for more info on how this works.
16373     *
16374     * @ingroup Slider
16375     */
16376   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);
16377
16378   /**
16379    * Set the format function pointer for the units label
16380    *
16381    * @param obj The slider object.
16382    * @param func The units format function.
16383    * @param free_func The freeing function for the format string.
16384    *
16385    * Set the callback function to format the indicator string.
16386    *
16387    * @see elm_slider_units_format_set() for more info on how this works.
16388    *
16389    * @ingroup Slider
16390    */
16391   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);
16392
16393   /**
16394    * Set the orientation of a given slider widget.
16395    *
16396    * @param obj The slider object.
16397    * @param horizontal Use @c EINA_TRUE to make @p obj to be
16398    * @b horizontal, @c EINA_FALSE to make it @b vertical.
16399    *
16400    * Use this function to change how your slider is to be
16401    * disposed: vertically or horizontally.
16402    *
16403    * By default it's displayed horizontally.
16404    *
16405    * @see elm_slider_horizontal_get()
16406    *
16407    * @ingroup Slider
16408    */
16409    EAPI void               elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16410
16411    /**
16412     * Retrieve the orientation of a given slider widget
16413     *
16414     * @param obj The slider object.
16415     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
16416     * @c EINA_FALSE if it's @b vertical (and on errors).
16417     *
16418     * @see elm_slider_horizontal_set() for more details.
16419     *
16420     * @ingroup Slider
16421     */
16422    EAPI Eina_Bool          elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16423
16424    /**
16425     * Set the minimum and maximum values for the slider.
16426     *
16427     * @param obj The slider object.
16428     * @param min The minimum value.
16429     * @param max The maximum value.
16430     *
16431     * Define the allowed range of values to be selected by the user.
16432     *
16433     * If actual value is less than @p min, it will be updated to @p min. If it
16434     * is bigger then @p max, will be updated to @p max. Actual value can be
16435     * get with elm_slider_value_get().
16436     *
16437     * By default, min is equal to 0.0, and max is equal to 1.0.
16438     *
16439     * @warning Maximum must be greater than minimum, otherwise behavior
16440     * is undefined.
16441     *
16442     * @see elm_slider_min_max_get()
16443     *
16444     * @ingroup Slider
16445     */
16446    EAPI void               elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
16447
16448    /**
16449     * Get the minimum and maximum values of the slider.
16450     *
16451     * @param obj The slider object.
16452     * @param min Pointer where to store the minimum value.
16453     * @param max Pointer where to store the maximum value.
16454     *
16455     * @note If only one value is needed, the other pointer can be passed
16456     * as @c NULL.
16457     *
16458     * @see elm_slider_min_max_set() for details.
16459     *
16460     * @ingroup Slider
16461     */
16462    EAPI void               elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
16463
16464    /**
16465     * Set the value the slider displays.
16466     *
16467     * @param obj The slider object.
16468     * @param val The value to be displayed.
16469     *
16470     * Value will be presented on the unit label following format specified with
16471     * elm_slider_unit_format_set() and on indicator with
16472     * elm_slider_indicator_format_set().
16473     *
16474     * @warning The value must to be between min and max values. This values
16475     * are set by elm_slider_min_max_set().
16476     *
16477     * @see elm_slider_value_get()
16478     * @see elm_slider_unit_format_set()
16479     * @see elm_slider_indicator_format_set()
16480     * @see elm_slider_min_max_set()
16481     *
16482     * @ingroup Slider
16483     */
16484    EAPI void               elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
16485
16486    /**
16487     * Get the value displayed by the spinner.
16488     *
16489     * @param obj The spinner object.
16490     * @return The value displayed.
16491     *
16492     * @see elm_spinner_value_set() for details.
16493     *
16494     * @ingroup Slider
16495     */
16496    EAPI double             elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16497
16498    /**
16499     * Invert a given slider widget's displaying values order
16500     *
16501     * @param obj The slider object.
16502     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
16503     * @c EINA_FALSE to bring it back to default, non-inverted values.
16504     *
16505     * A slider may be @b inverted, in which state it gets its
16506     * values inverted, with high vales being on the left or top and
16507     * low values on the right or bottom, as opposed to normally have
16508     * the low values on the former and high values on the latter,
16509     * respectively, for horizontal and vertical modes.
16510     *
16511     * @see elm_slider_inverted_get()
16512     *
16513     * @ingroup Slider
16514     */
16515    EAPI void               elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
16516
16517    /**
16518     * Get whether a given slider widget's displaying values are
16519     * inverted or not.
16520     *
16521     * @param obj The slider object.
16522     * @return @c EINA_TRUE, if @p obj has inverted values,
16523     * @c EINA_FALSE otherwise (and on errors).
16524     *
16525     * @see elm_slider_inverted_set() for more details.
16526     *
16527     * @ingroup Slider
16528     */
16529    EAPI Eina_Bool          elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16530
16531    /**
16532     * Set whether to enlarge slider indicator (augmented knob) or not.
16533     *
16534     * @param obj The slider object.
16535     * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
16536     * let the knob always at default size.
16537     *
16538     * By default, indicator will be bigger while dragged by the user.
16539     *
16540     * @warning It won't display values set with
16541     * elm_slider_indicator_format_set() if you disable indicator.
16542     *
16543     * @ingroup Slider
16544     */
16545    EAPI void               elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
16546
16547    /**
16548     * Get whether a given slider widget's enlarging indicator or not.
16549     *
16550     * @param obj The slider object.
16551     * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
16552     * @c EINA_FALSE otherwise (and on errors).
16553     *
16554     * @see elm_slider_indicator_show_set() for details.
16555     *
16556     * @ingroup Slider
16557     */
16558    EAPI Eina_Bool          elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16559
16560    /**
16561     * @}
16562     */
16563
16564    /**
16565     * @addtogroup Actionslider Actionslider
16566     *
16567     * @image html img/widget/actionslider/preview-00.png
16568     * @image latex img/widget/actionslider/preview-00.eps
16569     *
16570     * A actionslider is a switcher for 2 or 3 labels with customizable magnet
16571     * properties. The indicator is the element the user drags to choose a label.
16572     * When the position is set with magnet, when released the indicator will be
16573     * moved to it if it's nearest the magnetized position.
16574     *
16575     * @note By default all positions are set as enabled.
16576     *
16577     * Signals that you can add callbacks for are:
16578     *
16579     * "selected" - when user selects an enabled position (the label is passed
16580     *              as event info)".
16581     * @n
16582     * "pos_changed" - when the indicator reaches any of the positions("left",
16583     *                 "right" or "center").
16584     *
16585     * See an example of actionslider usage @ref actionslider_example_page "here"
16586     * @{
16587     */
16588    typedef enum _Elm_Actionslider_Pos
16589      {
16590         ELM_ACTIONSLIDER_NONE = 0,
16591         ELM_ACTIONSLIDER_LEFT = 1 << 0,
16592         ELM_ACTIONSLIDER_CENTER = 1 << 1,
16593         ELM_ACTIONSLIDER_RIGHT = 1 << 2,
16594         ELM_ACTIONSLIDER_ALL = (1 << 3) -1
16595      } Elm_Actionslider_Pos;
16596
16597    /**
16598     * Add a new actionslider to the parent.
16599     *
16600     * @param parent The parent object
16601     * @return The new actionslider object or NULL if it cannot be created
16602     */
16603    EAPI Evas_Object          *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16604    /**
16605     * Set actionslider labels.
16606     *
16607     * @param obj The actionslider object
16608     * @param left_label The label to be set on the left.
16609     * @param center_label The label to be set on the center.
16610     * @param right_label The label to be set on the right.
16611     * @deprecated use elm_object_text_set() instead.
16612     */
16613    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);
16614    /**
16615     * Get actionslider labels.
16616     *
16617     * @param obj The actionslider object
16618     * @param left_label A char** to place the left_label of @p obj into.
16619     * @param center_label A char** to place the center_label of @p obj into.
16620     * @param right_label A char** to place the right_label of @p obj into.
16621     * @deprecated use elm_object_text_set() instead.
16622     */
16623    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);
16624    /**
16625     * Get actionslider selected label.
16626     *
16627     * @param obj The actionslider object
16628     * @return The selected label
16629     */
16630    EAPI const char           *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16631    /**
16632     * Set actionslider indicator position.
16633     *
16634     * @param obj The actionslider object.
16635     * @param pos The position of the indicator.
16636     */
16637    EAPI void                  elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16638    /**
16639     * Get actionslider indicator position.
16640     *
16641     * @param obj The actionslider object.
16642     * @return The position of the indicator.
16643     */
16644    EAPI Elm_Actionslider_Pos  elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16645    /**
16646     * Set actionslider magnet position. To make multiple positions magnets @c or
16647     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
16648     *
16649     * @param obj The actionslider object.
16650     * @param pos Bit mask indicating the magnet positions.
16651     */
16652    EAPI void                  elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16653    /**
16654     * Get actionslider magnet position.
16655     *
16656     * @param obj The actionslider object.
16657     * @return The positions with magnet property.
16658     */
16659    EAPI Elm_Actionslider_Pos  elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16660    /**
16661     * Set actionslider enabled position. To set multiple positions as enabled @c or
16662     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
16663     *
16664     * @note All the positions are enabled by default.
16665     *
16666     * @param obj The actionslider object.
16667     * @param pos Bit mask indicating the enabled positions.
16668     */
16669    EAPI void                  elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16670    /**
16671     * Get actionslider enabled position.
16672     *
16673     * @param obj The actionslider object.
16674     * @return The enabled positions.
16675     */
16676    EAPI Elm_Actionslider_Pos  elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16677    /**
16678     * Set the label used on the indicator.
16679     *
16680     * @param obj The actionslider object
16681     * @param label The label to be set on the indicator.
16682     * @deprecated use elm_object_text_set() instead.
16683     */
16684    EINA_DEPRECATED EAPI void                  elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
16685    /**
16686     * Get the label used on the indicator object.
16687     *
16688     * @param obj The actionslider object
16689     * @return The indicator label
16690     * @deprecated use elm_object_text_get() instead.
16691     */
16692    EINA_DEPRECATED EAPI const char           *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
16693    /**
16694     * @}
16695     */
16696
16697    /**
16698     * @defgroup Genlist Genlist
16699     *
16700     * @image html img/widget/genlist/preview-00.png
16701     * @image latex img/widget/genlist/preview-00.eps
16702     * @image html img/genlist.png
16703     * @image latex img/genlist.eps
16704     *
16705     * This widget aims to have more expansive list than the simple list in
16706     * Elementary that could have more flexible items and allow many more entries
16707     * while still being fast and low on memory usage. At the same time it was
16708     * also made to be able to do tree structures. But the price to pay is more
16709     * complexity when it comes to usage. If all you want is a simple list with
16710     * icons and a single label, use the normal @ref List object.
16711     *
16712     * Genlist has a fairly large API, mostly because it's relatively complex,
16713     * trying to be both expansive, powerful and efficient. First we will begin
16714     * an overview on the theory behind genlist.
16715     *
16716     * @section Genlist_Item_Class Genlist item classes - creating items
16717     *
16718     * In order to have the ability to add and delete items on the fly, genlist
16719     * implements a class (callback) system where the application provides a
16720     * structure with information about that type of item (genlist may contain
16721     * multiple different items with different classes, states and styles).
16722     * Genlist will call the functions in this struct (methods) when an item is
16723     * "realized" (i.e., created dynamically, while the user is scrolling the
16724     * grid). All objects will simply be deleted when no longer needed with
16725     * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
16726     * following members:
16727     * - @c item_style - This is a constant string and simply defines the name
16728     *   of the item style. It @b must be specified and the default should be @c
16729     *   "default".
16730     * - @c mode_item_style - This is a constant string and simply defines the
16731     *   name of the style that will be used for mode animations. It can be left
16732     *   as @c NULL if you don't plan to use Genlist mode. See
16733     *   elm_genlist_item_mode_set() for more info.
16734     *
16735     * - @c func - A struct with pointers to functions that will be called when
16736     *   an item is going to be actually created. All of them receive a @c data
16737     *   parameter that will point to the same data passed to
16738     *   elm_genlist_item_append() and related item creation functions, and a @c
16739     *   obj parameter that points to the genlist object itself.
16740     *
16741     * The function pointers inside @c func are @c label_get, @c icon_get, @c
16742     * state_get and @c del. The 3 first functions also receive a @c part
16743     * parameter described below. A brief description of these functions follows:
16744     *
16745     * - @c label_get - The @c part parameter is the name string of one of the
16746     *   existing text parts in the Edje group implementing the item's theme.
16747     *   This function @b must return a strdup'()ed string, as the caller will
16748     *   free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
16749     * - @c icon_get - The @c part parameter is the name string of one of the
16750     *   existing (icon) swallow parts in the Edje group implementing the item's
16751     *   theme. It must return @c NULL, when no icon is desired, or a valid
16752     *   object handle, otherwise.  The object will be deleted by the genlist on
16753     *   its deletion or when the item is "unrealized".  See
16754     *   #Elm_Genlist_Item_Icon_Get_Cb.
16755     * - @c func.state_get - The @c part parameter is the name string of one of
16756     *   the state parts in the Edje group implementing the item's theme. Return
16757     *   @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
16758     *   emit a signal to its theming Edje object with @c "elm,state,XXX,active"
16759     *   and @c "elm" as "emission" and "source" arguments, respectively, when
16760     *   the state is true (the default is false), where @c XXX is the name of
16761     *   the (state) part.  See #Elm_Genlist_Item_State_Get_Cb.
16762     * - @c func.del - This is intended for use when genlist items are deleted,
16763     *   so any data attached to the item (e.g. its data parameter on creation)
16764     *   can be deleted. See #Elm_Genlist_Item_Del_Cb.
16765     *
16766     * available item styles:
16767     * - default
16768     * - default_style - The text part is a textblock
16769     *
16770     * @image html img/widget/genlist/preview-04.png
16771     * @image latex img/widget/genlist/preview-04.eps
16772     *
16773     * - double_label
16774     *
16775     * @image html img/widget/genlist/preview-01.png
16776     * @image latex img/widget/genlist/preview-01.eps
16777     *
16778     * - icon_top_text_bottom
16779     *
16780     * @image html img/widget/genlist/preview-02.png
16781     * @image latex img/widget/genlist/preview-02.eps
16782     *
16783     * - group_index
16784     *
16785     * @image html img/widget/genlist/preview-03.png
16786     * @image latex img/widget/genlist/preview-03.eps
16787     *
16788     * @section Genlist_Items Structure of items
16789     *
16790     * An item in a genlist can have 0 or more text labels (they can be regular
16791     * text or textblock Evas objects - that's up to the style to determine), 0
16792     * or more icons (which are simply objects swallowed into the genlist item's
16793     * theming Edje object) and 0 or more <b>boolean states</b>, which have the
16794     * behavior left to the user to define. The Edje part names for each of
16795     * these properties will be looked up, in the theme file for the genlist,
16796     * under the Edje (string) data items named @c "labels", @c "icons" and @c
16797     * "states", respectively. For each of those properties, if more than one
16798     * part is provided, they must have names listed separated by spaces in the
16799     * data fields. For the default genlist item theme, we have @b one label
16800     * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
16801     * "elm.swallow.end") and @b no state parts.
16802     *
16803     * A genlist item may be at one of several styles. Elementary provides one
16804     * by default - "default", but this can be extended by system or application
16805     * custom themes/overlays/extensions (see @ref Theme "themes" for more
16806     * details).
16807     *
16808     * @section Genlist_Manipulation Editing and Navigating
16809     *
16810     * Items can be added by several calls. All of them return a @ref
16811     * Elm_Genlist_Item handle that is an internal member inside the genlist.
16812     * They all take a data parameter that is meant to be used for a handle to
16813     * the applications internal data (eg the struct with the original item
16814     * data). The parent parameter is the parent genlist item this belongs to if
16815     * it is a tree or an indexed group, and NULL if there is no parent. The
16816     * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
16817     * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
16818     * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
16819     * that is able to expand and have child items.  If ELM_GENLIST_ITEM_GROUP
16820     * is set then this item is group index item that is displayed at the top
16821     * until the next group comes. The func parameter is a convenience callback
16822     * that is called when the item is selected and the data parameter will be
16823     * the func_data parameter, obj be the genlist object and event_info will be
16824     * the genlist item.
16825     *
16826     * elm_genlist_item_append() adds an item to the end of the list, or if
16827     * there is a parent, to the end of all the child items of the parent.
16828     * elm_genlist_item_prepend() is the same but adds to the beginning of
16829     * the list or children list. elm_genlist_item_insert_before() inserts at
16830     * item before another item and elm_genlist_item_insert_after() inserts after
16831     * the indicated item.
16832     *
16833     * The application can clear the list with elm_genlist_clear() which deletes
16834     * all the items in the list and elm_genlist_item_del() will delete a specific
16835     * item. elm_genlist_item_subitems_clear() will clear all items that are
16836     * children of the indicated parent item.
16837     *
16838     * To help inspect list items you can jump to the item at the top of the list
16839     * with elm_genlist_first_item_get() which will return the item pointer, and
16840     * similarly elm_genlist_last_item_get() gets the item at the end of the list.
16841     * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
16842     * and previous items respectively relative to the indicated item. Using
16843     * these calls you can walk the entire item list/tree. Note that as a tree
16844     * the items are flattened in the list, so elm_genlist_item_parent_get() will
16845     * let you know which item is the parent (and thus know how to skip them if
16846     * wanted).
16847     *
16848     * @section Genlist_Muti_Selection Multi-selection
16849     *
16850     * If the application wants multiple items to be able to be selected,
16851     * elm_genlist_multi_select_set() can enable this. If the list is
16852     * single-selection only (the default), then elm_genlist_selected_item_get()
16853     * will return the selected item, if any, or NULL I none is selected. If the
16854     * list is multi-select then elm_genlist_selected_items_get() will return a
16855     * list (that is only valid as long as no items are modified (added, deleted,
16856     * selected or unselected)).
16857     *
16858     * @section Genlist_Usage_Hints Usage hints
16859     *
16860     * There are also convenience functions. elm_genlist_item_genlist_get() will
16861     * return the genlist object the item belongs to. elm_genlist_item_show()
16862     * will make the scroller scroll to show that specific item so its visible.
16863     * elm_genlist_item_data_get() returns the data pointer set by the item
16864     * creation functions.
16865     *
16866     * If an item changes (state of boolean changes, label or icons change),
16867     * then use elm_genlist_item_update() to have genlist update the item with
16868     * the new state. Genlist will re-realize the item thus call the functions
16869     * in the _Elm_Genlist_Item_Class for that item.
16870     *
16871     * To programmatically (un)select an item use elm_genlist_item_selected_set().
16872     * To get its selected state use elm_genlist_item_selected_get(). Similarly
16873     * to expand/contract an item and get its expanded state, use
16874     * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
16875     * again to make an item disabled (unable to be selected and appear
16876     * differently) use elm_genlist_item_disabled_set() to set this and
16877     * elm_genlist_item_disabled_get() to get the disabled state.
16878     *
16879     * In general to indicate how the genlist should expand items horizontally to
16880     * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
16881     * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
16882     * mode means that if items are too wide to fit, the scroller will scroll
16883     * horizontally. Otherwise items are expanded to fill the width of the
16884     * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
16885     * to the viewport width and limited to that size. This can be combined with
16886     * a different style that uses edjes' ellipsis feature (cutting text off like
16887     * this: "tex...").
16888     *
16889     * Items will only call their selection func and callback when first becoming
16890     * selected. Any further clicks will do nothing, unless you enable always
16891     * select with elm_genlist_always_select_mode_set(). This means even if
16892     * selected, every click will make the selected callbacks be called.
16893     * elm_genlist_no_select_mode_set() will turn off the ability to select
16894     * items entirely and they will neither appear selected nor call selected
16895     * callback functions.
16896     *
16897     * Remember that you can create new styles and add your own theme augmentation
16898     * per application with elm_theme_extension_add(). If you absolutely must
16899     * have a specific style that overrides any theme the user or system sets up
16900     * you can use elm_theme_overlay_add() to add such a file.
16901     *
16902     * @section Genlist_Implementation Implementation
16903     *
16904     * Evas tracks every object you create. Every time it processes an event
16905     * (mouse move, down, up etc.) it needs to walk through objects and find out
16906     * what event that affects. Even worse every time it renders display updates,
16907     * in order to just calculate what to re-draw, it needs to walk through many
16908     * many many objects. Thus, the more objects you keep active, the more
16909     * overhead Evas has in just doing its work. It is advisable to keep your
16910     * active objects to the minimum working set you need. Also remember that
16911     * object creation and deletion carries an overhead, so there is a
16912     * middle-ground, which is not easily determined. But don't keep massive lists
16913     * of objects you can't see or use. Genlist does this with list objects. It
16914     * creates and destroys them dynamically as you scroll around. It groups them
16915     * into blocks so it can determine the visibility etc. of a whole block at
16916     * once as opposed to having to walk the whole list. This 2-level list allows
16917     * for very large numbers of items to be in the list (tests have used up to
16918     * 2,000,000 items). Also genlist employs a queue for adding items. As items
16919     * may be different sizes, every item added needs to be calculated as to its
16920     * size and thus this presents a lot of overhead on populating the list, this
16921     * genlist employs a queue. Any item added is queued and spooled off over
16922     * time, actually appearing some time later, so if your list has many members
16923     * you may find it takes a while for them to all appear, with your process
16924     * consuming a lot of CPU while it is busy spooling.
16925     *
16926     * Genlist also implements a tree structure, but it does so with callbacks to
16927     * the application, with the application filling in tree structures when
16928     * requested (allowing for efficient building of a very deep tree that could
16929     * even be used for file-management). See the above smart signal callbacks for
16930     * details.
16931     *
16932     * @section Genlist_Smart_Events Genlist smart events
16933     *
16934     * Signals that you can add callbacks for are:
16935     * - @c "activated" - The user has double-clicked or pressed
16936     *   (enter|return|spacebar) on an item. The @c event_info parameter is the
16937     *   item that was activated.
16938     * - @c "clicked,double" - The user has double-clicked an item.  The @c
16939     *   event_info parameter is the item that was double-clicked.
16940     * - @c "selected" - This is called when a user has made an item selected.
16941     *   The event_info parameter is the genlist item that was selected.
16942     * - @c "unselected" - This is called when a user has made an item
16943     *   unselected. The event_info parameter is the genlist item that was
16944     *   unselected.
16945     * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
16946     *   called and the item is now meant to be expanded. The event_info
16947     *   parameter is the genlist item that was indicated to expand.  It is the
16948     *   job of this callback to then fill in the child items.
16949     * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
16950     *   called and the item is now meant to be contracted. The event_info
16951     *   parameter is the genlist item that was indicated to contract. It is the
16952     *   job of this callback to then delete the child items.
16953     * - @c "expand,request" - This is called when a user has indicated they want
16954     *   to expand a tree branch item. The callback should decide if the item can
16955     *   expand (has any children) and then call elm_genlist_item_expanded_set()
16956     *   appropriately to set the state. The event_info parameter is the genlist
16957     *   item that was indicated to expand.
16958     * - @c "contract,request" - This is called when a user has indicated they
16959     *   want to contract a tree branch item. The callback should decide if the
16960     *   item can contract (has any children) and then call
16961     *   elm_genlist_item_expanded_set() appropriately to set the state. The
16962     *   event_info parameter is the genlist item that was indicated to contract.
16963     * - @c "realized" - This is called when the item in the list is created as a
16964     *   real evas object. event_info parameter is the genlist item that was
16965     *   created. The object may be deleted at any time, so it is up to the
16966     *   caller to not use the object pointer from elm_genlist_item_object_get()
16967     *   in a way where it may point to freed objects.
16968     * - @c "unrealized" - This is called just before an item is unrealized.
16969     *   After this call icon objects provided will be deleted and the item
16970     *   object itself delete or be put into a floating cache.
16971     * - @c "drag,start,up" - This is called when the item in the list has been
16972     *   dragged (not scrolled) up.
16973     * - @c "drag,start,down" - This is called when the item in the list has been
16974     *   dragged (not scrolled) down.
16975     * - @c "drag,start,left" - This is called when the item in the list has been
16976     *   dragged (not scrolled) left.
16977     * - @c "drag,start,right" - This is called when the item in the list has
16978     *   been dragged (not scrolled) right.
16979     * - @c "drag,stop" - This is called when the item in the list has stopped
16980     *   being dragged.
16981     * - @c "drag" - This is called when the item in the list is being dragged.
16982     * - @c "longpressed" - This is called when the item is pressed for a certain
16983     *   amount of time. By default it's 1 second.
16984     * - @c "scroll,anim,start" - This is called when scrolling animation has
16985     *   started.
16986     * - @c "scroll,anim,stop" - This is called when scrolling animation has
16987     *   stopped.
16988     * - @c "scroll,drag,start" - This is called when dragging the content has
16989     *   started.
16990     * - @c "scroll,drag,stop" - This is called when dragging the content has
16991     *   stopped.
16992     * - @c "scroll,edge,top" - This is called when the genlist is scrolled until
16993     *   the top edge.
16994     * - @c "scroll,edge,bottom" - This is called when the genlist is scrolled
16995     *   until the bottom edge.
16996     * - @c "scroll,edge,left" - This is called when the genlist is scrolled
16997     *   until the left edge.
16998     * - @c "scroll,edge,right" - This is called when the genlist is scrolled
16999     *   until the right edge.
17000     * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
17001     *   swiped left.
17002     * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
17003     *   swiped right.
17004     * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
17005     *   swiped up.
17006     * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
17007     *   swiped down.
17008     * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
17009     *   pinched out.  "- @c multi,pinch,in" - This is called when the genlist is
17010     *   multi-touch pinched in.
17011     * - @c "swipe" - This is called when the genlist is swiped.
17012     *
17013     * @section Genlist_Examples Examples
17014     *
17015     * Here is a list of examples that use the genlist, trying to show some of
17016     * its capabilities:
17017     * - @ref genlist_example_01
17018     * - @ref genlist_example_02
17019     * - @ref genlist_example_03
17020     * - @ref genlist_example_04
17021     * - @ref genlist_example_05
17022     */
17023
17024    /**
17025     * @addtogroup Genlist
17026     * @{
17027     */
17028
17029    /**
17030     * @enum _Elm_Genlist_Item_Flags
17031     * @typedef Elm_Genlist_Item_Flags
17032     *
17033     * Defines if the item is of any special type (has subitems or it's the
17034     * index of a group), or is just a simple item.
17035     *
17036     * @ingroup Genlist
17037     */
17038    typedef enum _Elm_Genlist_Item_Flags
17039      {
17040         ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
17041         ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
17042         ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
17043      } Elm_Genlist_Item_Flags;
17044    typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;  /**< Genlist item class definition structs */
17045    typedef struct _Elm_Genlist_Item       Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
17046    typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
17047    typedef char        *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
17048    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. */
17049    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. */
17050    typedef void         (*Elm_Genlist_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
17051    typedef void         (*GenlistItemMovedFunc)    (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after); /** TODO: remove this by SeoZ **/
17052
17053    typedef char        *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Label_Get_Cb instead. */
17054    typedef Evas_Object *(*GenlistItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Icon_Get_Cb instead. */
17055    typedef Eina_Bool    (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_State_Get_Cb instead. */
17056    typedef void         (*GenlistItemDelFunc)      (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Del_Cb instead. */
17057
17058    /**
17059     * @struct _Elm_Genlist_Item_Class
17060     *
17061     * Genlist item class definition structs.
17062     *
17063     * This struct contains the style and fetching functions that will define the
17064     * contents of each item.
17065     *
17066     * @see @ref Genlist_Item_Class
17067     */
17068    struct _Elm_Genlist_Item_Class
17069      {
17070         const char                *item_style; /**< style of this class. */
17071         struct
17072           {
17073              Elm_Genlist_Item_Label_Get_Cb  label_get; /**< Label fetching class function for genlist item classes.*/
17074              Elm_Genlist_Item_Icon_Get_Cb   icon_get; /**< Icon fetching class function for genlist item classes. */
17075              Elm_Genlist_Item_State_Get_Cb  state_get; /**< State fetching class function for genlist item classes. */
17076              Elm_Genlist_Item_Del_Cb        del; /**< Deletion class function for genlist item classes. */
17077              GenlistItemMovedFunc     moved; // TODO: do not use this. change this to smart callback.
17078           } func;
17079         const char                *mode_item_style;
17080      };
17081
17082    /**
17083     * Add a new genlist widget to the given parent Elementary
17084     * (container) object
17085     *
17086     * @param parent The parent object
17087     * @return a new genlist widget handle or @c NULL, on errors
17088     *
17089     * This function inserts a new genlist widget on the canvas.
17090     *
17091     * @see elm_genlist_item_append()
17092     * @see elm_genlist_item_del()
17093     * @see elm_genlist_clear()
17094     *
17095     * @ingroup Genlist
17096     */
17097    EAPI Evas_Object      *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17098    /**
17099     * Remove all items from a given genlist widget.
17100     *
17101     * @param obj The genlist object
17102     *
17103     * This removes (and deletes) all items in @p obj, leaving it empty.
17104     *
17105     * @see elm_genlist_item_del(), to remove just one item.
17106     *
17107     * @ingroup Genlist
17108     */
17109    EAPI void              elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
17110    /**
17111     * Enable or disable multi-selection in the genlist
17112     *
17113     * @param obj The genlist object
17114     * @param multi Multi-select enable/disable. Default is disabled.
17115     *
17116     * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
17117     * the list. This allows more than 1 item to be selected. To retrieve the list
17118     * of selected items, use elm_genlist_selected_items_get().
17119     *
17120     * @see elm_genlist_selected_items_get()
17121     * @see elm_genlist_multi_select_get()
17122     *
17123     * @ingroup Genlist
17124     */
17125    EAPI void              elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
17126    /**
17127     * Gets if multi-selection in genlist is enabled or disabled.
17128     *
17129     * @param obj The genlist object
17130     * @return Multi-select enabled/disabled
17131     * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
17132     *
17133     * @see elm_genlist_multi_select_set()
17134     *
17135     * @ingroup Genlist
17136     */
17137    EAPI Eina_Bool         elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17138    /**
17139     * This sets the horizontal stretching mode.
17140     *
17141     * @param obj The genlist object
17142     * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
17143     *
17144     * This sets the mode used for sizing items horizontally. Valid modes
17145     * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
17146     * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
17147     * the scroller will scroll horizontally. Otherwise items are expanded
17148     * to fill the width of the viewport of the scroller. If it is
17149     * ELM_LIST_LIMIT, items will be expanded to the viewport width and
17150     * limited to that size.
17151     *
17152     * @see elm_genlist_horizontal_get()
17153     *
17154     * @ingroup Genlist
17155     */
17156    EAPI void              elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
17157    EINA_DEPRECATED EAPI void              elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
17158    /**
17159     * Gets the horizontal stretching mode.
17160     *
17161     * @param obj The genlist object
17162     * @return The mode to use
17163     * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
17164     *
17165     * @see elm_genlist_horizontal_set()
17166     *
17167     * @ingroup Genlist
17168     */
17169    EAPI Elm_List_Mode     elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17170    EINA_DEPRECATED EAPI Elm_List_Mode     elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17171    /**
17172     * Set the always select mode.
17173     *
17174     * @param obj The genlist object
17175     * @param always_select The always select mode (@c EINA_TRUE = on, @c
17176     * EINA_FALSE = off). Default is @c EINA_FALSE.
17177     *
17178     * Items will only call their selection func and callback when first
17179     * becoming selected. Any further clicks will do nothing, unless you
17180     * enable always select with elm_genlist_always_select_mode_set().
17181     * This means that, even if selected, every click will make the selected
17182     * callbacks be called.
17183     *
17184     * @see elm_genlist_always_select_mode_get()
17185     *
17186     * @ingroup Genlist
17187     */
17188    EAPI void              elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
17189    /**
17190     * Get the always select mode.
17191     *
17192     * @param obj The genlist object
17193     * @return The always select mode
17194     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
17195     *
17196     * @see elm_genlist_always_select_mode_set()
17197     *
17198     * @ingroup Genlist
17199     */
17200    EAPI Eina_Bool         elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17201    /**
17202     * Enable/disable the no select mode.
17203     *
17204     * @param obj The genlist object
17205     * @param no_select The no select mode
17206     * (EINA_TRUE = on, EINA_FALSE = off)
17207     *
17208     * This will turn off the ability to select items entirely and they
17209     * will neither appear selected nor call selected callback functions.
17210     *
17211     * @see elm_genlist_no_select_mode_get()
17212     *
17213     * @ingroup Genlist
17214     */
17215    EAPI void              elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
17216    /**
17217     * Gets whether the no select mode is enabled.
17218     *
17219     * @param obj The genlist object
17220     * @return The no select mode
17221     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
17222     *
17223     * @see elm_genlist_no_select_mode_set()
17224     *
17225     * @ingroup Genlist
17226     */
17227    EAPI Eina_Bool         elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17228    /**
17229     * Enable/disable compress mode.
17230     *
17231     * @param obj The genlist object
17232     * @param compress The compress mode
17233     * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
17234     *
17235     * This will enable the compress mode where items are "compressed"
17236     * horizontally to fit the genlist scrollable viewport width. This is
17237     * special for genlist.  Do not rely on
17238     * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
17239     * work as genlist needs to handle it specially.
17240     *
17241     * @see elm_genlist_compress_mode_get()
17242     *
17243     * @ingroup Genlist
17244     */
17245    EAPI void              elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
17246    /**
17247     * Get whether the compress mode is enabled.
17248     *
17249     * @param obj The genlist object
17250     * @return The compress mode
17251     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
17252     *
17253     * @see elm_genlist_compress_mode_set()
17254     *
17255     * @ingroup Genlist
17256     */
17257    EAPI Eina_Bool         elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17258    /**
17259     * Enable/disable height-for-width mode.
17260     *
17261     * @param obj The genlist object
17262     * @param setting The height-for-width mode (@c EINA_TRUE = on,
17263     * @c EINA_FALSE = off). Default is @c EINA_FALSE.
17264     *
17265     * With height-for-width mode the item width will be fixed (restricted
17266     * to a minimum of) to the list width when calculating its size in
17267     * order to allow the height to be calculated based on it. This allows,
17268     * for instance, text block to wrap lines if the Edje part is
17269     * configured with "text.min: 0 1".
17270     *
17271     * @note This mode will make list resize slower as it will have to
17272     *       recalculate every item height again whenever the list width
17273     *       changes!
17274     *
17275     * @note When height-for-width mode is enabled, it also enables
17276     *       compress mode (see elm_genlist_compress_mode_set()) and
17277     *       disables homogeneous (see elm_genlist_homogeneous_set()).
17278     *
17279     * @ingroup Genlist
17280     */
17281    EAPI void              elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
17282    /**
17283     * Get whether the height-for-width mode is enabled.
17284     *
17285     * @param obj The genlist object
17286     * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
17287     * off)
17288     *
17289     * @ingroup Genlist
17290     */
17291    EAPI Eina_Bool         elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17292    /**
17293     * Enable/disable horizontal and vertical bouncing effect.
17294     *
17295     * @param obj The genlist object
17296     * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
17297     * EINA_FALSE = off). Default is @c EINA_FALSE.
17298     * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
17299     * EINA_FALSE = off). Default is @c EINA_TRUE.
17300     *
17301     * This will enable or disable the scroller bouncing effect for the
17302     * genlist. See elm_scroller_bounce_set() for details.
17303     *
17304     * @see elm_scroller_bounce_set()
17305     * @see elm_genlist_bounce_get()
17306     *
17307     * @ingroup Genlist
17308     */
17309    EAPI void              elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
17310    /**
17311     * Get whether the horizontal and vertical bouncing effect is enabled.
17312     *
17313     * @param obj The genlist object
17314     * @param h_bounce Pointer to a bool to receive if the bounce horizontally
17315     * option is set.
17316     * @param v_bounce Pointer to a bool to receive if the bounce vertically
17317     * option is set.
17318     *
17319     * @see elm_genlist_bounce_set()
17320     *
17321     * @ingroup Genlist
17322     */
17323    EAPI void              elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
17324    /**
17325     * Enable/disable homogenous mode.
17326     *
17327     * @param obj The genlist object
17328     * @param homogeneous Assume the items within the genlist are of the
17329     * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
17330     * EINA_FALSE.
17331     *
17332     * This will enable the homogeneous mode where items are of the same
17333     * height and width so that genlist may do the lazy-loading at its
17334     * maximum (which increases the performance for scrolling the list). This
17335     * implies 'compressed' mode.
17336     *
17337     * @see elm_genlist_compress_mode_set()
17338     * @see elm_genlist_homogeneous_get()
17339     *
17340     * @ingroup Genlist
17341     */
17342    EAPI void              elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
17343    /**
17344     * Get whether the homogenous mode is enabled.
17345     *
17346     * @param obj The genlist object
17347     * @return Assume the items within the genlist are of the same height
17348     * and width (EINA_TRUE = on, EINA_FALSE = off)
17349     *
17350     * @see elm_genlist_homogeneous_set()
17351     *
17352     * @ingroup Genlist
17353     */
17354    EAPI Eina_Bool         elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17355    /**
17356     * Set the maximum number of items within an item block
17357     *
17358     * @param obj The genlist object
17359     * @param n   Maximum number of items within an item block. Default is 32.
17360     *
17361     * This will configure the block count to tune to the target with
17362     * particular performance matrix.
17363     *
17364     * A block of objects will be used to reduce the number of operations due to
17365     * many objects in the screen. It can determine the visibility, or if the
17366     * object has changed, it theme needs to be updated, etc. doing this kind of
17367     * calculation to the entire block, instead of per object.
17368     *
17369     * The default value for the block count is enough for most lists, so unless
17370     * you know you will have a lot of objects visible in the screen at the same
17371     * time, don't try to change this.
17372     *
17373     * @see elm_genlist_block_count_get()
17374     * @see @ref Genlist_Implementation
17375     *
17376     * @ingroup Genlist
17377     */
17378    EAPI void              elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
17379    /**
17380     * Get the maximum number of items within an item block
17381     *
17382     * @param obj The genlist object
17383     * @return Maximum number of items within an item block
17384     *
17385     * @see elm_genlist_block_count_set()
17386     *
17387     * @ingroup Genlist
17388     */
17389    EAPI int               elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17390    /**
17391     * Set the timeout in seconds for the longpress event.
17392     *
17393     * @param obj The genlist object
17394     * @param timeout timeout in seconds. Default is 1.
17395     *
17396     * This option will change how long it takes to send an event "longpressed"
17397     * after the mouse down signal is sent to the list. If this event occurs, no
17398     * "clicked" event will be sent.
17399     *
17400     * @see elm_genlist_longpress_timeout_set()
17401     *
17402     * @ingroup Genlist
17403     */
17404    EAPI void              elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
17405    /**
17406     * Get the timeout in seconds for the longpress event.
17407     *
17408     * @param obj The genlist object
17409     * @return timeout in seconds
17410     *
17411     * @see elm_genlist_longpress_timeout_get()
17412     *
17413     * @ingroup Genlist
17414     */
17415    EAPI double            elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17416    /**
17417     * Append a new item in a given genlist widget.
17418     *
17419     * @param obj The genlist object
17420     * @param itc The item class for the item
17421     * @param data The item data
17422     * @param parent The parent item, or NULL if none
17423     * @param flags Item flags
17424     * @param func Convenience function called when the item is selected
17425     * @param func_data Data passed to @p func above.
17426     * @return A handle to the item added or @c NULL if not possible
17427     *
17428     * This adds the given item to the end of the list or the end of
17429     * the children list if the @p parent is given.
17430     *
17431     * @see elm_genlist_item_prepend()
17432     * @see elm_genlist_item_insert_before()
17433     * @see elm_genlist_item_insert_after()
17434     * @see elm_genlist_item_del()
17435     *
17436     * @ingroup Genlist
17437     */
17438    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);
17439    /**
17440     * Prepend a new item in a given genlist widget.
17441     *
17442     * @param obj The genlist object
17443     * @param itc The item class for the item
17444     * @param data The item data
17445     * @param parent The parent item, or NULL if none
17446     * @param flags Item flags
17447     * @param func Convenience function called when the item is selected
17448     * @param func_data Data passed to @p func above.
17449     * @return A handle to the item added or NULL if not possible
17450     *
17451     * This adds an item to the beginning of the list or beginning of the
17452     * children of the parent if given.
17453     *
17454     * @see elm_genlist_item_append()
17455     * @see elm_genlist_item_insert_before()
17456     * @see elm_genlist_item_insert_after()
17457     * @see elm_genlist_item_del()
17458     *
17459     * @ingroup Genlist
17460     */
17461    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);
17462    /**
17463     * Insert an item before another in a genlist widget
17464     *
17465     * @param obj The genlist object
17466     * @param itc The item class for the item
17467     * @param data The item data
17468     * @param before The item to place this new one before.
17469     * @param flags Item flags
17470     * @param func Convenience function called when the item is selected
17471     * @param func_data Data passed to @p func above.
17472     * @return A handle to the item added or @c NULL if not possible
17473     *
17474     * This inserts an item before another in the list. It will be in the
17475     * same tree level or group as the item it is inserted before.
17476     *
17477     * @see elm_genlist_item_append()
17478     * @see elm_genlist_item_prepend()
17479     * @see elm_genlist_item_insert_after()
17480     * @see elm_genlist_item_del()
17481     *
17482     * @ingroup Genlist
17483     */
17484    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);
17485    /**
17486     * Insert an item after another in a genlist widget
17487     *
17488     * @param obj The genlist object
17489     * @param itc The item class for the item
17490     * @param data The item data
17491     * @param after The item to place this new one after.
17492     * @param flags Item flags
17493     * @param func Convenience function called when the item is selected
17494     * @param func_data Data passed to @p func above.
17495     * @return A handle to the item added or @c NULL if not possible
17496     *
17497     * This inserts an item after another in the list. It will be in the
17498     * same tree level or group as the item it is inserted after.
17499     *
17500     * @see elm_genlist_item_append()
17501     * @see elm_genlist_item_prepend()
17502     * @see elm_genlist_item_insert_before()
17503     * @see elm_genlist_item_del()
17504     *
17505     * @ingroup Genlist
17506     */
17507    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);
17508    /**
17509     * Insert a new item into the sorted genlist object
17510     *
17511     * @param obj The genlist object
17512     * @param itc The item class for the item
17513     * @param data The item data
17514     * @param parent The parent item, or NULL if none
17515     * @param flags Item flags
17516     * @param comp The function called for the sort
17517     * @param func Convenience function called when item selected
17518     * @param func_data Data passed to @p func above.
17519     * @return A handle to the item added or NULL if not possible
17520     *
17521     * @ingroup Genlist
17522     */
17523    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);
17524    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);
17525    /* operations to retrieve existing items */
17526    /**
17527     * Get the selectd item in the genlist.
17528     *
17529     * @param obj The genlist object
17530     * @return The selected item, or NULL if none is selected.
17531     *
17532     * This gets the selected item in the list (if multi-selection is enabled, only
17533     * the item that was first selected in the list is returned - which is not very
17534     * useful, so see elm_genlist_selected_items_get() for when multi-selection is
17535     * used).
17536     *
17537     * If no item is selected, NULL is returned.
17538     *
17539     * @see elm_genlist_selected_items_get()
17540     *
17541     * @ingroup Genlist
17542     */
17543    EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17544    /**
17545     * Get a list of selected items in the genlist.
17546     *
17547     * @param obj The genlist object
17548     * @return The list of selected items, or NULL if none are selected.
17549     *
17550     * It returns a list of the selected items. This list pointer is only valid so
17551     * long as the selection doesn't change (no items are selected or unselected, or
17552     * unselected implicitly by deletion). The list contains Elm_Genlist_Item
17553     * pointers. The order of the items in this list is the order which they were
17554     * selected, i.e. the first item in this list is the first item that was
17555     * selected, and so on.
17556     *
17557     * @note If not in multi-select mode, consider using function
17558     * elm_genlist_selected_item_get() instead.
17559     *
17560     * @see elm_genlist_multi_select_set()
17561     * @see elm_genlist_selected_item_get()
17562     *
17563     * @ingroup Genlist
17564     */
17565    EAPI const Eina_List  *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17566    /**
17567     * Get a list of realized items in genlist
17568     *
17569     * @param obj The genlist object
17570     * @return The list of realized items, nor NULL if none are realized.
17571     *
17572     * This returns a list of the realized items in the genlist. The list
17573     * contains Elm_Genlist_Item pointers. The list must be freed by the
17574     * caller when done with eina_list_free(). The item pointers in the
17575     * list are only valid so long as those items are not deleted or the
17576     * genlist is not deleted.
17577     *
17578     * @see elm_genlist_realized_items_update()
17579     *
17580     * @ingroup Genlist
17581     */
17582    EAPI Eina_List        *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17583    /**
17584     * Get the item that is at the x, y canvas coords.
17585     *
17586     * @param obj The gelinst object.
17587     * @param x The input x coordinate
17588     * @param y The input y coordinate
17589     * @param posret The position relative to the item returned here
17590     * @return The item at the coordinates or NULL if none
17591     *
17592     * This returns the item at the given coordinates (which are canvas
17593     * relative, not object-relative). If an item is at that coordinate,
17594     * that item handle is returned, and if @p posret is not NULL, the
17595     * integer pointed to is set to a value of -1, 0 or 1, depending if
17596     * the coordinate is on the upper portion of that item (-1), on the
17597     * middle section (0) or on the lower part (1). If NULL is returned as
17598     * an item (no item found there), then posret may indicate -1 or 1
17599     * based if the coordinate is above or below all items respectively in
17600     * the genlist.
17601     *
17602     * @ingroup Genlist
17603     */
17604    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);
17605    /**
17606     * Get the first item in the genlist
17607     *
17608     * This returns the first item in the list.
17609     *
17610     * @param obj The genlist object
17611     * @return The first item, or NULL if none
17612     *
17613     * @ingroup Genlist
17614     */
17615    EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17616    /**
17617     * Get the last item in the genlist
17618     *
17619     * This returns the last item in the list.
17620     *
17621     * @return The last item, or NULL if none
17622     *
17623     * @ingroup Genlist
17624     */
17625    EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17626    /**
17627     * Set the scrollbar policy
17628     *
17629     * @param obj The genlist object
17630     * @param policy_h Horizontal scrollbar policy.
17631     * @param policy_v Vertical scrollbar policy.
17632     *
17633     * This sets the scrollbar visibility policy for the given genlist
17634     * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
17635     * made visible if it is needed, and otherwise kept hidden.
17636     * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
17637     * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
17638     * respectively for the horizontal and vertical scrollbars. Default is
17639     * #ELM_SMART_SCROLLER_POLICY_AUTO
17640     *
17641     * @see elm_genlist_scroller_policy_get()
17642     *
17643     * @ingroup Genlist
17644     */
17645    EAPI void              elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
17646    /**
17647     * Get the scrollbar policy
17648     *
17649     * @param obj The genlist object
17650     * @param policy_h Pointer to store the horizontal scrollbar policy.
17651     * @param policy_v Pointer to store the vertical scrollbar policy.
17652     *
17653     * @see elm_genlist_scroller_policy_set()
17654     *
17655     * @ingroup Genlist
17656     */
17657    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);
17658    /**
17659     * Get the @b next item in a genlist widget's internal list of items,
17660     * given a handle to one of those items.
17661     *
17662     * @param item The genlist item to fetch next from
17663     * @return The item after @p item, or @c NULL if there's none (and
17664     * on errors)
17665     *
17666     * This returns the item placed after the @p item, on the container
17667     * genlist.
17668     *
17669     * @see elm_genlist_item_prev_get()
17670     *
17671     * @ingroup Genlist
17672     */
17673    EAPI Elm_Genlist_Item  *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17674    /**
17675     * Get the @b previous item in a genlist widget's internal list of items,
17676     * given a handle to one of those items.
17677     *
17678     * @param item The genlist item to fetch previous from
17679     * @return The item before @p item, or @c NULL if there's none (and
17680     * on errors)
17681     *
17682     * This returns the item placed before the @p item, on the container
17683     * genlist.
17684     *
17685     * @see elm_genlist_item_next_get()
17686     *
17687     * @ingroup Genlist
17688     */
17689    EAPI Elm_Genlist_Item  *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17690    /**
17691     * Get the genlist object's handle which contains a given genlist
17692     * item
17693     *
17694     * @param item The item to fetch the container from
17695     * @return The genlist (parent) object
17696     *
17697     * This returns the genlist object itself that an item belongs to.
17698     *
17699     * @ingroup Genlist
17700     */
17701    EAPI Evas_Object       *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17702    /**
17703     * Get the parent item of the given item
17704     *
17705     * @param it The item
17706     * @return The parent of the item or @c NULL if it has no parent.
17707     *
17708     * This returns the item that was specified as parent of the item @p it on
17709     * elm_genlist_item_append() and insertion related functions.
17710     *
17711     * @ingroup Genlist
17712     */
17713    EAPI Elm_Genlist_Item  *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17714    /**
17715     * Remove all sub-items (children) of the given item
17716     *
17717     * @param it The item
17718     *
17719     * This removes all items that are children (and their descendants) of the
17720     * given item @p it.
17721     *
17722     * @see elm_genlist_clear()
17723     * @see elm_genlist_item_del()
17724     *
17725     * @ingroup Genlist
17726     */
17727    EAPI void               elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17728    /**
17729     * Set whether a given genlist item is selected or not
17730     *
17731     * @param it The item
17732     * @param selected Use @c EINA_TRUE, to make it selected, @c
17733     * EINA_FALSE to make it unselected
17734     *
17735     * This sets the selected state of an item. If multi selection is
17736     * not enabled on the containing genlist and @p selected is @c
17737     * EINA_TRUE, any other previously selected items will get
17738     * unselected in favor of this new one.
17739     *
17740     * @see elm_genlist_item_selected_get()
17741     *
17742     * @ingroup Genlist
17743     */
17744    EAPI void               elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
17745    /**
17746     * Get whether a given genlist item is selected or not
17747     *
17748     * @param it The item
17749     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
17750     *
17751     * @see elm_genlist_item_selected_set() for more details
17752     *
17753     * @ingroup Genlist
17754     */
17755    EAPI Eina_Bool          elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17756    /**
17757     * Sets the expanded state of an item.
17758     *
17759     * @param it The item
17760     * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
17761     *
17762     * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
17763     * expanded or not.
17764     *
17765     * The theme will respond to this change visually, and a signal "expanded" or
17766     * "contracted" will be sent from the genlist with a pointer to the item that
17767     * has been expanded/contracted.
17768     *
17769     * Calling this function won't show or hide any child of this item (if it is
17770     * a parent). You must manually delete and create them on the callbacks fo
17771     * the "expanded" or "contracted" signals.
17772     *
17773     * @see elm_genlist_item_expanded_get()
17774     *
17775     * @ingroup Genlist
17776     */
17777    EAPI void               elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
17778    /**
17779     * Get the expanded state of an item
17780     *
17781     * @param it The item
17782     * @return The expanded state
17783     *
17784     * This gets the expanded state of an item.
17785     *
17786     * @see elm_genlist_item_expanded_set()
17787     *
17788     * @ingroup Genlist
17789     */
17790    EAPI Eina_Bool          elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17791    /**
17792     * Get the depth of expanded item
17793     *
17794     * @param it The genlist item object
17795     * @return The depth of expanded item
17796     *
17797     * @ingroup Genlist
17798     */
17799    EAPI int                elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17800    /**
17801     * Set whether a given genlist item is disabled or not.
17802     *
17803     * @param it The item
17804     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
17805     * to enable it back.
17806     *
17807     * A disabled item cannot be selected or unselected. It will also
17808     * change its appearance, to signal the user it's disabled.
17809     *
17810     * @see elm_genlist_item_disabled_get()
17811     *
17812     * @ingroup Genlist
17813     */
17814    EAPI void               elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17815    /**
17816     * Get whether a given genlist item is disabled or not.
17817     *
17818     * @param it The item
17819     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
17820     * (and on errors).
17821     *
17822     * @see elm_genlist_item_disabled_set() for more details
17823     *
17824     * @ingroup Genlist
17825     */
17826    EAPI Eina_Bool          elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17827    /**
17828     * Sets the display only state of an item.
17829     *
17830     * @param it The item
17831     * @param display_only @c EINA_TRUE if the item is display only, @c
17832     * EINA_FALSE otherwise.
17833     *
17834     * A display only item cannot be selected or unselected. It is for
17835     * display only and not selecting or otherwise clicking, dragging
17836     * etc. by the user, thus finger size rules will not be applied to
17837     * this item.
17838     *
17839     * It's good to set group index items to display only state.
17840     *
17841     * @see elm_genlist_item_display_only_get()
17842     *
17843     * @ingroup Genlist
17844     */
17845    EAPI void               elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
17846    /**
17847     * Get the display only state of an item
17848     *
17849     * @param it The item
17850     * @return @c EINA_TRUE if the item is display only, @c
17851     * EINA_FALSE otherwise.
17852     *
17853     * @see elm_genlist_item_display_only_set()
17854     *
17855     * @ingroup Genlist
17856     */
17857    EAPI Eina_Bool          elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17858    /**
17859     * Show the portion of a genlist's internal list containing a given
17860     * item, immediately.
17861     *
17862     * @param it The item to display
17863     *
17864     * This causes genlist to jump to the given item @p it and show it (by
17865     * immediately scrolling to that position), if it is not fully visible.
17866     *
17867     * @see elm_genlist_item_bring_in()
17868     * @see elm_genlist_item_top_show()
17869     * @see elm_genlist_item_middle_show()
17870     *
17871     * @ingroup Genlist
17872     */
17873    EAPI void               elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17874    /**
17875     * Animatedly bring in, to the visible are of a genlist, a given
17876     * item on it.
17877     *
17878     * @param it The item to display
17879     *
17880     * This causes genlist to jump to the given item @p it and show it (by
17881     * animatedly scrolling), if it is not fully visible. This may use animation
17882     * to do so and take a period of time
17883     *
17884     * @see elm_genlist_item_show()
17885     * @see elm_genlist_item_top_bring_in()
17886     * @see elm_genlist_item_middle_bring_in()
17887     *
17888     * @ingroup Genlist
17889     */
17890    EAPI void               elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17891    /**
17892     * Show the portion of a genlist's internal list containing a given
17893     * item, immediately.
17894     *
17895     * @param it The item to display
17896     *
17897     * This causes genlist to jump to the given item @p it and show it (by
17898     * immediately scrolling to that position), if it is not fully visible.
17899     *
17900     * The item will be positioned at the top of the genlist viewport.
17901     *
17902     * @see elm_genlist_item_show()
17903     * @see elm_genlist_item_top_bring_in()
17904     *
17905     * @ingroup Genlist
17906     */
17907    EAPI void               elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17908    /**
17909     * Animatedly bring in, to the visible are of a genlist, a given
17910     * item on it.
17911     *
17912     * @param it The item
17913     *
17914     * This causes genlist to jump to the given item @p it and show it (by
17915     * animatedly scrolling), if it is not fully visible. This may use animation
17916     * to do so and take a period of time
17917     *
17918     * The item will be positioned at the top of the genlist viewport.
17919     *
17920     * @see elm_genlist_item_bring_in()
17921     * @see elm_genlist_item_top_show()
17922     *
17923     * @ingroup Genlist
17924     */
17925    EAPI void               elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17926    /**
17927     * Show the portion of a genlist's internal list containing a given
17928     * item, immediately.
17929     *
17930     * @param it The item to display
17931     *
17932     * This causes genlist to jump to the given item @p it and show it (by
17933     * immediately scrolling to that position), if it is not fully visible.
17934     *
17935     * The item will be positioned at the middle of the genlist viewport.
17936     *
17937     * @see elm_genlist_item_show()
17938     * @see elm_genlist_item_middle_bring_in()
17939     *
17940     * @ingroup Genlist
17941     */
17942    EAPI void               elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17943    /**
17944     * Animatedly bring in, to the visible are of a genlist, a given
17945     * item on it.
17946     *
17947     * @param it The item
17948     *
17949     * This causes genlist to jump to the given item @p it and show it (by
17950     * animatedly scrolling), if it is not fully visible. This may use animation
17951     * to do so and take a period of time
17952     *
17953     * The item will be positioned at the middle of the genlist viewport.
17954     *
17955     * @see elm_genlist_item_bring_in()
17956     * @see elm_genlist_item_middle_show()
17957     *
17958     * @ingroup Genlist
17959     */
17960    EAPI void               elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17961    /**
17962     * Remove a genlist item from the its parent, deleting it.
17963     *
17964     * @param item The item to be removed.
17965     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
17966     *
17967     * @see elm_genlist_clear(), to remove all items in a genlist at
17968     * once.
17969     *
17970     * @ingroup Genlist
17971     */
17972    EAPI void               elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17973    /**
17974     * Return the data associated to a given genlist item
17975     *
17976     * @param item The genlist item.
17977     * @return the data associated to this item.
17978     *
17979     * This returns the @c data value passed on the
17980     * elm_genlist_item_append() and related item addition calls.
17981     *
17982     * @see elm_genlist_item_append()
17983     * @see elm_genlist_item_data_set()
17984     *
17985     * @ingroup Genlist
17986     */
17987    EAPI void              *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17988    /**
17989     * Set the data associated to a given genlist item
17990     *
17991     * @param item The genlist item
17992     * @param data The new data pointer to set on it
17993     *
17994     * This @b overrides the @c data value passed on the
17995     * elm_genlist_item_append() and related item addition calls. This
17996     * function @b won't call elm_genlist_item_update() automatically,
17997     * so you'd issue it afterwards if you want to hove the item
17998     * updated to reflect the that new data.
17999     *
18000     * @see elm_genlist_item_data_get()
18001     *
18002     * @ingroup Genlist
18003     */
18004    EAPI void               elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
18005    /**
18006     * Tells genlist to "orphan" icons fetchs by the item class
18007     *
18008     * @param it The item
18009     *
18010     * This instructs genlist to release references to icons in the item,
18011     * meaning that they will no longer be managed by genlist and are
18012     * floating "orphans" that can be re-used elsewhere if the user wants
18013     * to.
18014     *
18015     * @ingroup Genlist
18016     */
18017    EAPI void               elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18018    /**
18019     * Get the real Evas object created to implement the view of a
18020     * given genlist item
18021     *
18022     * @param item The genlist item.
18023     * @return the Evas object implementing this item's view.
18024     *
18025     * This returns the actual Evas object used to implement the
18026     * specified genlist item's view. This may be @c NULL, as it may
18027     * not have been created or may have been deleted, at any time, by
18028     * the genlist. <b>Do not modify this object</b> (move, resize,
18029     * show, hide, etc.), as the genlist is controlling it. This
18030     * function is for querying, emitting custom signals or hooking
18031     * lower level callbacks for events on that object. Do not delete
18032     * this object under any circumstances.
18033     *
18034     * @see elm_genlist_item_data_get()
18035     *
18036     * @ingroup Genlist
18037     */
18038    EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18039    /**
18040     * Update the contents of an item
18041     *
18042     * @param it The item
18043     *
18044     * This updates an item by calling all the item class functions again
18045     * to get the icons, labels and states. Use this when the original
18046     * item data has changed and the changes are desired to be reflected.
18047     *
18048     * Use elm_genlist_realized_items_update() to update all already realized
18049     * items.
18050     *
18051     * @see elm_genlist_realized_items_update()
18052     *
18053     * @ingroup Genlist
18054     */
18055    EAPI void               elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18056    /**
18057     * Update the item class of an item
18058     *
18059     * @param it The item
18060     * @param itc The item class for the item
18061     *
18062     * This sets another class fo the item, changing the way that it is
18063     * displayed. After changing the item class, elm_genlist_item_update() is
18064     * called on the item @p it.
18065     *
18066     * @ingroup Genlist
18067     */
18068    EAPI void               elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
18069    EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18070    /**
18071     * Set the text to be shown in a given genlist item's tooltips.
18072     *
18073     * @param item The genlist item
18074     * @param text The text to set in the content
18075     *
18076     * This call will setup the text to be used as tooltip to that item
18077     * (analogous to elm_object_tooltip_text_set(), but being item
18078     * tooltips with higher precedence than object tooltips). It can
18079     * have only one tooltip at a time, so any previous tooltip data
18080     * will get removed.
18081     *
18082     * In order to set an icon or something else as a tooltip, look at
18083     * elm_genlist_item_tooltip_content_cb_set().
18084     *
18085     * @ingroup Genlist
18086     */
18087    EAPI void               elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
18088    /**
18089     * Set the content to be shown in a given genlist item's tooltips
18090     *
18091     * @param item The genlist item.
18092     * @param func The function returning the tooltip contents.
18093     * @param data What to provide to @a func as callback data/context.
18094     * @param del_cb Called when data is not needed anymore, either when
18095     *        another callback replaces @p func, the tooltip is unset with
18096     *        elm_genlist_item_tooltip_unset() or the owner @p item
18097     *        dies. This callback receives as its first parameter the
18098     *        given @p data, being @c event_info the item handle.
18099     *
18100     * This call will setup the tooltip's contents to @p item
18101     * (analogous to elm_object_tooltip_content_cb_set(), but being
18102     * item tooltips with higher precedence than object tooltips). It
18103     * can have only one tooltip at a time, so any previous tooltip
18104     * content will get removed. @p func (with @p data) will be called
18105     * every time Elementary needs to show the tooltip and it should
18106     * return a valid Evas object, which will be fully managed by the
18107     * tooltip system, getting deleted when the tooltip is gone.
18108     *
18109     * In order to set just a text as a tooltip, look at
18110     * elm_genlist_item_tooltip_text_set().
18111     *
18112     * @ingroup Genlist
18113     */
18114    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);
18115    /**
18116     * Unset a tooltip from a given genlist item
18117     *
18118     * @param item genlist item to remove a previously set tooltip from.
18119     *
18120     * This call removes any tooltip set on @p item. The callback
18121     * provided as @c del_cb to
18122     * elm_genlist_item_tooltip_content_cb_set() will be called to
18123     * notify it is not used anymore (and have resources cleaned, if
18124     * need be).
18125     *
18126     * @see elm_genlist_item_tooltip_content_cb_set()
18127     *
18128     * @ingroup Genlist
18129     */
18130    EAPI void               elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18131    /**
18132     * Set a different @b style for a given genlist item's tooltip.
18133     *
18134     * @param item genlist item with tooltip set
18135     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
18136     * "default", @c "transparent", etc)
18137     *
18138     * Tooltips can have <b>alternate styles</b> to be displayed on,
18139     * which are defined by the theme set on Elementary. This function
18140     * works analogously as elm_object_tooltip_style_set(), but here
18141     * applied only to genlist item objects. The default style for
18142     * tooltips is @c "default".
18143     *
18144     * @note before you set a style you should define a tooltip with
18145     *       elm_genlist_item_tooltip_content_cb_set() or
18146     *       elm_genlist_item_tooltip_text_set()
18147     *
18148     * @see elm_genlist_item_tooltip_style_get()
18149     *
18150     * @ingroup Genlist
18151     */
18152    EAPI void               elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
18153    /**
18154     * Get the style set a given genlist item's tooltip.
18155     *
18156     * @param item genlist item with tooltip already set on.
18157     * @return style the theme style in use, which defaults to
18158     *         "default". If the object does not have a tooltip set,
18159     *         then @c NULL is returned.
18160     *
18161     * @see elm_genlist_item_tooltip_style_set() for more details
18162     *
18163     * @ingroup Genlist
18164     */
18165    EAPI const char        *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18166    /**
18167     * @brief Disable size restrictions on an object's tooltip
18168     * @param item The tooltip's anchor object
18169     * @param disable If EINA_TRUE, size restrictions are disabled
18170     * @return EINA_FALSE on failure, EINA_TRUE on success
18171     *
18172     * This function allows a tooltip to expand beyond its parant window's canvas.
18173     * It will instead be limited only by the size of the display.
18174     */
18175    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
18176    /**
18177     * @brief Retrieve size restriction state of an object's tooltip
18178     * @param item The tooltip's anchor object
18179     * @return If EINA_TRUE, size restrictions are disabled
18180     *
18181     * This function returns whether a tooltip is allowed to expand beyond
18182     * its parant window's canvas.
18183     * It will instead be limited only by the size of the display.
18184     */
18185    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
18186    /**
18187     * Set the type of mouse pointer/cursor decoration to be shown,
18188     * when the mouse pointer is over the given genlist widget item
18189     *
18190     * @param item genlist item to customize cursor on
18191     * @param cursor the cursor type's name
18192     *
18193     * This function works analogously as elm_object_cursor_set(), but
18194     * here the cursor's changing area is restricted to the item's
18195     * area, and not the whole widget's. Note that that item cursors
18196     * have precedence over widget cursors, so that a mouse over @p
18197     * item will always show cursor @p type.
18198     *
18199     * If this function is called twice for an object, a previously set
18200     * cursor will be unset on the second call.
18201     *
18202     * @see elm_object_cursor_set()
18203     * @see elm_genlist_item_cursor_get()
18204     * @see elm_genlist_item_cursor_unset()
18205     *
18206     * @ingroup Genlist
18207     */
18208    EAPI void               elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
18209    /**
18210     * Get the type of mouse pointer/cursor decoration set to be shown,
18211     * when the mouse pointer is over the given genlist widget item
18212     *
18213     * @param item genlist item with custom cursor set
18214     * @return the cursor type's name or @c NULL, if no custom cursors
18215     * were set to @p item (and on errors)
18216     *
18217     * @see elm_object_cursor_get()
18218     * @see elm_genlist_item_cursor_set() for more details
18219     * @see elm_genlist_item_cursor_unset()
18220     *
18221     * @ingroup Genlist
18222     */
18223    EAPI const char        *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18224    /**
18225     * Unset any custom mouse pointer/cursor decoration set to be
18226     * shown, when the mouse pointer is over the given genlist widget
18227     * item, thus making it show the @b default cursor again.
18228     *
18229     * @param item a genlist item
18230     *
18231     * Use this call to undo any custom settings on this item's cursor
18232     * decoration, bringing it back to defaults (no custom style set).
18233     *
18234     * @see elm_object_cursor_unset()
18235     * @see elm_genlist_item_cursor_set() for more details
18236     *
18237     * @ingroup Genlist
18238     */
18239    EAPI void               elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18240    /**
18241     * Set a different @b style for a given custom cursor set for a
18242     * genlist item.
18243     *
18244     * @param item genlist item with custom cursor set
18245     * @param style the <b>theme style</b> to use (e.g. @c "default",
18246     * @c "transparent", etc)
18247     *
18248     * This function only makes sense when one is using custom mouse
18249     * cursor decorations <b>defined in a theme file</b> , which can
18250     * have, given a cursor name/type, <b>alternate styles</b> on
18251     * it. It works analogously as elm_object_cursor_style_set(), but
18252     * here applied only to genlist item objects.
18253     *
18254     * @warning Before you set a cursor style you should have defined a
18255     *       custom cursor previously on the item, with
18256     *       elm_genlist_item_cursor_set()
18257     *
18258     * @see elm_genlist_item_cursor_engine_only_set()
18259     * @see elm_genlist_item_cursor_style_get()
18260     *
18261     * @ingroup Genlist
18262     */
18263    EAPI void               elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
18264    /**
18265     * Get the current @b style set for a given genlist item's custom
18266     * cursor
18267     *
18268     * @param item genlist item with custom cursor set.
18269     * @return style the cursor style in use. If the object does not
18270     *         have a cursor set, then @c NULL is returned.
18271     *
18272     * @see elm_genlist_item_cursor_style_set() for more details
18273     *
18274     * @ingroup Genlist
18275     */
18276    EAPI const char        *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18277    /**
18278     * Set if the (custom) cursor for a given genlist item should be
18279     * searched in its theme, also, or should only rely on the
18280     * rendering engine.
18281     *
18282     * @param item item with custom (custom) cursor already set on
18283     * @param engine_only Use @c EINA_TRUE to have cursors looked for
18284     * only on those provided by the rendering engine, @c EINA_FALSE to
18285     * have them searched on the widget's theme, as well.
18286     *
18287     * @note This call is of use only if you've set a custom cursor
18288     * for genlist items, with elm_genlist_item_cursor_set().
18289     *
18290     * @note By default, cursors will only be looked for between those
18291     * provided by the rendering engine.
18292     *
18293     * @ingroup Genlist
18294     */
18295    EAPI void               elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
18296    /**
18297     * Get if the (custom) cursor for a given genlist item is being
18298     * searched in its theme, also, or is only relying on the rendering
18299     * engine.
18300     *
18301     * @param item a genlist item
18302     * @return @c EINA_TRUE, if cursors are being looked for only on
18303     * those provided by the rendering engine, @c EINA_FALSE if they
18304     * are being searched on the widget's theme, as well.
18305     *
18306     * @see elm_genlist_item_cursor_engine_only_set(), for more details
18307     *
18308     * @ingroup Genlist
18309     */
18310    EAPI Eina_Bool          elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18311    /**
18312     * Update the contents of all realized items.
18313     *
18314     * @param obj The genlist object.
18315     *
18316     * This updates all realized items by calling all the item class functions again
18317     * to get the icons, labels and states. Use this when the original
18318     * item data has changed and the changes are desired to be reflected.
18319     *
18320     * To update just one item, use elm_genlist_item_update().
18321     *
18322     * @see elm_genlist_realized_items_get()
18323     * @see elm_genlist_item_update()
18324     *
18325     * @ingroup Genlist
18326     */
18327    EAPI void               elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
18328    /**
18329     * Activate a genlist mode on an item
18330     *
18331     * @param item The genlist item
18332     * @param mode Mode name
18333     * @param mode_set Boolean to define set or unset mode.
18334     *
18335     * A genlist mode is a different way of selecting an item. Once a mode is
18336     * activated on an item, any other selected item is immediately unselected.
18337     * This feature provides an easy way of implementing a new kind of animation
18338     * for selecting an item, without having to entirely rewrite the item style
18339     * theme. However, the elm_genlist_selected_* API can't be used to get what
18340     * item is activate for a mode.
18341     *
18342     * The current item style will still be used, but applying a genlist mode to
18343     * an item will select it using a different kind of animation.
18344     *
18345     * The current active item for a mode can be found by
18346     * elm_genlist_mode_item_get().
18347     *
18348     * The characteristics of genlist mode are:
18349     * - Only one mode can be active at any time, and for only one item.
18350     * - Genlist handles deactivating other items when one item is activated.
18351     * - A mode is defined in the genlist theme (edc), and more modes can easily
18352     *   be added.
18353     * - A mode style and the genlist item style are different things. They
18354     *   can be combined to provide a default style to the item, with some kind
18355     *   of animation for that item when the mode is activated.
18356     *
18357     * When a mode is activated on an item, a new view for that item is created.
18358     * The theme of this mode defines the animation that will be used to transit
18359     * the item from the old view to the new view. This second (new) view will be
18360     * active for that item while the mode is active on the item, and will be
18361     * destroyed after the mode is totally deactivated from that item.
18362     *
18363     * @see elm_genlist_mode_get()
18364     * @see elm_genlist_mode_item_get()
18365     *
18366     * @ingroup Genlist
18367     */
18368    EAPI void               elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
18369    /**
18370     * Get the last (or current) genlist mode used.
18371     *
18372     * @param obj The genlist object
18373     *
18374     * This function just returns the name of the last used genlist mode. It will
18375     * be the current mode if it's still active.
18376     *
18377     * @see elm_genlist_item_mode_set()
18378     * @see elm_genlist_mode_item_get()
18379     *
18380     * @ingroup Genlist
18381     */
18382    EAPI const char        *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18383    /**
18384     * Get active genlist mode item
18385     *
18386     * @param obj The genlist object
18387     * @return The active item for that current mode. Or @c NULL if no item is
18388     * activated with any mode.
18389     *
18390     * This function returns the item that was activated with a mode, by the
18391     * function elm_genlist_item_mode_set().
18392     *
18393     * @see elm_genlist_item_mode_set()
18394     * @see elm_genlist_mode_get()
18395     *
18396     * @ingroup Genlist
18397     */
18398    EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18399
18400    /**
18401     * Set reorder mode
18402     *
18403     * @param obj The genlist object
18404     * @param reorder_mode The reorder mode
18405     * (EINA_TRUE = on, EINA_FALSE = off)
18406     *
18407     * @ingroup Genlist
18408     */
18409    EAPI void               elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
18410
18411    /**
18412     * Get the reorder mode
18413     *
18414     * @param obj The genlist object
18415     * @return The reorder mode
18416     * (EINA_TRUE = on, EINA_FALSE = off)
18417     *
18418     * @ingroup Genlist
18419     */
18420    EAPI Eina_Bool          elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18421
18422    /**
18423     * @}
18424     */
18425
18426    /**
18427     * @defgroup Check Check
18428     *
18429     * @image html img/widget/check/preview-00.png
18430     * @image latex img/widget/check/preview-00.eps
18431     * @image html img/widget/check/preview-01.png
18432     * @image latex img/widget/check/preview-01.eps
18433     * @image html img/widget/check/preview-02.png
18434     * @image latex img/widget/check/preview-02.eps
18435     *
18436     * @brief The check widget allows for toggling a value between true and
18437     * false.
18438     *
18439     * Check objects are a lot like radio objects in layout and functionality
18440     * except they do not work as a group, but independently and only toggle the
18441     * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
18442     * the boolean state (1 for true, 0 for false), and elm_check_state_get()
18443     * returns the current state. For convenience, like the radio objects, you
18444     * can set a pointer to a boolean directly with elm_check_state_pointer_set()
18445     * for it to modify.
18446     *
18447     * Signals that you can add callbacks for are:
18448     * "changed" - This is called whenever the user changes the state of one of
18449     *             the check object(event_info is NULL).
18450     *
18451     * @ref tutorial_check should give you a firm grasp of how to use this widget.
18452     * @{
18453     */
18454    /**
18455     * @brief Add a new Check object
18456     *
18457     * @param parent The parent object
18458     * @return The new object or NULL if it cannot be created
18459     */
18460    EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18461    /**
18462     * @brief Set the text label of the check object
18463     *
18464     * @param obj The check object
18465     * @param label The text label string in UTF-8
18466     *
18467     * @deprecated use elm_object_text_set() instead.
18468     */
18469    EINA_DEPRECATED EAPI void         elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18470    /**
18471     * @brief Get the text label of the check object
18472     *
18473     * @param obj The check object
18474     * @return The text label string in UTF-8
18475     *
18476     * @deprecated use elm_object_text_get() instead.
18477     */
18478    EINA_DEPRECATED EAPI const char  *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18479    /**
18480     * @brief Set the icon object of the check object
18481     *
18482     * @param obj The check object
18483     * @param icon The icon object
18484     *
18485     * Once the icon object is set, a previously set one will be deleted.
18486     * If you want to keep that old content object, use the
18487     * elm_check_icon_unset() function.
18488     */
18489    EAPI void         elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18490    /**
18491     * @brief Get the icon object of the check object
18492     *
18493     * @param obj The check object
18494     * @return The icon object
18495     */
18496    EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18497    /**
18498     * @brief Unset the icon used for the check object
18499     *
18500     * @param obj The check object
18501     * @return The icon object that was being used
18502     *
18503     * Unparent and return the icon object which was set for this widget.
18504     */
18505    EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18506    /**
18507     * @brief Set the on/off state of the check object
18508     *
18509     * @param obj The check object
18510     * @param state The state to use (1 == on, 0 == off)
18511     *
18512     * This sets the state of the check. If set
18513     * with elm_check_state_pointer_set() the state of that variable is also
18514     * changed. Calling this @b doesn't cause the "changed" signal to be emited.
18515     */
18516    EAPI void         elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
18517    /**
18518     * @brief Get the state of the check object
18519     *
18520     * @param obj The check object
18521     * @return The boolean state
18522     */
18523    EAPI Eina_Bool    elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18524    /**
18525     * @brief Set a convenience pointer to a boolean to change
18526     *
18527     * @param obj The check object
18528     * @param statep Pointer to the boolean to modify
18529     *
18530     * This sets a pointer to a boolean, that, in addition to the check objects
18531     * state will also be modified directly. To stop setting the object pointed
18532     * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
18533     * then when this is called, the check objects state will also be modified to
18534     * reflect the value of the boolean @p statep points to, just like calling
18535     * elm_check_state_set().
18536     */
18537    EAPI void         elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
18538    /**
18539     * @}
18540     */
18541
18542    /**
18543     * @defgroup Radio Radio
18544     *
18545     * @image html img/widget/radio/preview-00.png
18546     * @image latex img/widget/radio/preview-00.eps
18547     *
18548     * @brief Radio is a widget that allows for 1 or more options to be displayed
18549     * and have the user choose only 1 of them.
18550     *
18551     * A radio object contains an indicator, an optional Label and an optional
18552     * icon object. While it's possible to have a group of only one radio they,
18553     * are normally used in groups of 2 or more. To add a radio to a group use
18554     * elm_radio_group_add(). The radio object(s) will select from one of a set
18555     * of integer values, so any value they are configuring needs to be mapped to
18556     * a set of integers. To configure what value that radio object represents,
18557     * use  elm_radio_state_value_set() to set the integer it represents. To set
18558     * the value the whole group(which one is currently selected) is to indicate
18559     * use elm_radio_value_set() on any group member, and to get the groups value
18560     * use elm_radio_value_get(). For convenience the radio objects are also able
18561     * to directly set an integer(int) to the value that is selected. To specify
18562     * the pointer to this integer to modify, use elm_radio_value_pointer_set().
18563     * The radio objects will modify this directly. That implies the pointer must
18564     * point to valid memory for as long as the radio objects exist.
18565     *
18566     * Signals that you can add callbacks for are:
18567     * @li changed - This is called whenever the user changes the state of one of
18568     * the radio objects within the group of radio objects that work together.
18569     *
18570     * @ref tutorial_radio show most of this API in action.
18571     * @{
18572     */
18573    /**
18574     * @brief Add a new radio to the parent
18575     *
18576     * @param parent The parent object
18577     * @return The new object or NULL if it cannot be created
18578     */
18579    EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18580    /**
18581     * @brief Set the text label of the radio object
18582     *
18583     * @param obj The radio object
18584     * @param label The text label string in UTF-8
18585     *
18586     * @deprecated use elm_object_text_set() instead.
18587     */
18588    EINA_DEPRECATED EAPI void         elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18589    /**
18590     * @brief Get the text label of the radio object
18591     *
18592     * @param obj The radio object
18593     * @return The text label string in UTF-8
18594     *
18595     * @deprecated use elm_object_text_set() instead.
18596     */
18597    EINA_DEPRECATED EAPI const char  *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18598    /**
18599     * @brief Set the icon object of the radio object
18600     *
18601     * @param obj The radio object
18602     * @param icon The icon object
18603     *
18604     * Once the icon object is set, a previously set one will be deleted. If you
18605     * want to keep that old content object, use the elm_radio_icon_unset()
18606     * function.
18607     */
18608    EAPI void         elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18609    /**
18610     * @brief Get the icon object of the radio object
18611     *
18612     * @param obj The radio object
18613     * @return The icon object
18614     *
18615     * @see elm_radio_icon_set()
18616     */
18617    EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18618    /**
18619     * @brief Unset the icon used for the radio object
18620     *
18621     * @param obj The radio object
18622     * @return The icon object that was being used
18623     *
18624     * Unparent and return the icon object which was set for this widget.
18625     *
18626     * @see elm_radio_icon_set()
18627     */
18628    EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18629    /**
18630     * @brief Add this radio to a group of other radio objects
18631     *
18632     * @param obj The radio object
18633     * @param group Any object whose group the @p obj is to join.
18634     *
18635     * Radio objects work in groups. Each member should have a different integer
18636     * value assigned. In order to have them work as a group, they need to know
18637     * about each other. This adds the given radio object to the group of which
18638     * the group object indicated is a member.
18639     */
18640    EAPI void         elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
18641    /**
18642     * @brief Set the integer value that this radio object represents
18643     *
18644     * @param obj The radio object
18645     * @param value The value to use if this radio object is selected
18646     *
18647     * This sets the value of the radio.
18648     */
18649    EAPI void         elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
18650    /**
18651     * @brief Get the integer value that this radio object represents
18652     *
18653     * @param obj The radio object
18654     * @return The value used if this radio object is selected
18655     *
18656     * This gets the value of the radio.
18657     *
18658     * @see elm_radio_value_set()
18659     */
18660    EAPI int          elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18661    /**
18662     * @brief Set the value of the radio.
18663     *
18664     * @param obj The radio object
18665     * @param value The value to use for the group
18666     *
18667     * This sets the value of the radio group and will also set the value if
18668     * pointed to, to the value supplied, but will not call any callbacks.
18669     */
18670    EAPI void         elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
18671    /**
18672     * @brief Get the state of the radio object
18673     *
18674     * @param obj The radio object
18675     * @return The integer state
18676     */
18677    EAPI int          elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18678    /**
18679     * @brief Set a convenience pointer to a integer to change
18680     *
18681     * @param obj The radio object
18682     * @param valuep Pointer to the integer to modify
18683     *
18684     * This sets a pointer to a integer, that, in addition to the radio objects
18685     * state will also be modified directly. To stop setting the object pointed
18686     * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
18687     * when this is called, the radio objects state will also be modified to
18688     * reflect the value of the integer valuep points to, just like calling
18689     * elm_radio_value_set().
18690     */
18691    EAPI void         elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
18692    /**
18693     * @}
18694     */
18695
18696    /**
18697     * @defgroup Pager Pager
18698     *
18699     * @image html img/widget/pager/preview-00.png
18700     * @image latex img/widget/pager/preview-00.eps
18701     *
18702     * @brief Widget that allows flipping between 1 or more “pages” of objects.
18703     *
18704     * The flipping between “pages” of objects is animated. All content in pager
18705     * is kept in a stack, the last content to be added will be on the top of the
18706     * stack(be visible).
18707     *
18708     * Objects can be pushed or popped from the stack or deleted as normal.
18709     * Pushes and pops will animate (and a pop will delete the object once the
18710     * animation is finished). Any object already in the pager can be promoted to
18711     * the top(from its current stacking position) through the use of
18712     * elm_pager_content_promote(). Objects are pushed to the top with
18713     * elm_pager_content_push() and when the top item is no longer wanted, simply
18714     * pop it with elm_pager_content_pop() and it will also be deleted. If an
18715     * object is no longer needed and is not the top item, just delete it as
18716     * normal. You can query which objects are the top and bottom with
18717     * elm_pager_content_bottom_get() and elm_pager_content_top_get().
18718     *
18719     * Signals that you can add callbacks for are:
18720     * "hide,finished" - when the previous page is hided
18721     *
18722     * This widget has the following styles available:
18723     * @li default
18724     * @li fade
18725     * @li fade_translucide
18726     * @li fade_invisible
18727     * @note This styles affect only the flipping animations, the appearance when
18728     * not animating is unaffected by styles.
18729     *
18730     * @ref tutorial_pager gives a good overview of the usage of the API.
18731     * @{
18732     */
18733    /**
18734     * Add a new pager to the parent
18735     *
18736     * @param parent The parent object
18737     * @return The new object or NULL if it cannot be created
18738     *
18739     * @ingroup Pager
18740     */
18741    EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18742    /**
18743     * @brief Push an object to the top of the pager stack (and show it).
18744     *
18745     * @param obj The pager object
18746     * @param content The object to push
18747     *
18748     * The object pushed becomes a child of the pager, it will be controlled and
18749     * deleted when the pager is deleted.
18750     *
18751     * @note If the content is already in the stack use
18752     * elm_pager_content_promote().
18753     * @warning Using this function on @p content already in the stack results in
18754     * undefined behavior.
18755     */
18756    EAPI void         elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18757    /**
18758     * @brief Pop the object that is on top of the stack
18759     *
18760     * @param obj The pager object
18761     *
18762     * This pops the object that is on the top(visible) of the pager, makes it
18763     * disappear, then deletes the object. The object that was underneath it on
18764     * the stack will become visible.
18765     */
18766    EAPI void         elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
18767    /**
18768     * @brief Moves an object already in the pager stack to the top of the stack.
18769     *
18770     * @param obj The pager object
18771     * @param content The object to promote
18772     *
18773     * This will take the @p content and move it to the top of the stack as
18774     * if it had been pushed there.
18775     *
18776     * @note If the content isn't already in the stack use
18777     * elm_pager_content_push().
18778     * @warning Using this function on @p content not already in the stack
18779     * results in undefined behavior.
18780     */
18781    EAPI void         elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18782    /**
18783     * @brief Return the object at the bottom of the pager stack
18784     *
18785     * @param obj The pager object
18786     * @return The bottom object or NULL if none
18787     */
18788    EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18789    /**
18790     * @brief  Return the object at the top of the pager stack
18791     *
18792     * @param obj The pager object
18793     * @return The top object or NULL if none
18794     */
18795    EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18796    /**
18797     * @}
18798     */
18799
18800    /**
18801     * @defgroup Slideshow Slideshow
18802     *
18803     * @image html img/widget/slideshow/preview-00.png
18804     * @image latex img/widget/slideshow/preview-00.eps
18805     *
18806     * This widget, as the name indicates, is a pre-made image
18807     * slideshow panel, with API functions acting on (child) image
18808     * items presentation. Between those actions, are:
18809     * - advance to next/previous image
18810     * - select the style of image transition animation
18811     * - set the exhibition time for each image
18812     * - start/stop the slideshow
18813     *
18814     * The transition animations are defined in the widget's theme,
18815     * consequently new animations can be added without having to
18816     * update the widget's code.
18817     *
18818     * @section Slideshow_Items Slideshow items
18819     *
18820     * For slideshow items, just like for @ref Genlist "genlist" ones,
18821     * the user defines a @b classes, specifying functions that will be
18822     * called on the item's creation and deletion times.
18823     *
18824     * The #Elm_Slideshow_Item_Class structure contains the following
18825     * members:
18826     *
18827     * - @c func.get - When an item is displayed, this function is
18828     *   called, and it's where one should create the item object, de
18829     *   facto. For example, the object can be a pure Evas image object
18830     *   or an Elementary @ref Photocam "photocam" widget. See
18831     *   #SlideshowItemGetFunc.
18832     * - @c func.del - When an item is no more displayed, this function
18833     *   is called, where the user must delete any data associated to
18834     *   the item. See #SlideshowItemDelFunc.
18835     *
18836     * @section Slideshow_Caching Slideshow caching
18837     *
18838     * The slideshow provides facilities to have items adjacent to the
18839     * one being displayed <b>already "realized"</b> (i.e. loaded) for
18840     * you, so that the system does not have to decode image data
18841     * anymore at the time it has to actually switch images on its
18842     * viewport. The user is able to set the numbers of items to be
18843     * cached @b before and @b after the current item, in the widget's
18844     * item list.
18845     *
18846     * Smart events one can add callbacks for are:
18847     *
18848     * - @c "changed" - when the slideshow switches its view to a new
18849     *   item
18850     *
18851     * List of examples for the slideshow widget:
18852     * @li @ref slideshow_example
18853     */
18854
18855    /**
18856     * @addtogroup Slideshow
18857     * @{
18858     */
18859
18860    typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
18861    typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
18862    typedef struct _Elm_Slideshow_Item       Elm_Slideshow_Item; /**< Slideshow item handle */
18863    typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
18864    typedef void         (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
18865
18866    /**
18867     * @struct _Elm_Slideshow_Item_Class
18868     *
18869     * Slideshow item class definition. See @ref Slideshow_Items for
18870     * field details.
18871     */
18872    struct _Elm_Slideshow_Item_Class
18873      {
18874         struct _Elm_Slideshow_Item_Class_Func
18875           {
18876              SlideshowItemGetFunc get;
18877              SlideshowItemDelFunc del;
18878           } func;
18879      }; /**< #Elm_Slideshow_Item_Class member definitions */
18880
18881    /**
18882     * Add a new slideshow widget to the given parent Elementary
18883     * (container) object
18884     *
18885     * @param parent The parent object
18886     * @return A new slideshow widget handle or @c NULL, on errors
18887     *
18888     * This function inserts a new slideshow widget on the canvas.
18889     *
18890     * @ingroup Slideshow
18891     */
18892    EAPI Evas_Object        *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18893
18894    /**
18895     * Add (append) a new item in a given slideshow widget.
18896     *
18897     * @param obj The slideshow object
18898     * @param itc The item class for the item
18899     * @param data The item's data
18900     * @return A handle to the item added or @c NULL, on errors
18901     *
18902     * Add a new item to @p obj's internal list of items, appending it.
18903     * The item's class must contain the function really fetching the
18904     * image object to show for this item, which could be an Evas image
18905     * object or an Elementary photo, for example. The @p data
18906     * parameter is going to be passed to both class functions of the
18907     * item.
18908     *
18909     * @see #Elm_Slideshow_Item_Class
18910     * @see elm_slideshow_item_sorted_insert()
18911     *
18912     * @ingroup Slideshow
18913     */
18914    EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
18915
18916    /**
18917     * Insert a new item into the given slideshow widget, using the @p func
18918     * function to sort items (by item handles).
18919     *
18920     * @param obj The slideshow object
18921     * @param itc The item class for the item
18922     * @param data The item's data
18923     * @param func The comparing function to be used to sort slideshow
18924     * items <b>by #Elm_Slideshow_Item item handles</b>
18925     * @return Returns The slideshow item handle, on success, or
18926     * @c NULL, on errors
18927     *
18928     * Add a new item to @p obj's internal list of items, in a position
18929     * determined by the @p func comparing function. The item's class
18930     * must contain the function really fetching the image object to
18931     * show for this item, which could be an Evas image object or an
18932     * Elementary photo, for example. The @p data parameter is going to
18933     * be passed to both class functions of the item.
18934     *
18935     * @see #Elm_Slideshow_Item_Class
18936     * @see elm_slideshow_item_add()
18937     *
18938     * @ingroup Slideshow
18939     */
18940    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);
18941
18942    /**
18943     * Display a given slideshow widget's item, programmatically.
18944     *
18945     * @param obj The slideshow object
18946     * @param item The item to display on @p obj's viewport
18947     *
18948     * The change between the current item and @p item will use the
18949     * transition @p obj is set to use (@see
18950     * elm_slideshow_transition_set()).
18951     *
18952     * @ingroup Slideshow
18953     */
18954    EAPI void                elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18955
18956    /**
18957     * Slide to the @b next item, in a given slideshow widget
18958     *
18959     * @param obj The slideshow object
18960     *
18961     * The sliding animation @p obj is set to use will be the
18962     * transition effect used, after this call is issued.
18963     *
18964     * @note If the end of the slideshow's internal list of items is
18965     * reached, it'll wrap around to the list's beginning, again.
18966     *
18967     * @ingroup Slideshow
18968     */
18969    EAPI void                elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
18970
18971    /**
18972     * Slide to the @b previous item, in a given slideshow widget
18973     *
18974     * @param obj The slideshow object
18975     *
18976     * The sliding animation @p obj is set to use will be the
18977     * transition effect used, after this call is issued.
18978     *
18979     * @note If the beginning of the slideshow's internal list of items
18980     * is reached, it'll wrap around to the list's end, again.
18981     *
18982     * @ingroup Slideshow
18983     */
18984    EAPI void                elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
18985
18986    /**
18987     * Returns the list of sliding transition/effect names available, for a
18988     * given slideshow widget.
18989     *
18990     * @param obj The slideshow object
18991     * @return The list of transitions (list of @b stringshared strings
18992     * as data)
18993     *
18994     * The transitions, which come from @p obj's theme, must be an EDC
18995     * data item named @c "transitions" on the theme file, with (prefix)
18996     * names of EDC programs actually implementing them.
18997     *
18998     * The available transitions for slideshows on the default theme are:
18999     * - @c "fade" - the current item fades out, while the new one
19000     *   fades in to the slideshow's viewport.
19001     * - @c "black_fade" - the current item fades to black, and just
19002     *   then, the new item will fade in.
19003     * - @c "horizontal" - the current item slides horizontally, until
19004     *   it gets out of the slideshow's viewport, while the new item
19005     *   comes from the left to take its place.
19006     * - @c "vertical" - the current item slides vertically, until it
19007     *   gets out of the slideshow's viewport, while the new item comes
19008     *   from the bottom to take its place.
19009     * - @c "square" - the new item starts to appear from the middle of
19010     *   the current one, but with a tiny size, growing until its
19011     *   target (full) size and covering the old one.
19012     *
19013     * @warning The stringshared strings get no new references
19014     * exclusive to the user grabbing the list, here, so if you'd like
19015     * to use them out of this call's context, you'd better @c
19016     * eina_stringshare_ref() them.
19017     *
19018     * @see elm_slideshow_transition_set()
19019     *
19020     * @ingroup Slideshow
19021     */
19022    EAPI const Eina_List    *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19023
19024    /**
19025     * Set the current slide transition/effect in use for a given
19026     * slideshow widget
19027     *
19028     * @param obj The slideshow object
19029     * @param transition The new transition's name string
19030     *
19031     * If @p transition is implemented in @p obj's theme (i.e., is
19032     * contained in the list returned by
19033     * elm_slideshow_transitions_get()), this new sliding effect will
19034     * be used on the widget.
19035     *
19036     * @see elm_slideshow_transitions_get() for more details
19037     *
19038     * @ingroup Slideshow
19039     */
19040    EAPI void                elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
19041
19042    /**
19043     * Get the current slide transition/effect in use for a given
19044     * slideshow widget
19045     *
19046     * @param obj The slideshow object
19047     * @return The current transition's name
19048     *
19049     * @see elm_slideshow_transition_set() for more details
19050     *
19051     * @ingroup Slideshow
19052     */
19053    EAPI const char         *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19054
19055    /**
19056     * Set the interval between each image transition on a given
19057     * slideshow widget, <b>and start the slideshow, itself</b>
19058     *
19059     * @param obj The slideshow object
19060     * @param timeout The new displaying timeout for images
19061     *
19062     * After this call, the slideshow widget will start cycling its
19063     * view, sequentially and automatically, with the images of the
19064     * items it has. The time between each new image displayed is going
19065     * to be @p timeout, in @b seconds. If a different timeout was set
19066     * previously and an slideshow was in progress, it will continue
19067     * with the new time between transitions, after this call.
19068     *
19069     * @note A value less than or equal to 0 on @p timeout will disable
19070     * the widget's internal timer, thus halting any slideshow which
19071     * could be happening on @p obj.
19072     *
19073     * @see elm_slideshow_timeout_get()
19074     *
19075     * @ingroup Slideshow
19076     */
19077    EAPI void                elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
19078
19079    /**
19080     * Get the interval set for image transitions on a given slideshow
19081     * widget.
19082     *
19083     * @param obj The slideshow object
19084     * @return Returns the timeout set on it
19085     *
19086     * @see elm_slideshow_timeout_set() for more details
19087     *
19088     * @ingroup Slideshow
19089     */
19090    EAPI double              elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19091
19092    /**
19093     * Set if, after a slideshow is started, for a given slideshow
19094     * widget, its items should be displayed cyclically or not.
19095     *
19096     * @param obj The slideshow object
19097     * @param loop Use @c EINA_TRUE to make it cycle through items or
19098     * @c EINA_FALSE for it to stop at the end of @p obj's internal
19099     * list of items
19100     *
19101     * @note elm_slideshow_next() and elm_slideshow_previous() will @b
19102     * ignore what is set by this functions, i.e., they'll @b always
19103     * cycle through items. This affects only the "automatic"
19104     * slideshow, as set by elm_slideshow_timeout_set().
19105     *
19106     * @see elm_slideshow_loop_get()
19107     *
19108     * @ingroup Slideshow
19109     */
19110    EAPI void                elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
19111
19112    /**
19113     * Get if, after a slideshow is started, for a given slideshow
19114     * widget, its items are to be displayed cyclically or not.
19115     *
19116     * @param obj The slideshow object
19117     * @return @c EINA_TRUE, if the items in @p obj will be cycled
19118     * through or @c EINA_FALSE, otherwise
19119     *
19120     * @see elm_slideshow_loop_set() for more details
19121     *
19122     * @ingroup Slideshow
19123     */
19124    EAPI Eina_Bool           elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19125
19126    /**
19127     * Remove all items from a given slideshow widget
19128     *
19129     * @param obj The slideshow object
19130     *
19131     * This removes (and deletes) all items in @p obj, leaving it
19132     * empty.
19133     *
19134     * @see elm_slideshow_item_del(), to remove just one item.
19135     *
19136     * @ingroup Slideshow
19137     */
19138    EAPI void                elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
19139
19140    /**
19141     * Get the internal list of items in a given slideshow widget.
19142     *
19143     * @param obj The slideshow object
19144     * @return The list of items (#Elm_Slideshow_Item as data) or
19145     * @c NULL on errors.
19146     *
19147     * This list is @b not to be modified in any way and must not be
19148     * freed. Use the list members with functions like
19149     * elm_slideshow_item_del(), elm_slideshow_item_data_get().
19150     *
19151     * @warning This list is only valid until @p obj object's internal
19152     * items list is changed. It should be fetched again with another
19153     * call to this function when changes happen.
19154     *
19155     * @ingroup Slideshow
19156     */
19157    EAPI const Eina_List    *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19158
19159    /**
19160     * Delete a given item from a slideshow widget.
19161     *
19162     * @param item The slideshow item
19163     *
19164     * @ingroup Slideshow
19165     */
19166    EAPI void                elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
19167
19168    /**
19169     * Return the data associated with a given slideshow item
19170     *
19171     * @param item The slideshow item
19172     * @return Returns the data associated to this item
19173     *
19174     * @ingroup Slideshow
19175     */
19176    EAPI void               *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
19177
19178    /**
19179     * Returns the currently displayed item, in a given slideshow widget
19180     *
19181     * @param obj The slideshow object
19182     * @return A handle to the item being displayed in @p obj or
19183     * @c NULL, if none is (and on errors)
19184     *
19185     * @ingroup Slideshow
19186     */
19187    EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19188
19189    /**
19190     * Get the real Evas object created to implement the view of a
19191     * given slideshow item
19192     *
19193     * @param item The slideshow item.
19194     * @return the Evas object implementing this item's view.
19195     *
19196     * This returns the actual Evas object used to implement the
19197     * specified slideshow item's view. This may be @c NULL, as it may
19198     * not have been created or may have been deleted, at any time, by
19199     * the slideshow. <b>Do not modify this object</b> (move, resize,
19200     * show, hide, etc.), as the slideshow is controlling it. This
19201     * function is for querying, emitting custom signals or hooking
19202     * lower level callbacks for events on that object. Do not delete
19203     * this object under any circumstances.
19204     *
19205     * @see elm_slideshow_item_data_get()
19206     *
19207     * @ingroup Slideshow
19208     */
19209    EAPI Evas_Object*        elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
19210
19211    /**
19212     * Get the the item, in a given slideshow widget, placed at
19213     * position @p nth, in its internal items list
19214     *
19215     * @param obj The slideshow object
19216     * @param nth The number of the item to grab a handle to (0 being
19217     * the first)
19218     * @return The item stored in @p obj at position @p nth or @c NULL,
19219     * if there's no item with that index (and on errors)
19220     *
19221     * @ingroup Slideshow
19222     */
19223    EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
19224
19225    /**
19226     * Set the current slide layout in use for a given slideshow widget
19227     *
19228     * @param obj The slideshow object
19229     * @param layout The new layout's name string
19230     *
19231     * If @p layout is implemented in @p obj's theme (i.e., is contained
19232     * in the list returned by elm_slideshow_layouts_get()), this new
19233     * images layout will be used on the widget.
19234     *
19235     * @see elm_slideshow_layouts_get() for more details
19236     *
19237     * @ingroup Slideshow
19238     */
19239    EAPI void                elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
19240
19241    /**
19242     * Get the current slide layout in use for a given slideshow widget
19243     *
19244     * @param obj The slideshow object
19245     * @return The current layout's name
19246     *
19247     * @see elm_slideshow_layout_set() for more details
19248     *
19249     * @ingroup Slideshow
19250     */
19251    EAPI const char         *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19252
19253    /**
19254     * Returns the list of @b layout names available, for a given
19255     * slideshow widget.
19256     *
19257     * @param obj The slideshow object
19258     * @return The list of layouts (list of @b stringshared strings
19259     * as data)
19260     *
19261     * Slideshow layouts will change how the widget is to dispose each
19262     * image item in its viewport, with regard to cropping, scaling,
19263     * etc.
19264     *
19265     * The layouts, which come from @p obj's theme, must be an EDC
19266     * data item name @c "layouts" on the theme file, with (prefix)
19267     * names of EDC programs actually implementing them.
19268     *
19269     * The available layouts for slideshows on the default theme are:
19270     * - @c "fullscreen" - item images with original aspect, scaled to
19271     *   touch top and down slideshow borders or, if the image's heigh
19272     *   is not enough, left and right slideshow borders.
19273     * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
19274     *   one, but always leaving 10% of the slideshow's dimensions of
19275     *   distance between the item image's borders and the slideshow
19276     *   borders, for each axis.
19277     *
19278     * @warning The stringshared strings get no new references
19279     * exclusive to the user grabbing the list, here, so if you'd like
19280     * to use them out of this call's context, you'd better @c
19281     * eina_stringshare_ref() them.
19282     *
19283     * @see elm_slideshow_layout_set()
19284     *
19285     * @ingroup Slideshow
19286     */
19287    EAPI const Eina_List    *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19288
19289    /**
19290     * Set the number of items to cache, on a given slideshow widget,
19291     * <b>before the current item</b>
19292     *
19293     * @param obj The slideshow object
19294     * @param count Number of items to cache before the current one
19295     *
19296     * The default value for this property is @c 2. See
19297     * @ref Slideshow_Caching "slideshow caching" for more details.
19298     *
19299     * @see elm_slideshow_cache_before_get()
19300     *
19301     * @ingroup Slideshow
19302     */
19303    EAPI void                elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
19304
19305    /**
19306     * Retrieve the number of items to cache, on a given slideshow widget,
19307     * <b>before the current item</b>
19308     *
19309     * @param obj The slideshow object
19310     * @return The number of items set to be cached before the current one
19311     *
19312     * @see elm_slideshow_cache_before_set() for more details
19313     *
19314     * @ingroup Slideshow
19315     */
19316    EAPI int                 elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19317
19318    /**
19319     * Set the number of items to cache, on a given slideshow widget,
19320     * <b>after the current item</b>
19321     *
19322     * @param obj The slideshow object
19323     * @param count Number of items to cache after the current one
19324     *
19325     * The default value for this property is @c 2. See
19326     * @ref Slideshow_Caching "slideshow caching" for more details.
19327     *
19328     * @see elm_slideshow_cache_after_get()
19329     *
19330     * @ingroup Slideshow
19331     */
19332    EAPI void                elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
19333
19334    /**
19335     * Retrieve the number of items to cache, on a given slideshow widget,
19336     * <b>after the current item</b>
19337     *
19338     * @param obj The slideshow object
19339     * @return The number of items set to be cached after the current one
19340     *
19341     * @see elm_slideshow_cache_after_set() for more details
19342     *
19343     * @ingroup Slideshow
19344     */
19345    EAPI int                 elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19346
19347    /**
19348     * Get the number of items stored in a given slideshow widget
19349     *
19350     * @param obj The slideshow object
19351     * @return The number of items on @p obj, at the moment of this call
19352     *
19353     * @ingroup Slideshow
19354     */
19355    EAPI unsigned int        elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19356
19357    /**
19358     * @}
19359     */
19360
19361    /**
19362     * @defgroup Fileselector File Selector
19363     *
19364     * @image html img/widget/fileselector/preview-00.png
19365     * @image latex img/widget/fileselector/preview-00.eps
19366     *
19367     * A file selector is a widget that allows a user to navigate
19368     * through a file system, reporting file selections back via its
19369     * API.
19370     *
19371     * It contains shortcut buttons for home directory (@c ~) and to
19372     * jump one directory upwards (..), as well as cancel/ok buttons to
19373     * confirm/cancel a given selection. After either one of those two
19374     * former actions, the file selector will issue its @c "done" smart
19375     * callback.
19376     *
19377     * There's a text entry on it, too, showing the name of the current
19378     * selection. There's the possibility of making it editable, so it
19379     * is useful on file saving dialogs on applications, where one
19380     * gives a file name to save contents to, in a given directory in
19381     * the system. This custom file name will be reported on the @c
19382     * "done" smart callback (explained in sequence).
19383     *
19384     * Finally, it has a view to display file system items into in two
19385     * possible forms:
19386     * - list
19387     * - grid
19388     *
19389     * If Elementary is built with support of the Ethumb thumbnailing
19390     * library, the second form of view will display preview thumbnails
19391     * of files which it supports.
19392     *
19393     * Smart callbacks one can register to:
19394     *
19395     * - @c "selected" - the user has clicked on a file (when not in
19396     *      folders-only mode) or directory (when in folders-only mode)
19397     * - @c "directory,open" - the list has been populated with new
19398     *      content (@c event_info is a pointer to the directory's
19399     *      path, a @b stringshared string)
19400     * - @c "done" - the user has clicked on the "ok" or "cancel"
19401     *      buttons (@c event_info is a pointer to the selection's
19402     *      path, a @b stringshared string)
19403     *
19404     * Here is an example on its usage:
19405     * @li @ref fileselector_example
19406     */
19407
19408    /**
19409     * @addtogroup Fileselector
19410     * @{
19411     */
19412
19413    /**
19414     * Defines how a file selector widget is to layout its contents
19415     * (file system entries).
19416     */
19417    typedef enum _Elm_Fileselector_Mode
19418      {
19419         ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
19420         ELM_FILESELECTOR_GRID, /**< layout as a grid */
19421         ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
19422      } Elm_Fileselector_Mode;
19423
19424    /**
19425     * Add a new file selector widget to the given parent Elementary
19426     * (container) object
19427     *
19428     * @param parent The parent object
19429     * @return a new file selector widget handle or @c NULL, on errors
19430     *
19431     * This function inserts a new file selector widget on the canvas.
19432     *
19433     * @ingroup Fileselector
19434     */
19435    EAPI Evas_Object          *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19436
19437    /**
19438     * Enable/disable the file name entry box where the user can type
19439     * in a name for a file, in a given file selector widget
19440     *
19441     * @param obj The file selector object
19442     * @param is_save @c EINA_TRUE to make the file selector a "saving
19443     * dialog", @c EINA_FALSE otherwise
19444     *
19445     * Having the entry editable is useful on file saving dialogs on
19446     * applications, where one gives a file name to save contents to,
19447     * in a given directory in the system. This custom file name will
19448     * be reported on the @c "done" smart callback.
19449     *
19450     * @see elm_fileselector_is_save_get()
19451     *
19452     * @ingroup Fileselector
19453     */
19454    EAPI void                  elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
19455
19456    /**
19457     * Get whether the given file selector is in "saving dialog" mode
19458     *
19459     * @param obj The file selector object
19460     * @return @c EINA_TRUE, if the file selector is in "saving dialog"
19461     * mode, @c EINA_FALSE otherwise (and on errors)
19462     *
19463     * @see elm_fileselector_is_save_set() for more details
19464     *
19465     * @ingroup Fileselector
19466     */
19467    EAPI Eina_Bool             elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19468
19469    /**
19470     * Enable/disable folder-only view for a given file selector widget
19471     *
19472     * @param obj The file selector object
19473     * @param only @c EINA_TRUE to make @p obj only display
19474     * directories, @c EINA_FALSE to make files to be displayed in it
19475     * too
19476     *
19477     * If enabled, the widget's view will only display folder items,
19478     * naturally.
19479     *
19480     * @see elm_fileselector_folder_only_get()
19481     *
19482     * @ingroup Fileselector
19483     */
19484    EAPI void                  elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
19485
19486    /**
19487     * Get whether folder-only view is set for a given file selector
19488     * widget
19489     *
19490     * @param obj The file selector object
19491     * @return only @c EINA_TRUE if @p obj is only displaying
19492     * directories, @c EINA_FALSE if files are being displayed in it
19493     * too (and on errors)
19494     *
19495     * @see elm_fileselector_folder_only_get()
19496     *
19497     * @ingroup Fileselector
19498     */
19499    EAPI Eina_Bool             elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19500
19501    /**
19502     * Enable/disable the "ok" and "cancel" buttons on a given file
19503     * selector widget
19504     *
19505     * @param obj The file selector object
19506     * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
19507     *
19508     * @note A file selector without those buttons will never emit the
19509     * @c "done" smart event, and is only usable if one is just hooking
19510     * to the other two events.
19511     *
19512     * @see elm_fileselector_buttons_ok_cancel_get()
19513     *
19514     * @ingroup Fileselector
19515     */
19516    EAPI void                  elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
19517
19518    /**
19519     * Get whether the "ok" and "cancel" buttons on a given file
19520     * selector widget are being shown.
19521     *
19522     * @param obj The file selector object
19523     * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
19524     * otherwise (and on errors)
19525     *
19526     * @see elm_fileselector_buttons_ok_cancel_set() for more details
19527     *
19528     * @ingroup Fileselector
19529     */
19530    EAPI Eina_Bool             elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19531
19532    /**
19533     * Enable/disable a tree view in the given file selector widget,
19534     * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
19535     *
19536     * @param obj The file selector object
19537     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
19538     * disable
19539     *
19540     * In a tree view, arrows are created on the sides of directories,
19541     * allowing them to expand in place.
19542     *
19543     * @note If it's in other mode, the changes made by this function
19544     * will only be visible when one switches back to "list" mode.
19545     *
19546     * @see elm_fileselector_expandable_get()
19547     *
19548     * @ingroup Fileselector
19549     */
19550    EAPI void                  elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
19551
19552    /**
19553     * Get whether tree view is enabled for the given file selector
19554     * widget
19555     *
19556     * @param obj The file selector object
19557     * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
19558     * otherwise (and or errors)
19559     *
19560     * @see elm_fileselector_expandable_set() for more details
19561     *
19562     * @ingroup Fileselector
19563     */
19564    EAPI Eina_Bool             elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19565
19566    /**
19567     * Set, programmatically, the @b directory that a given file
19568     * selector widget will display contents from
19569     *
19570     * @param obj The file selector object
19571     * @param path The path to display in @p obj
19572     *
19573     * This will change the @b directory that @p obj is displaying. It
19574     * will also clear the text entry area on the @p obj object, which
19575     * displays select files' names.
19576     *
19577     * @see elm_fileselector_path_get()
19578     *
19579     * @ingroup Fileselector
19580     */
19581    EAPI void                  elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
19582
19583    /**
19584     * Get the parent directory's path that a given file selector
19585     * widget is displaying
19586     *
19587     * @param obj The file selector object
19588     * @return The (full) path of the directory the file selector is
19589     * displaying, a @b stringshared string
19590     *
19591     * @see elm_fileselector_path_set()
19592     *
19593     * @ingroup Fileselector
19594     */
19595    EAPI const char           *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19596
19597    /**
19598     * Set, programmatically, the currently selected file/directory in
19599     * the given file selector widget
19600     *
19601     * @param obj The file selector object
19602     * @param path The (full) path to a file or directory
19603     * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
19604     * latter case occurs if the directory or file pointed to do not
19605     * exist.
19606     *
19607     * @see elm_fileselector_selected_get()
19608     *
19609     * @ingroup Fileselector
19610     */
19611    EAPI Eina_Bool             elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
19612
19613    /**
19614     * Get the currently selected item's (full) path, in the given file
19615     * selector widget
19616     *
19617     * @param obj The file selector object
19618     * @return The absolute path of the selected item, a @b
19619     * stringshared string
19620     *
19621     * @note Custom editions on @p obj object's text entry, if made,
19622     * will appear on the return string of this function, naturally.
19623     *
19624     * @see elm_fileselector_selected_set() for more details
19625     *
19626     * @ingroup Fileselector
19627     */
19628    EAPI const char           *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19629
19630    /**
19631     * Set the mode in which a given file selector widget will display
19632     * (layout) file system entries in its view
19633     *
19634     * @param obj The file selector object
19635     * @param mode The mode of the fileselector, being it one of
19636     * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
19637     * first one, naturally, will display the files in a list. The
19638     * latter will make the widget to display its entries in a grid
19639     * form.
19640     *
19641     * @note By using elm_fileselector_expandable_set(), the user may
19642     * trigger a tree view for that list.
19643     *
19644     * @note If Elementary is built with support of the Ethumb
19645     * thumbnailing library, the second form of view will display
19646     * preview thumbnails of files which it supports. You must have
19647     * elm_need_ethumb() called in your Elementary for thumbnailing to
19648     * work, though.
19649     *
19650     * @see elm_fileselector_expandable_set().
19651     * @see elm_fileselector_mode_get().
19652     *
19653     * @ingroup Fileselector
19654     */
19655    EAPI void                  elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
19656
19657    /**
19658     * Get the mode in which a given file selector widget is displaying
19659     * (layouting) file system entries in its view
19660     *
19661     * @param obj The fileselector object
19662     * @return The mode in which the fileselector is at
19663     *
19664     * @see elm_fileselector_mode_set() for more details
19665     *
19666     * @ingroup Fileselector
19667     */
19668    EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19669
19670    /**
19671     * @}
19672     */
19673
19674    /**
19675     * @defgroup Progressbar Progress bar
19676     *
19677     * The progress bar is a widget for visually representing the
19678     * progress status of a given job/task.
19679     *
19680     * A progress bar may be horizontal or vertical. It may display an
19681     * icon besides it, as well as primary and @b units labels. The
19682     * former is meant to label the widget as a whole, while the
19683     * latter, which is formatted with floating point values (and thus
19684     * accepts a <c>printf</c>-style format string, like <c>"%1.2f
19685     * units"</c>), is meant to label the widget's <b>progress
19686     * value</b>. Label, icon and unit strings/objects are @b optional
19687     * for progress bars.
19688     *
19689     * A progress bar may be @b inverted, in which state it gets its
19690     * values inverted, with high values being on the left or top and
19691     * low values on the right or bottom, as opposed to normally have
19692     * the low values on the former and high values on the latter,
19693     * respectively, for horizontal and vertical modes.
19694     *
19695     * The @b span of the progress, as set by
19696     * elm_progressbar_span_size_set(), is its length (horizontally or
19697     * vertically), unless one puts size hints on the widget to expand
19698     * on desired directions, by any container. That length will be
19699     * scaled by the object or applications scaling factor. At any
19700     * point code can query the progress bar for its value with
19701     * elm_progressbar_value_get().
19702     *
19703     * Available widget styles for progress bars:
19704     * - @c "default"
19705     * - @c "wheel" (simple style, no text, no progression, only
19706     *      "pulse" effect is available)
19707     *
19708     * Here is an example on its usage:
19709     * @li @ref progressbar_example
19710     */
19711
19712    /**
19713     * Add a new progress bar widget to the given parent Elementary
19714     * (container) object
19715     *
19716     * @param parent The parent object
19717     * @return a new progress bar widget handle or @c NULL, on errors
19718     *
19719     * This function inserts a new progress bar widget on the canvas.
19720     *
19721     * @ingroup Progressbar
19722     */
19723    EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19724
19725    /**
19726     * Set whether a given progress bar widget is at "pulsing mode" or
19727     * not.
19728     *
19729     * @param obj The progress bar object
19730     * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
19731     * @c EINA_FALSE to put it back to its default one
19732     *
19733     * By default, progress bars will display values from the low to
19734     * high value boundaries. There are, though, contexts in which the
19735     * state of progression of a given task is @b unknown.  For those,
19736     * one can set a progress bar widget to a "pulsing state", to give
19737     * the user an idea that some computation is being held, but
19738     * without exact progress values. In the default theme it will
19739     * animate its bar with the contents filling in constantly and back
19740     * to non-filled, in a loop. To start and stop this pulsing
19741     * animation, one has to explicitly call elm_progressbar_pulse().
19742     *
19743     * @see elm_progressbar_pulse_get()
19744     * @see elm_progressbar_pulse()
19745     *
19746     * @ingroup Progressbar
19747     */
19748    EAPI void         elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
19749
19750    /**
19751     * Get whether a given progress bar widget is at "pulsing mode" or
19752     * not.
19753     *
19754     * @param obj The progress bar object
19755     * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
19756     * if it's in the default one (and on errors)
19757     *
19758     * @ingroup Progressbar
19759     */
19760    EAPI Eina_Bool    elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19761
19762    /**
19763     * Start/stop a given progress bar "pulsing" animation, if its
19764     * under that mode
19765     *
19766     * @param obj The progress bar object
19767     * @param state @c EINA_TRUE, to @b start the pulsing animation,
19768     * @c EINA_FALSE to @b stop it
19769     *
19770     * @note This call won't do anything if @p obj is not under "pulsing mode".
19771     *
19772     * @see elm_progressbar_pulse_set() for more details.
19773     *
19774     * @ingroup Progressbar
19775     */
19776    EAPI void         elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19777
19778    /**
19779     * Set the progress value (in percentage) on a given progress bar
19780     * widget
19781     *
19782     * @param obj The progress bar object
19783     * @param val The progress value (@b must be between @c 0.0 and @c
19784     * 1.0)
19785     *
19786     * Use this call to set progress bar levels.
19787     *
19788     * @note If you passes a value out of the specified range for @p
19789     * val, it will be interpreted as the @b closest of the @b boundary
19790     * values in the range.
19791     *
19792     * @ingroup Progressbar
19793     */
19794    EAPI void         elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
19795
19796    /**
19797     * Get the progress value (in percentage) on a given progress bar
19798     * widget
19799     *
19800     * @param obj The progress bar object
19801     * @return The value of the progressbar
19802     *
19803     * @see elm_progressbar_value_set() for more details
19804     *
19805     * @ingroup Progressbar
19806     */
19807    EAPI double       elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19808
19809    /**
19810     * Set the label of a given progress bar widget
19811     *
19812     * @param obj The progress bar object
19813     * @param label The text label string, in UTF-8
19814     *
19815     * @ingroup Progressbar
19816     * @deprecated use elm_object_text_set() instead.
19817     */
19818    EINA_DEPRECATED EAPI void         elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19819
19820    /**
19821     * Get the label of a given progress bar widget
19822     *
19823     * @param obj The progressbar object
19824     * @return The text label string, in UTF-8
19825     *
19826     * @ingroup Progressbar
19827     * @deprecated use elm_object_text_set() instead.
19828     */
19829    EINA_DEPRECATED EAPI const char  *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19830
19831    /**
19832     * Set the icon object of a given progress bar widget
19833     *
19834     * @param obj The progress bar object
19835     * @param icon The icon object
19836     *
19837     * Use this call to decorate @p obj with an icon next to it.
19838     *
19839     * @note Once the icon object is set, a previously set one will be
19840     * deleted. If you want to keep that old content object, use the
19841     * elm_progressbar_icon_unset() function.
19842     *
19843     * @see elm_progressbar_icon_get()
19844     *
19845     * @ingroup Progressbar
19846     */
19847    EAPI void         elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19848
19849    /**
19850     * Retrieve the icon object set for a given progress bar widget
19851     *
19852     * @param obj The progress bar object
19853     * @return The icon object's handle, if @p obj had one set, or @c NULL,
19854     * otherwise (and on errors)
19855     *
19856     * @see elm_progressbar_icon_set() for more details
19857     *
19858     * @ingroup Progressbar
19859     */
19860    EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19861
19862    /**
19863     * Unset an icon set on a given progress bar widget
19864     *
19865     * @param obj The progress bar object
19866     * @return The icon object that was being used, if any was set, or
19867     * @c NULL, otherwise (and on errors)
19868     *
19869     * This call will unparent and return the icon object which was set
19870     * for this widget, previously, on success.
19871     *
19872     * @see elm_progressbar_icon_set() for more details
19873     *
19874     * @ingroup Progressbar
19875     */
19876    EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19877
19878    /**
19879     * Set the (exact) length of the bar region of a given progress bar
19880     * widget
19881     *
19882     * @param obj The progress bar object
19883     * @param size The length of the progress bar's bar region
19884     *
19885     * This sets the minimum width (when in horizontal mode) or height
19886     * (when in vertical mode) of the actual bar area of the progress
19887     * bar @p obj. This in turn affects the object's minimum size. Use
19888     * this when you're not setting other size hints expanding on the
19889     * given direction (like weight and alignment hints) and you would
19890     * like it to have a specific size.
19891     *
19892     * @note Icon, label and unit text around @p obj will require their
19893     * own space, which will make @p obj to require more the @p size,
19894     * actually.
19895     *
19896     * @see elm_progressbar_span_size_get()
19897     *
19898     * @ingroup Progressbar
19899     */
19900    EAPI void         elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
19901
19902    /**
19903     * Get the length set for the bar region of a given progress bar
19904     * widget
19905     *
19906     * @param obj The progress bar object
19907     * @return The length of the progress bar's bar region
19908     *
19909     * If that size was not set previously, with
19910     * elm_progressbar_span_size_set(), this call will return @c 0.
19911     *
19912     * @ingroup Progressbar
19913     */
19914    EAPI Evas_Coord   elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19915
19916    /**
19917     * Set the format string for a given progress bar widget's units
19918     * label
19919     *
19920     * @param obj The progress bar object
19921     * @param format The format string for @p obj's units label
19922     *
19923     * If @c NULL is passed on @p format, it will make @p obj's units
19924     * area to be hidden completely. If not, it'll set the <b>format
19925     * string</b> for the units label's @b text. The units label is
19926     * provided a floating point value, so the units text is up display
19927     * at most one floating point falue. Note that the units label is
19928     * optional. Use a format string such as "%1.2f meters" for
19929     * example.
19930     *
19931     * @note The default format string for a progress bar is an integer
19932     * percentage, as in @c "%.0f %%".
19933     *
19934     * @see elm_progressbar_unit_format_get()
19935     *
19936     * @ingroup Progressbar
19937     */
19938    EAPI void         elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
19939
19940    /**
19941     * Retrieve the format string set for a given progress bar widget's
19942     * units label
19943     *
19944     * @param obj The progress bar object
19945     * @return The format set string for @p obj's units label or
19946     * @c NULL, if none was set (and on errors)
19947     *
19948     * @see elm_progressbar_unit_format_set() for more details
19949     *
19950     * @ingroup Progressbar
19951     */
19952    EAPI const char  *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19953
19954    /**
19955     * Set the orientation of a given progress bar widget
19956     *
19957     * @param obj The progress bar object
19958     * @param horizontal Use @c EINA_TRUE to make @p obj to be
19959     * @b horizontal, @c EINA_FALSE to make it @b vertical
19960     *
19961     * Use this function to change how your progress bar is to be
19962     * disposed: vertically or horizontally.
19963     *
19964     * @see elm_progressbar_horizontal_get()
19965     *
19966     * @ingroup Progressbar
19967     */
19968    EAPI void         elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
19969
19970    /**
19971     * Retrieve the orientation of a given progress bar widget
19972     *
19973     * @param obj The progress bar object
19974     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
19975     * @c EINA_FALSE if it's @b vertical (and on errors)
19976     *
19977     * @see elm_progressbar_horizontal_set() for more details
19978     *
19979     * @ingroup Progressbar
19980     */
19981    EAPI Eina_Bool    elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19982
19983    /**
19984     * Invert a given progress bar widget's displaying values order
19985     *
19986     * @param obj The progress bar object
19987     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
19988     * @c EINA_FALSE to bring it back to default, non-inverted values.
19989     *
19990     * A progress bar may be @b inverted, in which state it gets its
19991     * values inverted, with high values being on the left or top and
19992     * low values on the right or bottom, as opposed to normally have
19993     * the low values on the former and high values on the latter,
19994     * respectively, for horizontal and vertical modes.
19995     *
19996     * @see elm_progressbar_inverted_get()
19997     *
19998     * @ingroup Progressbar
19999     */
20000    EAPI void         elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
20001
20002    /**
20003     * Get whether a given progress bar widget's displaying values are
20004     * inverted or not
20005     *
20006     * @param obj The progress bar object
20007     * @return @c EINA_TRUE, if @p obj has inverted values,
20008     * @c EINA_FALSE otherwise (and on errors)
20009     *
20010     * @see elm_progressbar_inverted_set() for more details
20011     *
20012     * @ingroup Progressbar
20013     */
20014    EAPI Eina_Bool    elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20015
20016    /**
20017     * @defgroup Separator Separator
20018     *
20019     * @brief Separator is a very thin object used to separate other objects.
20020     *
20021     * A separator can be vertical or horizontal.
20022     *
20023     * @ref tutorial_separator is a good example of how to use a separator.
20024     * @{
20025     */
20026    /**
20027     * @brief Add a separator object to @p parent
20028     *
20029     * @param parent The parent object
20030     *
20031     * @return The separator object, or NULL upon failure
20032     */
20033    EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20034    /**
20035     * @brief Set the horizontal mode of a separator object
20036     *
20037     * @param obj The separator object
20038     * @param horizontal If true, the separator is horizontal
20039     */
20040    EAPI void         elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
20041    /**
20042     * @brief Get the horizontal mode of a separator object
20043     *
20044     * @param obj The separator object
20045     * @return If true, the separator is horizontal
20046     *
20047     * @see elm_separator_horizontal_set()
20048     */
20049    EAPI Eina_Bool    elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20050    /**
20051     * @}
20052     */
20053
20054    /**
20055     * @defgroup Spinner Spinner
20056     * @ingroup Elementary
20057     *
20058     * @image html img/widget/spinner/preview-00.png
20059     * @image latex img/widget/spinner/preview-00.eps
20060     *
20061     * A spinner is a widget which allows the user to increase or decrease
20062     * numeric values using arrow buttons, or edit values directly, clicking
20063     * over it and typing the new value.
20064     *
20065     * By default the spinner will not wrap and has a label
20066     * of "%.0f" (just showing the integer value of the double).
20067     *
20068     * A spinner has a label that is formatted with floating
20069     * point values and thus accepts a printf-style format string, like
20070     * “%1.2f units”.
20071     *
20072     * It also allows specific values to be replaced by pre-defined labels.
20073     *
20074     * Smart callbacks one can register to:
20075     *
20076     * - "changed" - Whenever the spinner value is changed.
20077     * - "delay,changed" - A short time after the value is changed by the user.
20078     *    This will be called only when the user stops dragging for a very short
20079     *    period or when they release their finger/mouse, so it avoids possibly
20080     *    expensive reactions to the value change.
20081     *
20082     * Available styles for it:
20083     * - @c "default";
20084     * - @c "vertical": up/down buttons at the right side and text left aligned.
20085     *
20086     * Here is an example on its usage:
20087     * @ref spinner_example
20088     */
20089
20090    /**
20091     * @addtogroup Spinner
20092     * @{
20093     */
20094
20095    /**
20096     * Add a new spinner widget to the given parent Elementary
20097     * (container) object.
20098     *
20099     * @param parent The parent object.
20100     * @return a new spinner widget handle or @c NULL, on errors.
20101     *
20102     * This function inserts a new spinner widget on the canvas.
20103     *
20104     * @ingroup Spinner
20105     *
20106     */
20107    EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20108
20109    /**
20110     * Set the format string of the displayed label.
20111     *
20112     * @param obj The spinner object.
20113     * @param fmt The format string for the label display.
20114     *
20115     * If @c NULL, this sets the format to "%.0f". If not it sets the format
20116     * string for the label text. The label text is provided a floating point
20117     * value, so the label text can display up to 1 floating point value.
20118     * Note that this is optional.
20119     *
20120     * Use a format string such as "%1.2f meters" for example, and it will
20121     * display values like: "3.14 meters" for a value equal to 3.14159.
20122     *
20123     * Default is "%0.f".
20124     *
20125     * @see elm_spinner_label_format_get()
20126     *
20127     * @ingroup Spinner
20128     */
20129    EAPI void         elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
20130
20131    /**
20132     * Get the label format of the spinner.
20133     *
20134     * @param obj The spinner object.
20135     * @return The text label format string in UTF-8.
20136     *
20137     * @see elm_spinner_label_format_set() for details.
20138     *
20139     * @ingroup Spinner
20140     */
20141    EAPI const char  *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20142
20143    /**
20144     * Set the minimum and maximum values for the spinner.
20145     *
20146     * @param obj The spinner object.
20147     * @param min The minimum value.
20148     * @param max The maximum value.
20149     *
20150     * Define the allowed range of values to be selected by the user.
20151     *
20152     * If actual value is less than @p min, it will be updated to @p min. If it
20153     * is bigger then @p max, will be updated to @p max. Actual value can be
20154     * get with elm_spinner_value_get().
20155     *
20156     * By default, min is equal to 0, and max is equal to 100.
20157     *
20158     * @warning Maximum must be greater than minimum.
20159     *
20160     * @see elm_spinner_min_max_get()
20161     *
20162     * @ingroup Spinner
20163     */
20164    EAPI void         elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
20165
20166    /**
20167     * Get the minimum and maximum values of the spinner.
20168     *
20169     * @param obj The spinner object.
20170     * @param min Pointer where to store the minimum value.
20171     * @param max Pointer where to store the maximum value.
20172     *
20173     * @note If only one value is needed, the other pointer can be passed
20174     * as @c NULL.
20175     *
20176     * @see elm_spinner_min_max_set() for details.
20177     *
20178     * @ingroup Spinner
20179     */
20180    EAPI void         elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
20181
20182    /**
20183     * Set the step used to increment or decrement the spinner value.
20184     *
20185     * @param obj The spinner object.
20186     * @param step The step value.
20187     *
20188     * This value will be incremented or decremented to the displayed value.
20189     * It will be incremented while the user keep right or top arrow pressed,
20190     * and will be decremented while the user keep left or bottom arrow pressed.
20191     *
20192     * The interval to increment / decrement can be set with
20193     * elm_spinner_interval_set().
20194     *
20195     * By default step value is equal to 1.
20196     *
20197     * @see elm_spinner_step_get()
20198     *
20199     * @ingroup Spinner
20200     */
20201    EAPI void         elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
20202
20203    /**
20204     * Get the step used to increment or decrement the spinner value.
20205     *
20206     * @param obj The spinner object.
20207     * @return The step value.
20208     *
20209     * @see elm_spinner_step_get() for more details.
20210     *
20211     * @ingroup Spinner
20212     */
20213    EAPI double       elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20214
20215    /**
20216     * Set the value the spinner displays.
20217     *
20218     * @param obj The spinner object.
20219     * @param val The value to be displayed.
20220     *
20221     * Value will be presented on the label following format specified with
20222     * elm_spinner_format_set().
20223     *
20224     * @warning The value must to be between min and max values. This values
20225     * are set by elm_spinner_min_max_set().
20226     *
20227     * @see elm_spinner_value_get().
20228     * @see elm_spinner_format_set().
20229     * @see elm_spinner_min_max_set().
20230     *
20231     * @ingroup Spinner
20232     */
20233    EAPI void         elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
20234
20235    /**
20236     * Get the value displayed by the spinner.
20237     *
20238     * @param obj The spinner object.
20239     * @return The value displayed.
20240     *
20241     * @see elm_spinner_value_set() for details.
20242     *
20243     * @ingroup Spinner
20244     */
20245    EAPI double       elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20246
20247    /**
20248     * Set whether the spinner should wrap when it reaches its
20249     * minimum or maximum value.
20250     *
20251     * @param obj The spinner object.
20252     * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
20253     * disable it.
20254     *
20255     * Disabled by default. If disabled, when the user tries to increment the
20256     * value,
20257     * but displayed value plus step value is bigger than maximum value,
20258     * the spinner
20259     * won't allow it. The same happens when the user tries to decrement it,
20260     * but the value less step is less than minimum value.
20261     *
20262     * When wrap is enabled, in such situations it will allow these changes,
20263     * but will get the value that would be less than minimum and subtracts
20264     * from maximum. Or add the value that would be more than maximum to
20265     * the minimum.
20266     *
20267     * E.g.:
20268     * @li min value = 10
20269     * @li max value = 50
20270     * @li step value = 20
20271     * @li displayed value = 20
20272     *
20273     * When the user decrement value (using left or bottom arrow), it will
20274     * displays @c 40, because max - (min - (displayed - step)) is
20275     * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
20276     *
20277     * @see elm_spinner_wrap_get().
20278     *
20279     * @ingroup Spinner
20280     */
20281    EAPI void         elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
20282
20283    /**
20284     * Get whether the spinner should wrap when it reaches its
20285     * minimum or maximum value.
20286     *
20287     * @param obj The spinner object
20288     * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
20289     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20290     *
20291     * @see elm_spinner_wrap_set() for details.
20292     *
20293     * @ingroup Spinner
20294     */
20295    EAPI Eina_Bool    elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20296
20297    /**
20298     * Set whether the spinner can be directly edited by the user or not.
20299     *
20300     * @param obj The spinner object.
20301     * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
20302     * don't allow users to edit it directly.
20303     *
20304     * Spinner objects can have edition @b disabled, in which state they will
20305     * be changed only by arrows.
20306     * Useful for contexts
20307     * where you don't want your users to interact with it writting the value.
20308     * Specially
20309     * when using special values, the user can see real value instead
20310     * of special label on edition.
20311     *
20312     * It's enabled by default.
20313     *
20314     * @see elm_spinner_editable_get()
20315     *
20316     * @ingroup Spinner
20317     */
20318    EAPI void         elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
20319
20320    /**
20321     * Get whether the spinner can be directly edited by the user or not.
20322     *
20323     * @param obj The spinner object.
20324     * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
20325     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20326     *
20327     * @see elm_spinner_editable_set() for details.
20328     *
20329     * @ingroup Spinner
20330     */
20331    EAPI Eina_Bool    elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20332
20333    /**
20334     * Set a special string to display in the place of the numerical value.
20335     *
20336     * @param obj The spinner object.
20337     * @param value The value to be replaced.
20338     * @param label The label to be used.
20339     *
20340     * It's useful for cases when a user should select an item that is
20341     * better indicated by a label than a value. For example, weekdays or months.
20342     *
20343     * E.g.:
20344     * @code
20345     * sp = elm_spinner_add(win);
20346     * elm_spinner_min_max_set(sp, 1, 3);
20347     * elm_spinner_special_value_add(sp, 1, "January");
20348     * elm_spinner_special_value_add(sp, 2, "February");
20349     * elm_spinner_special_value_add(sp, 3, "March");
20350     * evas_object_show(sp);
20351     * @endcode
20352     *
20353     * @ingroup Spinner
20354     */
20355    EAPI void         elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
20356
20357    /**
20358     * Set the interval on time updates for an user mouse button hold
20359     * on spinner widgets' arrows.
20360     *
20361     * @param obj The spinner object.
20362     * @param interval The (first) interval value in seconds.
20363     *
20364     * This interval value is @b decreased while the user holds the
20365     * mouse pointer either incrementing or decrementing spinner's value.
20366     *
20367     * This helps the user to get to a given value distant from the
20368     * current one easier/faster, as it will start to change quicker and
20369     * quicker on mouse button holds.
20370     *
20371     * The calculation for the next change interval value, starting from
20372     * the one set with this call, is the previous interval divided by
20373     * @c 1.05, so it decreases a little bit.
20374     *
20375     * The default starting interval value for automatic changes is
20376     * @c 0.85 seconds.
20377     *
20378     * @see elm_spinner_interval_get()
20379     *
20380     * @ingroup Spinner
20381     */
20382    EAPI void         elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
20383
20384    /**
20385     * Get the interval on time updates for an user mouse button hold
20386     * on spinner widgets' arrows.
20387     *
20388     * @param obj The spinner object.
20389     * @return The (first) interval value, in seconds, set on it.
20390     *
20391     * @see elm_spinner_interval_set() for more details.
20392     *
20393     * @ingroup Spinner
20394     */
20395    EAPI double       elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20396
20397    /**
20398     * @}
20399     */
20400
20401    /**
20402     * @defgroup Index Index
20403     *
20404     * @image html img/widget/index/preview-00.png
20405     * @image latex img/widget/index/preview-00.eps
20406     *
20407     * An index widget gives you an index for fast access to whichever
20408     * group of other UI items one might have. It's a list of text
20409     * items (usually letters, for alphabetically ordered access).
20410     *
20411     * Index widgets are by default hidden and just appear when the
20412     * user clicks over it's reserved area in the canvas. In its
20413     * default theme, it's an area one @ref Fingers "finger" wide on
20414     * the right side of the index widget's container.
20415     *
20416     * When items on the index are selected, smart callbacks get
20417     * called, so that its user can make other container objects to
20418     * show a given area or child object depending on the index item
20419     * selected. You'd probably be using an index together with @ref
20420     * List "lists", @ref Genlist "generic lists" or @ref Gengrid
20421     * "general grids".
20422     *
20423     * Smart events one  can add callbacks for are:
20424     * - @c "changed" - When the selected index item changes. @c
20425     *      event_info is the selected item's data pointer.
20426     * - @c "delay,changed" - When the selected index item changes, but
20427     *      after a small idling period. @c event_info is the selected
20428     *      item's data pointer.
20429     * - @c "selected" - When the user releases a mouse button and
20430     *      selects an item. @c event_info is the selected item's data
20431     *      pointer.
20432     * - @c "level,up" - when the user moves a finger from the first
20433     *      level to the second level
20434     * - @c "level,down" - when the user moves a finger from the second
20435     *      level to the first level
20436     *
20437     * The @c "delay,changed" event is so that it'll wait a small time
20438     * before actually reporting those events and, moreover, just the
20439     * last event happening on those time frames will actually be
20440     * reported.
20441     *
20442     * Here are some examples on its usage:
20443     * @li @ref index_example_01
20444     * @li @ref index_example_02
20445     */
20446
20447    /**
20448     * @addtogroup Index
20449     * @{
20450     */
20451
20452    typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
20453
20454    /**
20455     * Add a new index widget to the given parent Elementary
20456     * (container) object
20457     *
20458     * @param parent The parent object
20459     * @return a new index widget handle or @c NULL, on errors
20460     *
20461     * This function inserts a new index widget on the canvas.
20462     *
20463     * @ingroup Index
20464     */
20465    EAPI Evas_Object    *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20466
20467    /**
20468     * Set whether a given index widget is or not visible,
20469     * programatically.
20470     *
20471     * @param obj The index object
20472     * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
20473     *
20474     * Not to be confused with visible as in @c evas_object_show() --
20475     * visible with regard to the widget's auto hiding feature.
20476     *
20477     * @see elm_index_active_get()
20478     *
20479     * @ingroup Index
20480     */
20481    EAPI void            elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
20482
20483    /**
20484     * Get whether a given index widget is currently visible or not.
20485     *
20486     * @param obj The index object
20487     * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
20488     *
20489     * @see elm_index_active_set() for more details
20490     *
20491     * @ingroup Index
20492     */
20493    EAPI Eina_Bool       elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20494
20495    /**
20496     * Set the items level for a given index widget.
20497     *
20498     * @param obj The index object.
20499     * @param level @c 0 or @c 1, the currently implemented levels.
20500     *
20501     * @see elm_index_item_level_get()
20502     *
20503     * @ingroup Index
20504     */
20505    EAPI void            elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20506
20507    /**
20508     * Get the items level set for a given index widget.
20509     *
20510     * @param obj The index object.
20511     * @return @c 0 or @c 1, which are the levels @p obj might be at.
20512     *
20513     * @see elm_index_item_level_set() for more information
20514     *
20515     * @ingroup Index
20516     */
20517    EAPI int             elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20518
20519    /**
20520     * Returns the last selected item's data, for a given index widget.
20521     *
20522     * @param obj The index object.
20523     * @return The item @b data associated to the last selected item on
20524     * @p obj (or @c NULL, on errors).
20525     *
20526     * @warning The returned value is @b not an #Elm_Index_Item item
20527     * handle, but the data associated to it (see the @c item parameter
20528     * in elm_index_item_append(), as an example).
20529     *
20530     * @ingroup Index
20531     */
20532    EAPI void           *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20533
20534    /**
20535     * Append a new item on a given index widget.
20536     *
20537     * @param obj The index object.
20538     * @param letter Letter under which the item should be indexed
20539     * @param item The item data to set for the index's item
20540     *
20541     * Despite the most common usage of the @p letter argument is for
20542     * single char strings, one could use arbitrary strings as index
20543     * entries.
20544     *
20545     * @c item will be the pointer returned back on @c "changed", @c
20546     * "delay,changed" and @c "selected" smart events.
20547     *
20548     * @ingroup Index
20549     */
20550    EAPI void            elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
20551
20552    /**
20553     * Prepend a new item on a given index widget.
20554     *
20555     * @param obj The index object.
20556     * @param letter Letter under which the item should be indexed
20557     * @param item The item data to set for the index's item
20558     *
20559     * Despite the most common usage of the @p letter argument is for
20560     * single char strings, one could use arbitrary strings as index
20561     * entries.
20562     *
20563     * @c item will be the pointer returned back on @c "changed", @c
20564     * "delay,changed" and @c "selected" smart events.
20565     *
20566     * @ingroup Index
20567     */
20568    EAPI void            elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
20569
20570    /**
20571     * Append a new item, on a given index widget, <b>after the item
20572     * having @p relative as data</b>.
20573     *
20574     * @param obj The index object.
20575     * @param letter Letter under which the item should be indexed
20576     * @param item The item data to set for the index's item
20577     * @param relative The item data of the index item to be the
20578     * predecessor of this new one
20579     *
20580     * Despite the most common usage of the @p letter argument is for
20581     * single char strings, one could use arbitrary strings as index
20582     * entries.
20583     *
20584     * @c item will be the pointer returned back on @c "changed", @c
20585     * "delay,changed" and @c "selected" smart events.
20586     *
20587     * @note If @p relative is @c NULL or if it's not found to be data
20588     * set on any previous item on @p obj, this function will behave as
20589     * elm_index_item_append().
20590     *
20591     * @ingroup Index
20592     */
20593    EAPI void            elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
20594
20595    /**
20596     * Prepend a new item, on a given index widget, <b>after the item
20597     * having @p relative as data</b>.
20598     *
20599     * @param obj The index object.
20600     * @param letter Letter under which the item should be indexed
20601     * @param item The item data to set for the index's item
20602     * @param relative The item data of the index item to be the
20603     * successor of this new one
20604     *
20605     * Despite the most common usage of the @p letter argument is for
20606     * single char strings, one could use arbitrary strings as index
20607     * entries.
20608     *
20609     * @c item will be the pointer returned back on @c "changed", @c
20610     * "delay,changed" and @c "selected" smart events.
20611     *
20612     * @note If @p relative is @c NULL or if it's not found to be data
20613     * set on any previous item on @p obj, this function will behave as
20614     * elm_index_item_prepend().
20615     *
20616     * @ingroup Index
20617     */
20618    EAPI void            elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
20619
20620    /**
20621     * Insert a new item into the given index widget, using @p cmp_func
20622     * function to sort items (by item handles).
20623     *
20624     * @param obj The index object.
20625     * @param letter Letter under which the item should be indexed
20626     * @param item The item data to set for the index's item
20627     * @param cmp_func The comparing function to be used to sort index
20628     * items <b>by #Elm_Index_Item item handles</b>
20629     * @param cmp_data_func A @b fallback function to be called for the
20630     * sorting of index items <b>by item data</b>). It will be used
20631     * when @p cmp_func returns @c 0 (equality), which means an index
20632     * item with provided item data already exists. To decide which
20633     * data item should be pointed to by the index item in question, @p
20634     * cmp_data_func will be used. If @p cmp_data_func returns a
20635     * non-negative value, the previous index item data will be
20636     * replaced by the given @p item pointer. If the previous data need
20637     * to be freed, it should be done by the @p cmp_data_func function,
20638     * because all references to it will be lost. If this function is
20639     * not provided (@c NULL is given), index items will be @b
20640     * duplicated, if @p cmp_func returns @c 0.
20641     *
20642     * Despite the most common usage of the @p letter argument is for
20643     * single char strings, one could use arbitrary strings as index
20644     * entries.
20645     *
20646     * @c item will be the pointer returned back on @c "changed", @c
20647     * "delay,changed" and @c "selected" smart events.
20648     *
20649     * @ingroup Index
20650     */
20651    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);
20652
20653    /**
20654     * Remove an item from a given index widget, <b>to be referenced by
20655     * it's data value</b>.
20656     *
20657     * @param obj The index object
20658     * @param item The item's data pointer for the item to be removed
20659     * from @p obj
20660     *
20661     * If a deletion callback is set, via elm_index_item_del_cb_set(),
20662     * that callback function will be called by this one.
20663     *
20664     * @warning The item to be removed from @p obj will be found via
20665     * its item data pointer, and not by an #Elm_Index_Item handle.
20666     *
20667     * @ingroup Index
20668     */
20669    EAPI void            elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
20670
20671    /**
20672     * Find a given index widget's item, <b>using item data</b>.
20673     *
20674     * @param obj The index object
20675     * @param item The item data pointed to by the desired index item
20676     * @return The index item handle, if found, or @c NULL otherwise
20677     *
20678     * @ingroup Index
20679     */
20680    EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
20681
20682    /**
20683     * Removes @b all items from a given index widget.
20684     *
20685     * @param obj The index object.
20686     *
20687     * If deletion callbacks are set, via elm_index_item_del_cb_set(),
20688     * that callback function will be called for each item in @p obj.
20689     *
20690     * @ingroup Index
20691     */
20692    EAPI void            elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20693
20694    /**
20695     * Go to a given items level on a index widget
20696     *
20697     * @param obj The index object
20698     * @param level The index level (one of @c 0 or @c 1)
20699     *
20700     * @ingroup Index
20701     */
20702    EAPI void            elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20703
20704    /**
20705     * Return the data associated with a given index widget item
20706     *
20707     * @param it The index widget item handle
20708     * @return The data associated with @p it
20709     *
20710     * @see elm_index_item_data_set()
20711     *
20712     * @ingroup Index
20713     */
20714    EAPI void           *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
20715
20716    /**
20717     * Set the data associated with a given index widget item
20718     *
20719     * @param it The index widget item handle
20720     * @param data The new data pointer to set to @p it
20721     *
20722     * This sets new item data on @p it.
20723     *
20724     * @warning The old data pointer won't be touched by this function, so
20725     * the user had better to free that old data himself/herself.
20726     *
20727     * @ingroup Index
20728     */
20729    EAPI void            elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
20730
20731    /**
20732     * Set the function to be called when a given index widget item is freed.
20733     *
20734     * @param it The item to set the callback on
20735     * @param func The function to call on the item's deletion
20736     *
20737     * When called, @p func will have both @c data and @c event_info
20738     * arguments with the @p it item's data value and, naturally, the
20739     * @c obj argument with a handle to the parent index widget.
20740     *
20741     * @ingroup Index
20742     */
20743    EAPI void            elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
20744
20745    /**
20746     * Get the letter (string) set on a given index widget item.
20747     *
20748     * @param it The index item handle
20749     * @return The letter string set on @p it
20750     *
20751     * @ingroup Index
20752     */
20753    EAPI const char     *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
20754
20755    /**
20756     * @}
20757     */
20758
20759    /**
20760     * @defgroup Photocam Photocam
20761     *
20762     * @image html img/widget/photocam/preview-00.png
20763     * @image latex img/widget/photocam/preview-00.eps
20764     *
20765     * This is a widget specifically for displaying high-resolution digital
20766     * camera photos giving speedy feedback (fast load), low memory footprint
20767     * and zooming and panning as well as fitting logic. It is entirely focused
20768     * on jpeg images, and takes advantage of properties of the jpeg format (via
20769     * evas loader features in the jpeg loader).
20770     *
20771     * Signals that you can add callbacks for are:
20772     * @li "clicked" - This is called when a user has clicked the photo without
20773     *                 dragging around.
20774     * @li "press" - This is called when a user has pressed down on the photo.
20775     * @li "longpressed" - This is called when a user has pressed down on the
20776     *                     photo for a long time without dragging around.
20777     * @li "clicked,double" - This is called when a user has double-clicked the
20778     *                        photo.
20779     * @li "load" - Photo load begins.
20780     * @li "loaded" - This is called when the image file load is complete for the
20781     *                first view (low resolution blurry version).
20782     * @li "load,detail" - Photo detailed data load begins.
20783     * @li "loaded,detail" - This is called when the image file load is complete
20784     *                      for the detailed image data (full resolution needed).
20785     * @li "zoom,start" - Zoom animation started.
20786     * @li "zoom,stop" - Zoom animation stopped.
20787     * @li "zoom,change" - Zoom changed when using an auto zoom mode.
20788     * @li "scroll" - the content has been scrolled (moved)
20789     * @li "scroll,anim,start" - scrolling animation has started
20790     * @li "scroll,anim,stop" - scrolling animation has stopped
20791     * @li "scroll,drag,start" - dragging the contents around has started
20792     * @li "scroll,drag,stop" - dragging the contents around has stopped
20793     *
20794     * @ref tutorial_photocam shows the API in action.
20795     * @{
20796     */
20797    /**
20798     * @brief Types of zoom available.
20799     */
20800    typedef enum _Elm_Photocam_Zoom_Mode
20801      {
20802         ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
20803         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
20804         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
20805         ELM_PHOTOCAM_ZOOM_MODE_LAST
20806      } Elm_Photocam_Zoom_Mode;
20807    /**
20808     * @brief Add a new Photocam object
20809     *
20810     * @param parent The parent object
20811     * @return The new object or NULL if it cannot be created
20812     */
20813    EAPI Evas_Object           *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20814    /**
20815     * @brief Set the photo file to be shown
20816     *
20817     * @param obj The photocam object
20818     * @param file The photo file
20819     * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
20820     *
20821     * This sets (and shows) the specified file (with a relative or absolute
20822     * path) and will return a load error (same error that
20823     * evas_object_image_load_error_get() will return). The image will change and
20824     * adjust its size at this point and begin a background load process for this
20825     * photo that at some time in the future will be displayed at the full
20826     * quality needed.
20827     */
20828    EAPI Evas_Load_Error        elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
20829    /**
20830     * @brief Returns the path of the current image file
20831     *
20832     * @param obj The photocam object
20833     * @return Returns the path
20834     *
20835     * @see elm_photocam_file_set()
20836     */
20837    EAPI const char            *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20838    /**
20839     * @brief Set the zoom level of the photo
20840     *
20841     * @param obj The photocam object
20842     * @param zoom The zoom level to set
20843     *
20844     * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
20845     * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
20846     * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
20847     * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
20848     * 16, 32, etc.).
20849     */
20850    EAPI void                   elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
20851    /**
20852     * @brief Get the zoom level of the photo
20853     *
20854     * @param obj The photocam object
20855     * @return The current zoom level
20856     *
20857     * This returns the current zoom level of the photocam object. Note that if
20858     * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
20859     * (which is the default), the zoom level may be changed at any time by the
20860     * photocam object itself to account for photo size and photocam viewpoer
20861     * size.
20862     *
20863     * @see elm_photocam_zoom_set()
20864     * @see elm_photocam_zoom_mode_set()
20865     */
20866    EAPI double                 elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20867    /**
20868     * @brief Set the zoom mode
20869     *
20870     * @param obj The photocam object
20871     * @param mode The desired mode
20872     *
20873     * This sets the zoom mode to manual or one of several automatic levels.
20874     * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
20875     * elm_photocam_zoom_set() and will stay at that level until changed by code
20876     * or until zoom mode is changed. This is the default mode. The Automatic
20877     * modes will allow the photocam object to automatically adjust zoom mode
20878     * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
20879     * the photo fits EXACTLY inside the scroll frame with no pixels outside this
20880     * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
20881     * pixels within the frame are left unfilled.
20882     */
20883    EAPI void                   elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
20884    /**
20885     * @brief Get the zoom mode
20886     *
20887     * @param obj The photocam object
20888     * @return The current zoom mode
20889     *
20890     * This gets the current zoom mode of the photocam object.
20891     *
20892     * @see elm_photocam_zoom_mode_set()
20893     */
20894    EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20895    /**
20896     * @brief Get the current image pixel width and height
20897     *
20898     * @param obj The photocam object
20899     * @param w A pointer to the width return
20900     * @param h A pointer to the height return
20901     *
20902     * This gets the current photo pixel width and height (for the original).
20903     * The size will be returned in the integers @p w and @p h that are pointed
20904     * to.
20905     */
20906    EAPI void                   elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
20907    /**
20908     * @brief Get the area of the image that is currently shown
20909     *
20910     * @param obj
20911     * @param x A pointer to the X-coordinate of region
20912     * @param y A pointer to the Y-coordinate of region
20913     * @param w A pointer to the width
20914     * @param h A pointer to the height
20915     *
20916     * @see elm_photocam_image_region_show()
20917     * @see elm_photocam_image_region_bring_in()
20918     */
20919    EAPI void                   elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
20920    /**
20921     * @brief Set the viewed portion of the image
20922     *
20923     * @param obj The photocam object
20924     * @param x X-coordinate of region in image original pixels
20925     * @param y Y-coordinate of region in image original pixels
20926     * @param w Width of region in image original pixels
20927     * @param h Height of region in image original pixels
20928     *
20929     * This shows the region of the image without using animation.
20930     */
20931    EAPI void                   elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
20932    /**
20933     * @brief Bring in the viewed portion of the image
20934     *
20935     * @param obj The photocam object
20936     * @param x X-coordinate of region in image original pixels
20937     * @param y Y-coordinate of region in image original pixels
20938     * @param w Width of region in image original pixels
20939     * @param h Height of region in image original pixels
20940     *
20941     * This shows the region of the image using animation.
20942     */
20943    EAPI void                   elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
20944    /**
20945     * @brief Set the paused state for photocam
20946     *
20947     * @param obj The photocam object
20948     * @param paused The pause state to set
20949     *
20950     * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
20951     * photocam. The default is off. This will stop zooming using animation on
20952     * zoom levels changes and change instantly. This will stop any existing
20953     * animations that are running.
20954     */
20955    EAPI void                   elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
20956    /**
20957     * @brief Get the paused state for photocam
20958     *
20959     * @param obj The photocam object
20960     * @return The current paused state
20961     *
20962     * This gets the current paused state for the photocam object.
20963     *
20964     * @see elm_photocam_paused_set()
20965     */
20966    EAPI Eina_Bool              elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20967    /**
20968     * @brief Get the internal low-res image used for photocam
20969     *
20970     * @param obj The photocam object
20971     * @return The internal image object handle, or NULL if none exists
20972     *
20973     * This gets the internal image object inside photocam. Do not modify it. It
20974     * is for inspection only, and hooking callbacks to. Nothing else. It may be
20975     * deleted at any time as well.
20976     */
20977    EAPI Evas_Object           *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20978    /**
20979     * @brief Set the photocam scrolling bouncing.
20980     *
20981     * @param obj The photocam object
20982     * @param h_bounce bouncing for horizontal
20983     * @param v_bounce bouncing for vertical
20984     */
20985    EAPI void                   elm_photocam_bounce_set(Evas_Object *obj,  Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
20986    /**
20987     * @brief Get the photocam scrolling bouncing.
20988     *
20989     * @param obj The photocam object
20990     * @param h_bounce bouncing for horizontal
20991     * @param v_bounce bouncing for vertical
20992     *
20993     * @see elm_photocam_bounce_set()
20994     */
20995    EAPI void                   elm_photocam_bounce_get(const Evas_Object *obj,  Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
20996    /**
20997     * @}
20998     */
20999
21000    /**
21001     * @defgroup Map Map
21002     * @ingroup Elementary
21003     *
21004     * @image html img/widget/map/preview-00.png
21005     * @image latex img/widget/map/preview-00.eps
21006     *
21007     * This is a widget specifically for displaying a map. It uses basically
21008     * OpenStreetMap provider http://www.openstreetmap.org/,
21009     * but custom providers can be added.
21010     *
21011     * It supports some basic but yet nice features:
21012     * @li zoom and scroll
21013     * @li markers with content to be displayed when user clicks over it
21014     * @li group of markers
21015     * @li routes
21016     *
21017     * Smart callbacks one can listen to:
21018     *
21019     * - "clicked" - This is called when a user has clicked the map without
21020     *   dragging around.
21021     * - "press" - This is called when a user has pressed down on the map.
21022     * - "longpressed" - This is called when a user has pressed down on the map
21023     *   for a long time without dragging around.
21024     * - "clicked,double" - This is called when a user has double-clicked
21025     *   the map.
21026     * - "load,detail" - Map detailed data load begins.
21027     * - "loaded,detail" - This is called when all currently visible parts of
21028     *   the map are loaded.
21029     * - "zoom,start" - Zoom animation started.
21030     * - "zoom,stop" - Zoom animation stopped.
21031     * - "zoom,change" - Zoom changed when using an auto zoom mode.
21032     * - "scroll" - the content has been scrolled (moved).
21033     * - "scroll,anim,start" - scrolling animation has started.
21034     * - "scroll,anim,stop" - scrolling animation has stopped.
21035     * - "scroll,drag,start" - dragging the contents around has started.
21036     * - "scroll,drag,stop" - dragging the contents around has stopped.
21037     * - "downloaded" - This is called when all currently required map images
21038     *   are downloaded.
21039     * - "route,load" - This is called when route request begins.
21040     * - "route,loaded" - This is called when route request ends.
21041     * - "name,load" - This is called when name request begins.
21042     * - "name,loaded- This is called when name request ends.
21043     *
21044     * Available style for map widget:
21045     * - @c "default"
21046     *
21047     * Available style for markers:
21048     * - @c "radio"
21049     * - @c "radio2"
21050     * - @c "empty"
21051     *
21052     * Available style for marker bubble:
21053     * - @c "default"
21054     *
21055     * List of examples:
21056     * @li @ref map_example_01
21057     * @li @ref map_example_02
21058     * @li @ref map_example_03
21059     */
21060
21061    /**
21062     * @addtogroup Map
21063     * @{
21064     */
21065
21066    /**
21067     * @enum _Elm_Map_Zoom_Mode
21068     * @typedef Elm_Map_Zoom_Mode
21069     *
21070     * Set map's zoom behavior. It can be set to manual or automatic.
21071     *
21072     * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
21073     *
21074     * Values <b> don't </b> work as bitmask, only one can be choosen.
21075     *
21076     * @note Valid sizes are 2^zoom, consequently the map may be smaller
21077     * than the scroller view.
21078     *
21079     * @see elm_map_zoom_mode_set()
21080     * @see elm_map_zoom_mode_get()
21081     *
21082     * @ingroup Map
21083     */
21084    typedef enum _Elm_Map_Zoom_Mode
21085      {
21086         ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
21087         ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
21088         ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
21089         ELM_MAP_ZOOM_MODE_LAST
21090      } Elm_Map_Zoom_Mode;
21091
21092    /**
21093     * @enum _Elm_Map_Route_Sources
21094     * @typedef Elm_Map_Route_Sources
21095     *
21096     * Set route service to be used. By default used source is
21097     * #ELM_MAP_ROUTE_SOURCE_YOURS.
21098     *
21099     * @see elm_map_route_source_set()
21100     * @see elm_map_route_source_get()
21101     *
21102     * @ingroup Map
21103     */
21104    typedef enum _Elm_Map_Route_Sources
21105      {
21106         ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
21107         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. */
21108         ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
21109         ELM_MAP_ROUTE_SOURCE_LAST
21110      } Elm_Map_Route_Sources;
21111
21112    typedef enum _Elm_Map_Name_Sources
21113      {
21114         ELM_MAP_NAME_SOURCE_NOMINATIM,
21115         ELM_MAP_NAME_SOURCE_LAST
21116      } Elm_Map_Name_Sources;
21117
21118    /**
21119     * @enum _Elm_Map_Route_Type
21120     * @typedef Elm_Map_Route_Type
21121     *
21122     * Set type of transport used on route.
21123     *
21124     * @see elm_map_route_add()
21125     *
21126     * @ingroup Map
21127     */
21128    typedef enum _Elm_Map_Route_Type
21129      {
21130         ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
21131         ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
21132         ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
21133         ELM_MAP_ROUTE_TYPE_LAST
21134      } Elm_Map_Route_Type;
21135
21136    /**
21137     * @enum _Elm_Map_Route_Method
21138     * @typedef Elm_Map_Route_Method
21139     *
21140     * Set the routing method, what should be priorized, time or distance.
21141     *
21142     * @see elm_map_route_add()
21143     *
21144     * @ingroup Map
21145     */
21146    typedef enum _Elm_Map_Route_Method
21147      {
21148         ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
21149         ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
21150         ELM_MAP_ROUTE_METHOD_LAST
21151      } Elm_Map_Route_Method;
21152
21153    typedef enum _Elm_Map_Name_Method
21154      {
21155         ELM_MAP_NAME_METHOD_SEARCH,
21156         ELM_MAP_NAME_METHOD_REVERSE,
21157         ELM_MAP_NAME_METHOD_LAST
21158      } Elm_Map_Name_Method;
21159
21160    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(). */
21161    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(). */
21162    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(). */
21163    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(). */
21164    typedef struct _Elm_Map_Name            Elm_Map_Name; /**< A handle for specific coordinates. */
21165    typedef struct _Elm_Map_Track           Elm_Map_Track;
21166
21167    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. */
21168    typedef void         (*ElmMapMarkerDelFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
21169    typedef Evas_Object *(*ElmMapMarkerIconGetFunc)  (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
21170    typedef Evas_Object *(*ElmMapGroupIconGetFunc)   (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
21171
21172    typedef char        *(*ElmMapModuleSourceFunc) (void);
21173    typedef int          (*ElmMapModuleZoomMinFunc) (void);
21174    typedef int          (*ElmMapModuleZoomMaxFunc) (void);
21175    typedef char        *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
21176    typedef int          (*ElmMapModuleRouteSourceFunc) (void);
21177    typedef char        *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
21178    typedef char        *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
21179    typedef Eina_Bool    (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
21180    typedef Eina_Bool    (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
21181
21182    /**
21183     * Add a new map widget to the given parent Elementary (container) object.
21184     *
21185     * @param parent The parent object.
21186     * @return a new map widget handle or @c NULL, on errors.
21187     *
21188     * This function inserts a new map widget on the canvas.
21189     *
21190     * @ingroup Map
21191     */
21192    EAPI Evas_Object          *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21193
21194    /**
21195     * Set the zoom level of the map.
21196     *
21197     * @param obj The map object.
21198     * @param zoom The zoom level to set.
21199     *
21200     * This sets the zoom level.
21201     *
21202     * It will respect limits defined by elm_map_source_zoom_min_set() and
21203     * elm_map_source_zoom_max_set().
21204     *
21205     * By default these values are 0 (world map) and 18 (maximum zoom).
21206     *
21207     * This function should be used when zoom mode is set to
21208     * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
21209     * with elm_map_zoom_mode_set().
21210     *
21211     * @see elm_map_zoom_mode_set().
21212     * @see elm_map_zoom_get().
21213     *
21214     * @ingroup Map
21215     */
21216    EAPI void                  elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
21217
21218    /**
21219     * Get the zoom level of the map.
21220     *
21221     * @param obj The map object.
21222     * @return The current zoom level.
21223     *
21224     * This returns the current zoom level of the map object.
21225     *
21226     * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
21227     * (which is the default), the zoom level may be changed at any time by the
21228     * map object itself to account for map size and map viewport size.
21229     *
21230     * @see elm_map_zoom_set() for details.
21231     *
21232     * @ingroup Map
21233     */
21234    EAPI int                   elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21235
21236    /**
21237     * Set the zoom mode used by the map object.
21238     *
21239     * @param obj The map object.
21240     * @param mode The zoom mode of the map, being it one of
21241     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
21242     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
21243     *
21244     * This sets the zoom mode to manual or one of the automatic levels.
21245     * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
21246     * elm_map_zoom_set() and will stay at that level until changed by code
21247     * or until zoom mode is changed. This is the default mode.
21248     *
21249     * The Automatic modes will allow the map object to automatically
21250     * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
21251     * adjust zoom so the map fits inside the scroll frame with no pixels
21252     * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
21253     * ensure no pixels within the frame are left unfilled. Do not forget that
21254     * the valid sizes are 2^zoom, consequently the map may be smaller than
21255     * the scroller view.
21256     *
21257     * @see elm_map_zoom_set()
21258     *
21259     * @ingroup Map
21260     */
21261    EAPI void                  elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
21262
21263    /**
21264     * Get the zoom mode used by the map object.
21265     *
21266     * @param obj The map object.
21267     * @return The zoom mode of the map, being it one of
21268     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
21269     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
21270     *
21271     * This function returns the current zoom mode used by the map object.
21272     *
21273     * @see elm_map_zoom_mode_set() for more details.
21274     *
21275     * @ingroup Map
21276     */
21277    EAPI Elm_Map_Zoom_Mode     elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21278
21279    /**
21280     * Get the current coordinates of the map.
21281     *
21282     * @param obj The map object.
21283     * @param lon Pointer where to store longitude.
21284     * @param lat Pointer where to store latitude.
21285     *
21286     * This gets the current center coordinates of the map object. It can be
21287     * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
21288     *
21289     * @see elm_map_geo_region_bring_in()
21290     * @see elm_map_geo_region_show()
21291     *
21292     * @ingroup Map
21293     */
21294    EAPI void                  elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
21295
21296    /**
21297     * Animatedly bring in given coordinates to the center of the map.
21298     *
21299     * @param obj The map object.
21300     * @param lon Longitude to center at.
21301     * @param lat Latitude to center at.
21302     *
21303     * This causes map to jump to the given @p lat and @p lon coordinates
21304     * and show it (by scrolling) in the center of the viewport, if it is not
21305     * already centered. This will use animation to do so and take a period
21306     * of time to complete.
21307     *
21308     * @see elm_map_geo_region_show() for a function to avoid animation.
21309     * @see elm_map_geo_region_get()
21310     *
21311     * @ingroup Map
21312     */
21313    EAPI void                  elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
21314
21315    /**
21316     * Show the given coordinates at the center of the map, @b immediately.
21317     *
21318     * @param obj The map object.
21319     * @param lon Longitude to center at.
21320     * @param lat Latitude to center at.
21321     *
21322     * This causes map to @b redraw its viewport's contents to the
21323     * region contining the given @p lat and @p lon, that will be moved to the
21324     * center of the map.
21325     *
21326     * @see elm_map_geo_region_bring_in() for a function to move with animation.
21327     * @see elm_map_geo_region_get()
21328     *
21329     * @ingroup Map
21330     */
21331    EAPI void                  elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
21332
21333    /**
21334     * Pause or unpause the map.
21335     *
21336     * @param obj The map object.
21337     * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
21338     * to unpause it.
21339     *
21340     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21341     * for map.
21342     *
21343     * The default is off.
21344     *
21345     * This will stop zooming using animation, changing zoom levels will
21346     * change instantly. This will stop any existing animations that are running.
21347     *
21348     * @see elm_map_paused_get()
21349     *
21350     * @ingroup Map
21351     */
21352    EAPI void                  elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
21353
21354    /**
21355     * Get a value whether map is paused or not.
21356     *
21357     * @param obj The map object.
21358     * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
21359     * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
21360     *
21361     * This gets the current paused state for the map object.
21362     *
21363     * @see elm_map_paused_set() for details.
21364     *
21365     * @ingroup Map
21366     */
21367    EAPI Eina_Bool             elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21368
21369    /**
21370     * Set to show markers during zoom level changes or not.
21371     *
21372     * @param obj The map object.
21373     * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
21374     * to show them.
21375     *
21376     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21377     * for map.
21378     *
21379     * The default is off.
21380     *
21381     * This will stop zooming using animation, changing zoom levels will
21382     * change instantly. This will stop any existing animations that are running.
21383     *
21384     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21385     * for the markers.
21386     *
21387     * The default  is off.
21388     *
21389     * Enabling it will force the map to stop displaying the markers during
21390     * zoom level changes. Set to on if you have a large number of markers.
21391     *
21392     * @see elm_map_paused_markers_get()
21393     *
21394     * @ingroup Map
21395     */
21396    EAPI void                  elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
21397
21398    /**
21399     * Get a value whether markers will be displayed on zoom level changes or not
21400     *
21401     * @param obj The map object.
21402     * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
21403     * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
21404     *
21405     * This gets the current markers paused state for the map object.
21406     *
21407     * @see elm_map_paused_markers_set() for details.
21408     *
21409     * @ingroup Map
21410     */
21411    EAPI Eina_Bool             elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21412
21413    /**
21414     * Get the information of downloading status.
21415     *
21416     * @param obj The map object.
21417     * @param try_num Pointer where to store number of tiles being downloaded.
21418     * @param finish_num Pointer where to store number of tiles successfully
21419     * downloaded.
21420     *
21421     * This gets the current downloading status for the map object, the number
21422     * of tiles being downloaded and the number of tiles already downloaded.
21423     *
21424     * @ingroup Map
21425     */
21426    EAPI void                  elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
21427
21428    /**
21429     * Convert a pixel coordinate (x,y) into a geographic coordinate
21430     * (longitude, latitude).
21431     *
21432     * @param obj The map object.
21433     * @param x the coordinate.
21434     * @param y the coordinate.
21435     * @param size the size in pixels of the map.
21436     * The map is a square and generally his size is : pow(2.0, zoom)*256.
21437     * @param lon Pointer where to store the longitude that correspond to x.
21438     * @param lat Pointer where to store the latitude that correspond to y.
21439     *
21440     * @note Origin pixel point is the top left corner of the viewport.
21441     * Map zoom and size are taken on account.
21442     *
21443     * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
21444     *
21445     * @ingroup Map
21446     */
21447    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);
21448
21449    /**
21450     * Convert a geographic coordinate (longitude, latitude) into a pixel
21451     * coordinate (x, y).
21452     *
21453     * @param obj The map object.
21454     * @param lon the longitude.
21455     * @param lat the latitude.
21456     * @param size the size in pixels of the map. The map is a square
21457     * and generally his size is : pow(2.0, zoom)*256.
21458     * @param x Pointer where to store the horizontal pixel coordinate that
21459     * correspond to the longitude.
21460     * @param y Pointer where to store the vertical pixel coordinate that
21461     * correspond to the latitude.
21462     *
21463     * @note Origin pixel point is the top left corner of the viewport.
21464     * Map zoom and size are taken on account.
21465     *
21466     * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
21467     *
21468     * @ingroup Map
21469     */
21470    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);
21471
21472    /**
21473     * Convert a geographic coordinate (longitude, latitude) into a name
21474     * (address).
21475     *
21476     * @param obj The map object.
21477     * @param lon the longitude.
21478     * @param lat the latitude.
21479     * @return name A #Elm_Map_Name handle for this coordinate.
21480     *
21481     * To get the string for this address, elm_map_name_address_get()
21482     * should be used.
21483     *
21484     * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
21485     *
21486     * @ingroup Map
21487     */
21488    EAPI Elm_Map_Name         *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
21489
21490    /**
21491     * Convert a name (address) into a geographic coordinate
21492     * (longitude, latitude).
21493     *
21494     * @param obj The map object.
21495     * @param name The address.
21496     * @return name A #Elm_Map_Name handle for this address.
21497     *
21498     * To get the longitude and latitude, elm_map_name_region_get()
21499     * should be used.
21500     *
21501     * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
21502     *
21503     * @ingroup Map
21504     */
21505    EAPI Elm_Map_Name         *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
21506
21507    /**
21508     * Convert a pixel coordinate into a rotated pixel coordinate.
21509     *
21510     * @param obj The map object.
21511     * @param x horizontal coordinate of the point to rotate.
21512     * @param y vertical coordinate of the point to rotate.
21513     * @param cx rotation's center horizontal position.
21514     * @param cy rotation's center vertical position.
21515     * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
21516     * @param xx Pointer where to store rotated x.
21517     * @param yy Pointer where to store rotated y.
21518     *
21519     * @ingroup Map
21520     */
21521    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);
21522
21523    /**
21524     * Add a new marker to the map object.
21525     *
21526     * @param obj The map object.
21527     * @param lon The longitude of the marker.
21528     * @param lat The latitude of the marker.
21529     * @param clas The class, to use when marker @b isn't grouped to others.
21530     * @param clas_group The class group, to use when marker is grouped to others
21531     * @param data The data passed to the callbacks.
21532     *
21533     * @return The created marker or @c NULL upon failure.
21534     *
21535     * A marker will be created and shown in a specific point of the map, defined
21536     * by @p lon and @p lat.
21537     *
21538     * It will be displayed using style defined by @p class when this marker
21539     * is displayed alone (not grouped). A new class can be created with
21540     * elm_map_marker_class_new().
21541     *
21542     * If the marker is grouped to other markers, it will be displayed with
21543     * style defined by @p class_group. Markers with the same group are grouped
21544     * if they are close. A new group class can be created with
21545     * elm_map_marker_group_class_new().
21546     *
21547     * Markers created with this method can be deleted with
21548     * elm_map_marker_remove().
21549     *
21550     * A marker can have associated content to be displayed by a bubble,
21551     * when a user click over it, as well as an icon. These objects will
21552     * be fetch using class' callback functions.
21553     *
21554     * @see elm_map_marker_class_new()
21555     * @see elm_map_marker_group_class_new()
21556     * @see elm_map_marker_remove()
21557     *
21558     * @ingroup Map
21559     */
21560    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);
21561
21562    /**
21563     * Set the maximum numbers of markers' content to be displayed in a group.
21564     *
21565     * @param obj The map object.
21566     * @param max The maximum numbers of items displayed in a bubble.
21567     *
21568     * A bubble will be displayed when the user clicks over the group,
21569     * and will place the content of markers that belong to this group
21570     * inside it.
21571     *
21572     * A group can have a long list of markers, consequently the creation
21573     * of the content of the bubble can be very slow.
21574     *
21575     * In order to avoid this, a maximum number of items is displayed
21576     * in a bubble.
21577     *
21578     * By default this number is 30.
21579     *
21580     * Marker with the same group class are grouped if they are close.
21581     *
21582     * @see elm_map_marker_add()
21583     *
21584     * @ingroup Map
21585     */
21586    EAPI void                  elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
21587
21588    /**
21589     * Remove a marker from the map.
21590     *
21591     * @param marker The marker to remove.
21592     *
21593     * @see elm_map_marker_add()
21594     *
21595     * @ingroup Map
21596     */
21597    EAPI void                  elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21598
21599    /**
21600     * Get the current coordinates of the marker.
21601     *
21602     * @param marker marker.
21603     * @param lat Pointer where to store the marker's latitude.
21604     * @param lon Pointer where to store the marker's longitude.
21605     *
21606     * These values are set when adding markers, with function
21607     * elm_map_marker_add().
21608     *
21609     * @see elm_map_marker_add()
21610     *
21611     * @ingroup Map
21612     */
21613    EAPI void                  elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
21614
21615    /**
21616     * Animatedly bring in given marker to the center of the map.
21617     *
21618     * @param marker The marker to center at.
21619     *
21620     * This causes map to jump to the given @p marker's coordinates
21621     * and show it (by scrolling) in the center of the viewport, if it is not
21622     * already centered. This will use animation to do so and take a period
21623     * of time to complete.
21624     *
21625     * @see elm_map_marker_show() for a function to avoid animation.
21626     * @see elm_map_marker_region_get()
21627     *
21628     * @ingroup Map
21629     */
21630    EAPI void                  elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21631
21632    /**
21633     * Show the given marker at the center of the map, @b immediately.
21634     *
21635     * @param marker The marker to center at.
21636     *
21637     * This causes map to @b redraw its viewport's contents to the
21638     * region contining the given @p marker's coordinates, that will be
21639     * moved to the center of the map.
21640     *
21641     * @see elm_map_marker_bring_in() for a function to move with animation.
21642     * @see elm_map_markers_list_show() if more than one marker need to be
21643     * displayed.
21644     * @see elm_map_marker_region_get()
21645     *
21646     * @ingroup Map
21647     */
21648    EAPI void                  elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21649
21650    /**
21651     * Move and zoom the map to display a list of markers.
21652     *
21653     * @param markers A list of #Elm_Map_Marker handles.
21654     *
21655     * The map will be centered on the center point of the markers in the list.
21656     * Then the map will be zoomed in order to fit the markers using the maximum
21657     * zoom which allows display of all the markers.
21658     *
21659     * @warning All the markers should belong to the same map object.
21660     *
21661     * @see elm_map_marker_show() to show a single marker.
21662     * @see elm_map_marker_bring_in()
21663     *
21664     * @ingroup Map
21665     */
21666    EAPI void                  elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
21667
21668    /**
21669     * Get the Evas object returned by the ElmMapMarkerGetFunc callback
21670     *
21671     * @param marker The marker wich content should be returned.
21672     * @return Return the evas object if it exists, else @c NULL.
21673     *
21674     * To set callback function #ElmMapMarkerGetFunc for the marker class,
21675     * elm_map_marker_class_get_cb_set() should be used.
21676     *
21677     * This content is what will be inside the bubble that will be displayed
21678     * when an user clicks over the marker.
21679     *
21680     * This returns the actual Evas object used to be placed inside
21681     * the bubble. This may be @c NULL, as it may
21682     * not have been created or may have been deleted, at any time, by
21683     * the map. <b>Do not modify this object</b> (move, resize,
21684     * show, hide, etc.), as the map is controlling it. This
21685     * function is for querying, emitting custom signals or hooking
21686     * lower level callbacks for events on that object. Do not delete
21687     * this object under any circumstances.
21688     *
21689     * @ingroup Map
21690     */
21691    EAPI Evas_Object          *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21692
21693    /**
21694     * Update the marker
21695     *
21696     * @param marker The marker to be updated.
21697     *
21698     * If a content is set to this marker, it will call function to delete it,
21699     * #ElmMapMarkerDelFunc, and then will fetch the content again with
21700     * #ElmMapMarkerGetFunc.
21701     *
21702     * These functions are set for the marker class with
21703     * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
21704     *
21705     * @ingroup Map
21706     */
21707    EAPI void                  elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21708
21709    /**
21710     * Close all the bubbles opened by the user.
21711     *
21712     * @param obj The map object.
21713     *
21714     * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
21715     * when the user clicks on a marker.
21716     *
21717     * This functions is set for the marker class with
21718     * elm_map_marker_class_get_cb_set().
21719     *
21720     * @ingroup Map
21721     */
21722    EAPI void                  elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
21723
21724    /**
21725     * Create a new group class.
21726     *
21727     * @param obj The map object.
21728     * @return Returns the new group class.
21729     *
21730     * Each marker must be associated to a group class. Markers in the same
21731     * group are grouped if they are close.
21732     *
21733     * The group class defines the style of the marker when a marker is grouped
21734     * to others markers. When it is alone, another class will be used.
21735     *
21736     * A group class will need to be provided when creating a marker with
21737     * elm_map_marker_add().
21738     *
21739     * Some properties and functions can be set by class, as:
21740     * - style, with elm_map_group_class_style_set()
21741     * - data - to be associated to the group class. It can be set using
21742     *   elm_map_group_class_data_set().
21743     * - min zoom to display markers, set with
21744     *   elm_map_group_class_zoom_displayed_set().
21745     * - max zoom to group markers, set using
21746     *   elm_map_group_class_zoom_grouped_set().
21747     * - visibility - set if markers will be visible or not, set with
21748     *   elm_map_group_class_hide_set().
21749     * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
21750     *   It can be set using elm_map_group_class_icon_cb_set().
21751     *
21752     * @see elm_map_marker_add()
21753     * @see elm_map_group_class_style_set()
21754     * @see elm_map_group_class_data_set()
21755     * @see elm_map_group_class_zoom_displayed_set()
21756     * @see elm_map_group_class_zoom_grouped_set()
21757     * @see elm_map_group_class_hide_set()
21758     * @see elm_map_group_class_icon_cb_set()
21759     *
21760     * @ingroup Map
21761     */
21762    EAPI Elm_Map_Group_Class  *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
21763
21764    /**
21765     * Set the marker's style of a group class.
21766     *
21767     * @param clas The group class.
21768     * @param style The style to be used by markers.
21769     *
21770     * Each marker must be associated to a group class, and will use the style
21771     * defined by such class when grouped to other markers.
21772     *
21773     * The following styles are provided by default theme:
21774     * @li @c radio - blue circle
21775     * @li @c radio2 - green circle
21776     * @li @c empty
21777     *
21778     * @see elm_map_group_class_new() for more details.
21779     * @see elm_map_marker_add()
21780     *
21781     * @ingroup Map
21782     */
21783    EAPI void                  elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
21784
21785    /**
21786     * Set the icon callback function of a group class.
21787     *
21788     * @param clas The group class.
21789     * @param icon_get The callback function that will return the icon.
21790     *
21791     * Each marker must be associated to a group class, and it can display a
21792     * custom icon. The function @p icon_get must return this icon.
21793     *
21794     * @see elm_map_group_class_new() for more details.
21795     * @see elm_map_marker_add()
21796     *
21797     * @ingroup Map
21798     */
21799    EAPI void                  elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
21800
21801    /**
21802     * Set the data associated to the group class.
21803     *
21804     * @param clas The group class.
21805     * @param data The new user data.
21806     *
21807     * This data will be passed for callback functions, like icon get callback,
21808     * that can be set with elm_map_group_class_icon_cb_set().
21809     *
21810     * If a data was previously set, the object will lose the pointer for it,
21811     * so if needs to be freed, you must do it yourself.
21812     *
21813     * @see elm_map_group_class_new() for more details.
21814     * @see elm_map_group_class_icon_cb_set()
21815     * @see elm_map_marker_add()
21816     *
21817     * @ingroup Map
21818     */
21819    EAPI void                  elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
21820
21821    /**
21822     * Set the minimum zoom from where the markers are displayed.
21823     *
21824     * @param clas The group class.
21825     * @param zoom The minimum zoom.
21826     *
21827     * Markers only will be displayed when the map is displayed at @p zoom
21828     * or bigger.
21829     *
21830     * @see elm_map_group_class_new() for more details.
21831     * @see elm_map_marker_add()
21832     *
21833     * @ingroup Map
21834     */
21835    EAPI void                  elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
21836
21837    /**
21838     * Set the zoom from where the markers are no more grouped.
21839     *
21840     * @param clas The group class.
21841     * @param zoom The maximum zoom.
21842     *
21843     * Markers only will be grouped when the map is displayed at
21844     * less than @p zoom.
21845     *
21846     * @see elm_map_group_class_new() for more details.
21847     * @see elm_map_marker_add()
21848     *
21849     * @ingroup Map
21850     */
21851    EAPI void                  elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
21852
21853    /**
21854     * Set if the markers associated to the group class @clas are hidden or not.
21855     *
21856     * @param clas The group class.
21857     * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
21858     * to show them.
21859     *
21860     * If @p hide is @c EINA_TRUE the markers will be hidden, but default
21861     * is to show them.
21862     *
21863     * @ingroup Map
21864     */
21865    EAPI void                  elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
21866
21867    /**
21868     * Create a new marker class.
21869     *
21870     * @param obj The map object.
21871     * @return Returns the new group class.
21872     *
21873     * Each marker must be associated to a class.
21874     *
21875     * The marker class defines the style of the marker when a marker is
21876     * displayed alone, i.e., not grouped to to others markers. When grouped
21877     * it will use group class style.
21878     *
21879     * A marker class will need to be provided when creating a marker with
21880     * elm_map_marker_add().
21881     *
21882     * Some properties and functions can be set by class, as:
21883     * - style, with elm_map_marker_class_style_set()
21884     * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
21885     *   It can be set using elm_map_marker_class_icon_cb_set().
21886     * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
21887     *   Set using elm_map_marker_class_get_cb_set().
21888     * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
21889     *   Set using elm_map_marker_class_del_cb_set().
21890     *
21891     * @see elm_map_marker_add()
21892     * @see elm_map_marker_class_style_set()
21893     * @see elm_map_marker_class_icon_cb_set()
21894     * @see elm_map_marker_class_get_cb_set()
21895     * @see elm_map_marker_class_del_cb_set()
21896     *
21897     * @ingroup Map
21898     */
21899    EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
21900
21901    /**
21902     * Set the marker's style of a marker class.
21903     *
21904     * @param clas The marker class.
21905     * @param style The style to be used by markers.
21906     *
21907     * Each marker must be associated to a marker class, and will use the style
21908     * defined by such class when alone, i.e., @b not grouped to other markers.
21909     *
21910     * The following styles are provided by default theme:
21911     * @li @c radio
21912     * @li @c radio2
21913     * @li @c empty
21914     *
21915     * @see elm_map_marker_class_new() for more details.
21916     * @see elm_map_marker_add()
21917     *
21918     * @ingroup Map
21919     */
21920    EAPI void                  elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
21921
21922    /**
21923     * Set the icon callback function of a marker class.
21924     *
21925     * @param clas The marker class.
21926     * @param icon_get The callback function that will return the icon.
21927     *
21928     * Each marker must be associated to a marker class, and it can display a
21929     * custom icon. The function @p icon_get must return this icon.
21930     *
21931     * @see elm_map_marker_class_new() for more details.
21932     * @see elm_map_marker_add()
21933     *
21934     * @ingroup Map
21935     */
21936    EAPI void                  elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
21937
21938    /**
21939     * Set the bubble content callback function of a marker class.
21940     *
21941     * @param clas The marker class.
21942     * @param get The callback function that will return the content.
21943     *
21944     * Each marker must be associated to a marker class, and it can display a
21945     * a content on a bubble that opens when the user click over the marker.
21946     * The function @p get must return this content object.
21947     *
21948     * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
21949     * can be used.
21950     *
21951     * @see elm_map_marker_class_new() for more details.
21952     * @see elm_map_marker_class_del_cb_set()
21953     * @see elm_map_marker_add()
21954     *
21955     * @ingroup Map
21956     */
21957    EAPI void                  elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
21958
21959    /**
21960     * Set the callback function used to delete bubble content of a marker class.
21961     *
21962     * @param clas The marker class.
21963     * @param del The callback function that will delete the content.
21964     *
21965     * Each marker must be associated to a marker class, and it can display a
21966     * a content on a bubble that opens when the user click over the marker.
21967     * The function to return such content can be set with
21968     * elm_map_marker_class_get_cb_set().
21969     *
21970     * If this content must be freed, a callback function need to be
21971     * set for that task with this function.
21972     *
21973     * If this callback is defined it will have to delete (or not) the
21974     * object inside, but if the callback is not defined the object will be
21975     * destroyed with evas_object_del().
21976     *
21977     * @see elm_map_marker_class_new() for more details.
21978     * @see elm_map_marker_class_get_cb_set()
21979     * @see elm_map_marker_add()
21980     *
21981     * @ingroup Map
21982     */
21983    EAPI void                  elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
21984
21985    /**
21986     * Get the list of available sources.
21987     *
21988     * @param obj The map object.
21989     * @return The source names list.
21990     *
21991     * It will provide a list with all available sources, that can be set as
21992     * current source with elm_map_source_name_set(), or get with
21993     * elm_map_source_name_get().
21994     *
21995     * Available sources:
21996     * @li "Mapnik"
21997     * @li "Osmarender"
21998     * @li "CycleMap"
21999     * @li "Maplint"
22000     *
22001     * @see elm_map_source_name_set() for more details.
22002     * @see elm_map_source_name_get()
22003     *
22004     * @ingroup Map
22005     */
22006    EAPI const char          **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22007
22008    /**
22009     * Set the source of the map.
22010     *
22011     * @param obj The map object.
22012     * @param source The source to be used.
22013     *
22014     * Map widget retrieves images that composes the map from a web service.
22015     * This web service can be set with this method.
22016     *
22017     * A different service can return a different maps with different
22018     * information and it can use different zoom values.
22019     *
22020     * The @p source_name need to match one of the names provided by
22021     * elm_map_source_names_get().
22022     *
22023     * The current source can be get using elm_map_source_name_get().
22024     *
22025     * @see elm_map_source_names_get()
22026     * @see elm_map_source_name_get()
22027     *
22028     *
22029     * @ingroup Map
22030     */
22031    EAPI void                  elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
22032
22033    /**
22034     * Get the name of currently used source.
22035     *
22036     * @param obj The map object.
22037     * @return Returns the name of the source in use.
22038     *
22039     * @see elm_map_source_name_set() for more details.
22040     *
22041     * @ingroup Map
22042     */
22043    EAPI const char           *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22044
22045    /**
22046     * Set the source of the route service to be used by the map.
22047     *
22048     * @param obj The map object.
22049     * @param source The route service to be used, being it one of
22050     * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
22051     * and #ELM_MAP_ROUTE_SOURCE_ORS.
22052     *
22053     * Each one has its own algorithm, so the route retrieved may
22054     * differ depending on the source route. Now, only the default is working.
22055     *
22056     * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
22057     * http://www.yournavigation.org/.
22058     *
22059     * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
22060     * assumptions. Its routing core is based on Contraction Hierarchies.
22061     *
22062     * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
22063     *
22064     * @see elm_map_route_source_get().
22065     *
22066     * @ingroup Map
22067     */
22068    EAPI void                  elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
22069
22070    /**
22071     * Get the current route source.
22072     *
22073     * @param obj The map object.
22074     * @return The source of the route service used by the map.
22075     *
22076     * @see elm_map_route_source_set() for details.
22077     *
22078     * @ingroup Map
22079     */
22080    EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22081
22082    /**
22083     * Set the minimum zoom of the source.
22084     *
22085     * @param obj The map object.
22086     * @param zoom New minimum zoom value to be used.
22087     *
22088     * By default, it's 0.
22089     *
22090     * @ingroup Map
22091     */
22092    EAPI void                  elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22093
22094    /**
22095     * Get the minimum zoom of the source.
22096     *
22097     * @param obj The map object.
22098     * @return Returns the minimum zoom of the source.
22099     *
22100     * @see elm_map_source_zoom_min_set() for details.
22101     *
22102     * @ingroup Map
22103     */
22104    EAPI int                   elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22105
22106    /**
22107     * Set the maximum zoom of the source.
22108     *
22109     * @param obj The map object.
22110     * @param zoom New maximum zoom value to be used.
22111     *
22112     * By default, it's 18.
22113     *
22114     * @ingroup Map
22115     */
22116    EAPI void                  elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22117
22118    /**
22119     * Get the maximum zoom of the source.
22120     *
22121     * @param obj The map object.
22122     * @return Returns the maximum zoom of the source.
22123     *
22124     * @see elm_map_source_zoom_min_set() for details.
22125     *
22126     * @ingroup Map
22127     */
22128    EAPI int                   elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22129
22130    /**
22131     * Set the user agent used by the map object to access routing services.
22132     *
22133     * @param obj The map object.
22134     * @param user_agent The user agent to be used by the map.
22135     *
22136     * User agent is a client application implementing a network protocol used
22137     * in communications within a client–server distributed computing system
22138     *
22139     * The @p user_agent identification string will transmitted in a header
22140     * field @c User-Agent.
22141     *
22142     * @see elm_map_user_agent_get()
22143     *
22144     * @ingroup Map
22145     */
22146    EAPI void                  elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
22147
22148    /**
22149     * Get the user agent used by the map object.
22150     *
22151     * @param obj The map object.
22152     * @return The user agent identification string used by the map.
22153     *
22154     * @see elm_map_user_agent_set() for details.
22155     *
22156     * @ingroup Map
22157     */
22158    EAPI const char           *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22159
22160    /**
22161     * Add a new route to the map object.
22162     *
22163     * @param obj The map object.
22164     * @param type The type of transport to be considered when tracing a route.
22165     * @param method The routing method, what should be priorized.
22166     * @param flon The start longitude.
22167     * @param flat The start latitude.
22168     * @param tlon The destination longitude.
22169     * @param tlat The destination latitude.
22170     *
22171     * @return The created route or @c NULL upon failure.
22172     *
22173     * A route will be traced by point on coordinates (@p flat, @p flon)
22174     * to point on coordinates (@p tlat, @p tlon), using the route service
22175     * set with elm_map_route_source_set().
22176     *
22177     * It will take @p type on consideration to define the route,
22178     * depending if the user will be walking or driving, the route may vary.
22179     * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
22180     * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
22181     *
22182     * Another parameter is what the route should priorize, the minor distance
22183     * or the less time to be spend on the route. So @p method should be one
22184     * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
22185     *
22186     * Routes created with this method can be deleted with
22187     * elm_map_route_remove(), colored with elm_map_route_color_set(),
22188     * and distance can be get with elm_map_route_distance_get().
22189     *
22190     * @see elm_map_route_remove()
22191     * @see elm_map_route_color_set()
22192     * @see elm_map_route_distance_get()
22193     * @see elm_map_route_source_set()
22194     *
22195     * @ingroup Map
22196     */
22197    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);
22198
22199    /**
22200     * Remove a route from the map.
22201     *
22202     * @param route The route to remove.
22203     *
22204     * @see elm_map_route_add()
22205     *
22206     * @ingroup Map
22207     */
22208    EAPI void                  elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
22209
22210    /**
22211     * Set the route color.
22212     *
22213     * @param route The route object.
22214     * @param r Red channel value, from 0 to 255.
22215     * @param g Green channel value, from 0 to 255.
22216     * @param b Blue channel value, from 0 to 255.
22217     * @param a Alpha channel value, from 0 to 255.
22218     *
22219     * It uses an additive color model, so each color channel represents
22220     * how much of each primary colors must to be used. 0 represents
22221     * ausence of this color, so if all of the three are set to 0,
22222     * the color will be black.
22223     *
22224     * These component values should be integers in the range 0 to 255,
22225     * (single 8-bit byte).
22226     *
22227     * This sets the color used for the route. By default, it is set to
22228     * solid red (r = 255, g = 0, b = 0, a = 255).
22229     *
22230     * For alpha channel, 0 represents completely transparent, and 255, opaque.
22231     *
22232     * @see elm_map_route_color_get()
22233     *
22234     * @ingroup Map
22235     */
22236    EAPI void                  elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
22237
22238    /**
22239     * Get the route color.
22240     *
22241     * @param route The route object.
22242     * @param r Pointer where to store the red channel value.
22243     * @param g Pointer where to store the green channel value.
22244     * @param b Pointer where to store the blue channel value.
22245     * @param a Pointer where to store the alpha channel value.
22246     *
22247     * @see elm_map_route_color_set() for details.
22248     *
22249     * @ingroup Map
22250     */
22251    EAPI void                  elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
22252
22253    /**
22254     * Get the route distance in kilometers.
22255     *
22256     * @param route The route object.
22257     * @return The distance of route (unit : km).
22258     *
22259     * @ingroup Map
22260     */
22261    EAPI double                elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
22262
22263    /**
22264     * Get the information of route nodes.
22265     *
22266     * @param route The route object.
22267     * @return Returns a string with the nodes of route.
22268     *
22269     * @ingroup Map
22270     */
22271    EAPI const char           *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
22272
22273    /**
22274     * Get the information of route waypoint.
22275     *
22276     * @param route the route object.
22277     * @return Returns a string with information about waypoint of route.
22278     *
22279     * @ingroup Map
22280     */
22281    EAPI const char           *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
22282
22283    /**
22284     * Get the address of the name.
22285     *
22286     * @param name The name handle.
22287     * @return Returns the address string of @p name.
22288     *
22289     * This gets the coordinates of the @p name, created with one of the
22290     * conversion functions.
22291     *
22292     * @see elm_map_utils_convert_name_into_coord()
22293     * @see elm_map_utils_convert_coord_into_name()
22294     *
22295     * @ingroup Map
22296     */
22297    EAPI const char           *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
22298
22299    /**
22300     * Get the current coordinates of the name.
22301     *
22302     * @param name The name handle.
22303     * @param lat Pointer where to store the latitude.
22304     * @param lon Pointer where to store The longitude.
22305     *
22306     * This gets the coordinates of the @p name, created with one of the
22307     * conversion functions.
22308     *
22309     * @see elm_map_utils_convert_name_into_coord()
22310     * @see elm_map_utils_convert_coord_into_name()
22311     *
22312     * @ingroup Map
22313     */
22314    EAPI void                  elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
22315
22316    /**
22317     * Remove a name from the map.
22318     *
22319     * @param name The name to remove.
22320     *
22321     * Basically the struct handled by @p name will be freed, so convertions
22322     * between address and coordinates will be lost.
22323     *
22324     * @see elm_map_utils_convert_name_into_coord()
22325     * @see elm_map_utils_convert_coord_into_name()
22326     *
22327     * @ingroup Map
22328     */
22329    EAPI void                  elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
22330
22331    /**
22332     * Rotate the map.
22333     *
22334     * @param obj The map object.
22335     * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
22336     * @param cx Rotation's center horizontal position.
22337     * @param cy Rotation's center vertical position.
22338     *
22339     * @see elm_map_rotate_get()
22340     *
22341     * @ingroup Map
22342     */
22343    EAPI void                  elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
22344
22345    /**
22346     * Get the rotate degree of the map
22347     *
22348     * @param obj The map object
22349     * @param degree Pointer where to store degrees from 0.0 to 360.0
22350     * to rotate arount Z axis.
22351     * @param cx Pointer where to store rotation's center horizontal position.
22352     * @param cy Pointer where to store rotation's center vertical position.
22353     *
22354     * @see elm_map_rotate_set() to set map rotation.
22355     *
22356     * @ingroup Map
22357     */
22358    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);
22359
22360    /**
22361     * Enable or disable mouse wheel to be used to zoom in / out the map.
22362     *
22363     * @param obj The map object.
22364     * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
22365     * to enable it.
22366     *
22367     * Mouse wheel can be used for the user to zoom in or zoom out the map.
22368     *
22369     * It's disabled by default.
22370     *
22371     * @see elm_map_wheel_disabled_get()
22372     *
22373     * @ingroup Map
22374     */
22375    EAPI void                  elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22376
22377    /**
22378     * Get a value whether mouse wheel is enabled or not.
22379     *
22380     * @param obj The map object.
22381     * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
22382     * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22383     *
22384     * Mouse wheel can be used for the user to zoom in or zoom out the map.
22385     *
22386     * @see elm_map_wheel_disabled_set() for details.
22387     *
22388     * @ingroup Map
22389     */
22390    EAPI Eina_Bool             elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22391
22392 #ifdef ELM_EMAP
22393    /**
22394     * Add a track on the map
22395     *
22396     * @param obj The map object.
22397     * @param emap The emap route object.
22398     * @return The route object. This is an elm object of type Route.
22399     *
22400     * @see elm_route_add() for details.
22401     *
22402     * @ingroup Map
22403     */
22404    EAPI Evas_Object          *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
22405 #endif
22406
22407    /**
22408     * Remove a track from the map
22409     *
22410     * @param obj The map object.
22411     * @param route The track to remove.
22412     *
22413     * @ingroup Map
22414     */
22415    EAPI void                  elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
22416
22417    /**
22418     * @}
22419     */
22420
22421    /* Route */
22422    EAPI Evas_Object *elm_route_add(Evas_Object *parent);
22423 #ifdef ELM_EMAP
22424    EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
22425 #endif
22426    EAPI double elm_route_lon_min_get(Evas_Object *obj);
22427    EAPI double elm_route_lat_min_get(Evas_Object *obj);
22428    EAPI double elm_route_lon_max_get(Evas_Object *obj);
22429    EAPI double elm_route_lat_max_get(Evas_Object *obj);
22430
22431
22432    /**
22433     * @defgroup Panel Panel
22434     *
22435     * @image html img/widget/panel/preview-00.png
22436     * @image latex img/widget/panel/preview-00.eps
22437     *
22438     * @brief A panel is a type of animated container that contains subobjects.
22439     * It can be expanded or contracted by clicking the button on it's edge.
22440     *
22441     * Orientations are as follows:
22442     * @li ELM_PANEL_ORIENT_TOP
22443     * @li ELM_PANEL_ORIENT_LEFT
22444     * @li ELM_PANEL_ORIENT_RIGHT
22445     *
22446     * @ref tutorial_panel shows one way to use this widget.
22447     * @{
22448     */
22449    typedef enum _Elm_Panel_Orient
22450      {
22451         ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
22452         ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
22453         ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
22454         ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
22455      } Elm_Panel_Orient;
22456    /**
22457     * @brief Adds a panel object
22458     *
22459     * @param parent The parent object
22460     *
22461     * @return The panel object, or NULL on failure
22462     */
22463    EAPI Evas_Object          *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22464    /**
22465     * @brief Sets the orientation of the panel
22466     *
22467     * @param parent The parent object
22468     * @param orient The panel orientation. Can be one of the following:
22469     * @li ELM_PANEL_ORIENT_TOP
22470     * @li ELM_PANEL_ORIENT_LEFT
22471     * @li ELM_PANEL_ORIENT_RIGHT
22472     *
22473     * Sets from where the panel will (dis)appear.
22474     */
22475    EAPI void                  elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
22476    /**
22477     * @brief Get the orientation of the panel.
22478     *
22479     * @param obj The panel object
22480     * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
22481     */
22482    EAPI Elm_Panel_Orient      elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22483    /**
22484     * @brief Set the content of the panel.
22485     *
22486     * @param obj The panel object
22487     * @param content The panel content
22488     *
22489     * Once the content object is set, a previously set one will be deleted.
22490     * If you want to keep that old content object, use the
22491     * elm_panel_content_unset() function.
22492     */
22493    EAPI void                  elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22494    /**
22495     * @brief Get the content of the panel.
22496     *
22497     * @param obj The panel object
22498     * @return The content that is being used
22499     *
22500     * Return the content object which is set for this widget.
22501     *
22502     * @see elm_panel_content_set()
22503     */
22504    EAPI Evas_Object          *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22505    /**
22506     * @brief Unset the content of the panel.
22507     *
22508     * @param obj The panel object
22509     * @return The content that was being used
22510     *
22511     * Unparent and return the content object which was set for this widget.
22512     *
22513     * @see elm_panel_content_set()
22514     */
22515    EAPI Evas_Object          *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22516    /**
22517     * @brief Set the state of the panel.
22518     *
22519     * @param obj The panel object
22520     * @param hidden If true, the panel will run the animation to contract
22521     */
22522    EAPI void                  elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
22523    /**
22524     * @brief Get the state of the panel.
22525     *
22526     * @param obj The panel object
22527     * @param hidden If true, the panel is in the "hide" state
22528     */
22529    EAPI Eina_Bool             elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22530    /**
22531     * @brief Toggle the hidden state of the panel from code
22532     *
22533     * @param obj The panel object
22534     */
22535    EAPI void                  elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
22536    /**
22537     * @}
22538     */
22539
22540    /**
22541     * @defgroup Panes Panes
22542     * @ingroup Elementary
22543     *
22544     * @image html img/widget/panes/preview-00.png
22545     * @image latex img/widget/panes/preview-00.eps width=\textwidth
22546     *
22547     * @image html img/panes.png
22548     * @image latex img/panes.eps width=\textwidth
22549     *
22550     * The panes adds a dragable bar between two contents. When dragged
22551     * this bar will resize contents size.
22552     *
22553     * Panes can be displayed vertically or horizontally, and contents
22554     * size proportion can be customized (homogeneous by default).
22555     *
22556     * Smart callbacks one can listen to:
22557     * - "press" - The panes has been pressed (button wasn't released yet).
22558     * - "unpressed" - The panes was released after being pressed.
22559     * - "clicked" - The panes has been clicked>
22560     * - "clicked,double" - The panes has been double clicked
22561     *
22562     * Available styles for it:
22563     * - @c "default"
22564     *
22565     * Here is an example on its usage:
22566     * @li @ref panes_example
22567     */
22568
22569    /**
22570     * @addtogroup Panes
22571     * @{
22572     */
22573
22574    /**
22575     * Add a new panes widget to the given parent Elementary
22576     * (container) object.
22577     *
22578     * @param parent The parent object.
22579     * @return a new panes widget handle or @c NULL, on errors.
22580     *
22581     * This function inserts a new panes widget on the canvas.
22582     *
22583     * @ingroup Panes
22584     */
22585    EAPI Evas_Object          *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22586
22587    /**
22588     * Set the left content of the panes widget.
22589     *
22590     * @param obj The panes object.
22591     * @param content The new left content object.
22592     *
22593     * Once the content object is set, a previously set one will be deleted.
22594     * If you want to keep that old content object, use the
22595     * elm_panes_content_left_unset() function.
22596     *
22597     * If panes is displayed vertically, left content will be displayed at
22598     * top.
22599     *
22600     * @see elm_panes_content_left_get()
22601     * @see elm_panes_content_right_set() to set content on the other side.
22602     *
22603     * @ingroup Panes
22604     */
22605    EAPI void                  elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22606
22607    /**
22608     * Set the right content of the panes widget.
22609     *
22610     * @param obj The panes object.
22611     * @param content The new right content object.
22612     *
22613     * Once the content object is set, a previously set one will be deleted.
22614     * If you want to keep that old content object, use the
22615     * elm_panes_content_right_unset() function.
22616     *
22617     * If panes is displayed vertically, left content will be displayed at
22618     * bottom.
22619     *
22620     * @see elm_panes_content_right_get()
22621     * @see elm_panes_content_left_set() to set content on the other side.
22622     *
22623     * @ingroup Panes
22624     */
22625    EAPI void                  elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22626
22627    /**
22628     * Get the left content of the panes.
22629     *
22630     * @param obj The panes object.
22631     * @return The left content object that is being used.
22632     *
22633     * Return the left content object which is set for this widget.
22634     *
22635     * @see elm_panes_content_left_set() for details.
22636     *
22637     * @ingroup Panes
22638     */
22639    EAPI Evas_Object          *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22640
22641    /**
22642     * Get the right content of the panes.
22643     *
22644     * @param obj The panes object
22645     * @return The right content object that is being used
22646     *
22647     * Return the right content object which is set for this widget.
22648     *
22649     * @see elm_panes_content_right_set() for details.
22650     *
22651     * @ingroup Panes
22652     */
22653    EAPI Evas_Object          *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22654
22655    /**
22656     * Unset the left content used for the panes.
22657     *
22658     * @param obj The panes object.
22659     * @return The left content object that was being used.
22660     *
22661     * Unparent and return the left content object which was set for this widget.
22662     *
22663     * @see elm_panes_content_left_set() for details.
22664     * @see elm_panes_content_left_get().
22665     *
22666     * @ingroup Panes
22667     */
22668    EAPI Evas_Object          *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22669
22670    /**
22671     * Unset the right content used for the panes.
22672     *
22673     * @param obj The panes object.
22674     * @return The right content object that was being used.
22675     *
22676     * Unparent and return the right content object which was set for this
22677     * widget.
22678     *
22679     * @see elm_panes_content_right_set() for details.
22680     * @see elm_panes_content_right_get().
22681     *
22682     * @ingroup Panes
22683     */
22684    EAPI Evas_Object          *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22685
22686    /**
22687     * Get the size proportion of panes widget's left side.
22688     *
22689     * @param obj The panes object.
22690     * @return float value between 0.0 and 1.0 representing size proportion
22691     * of left side.
22692     *
22693     * @see elm_panes_content_left_size_set() for more details.
22694     *
22695     * @ingroup Panes
22696     */
22697    EAPI double                elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22698
22699    /**
22700     * Set the size proportion of panes widget's left side.
22701     *
22702     * @param obj The panes object.
22703     * @param size Value between 0.0 and 1.0 representing size proportion
22704     * of left side.
22705     *
22706     * By default it's homogeneous, i.e., both sides have the same size.
22707     *
22708     * If something different is required, it can be set with this function.
22709     * For example, if the left content should be displayed over
22710     * 75% of the panes size, @p size should be passed as @c 0.75.
22711     * This way, right content will be resized to 25% of panes size.
22712     *
22713     * If displayed vertically, left content is displayed at top, and
22714     * right content at bottom.
22715     *
22716     * @note This proportion will change when user drags the panes bar.
22717     *
22718     * @see elm_panes_content_left_size_get()
22719     *
22720     * @ingroup Panes
22721     */
22722    EAPI void                  elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
22723
22724   /**
22725    * Set the orientation of a given panes widget.
22726    *
22727    * @param obj The panes object.
22728    * @param horizontal Use @c EINA_TRUE to make @p obj to be
22729    * @b horizontal, @c EINA_FALSE to make it @b vertical.
22730    *
22731    * Use this function to change how your panes is to be
22732    * disposed: vertically or horizontally.
22733    *
22734    * By default it's displayed horizontally.
22735    *
22736    * @see elm_panes_horizontal_get()
22737    *
22738    * @ingroup Panes
22739    */
22740    EAPI void                  elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22741
22742    /**
22743     * Retrieve the orientation of a given panes widget.
22744     *
22745     * @param obj The panes object.
22746     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
22747     * @c EINA_FALSE if it's @b vertical (and on errors).
22748     *
22749     * @see elm_panes_horizontal_set() for more details.
22750     *
22751     * @ingroup Panes
22752     */
22753    EAPI Eina_Bool             elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22754
22755    /**
22756     * @}
22757     */
22758
22759    /**
22760     * @defgroup Flip Flip
22761     *
22762     * @image html img/widget/flip/preview-00.png
22763     * @image latex img/widget/flip/preview-00.eps
22764     *
22765     * This widget holds 2 content objects(Evas_Object): one on the front and one
22766     * on the back. It allows you to flip from front to back and vice-versa using
22767     * various animations.
22768     *
22769     * If either the front or back contents are not set the flip will treat that
22770     * as transparent. So if you wore to set the front content but not the back,
22771     * and then call elm_flip_go() you would see whatever is below the flip.
22772     *
22773     * For a list of supported animations see elm_flip_go().
22774     *
22775     * Signals that you can add callbacks for are:
22776     * "animate,begin" - when a flip animation was started
22777     * "animate,done" - when a flip animation is finished
22778     *
22779     * @ref tutorial_flip show how to use most of the API.
22780     *
22781     * @{
22782     */
22783    typedef enum _Elm_Flip_Mode
22784      {
22785         ELM_FLIP_ROTATE_Y_CENTER_AXIS,
22786         ELM_FLIP_ROTATE_X_CENTER_AXIS,
22787         ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
22788         ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
22789         ELM_FLIP_CUBE_LEFT,
22790         ELM_FLIP_CUBE_RIGHT,
22791         ELM_FLIP_CUBE_UP,
22792         ELM_FLIP_CUBE_DOWN,
22793         ELM_FLIP_PAGE_LEFT,
22794         ELM_FLIP_PAGE_RIGHT,
22795         ELM_FLIP_PAGE_UP,
22796         ELM_FLIP_PAGE_DOWN
22797      } Elm_Flip_Mode;
22798    typedef enum _Elm_Flip_Interaction
22799      {
22800         ELM_FLIP_INTERACTION_NONE,
22801         ELM_FLIP_INTERACTION_ROTATE,
22802         ELM_FLIP_INTERACTION_CUBE,
22803         ELM_FLIP_INTERACTION_PAGE
22804      } Elm_Flip_Interaction;
22805    typedef enum _Elm_Flip_Direction
22806      {
22807         ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
22808         ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
22809         ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
22810         ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
22811      } Elm_Flip_Direction;
22812    /**
22813     * @brief Add a new flip to the parent
22814     *
22815     * @param parent The parent object
22816     * @return The new object or NULL if it cannot be created
22817     */
22818    EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22819    /**
22820     * @brief Set the front content of the flip widget.
22821     *
22822     * @param obj The flip object
22823     * @param content The new front content object
22824     *
22825     * Once the content object is set, a previously set one will be deleted.
22826     * If you want to keep that old content object, use the
22827     * elm_flip_content_front_unset() function.
22828     */
22829    EAPI void         elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22830    /**
22831     * @brief Set the back content of the flip widget.
22832     *
22833     * @param obj The flip object
22834     * @param content The new back content object
22835     *
22836     * Once the content object is set, a previously set one will be deleted.
22837     * If you want to keep that old content object, use the
22838     * elm_flip_content_back_unset() function.
22839     */
22840    EAPI void         elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22841    /**
22842     * @brief Get the front content used for the flip
22843     *
22844     * @param obj The flip object
22845     * @return The front content object that is being used
22846     *
22847     * Return the front content object which is set for this widget.
22848     */
22849    EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22850    /**
22851     * @brief Get the back content used for the flip
22852     *
22853     * @param obj The flip object
22854     * @return The back content object that is being used
22855     *
22856     * Return the back content object which is set for this widget.
22857     */
22858    EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22859    /**
22860     * @brief Unset the front content used for the flip
22861     *
22862     * @param obj The flip object
22863     * @return The front content object that was being used
22864     *
22865     * Unparent and return the front content object which was set for this widget.
22866     */
22867    EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22868    /**
22869     * @brief Unset the back content used for the flip
22870     *
22871     * @param obj The flip object
22872     * @return The back content object that was being used
22873     *
22874     * Unparent and return the back content object which was set for this widget.
22875     */
22876    EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22877    /**
22878     * @brief Get flip front visibility state
22879     *
22880     * @param obj The flip objct
22881     * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
22882     * showing.
22883     */
22884    EAPI Eina_Bool    elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22885    /**
22886     * @brief Set flip perspective
22887     *
22888     * @param obj The flip object
22889     * @param foc The coordinate to set the focus on
22890     * @param x The X coordinate
22891     * @param y The Y coordinate
22892     *
22893     * @warning This function currently does nothing.
22894     */
22895    EAPI void         elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
22896    /**
22897     * @brief Runs the flip animation
22898     *
22899     * @param obj The flip object
22900     * @param mode The mode type
22901     *
22902     * Flips the front and back contents using the @p mode animation. This
22903     * efectively hides the currently visible content and shows the hidden one.
22904     *
22905     * There a number of possible animations to use for the flipping:
22906     * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
22907     * around a horizontal axis in the middle of its height, the other content
22908     * is shown as the other side of the flip.
22909     * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
22910     * around a vertical axis in the middle of its width, the other content is
22911     * shown as the other side of the flip.
22912     * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
22913     * around a diagonal axis in the middle of its width, the other content is
22914     * shown as the other side of the flip.
22915     * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
22916     * around a diagonal axis in the middle of its height, the other content is
22917     * shown as the other side of the flip.
22918     * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
22919     * as if the flip was a cube, the other content is show as the right face of
22920     * the cube.
22921     * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
22922     * right as if the flip was a cube, the other content is show as the left
22923     * face of the cube.
22924     * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
22925     * flip was a cube, the other content is show as the bottom face of the cube.
22926     * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
22927     * the flip was a cube, the other content is show as the upper face of the
22928     * cube.
22929     * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
22930     * if the flip was a book, the other content is shown as the page below that.
22931     * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
22932     * as if the flip was a book, the other content is shown as the page below
22933     * that.
22934     * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
22935     * flip was a book, the other content is shown as the page below that.
22936     * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
22937     * flip was a book, the other content is shown as the page below that.
22938     *
22939     * @image html elm_flip.png
22940     * @image latex elm_flip.eps width=\textwidth
22941     */
22942    EAPI void         elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
22943    /**
22944     * @brief Set the interactive flip mode
22945     *
22946     * @param obj The flip object
22947     * @param mode The interactive flip mode to use
22948     *
22949     * This sets if the flip should be interactive (allow user to click and
22950     * drag a side of the flip to reveal the back page and cause it to flip).
22951     * By default a flip is not interactive. You may also need to set which
22952     * sides of the flip are "active" for flipping and how much space they use
22953     * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
22954     * and elm_flip_interacton_direction_hitsize_set()
22955     *
22956     * The four avilable mode of interaction are:
22957     * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
22958     * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
22959     * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
22960     * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
22961     *
22962     * @note ELM_FLIP_INTERACTION_ROTATE won't cause
22963     * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
22964     * happen, those can only be acheived with elm_flip_go();
22965     */
22966    EAPI void         elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
22967    /**
22968     * @brief Get the interactive flip mode
22969     *
22970     * @param obj The flip object
22971     * @return The interactive flip mode
22972     *
22973     * Returns the interactive flip mode set by elm_flip_interaction_set()
22974     */
22975    EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
22976    /**
22977     * @brief Set which directions of the flip respond to interactive flip
22978     *
22979     * @param obj The flip object
22980     * @param dir The direction to change
22981     * @param enabled If that direction is enabled or not
22982     *
22983     * By default all directions are disabled, so you may want to enable the
22984     * desired directions for flipping if you need interactive flipping. You must
22985     * call this function once for each direction that should be enabled.
22986     *
22987     * @see elm_flip_interaction_set()
22988     */
22989    EAPI void         elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
22990    /**
22991     * @brief Get the enabled state of that flip direction
22992     *
22993     * @param obj The flip object
22994     * @param dir The direction to check
22995     * @return If that direction is enabled or not
22996     *
22997     * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
22998     *
22999     * @see elm_flip_interaction_set()
23000     */
23001    EAPI Eina_Bool    elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
23002    /**
23003     * @brief Set the amount of the flip that is sensitive to interactive flip
23004     *
23005     * @param obj The flip object
23006     * @param dir The direction to modify
23007     * @param hitsize The amount of that dimension (0.0 to 1.0) to use
23008     *
23009     * Set the amount of the flip that is sensitive to interactive flip, with 0
23010     * representing no area in the flip and 1 representing the entire flip. There
23011     * is however a consideration to be made in that the area will never be
23012     * smaller than the finger size set(as set in your Elementary configuration).
23013     *
23014     * @see elm_flip_interaction_set()
23015     */
23016    EAPI void         elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
23017    /**
23018     * @brief Get the amount of the flip that is sensitive to interactive flip
23019     *
23020     * @param obj The flip object
23021     * @param dir The direction to check
23022     * @return The size set for that direction
23023     *
23024     * Returns the amount os sensitive area set by
23025     * elm_flip_interacton_direction_hitsize_set().
23026     */
23027    EAPI double       elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
23028    /**
23029     * @}
23030     */
23031
23032    /* scrolledentry */
23033    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23034    EINA_DEPRECATED EAPI void         elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
23035    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23036    EINA_DEPRECATED EAPI void         elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
23037    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23038    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
23039    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23040    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
23041    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23042    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23043    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
23044    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
23045    EINA_DEPRECATED EAPI void         elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
23046    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23047    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
23048    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
23049    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
23050    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
23051    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
23052    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
23053    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
23054    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
23055    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
23056    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
23057    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
23058    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
23059    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23060    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23061    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23062    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23063    EINA_DEPRECATED EAPI int          elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23064    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
23065    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
23066    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
23067    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
23068    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);
23069    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23070    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23071    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);
23072    EINA_DEPRECATED EAPI void         elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
23073    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);
23074    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
23075    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23076    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23077    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
23078    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
23079    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23080    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23081    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
23082    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);
23083    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);
23084    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);
23085    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);
23086    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);
23087    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);
23088    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
23089    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
23090    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
23091    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
23092    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23093    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
23094    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
23095
23096    /**
23097     * @defgroup Conformant Conformant
23098     * @ingroup Elementary
23099     *
23100     * @image html img/widget/conformant/preview-00.png
23101     * @image latex img/widget/conformant/preview-00.eps width=\textwidth
23102     *
23103     * @image html img/conformant.png
23104     * @image latex img/conformant.eps width=\textwidth
23105     *
23106     * The aim is to provide a widget that can be used in elementary apps to
23107     * account for space taken up by the indicator, virtual keypad & softkey
23108     * windows when running the illume2 module of E17.
23109     *
23110     * So conformant content will be sized and positioned considering the
23111     * space required for such stuff, and when they popup, as a keyboard
23112     * shows when an entry is selected, conformant content won't change.
23113     *
23114     * Available styles for it:
23115     * - @c "default"
23116     *
23117     * See how to use this widget in this example:
23118     * @ref conformant_example
23119     */
23120
23121    /**
23122     * @addtogroup Conformant
23123     * @{
23124     */
23125
23126    /**
23127     * Add a new conformant widget to the given parent Elementary
23128     * (container) object.
23129     *
23130     * @param parent The parent object.
23131     * @return A new conformant widget handle or @c NULL, on errors.
23132     *
23133     * This function inserts a new conformant widget on the canvas.
23134     *
23135     * @ingroup Conformant
23136     */
23137    EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23138
23139    /**
23140     * Set the content of the conformant widget.
23141     *
23142     * @param obj The conformant object.
23143     * @param content The content to be displayed by the conformant.
23144     *
23145     * Content will be sized and positioned considering the space required
23146     * to display a virtual keyboard. So it won't fill all the conformant
23147     * size. This way is possible to be sure that content won't resize
23148     * or be re-positioned after the keyboard is displayed.
23149     *
23150     * Once the content object is set, a previously set one will be deleted.
23151     * If you want to keep that old content object, use the
23152     * elm_conformat_content_unset() function.
23153     *
23154     * @see elm_conformant_content_unset()
23155     * @see elm_conformant_content_get()
23156     *
23157     * @ingroup Conformant
23158     */
23159    EAPI void         elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23160
23161    /**
23162     * Get the content of the conformant widget.
23163     *
23164     * @param obj The conformant object.
23165     * @return The content that is being used.
23166     *
23167     * Return the content object which is set for this widget.
23168     * It won't be unparent from conformant. For that, use
23169     * elm_conformant_content_unset().
23170     *
23171     * @see elm_conformant_content_set() for more details.
23172     * @see elm_conformant_content_unset()
23173     *
23174     * @ingroup Conformant
23175     */
23176    EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23177
23178    /**
23179     * Unset the content of the conformant widget.
23180     *
23181     * @param obj The conformant object.
23182     * @return The content that was being used.
23183     *
23184     * Unparent and return the content object which was set for this widget.
23185     *
23186     * @see elm_conformant_content_set() for more details.
23187     *
23188     * @ingroup Conformant
23189     */
23190    EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23191
23192    /**
23193     * Returns the Evas_Object that represents the content area.
23194     *
23195     * @param obj The conformant object.
23196     * @return The content area of the widget.
23197     *
23198     * @ingroup Conformant
23199     */
23200    EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23201
23202    /**
23203     * @}
23204     */
23205
23206    /**
23207     * @defgroup Mapbuf Mapbuf
23208     * @ingroup Elementary
23209     *
23210     * @image html img/widget/mapbuf/preview-00.png
23211     * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
23212     *
23213     * This holds one content object and uses an Evas Map of transformation
23214     * points to be later used with this content. So the content will be
23215     * moved, resized, etc as a single image. So it will improve performance
23216     * when you have a complex interafce, with a lot of elements, and will
23217     * need to resize or move it frequently (the content object and its
23218     * children).
23219     *
23220     * See how to use this widget in this example:
23221     * @ref mapbuf_example
23222     */
23223
23224    /**
23225     * @addtogroup Mapbuf
23226     * @{
23227     */
23228
23229    /**
23230     * Add a new mapbuf widget to the given parent Elementary
23231     * (container) object.
23232     *
23233     * @param parent The parent object.
23234     * @return A new mapbuf widget handle or @c NULL, on errors.
23235     *
23236     * This function inserts a new mapbuf widget on the canvas.
23237     *
23238     * @ingroup Mapbuf
23239     */
23240    EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23241
23242    /**
23243     * Set the content of the mapbuf.
23244     *
23245     * @param obj The mapbuf object.
23246     * @param content The content that will be filled in this mapbuf object.
23247     *
23248     * Once the content object is set, a previously set one will be deleted.
23249     * If you want to keep that old content object, use the
23250     * elm_mapbuf_content_unset() function.
23251     *
23252     * To enable map, elm_mapbuf_enabled_set() should be used.
23253     *
23254     * @ingroup Mapbuf
23255     */
23256    EAPI void         elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23257
23258    /**
23259     * Get the content of the mapbuf.
23260     *
23261     * @param obj The mapbuf object.
23262     * @return The content that is being used.
23263     *
23264     * Return the content object which is set for this widget.
23265     *
23266     * @see elm_mapbuf_content_set() for details.
23267     *
23268     * @ingroup Mapbuf
23269     */
23270    EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23271
23272    /**
23273     * Unset the content of the mapbuf.
23274     *
23275     * @param obj The mapbuf object.
23276     * @return The content that was being used.
23277     *
23278     * Unparent and return the content object which was set for this widget.
23279     *
23280     * @see elm_mapbuf_content_set() for details.
23281     *
23282     * @ingroup Mapbuf
23283     */
23284    EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23285
23286    /**
23287     * Enable or disable the map.
23288     *
23289     * @param obj The mapbuf object.
23290     * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
23291     *
23292     * This enables the map that is set or disables it. On enable, the object
23293     * geometry will be saved, and the new geometry will change (position and
23294     * size) to reflect the map geometry set.
23295     *
23296     * Also, when enabled, alpha and smooth states will be used, so if the
23297     * content isn't solid, alpha should be enabled, for example, otherwise
23298     * a black retangle will fill the content.
23299     *
23300     * When disabled, the stored map will be freed and geometry prior to
23301     * enabling the map will be restored.
23302     *
23303     * It's disabled by default.
23304     *
23305     * @see elm_mapbuf_alpha_set()
23306     * @see elm_mapbuf_smooth_set()
23307     *
23308     * @ingroup Mapbuf
23309     */
23310    EAPI void         elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23311
23312    /**
23313     * Get a value whether map is enabled or not.
23314     *
23315     * @param obj The mapbuf object.
23316     * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
23317     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23318     *
23319     * @see elm_mapbuf_enabled_set() for details.
23320     *
23321     * @ingroup Mapbuf
23322     */
23323    EAPI Eina_Bool    elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23324
23325    /**
23326     * Enable or disable smooth map rendering.
23327     *
23328     * @param obj The mapbuf object.
23329     * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
23330     * to disable it.
23331     *
23332     * This sets smoothing for map rendering. If the object is a type that has
23333     * its own smoothing settings, then both the smooth settings for this object
23334     * and the map must be turned off.
23335     *
23336     * By default smooth maps are enabled.
23337     *
23338     * @ingroup Mapbuf
23339     */
23340    EAPI void         elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
23341
23342    /**
23343     * Get a value whether smooth map rendering is enabled or not.
23344     *
23345     * @param obj The mapbuf object.
23346     * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
23347     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23348     *
23349     * @see elm_mapbuf_smooth_set() for details.
23350     *
23351     * @ingroup Mapbuf
23352     */
23353    EAPI Eina_Bool    elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23354
23355    /**
23356     * Set or unset alpha flag for map rendering.
23357     *
23358     * @param obj The mapbuf object.
23359     * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
23360     * to disable it.
23361     *
23362     * This sets alpha flag for map rendering. If the object is a type that has
23363     * its own alpha settings, then this will take precedence. Only image objects
23364     * have this currently. It stops alpha blending of the map area, and is
23365     * useful if you know the object and/or all sub-objects is 100% solid.
23366     *
23367     * Alpha is enabled by default.
23368     *
23369     * @ingroup Mapbuf
23370     */
23371    EAPI void         elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
23372
23373    /**
23374     * Get a value whether alpha blending is enabled or not.
23375     *
23376     * @param obj The mapbuf object.
23377     * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
23378     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23379     *
23380     * @see elm_mapbuf_alpha_set() for details.
23381     *
23382     * @ingroup Mapbuf
23383     */
23384    EAPI Eina_Bool    elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23385
23386    /**
23387     * @}
23388     */
23389
23390    /**
23391     * @defgroup Flipselector Flip Selector
23392     *
23393     * @image html img/widget/flipselector/preview-00.png
23394     * @image latex img/widget/flipselector/preview-00.eps
23395     *
23396     * A flip selector is a widget to show a set of @b text items, one
23397     * at a time, with the same sheet switching style as the @ref Clock
23398     * "clock" widget, when one changes the current displaying sheet
23399     * (thus, the "flip" in the name).
23400     *
23401     * User clicks to flip sheets which are @b held for some time will
23402     * make the flip selector to flip continuosly and automatically for
23403     * the user. The interval between flips will keep growing in time,
23404     * so that it helps the user to reach an item which is distant from
23405     * the current selection.
23406     *
23407     * Smart callbacks one can register to:
23408     * - @c "selected" - when the widget's selected text item is changed
23409     * - @c "overflowed" - when the widget's current selection is changed
23410     *   from the first item in its list to the last
23411     * - @c "underflowed" - when the widget's current selection is changed
23412     *   from the last item in its list to the first
23413     *
23414     * Available styles for it:
23415     * - @c "default"
23416     *
23417     * Here is an example on its usage:
23418     * @li @ref flipselector_example
23419     */
23420
23421    /**
23422     * @addtogroup Flipselector
23423     * @{
23424     */
23425
23426    typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
23427
23428    /**
23429     * Add a new flip selector widget to the given parent Elementary
23430     * (container) widget
23431     *
23432     * @param parent The parent object
23433     * @return a new flip selector widget handle or @c NULL, on errors
23434     *
23435     * This function inserts a new flip selector widget on the canvas.
23436     *
23437     * @ingroup Flipselector
23438     */
23439    EAPI Evas_Object               *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23440
23441    /**
23442     * Programmatically select the next item of a flip selector widget
23443     *
23444     * @param obj The flipselector object
23445     *
23446     * @note The selection will be animated. Also, if it reaches the
23447     * end of its list of member items, it will continue with the first
23448     * one onwards.
23449     *
23450     * @ingroup Flipselector
23451     */
23452    EAPI void                       elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
23453
23454    /**
23455     * Programmatically select the previous item of a flip selector
23456     * widget
23457     *
23458     * @param obj The flipselector object
23459     *
23460     * @note The selection will be animated.  Also, if it reaches the
23461     * beginning of its list of member items, it will continue with the
23462     * last one backwards.
23463     *
23464     * @ingroup Flipselector
23465     */
23466    EAPI void                       elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
23467
23468    /**
23469     * Append a (text) item to a flip selector widget
23470     *
23471     * @param obj The flipselector object
23472     * @param label The (text) label of the new item
23473     * @param func Convenience callback function to take place when
23474     * item is selected
23475     * @param data Data passed to @p func, above
23476     * @return A handle to the item added or @c NULL, on errors
23477     *
23478     * The widget's list of labels to show will be appended with the
23479     * given value. If the user wishes so, a callback function pointer
23480     * can be passed, which will get called when this same item is
23481     * selected.
23482     *
23483     * @note The current selection @b won't be modified by appending an
23484     * element to the list.
23485     *
23486     * @note The maximum length of the text label is going to be
23487     * determined <b>by the widget's theme</b>. Strings larger than
23488     * that value are going to be @b truncated.
23489     *
23490     * @ingroup Flipselector
23491     */
23492    EAPI Elm_Flipselector_Item     *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
23493
23494    /**
23495     * Prepend a (text) item to a flip selector widget
23496     *
23497     * @param obj The flipselector object
23498     * @param label The (text) label of the new item
23499     * @param func Convenience callback function to take place when
23500     * item is selected
23501     * @param data Data passed to @p func, above
23502     * @return A handle to the item added or @c NULL, on errors
23503     *
23504     * The widget's list of labels to show will be prepended with the
23505     * given value. If the user wishes so, a callback function pointer
23506     * can be passed, which will get called when this same item is
23507     * selected.
23508     *
23509     * @note The current selection @b won't be modified by prepending
23510     * an element to the list.
23511     *
23512     * @note The maximum length of the text label is going to be
23513     * determined <b>by the widget's theme</b>. Strings larger than
23514     * that value are going to be @b truncated.
23515     *
23516     * @ingroup Flipselector
23517     */
23518    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
23519
23520    /**
23521     * Get the internal list of items in a given flip selector widget.
23522     *
23523     * @param obj The flipselector object
23524     * @return The list of items (#Elm_Flipselector_Item as data) or
23525     * @c NULL on errors.
23526     *
23527     * This list is @b not to be modified in any way and must not be
23528     * freed. Use the list members with functions like
23529     * elm_flipselector_item_label_set(),
23530     * elm_flipselector_item_label_get(),
23531     * elm_flipselector_item_del(),
23532     * elm_flipselector_item_selected_get(),
23533     * elm_flipselector_item_selected_set().
23534     *
23535     * @warning This list is only valid until @p obj object's internal
23536     * items list is changed. It should be fetched again with another
23537     * call to this function when changes happen.
23538     *
23539     * @ingroup Flipselector
23540     */
23541    EAPI const Eina_List           *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23542
23543    /**
23544     * Get the first item in the given flip selector widget's list of
23545     * items.
23546     *
23547     * @param obj The flipselector object
23548     * @return The first item or @c NULL, if it has no items (and on
23549     * errors)
23550     *
23551     * @see elm_flipselector_item_append()
23552     * @see elm_flipselector_last_item_get()
23553     *
23554     * @ingroup Flipselector
23555     */
23556    EAPI Elm_Flipselector_Item     *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23557
23558    /**
23559     * Get the last item in the given flip selector widget's list of
23560     * items.
23561     *
23562     * @param obj The flipselector object
23563     * @return The last item or @c NULL, if it has no items (and on
23564     * errors)
23565     *
23566     * @see elm_flipselector_item_prepend()
23567     * @see elm_flipselector_first_item_get()
23568     *
23569     * @ingroup Flipselector
23570     */
23571    EAPI Elm_Flipselector_Item     *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23572
23573    /**
23574     * Get the currently selected item in a flip selector widget.
23575     *
23576     * @param obj The flipselector object
23577     * @return The selected item or @c NULL, if the widget has no items
23578     * (and on erros)
23579     *
23580     * @ingroup Flipselector
23581     */
23582    EAPI Elm_Flipselector_Item     *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23583
23584    /**
23585     * Set whether a given flip selector widget's item should be the
23586     * currently selected one.
23587     *
23588     * @param item The flip selector item
23589     * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
23590     *
23591     * This sets whether @p item is or not the selected (thus, under
23592     * display) one. If @p item is different than one under display,
23593     * the latter will be unselected. If the @p item is set to be
23594     * unselected, on the other hand, the @b first item in the widget's
23595     * internal members list will be the new selected one.
23596     *
23597     * @see elm_flipselector_item_selected_get()
23598     *
23599     * @ingroup Flipselector
23600     */
23601    EAPI void                       elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
23602
23603    /**
23604     * Get whether a given flip selector widget's item is the currently
23605     * selected one.
23606     *
23607     * @param item The flip selector item
23608     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
23609     * (or on errors).
23610     *
23611     * @see elm_flipselector_item_selected_set()
23612     *
23613     * @ingroup Flipselector
23614     */
23615    EAPI Eina_Bool                  elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23616
23617    /**
23618     * Delete a given item from a flip selector widget.
23619     *
23620     * @param item The item to delete
23621     *
23622     * @ingroup Flipselector
23623     */
23624    EAPI void                       elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23625
23626    /**
23627     * Get the label of a given flip selector widget's item.
23628     *
23629     * @param item The item to get label from
23630     * @return The text label of @p item or @c NULL, on errors
23631     *
23632     * @see elm_flipselector_item_label_set()
23633     *
23634     * @ingroup Flipselector
23635     */
23636    EAPI const char                *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23637
23638    /**
23639     * Set the label of a given flip selector widget's item.
23640     *
23641     * @param item The item to set label on
23642     * @param label The text label string, in UTF-8 encoding
23643     *
23644     * @see elm_flipselector_item_label_get()
23645     *
23646     * @ingroup Flipselector
23647     */
23648    EAPI void                       elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
23649
23650    /**
23651     * Gets the item before @p item in a flip selector widget's
23652     * internal list of items.
23653     *
23654     * @param item The item to fetch previous from
23655     * @return The item before the @p item, in its parent's list. If
23656     *         there is no previous item for @p item or there's an
23657     *         error, @c NULL is returned.
23658     *
23659     * @see elm_flipselector_item_next_get()
23660     *
23661     * @ingroup Flipselector
23662     */
23663    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23664
23665    /**
23666     * Gets the item after @p item in a flip selector widget's
23667     * internal list of items.
23668     *
23669     * @param item The item to fetch next from
23670     * @return The item after the @p item, in its parent's list. If
23671     *         there is no next item for @p item or there's an
23672     *         error, @c NULL is returned.
23673     *
23674     * @see elm_flipselector_item_next_get()
23675     *
23676     * @ingroup Flipselector
23677     */
23678    EAPI Elm_Flipselector_Item     *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23679
23680    /**
23681     * Set the interval on time updates for an user mouse button hold
23682     * on a flip selector widget.
23683     *
23684     * @param obj The flip selector object
23685     * @param interval The (first) interval value in seconds
23686     *
23687     * This interval value is @b decreased while the user holds the
23688     * mouse pointer either flipping up or flipping doww a given flip
23689     * selector.
23690     *
23691     * This helps the user to get to a given item distant from the
23692     * current one easier/faster, as it will start to flip quicker and
23693     * quicker on mouse button holds.
23694     *
23695     * The calculation for the next flip interval value, starting from
23696     * the one set with this call, is the previous interval divided by
23697     * 1.05, so it decreases a little bit.
23698     *
23699     * The default starting interval value for automatic flips is
23700     * @b 0.85 seconds.
23701     *
23702     * @see elm_flipselector_interval_get()
23703     *
23704     * @ingroup Flipselector
23705     */
23706    EAPI void                       elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
23707
23708    /**
23709     * Get the interval on time updates for an user mouse button hold
23710     * on a flip selector widget.
23711     *
23712     * @param obj The flip selector object
23713     * @return The (first) interval value, in seconds, set on it
23714     *
23715     * @see elm_flipselector_interval_set() for more details
23716     *
23717     * @ingroup Flipselector
23718     */
23719    EAPI double                     elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23720    /**
23721     * @}
23722     */
23723
23724    /**
23725     * @addtogroup Calendar
23726     * @{
23727     */
23728
23729    /**
23730     * @enum _Elm_Calendar_Mark_Repeat
23731     * @typedef Elm_Calendar_Mark_Repeat
23732     *
23733     * Event periodicity, used to define if a mark should be repeated
23734     * @b beyond event's day. It's set when a mark is added.
23735     *
23736     * So, for a mark added to 13th May with periodicity set to WEEKLY,
23737     * there will be marks every week after this date. Marks will be displayed
23738     * at 13th, 20th, 27th, 3rd June ...
23739     *
23740     * Values don't work as bitmask, only one can be choosen.
23741     *
23742     * @see elm_calendar_mark_add()
23743     *
23744     * @ingroup Calendar
23745     */
23746    typedef enum _Elm_Calendar_Mark_Repeat
23747      {
23748         ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
23749         ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
23750         ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
23751         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*/
23752         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. */
23753      } Elm_Calendar_Mark_Repeat;
23754
23755    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(). */
23756
23757    /**
23758     * Add a new calendar widget to the given parent Elementary
23759     * (container) object.
23760     *
23761     * @param parent The parent object.
23762     * @return a new calendar widget handle or @c NULL, on errors.
23763     *
23764     * This function inserts a new calendar widget on the canvas.
23765     *
23766     * @ref calendar_example_01
23767     *
23768     * @ingroup Calendar
23769     */
23770    EAPI Evas_Object       *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23771
23772    /**
23773     * Get weekdays names displayed by the calendar.
23774     *
23775     * @param obj The calendar object.
23776     * @return Array of seven strings to be used as weekday names.
23777     *
23778     * By default, weekdays abbreviations get from system are displayed:
23779     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
23780     * The first string is related to Sunday, the second to Monday...
23781     *
23782     * @see elm_calendar_weekdays_name_set()
23783     *
23784     * @ref calendar_example_05
23785     *
23786     * @ingroup Calendar
23787     */
23788    EAPI const char       **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23789
23790    /**
23791     * Set weekdays names to be displayed by the calendar.
23792     *
23793     * @param obj The calendar object.
23794     * @param weekdays Array of seven strings to be used as weekday names.
23795     * @warning It must have 7 elements, or it will access invalid memory.
23796     * @warning The strings must be NULL terminated ('@\0').
23797     *
23798     * By default, weekdays abbreviations get from system are displayed:
23799     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
23800     *
23801     * The first string should be related to Sunday, the second to Monday...
23802     *
23803     * The usage should be like this:
23804     * @code
23805     *   const char *weekdays[] =
23806     *   {
23807     *      "Sunday", "Monday", "Tuesday", "Wednesday",
23808     *      "Thursday", "Friday", "Saturday"
23809     *   };
23810     *   elm_calendar_weekdays_names_set(calendar, weekdays);
23811     * @endcode
23812     *
23813     * @see elm_calendar_weekdays_name_get()
23814     *
23815     * @ref calendar_example_02
23816     *
23817     * @ingroup Calendar
23818     */
23819    EAPI void               elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
23820
23821    /**
23822     * Set the minimum and maximum values for the year
23823     *
23824     * @param obj The calendar object
23825     * @param min The minimum year, greater than 1901;
23826     * @param max The maximum year;
23827     *
23828     * Maximum must be greater than minimum, except if you don't wan't to set
23829     * maximum year.
23830     * Default values are 1902 and -1.
23831     *
23832     * If the maximum year is a negative value, it will be limited depending
23833     * on the platform architecture (year 2037 for 32 bits);
23834     *
23835     * @see elm_calendar_min_max_year_get()
23836     *
23837     * @ref calendar_example_03
23838     *
23839     * @ingroup Calendar
23840     */
23841    EAPI void               elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
23842
23843    /**
23844     * Get the minimum and maximum values for the year
23845     *
23846     * @param obj The calendar object.
23847     * @param min The minimum year.
23848     * @param max The maximum year.
23849     *
23850     * Default values are 1902 and -1.
23851     *
23852     * @see elm_calendar_min_max_year_get() for more details.
23853     *
23854     * @ref calendar_example_05
23855     *
23856     * @ingroup Calendar
23857     */
23858    EAPI void               elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
23859
23860    /**
23861     * Enable or disable day selection
23862     *
23863     * @param obj The calendar object.
23864     * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
23865     * disable it.
23866     *
23867     * Enabled by default. If disabled, the user still can select months,
23868     * but not days. Selected days are highlighted on calendar.
23869     * It should be used if you won't need such selection for the widget usage.
23870     *
23871     * When a day is selected, or month is changed, smart callbacks for
23872     * signal "changed" will be called.
23873     *
23874     * @see elm_calendar_day_selection_enable_get()
23875     *
23876     * @ref calendar_example_04
23877     *
23878     * @ingroup Calendar
23879     */
23880    EAPI void               elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23881
23882    /**
23883     * Get a value whether day selection is enabled or not.
23884     *
23885     * @see elm_calendar_day_selection_enable_set() for details.
23886     *
23887     * @param obj The calendar object.
23888     * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
23889     * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
23890     *
23891     * @ref calendar_example_05
23892     *
23893     * @ingroup Calendar
23894     */
23895    EAPI Eina_Bool          elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23896
23897
23898    /**
23899     * Set selected date to be highlighted on calendar.
23900     *
23901     * @param obj The calendar object.
23902     * @param selected_time A @b tm struct to represent the selected date.
23903     *
23904     * Set the selected date, changing the displayed month if needed.
23905     * Selected date changes when the user goes to next/previous month or
23906     * select a day pressing over it on calendar.
23907     *
23908     * @see elm_calendar_selected_time_get()
23909     *
23910     * @ref calendar_example_04
23911     *
23912     * @ingroup Calendar
23913     */
23914    EAPI void               elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
23915
23916    /**
23917     * Get selected date.
23918     *
23919     * @param obj The calendar object
23920     * @param selected_time A @b tm struct to point to selected date
23921     * @return EINA_FALSE means an error ocurred and returned time shouldn't
23922     * be considered.
23923     *
23924     * Get date selected by the user or set by function
23925     * elm_calendar_selected_time_set().
23926     * Selected date changes when the user goes to next/previous month or
23927     * select a day pressing over it on calendar.
23928     *
23929     * @see elm_calendar_selected_time_get()
23930     *
23931     * @ref calendar_example_05
23932     *
23933     * @ingroup Calendar
23934     */
23935    EAPI Eina_Bool          elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
23936
23937    /**
23938     * Set a function to format the string that will be used to display
23939     * month and year;
23940     *
23941     * @param obj The calendar object
23942     * @param format_function Function to set the month-year string given
23943     * the selected date
23944     *
23945     * By default it uses strftime with "%B %Y" format string.
23946     * It should allocate the memory that will be used by the string,
23947     * that will be freed by the widget after usage.
23948     * A pointer to the string and a pointer to the time struct will be provided.
23949     *
23950     * Example:
23951     * @code
23952     * static char *
23953     * _format_month_year(struct tm *selected_time)
23954     * {
23955     *    char buf[32];
23956     *    if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
23957     *    return strdup(buf);
23958     * }
23959     *
23960     * elm_calendar_format_function_set(calendar, _format_month_year);
23961     * @endcode
23962     *
23963     * @ref calendar_example_02
23964     *
23965     * @ingroup Calendar
23966     */
23967    EAPI void               elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
23968
23969    /**
23970     * Add a new mark to the calendar
23971     *
23972     * @param obj The calendar object
23973     * @param mark_type A string used to define the type of mark. It will be
23974     * emitted to the theme, that should display a related modification on these
23975     * days representation.
23976     * @param mark_time A time struct to represent the date of inclusion of the
23977     * mark. For marks that repeats it will just be displayed after the inclusion
23978     * date in the calendar.
23979     * @param repeat Repeat the event following this periodicity. Can be a unique
23980     * mark (that don't repeat), daily, weekly, monthly or annually.
23981     * @return The created mark or @p NULL upon failure.
23982     *
23983     * Add a mark that will be drawn in the calendar respecting the insertion
23984     * time and periodicity. It will emit the type as signal to the widget theme.
23985     * Default theme supports "holiday" and "checked", but it can be extended.
23986     *
23987     * It won't immediately update the calendar, drawing the marks.
23988     * For this, call elm_calendar_marks_draw(). However, when user selects
23989     * next or previous month calendar forces marks drawn.
23990     *
23991     * Marks created with this method can be deleted with
23992     * elm_calendar_mark_del().
23993     *
23994     * Example
23995     * @code
23996     * struct tm selected_time;
23997     * time_t current_time;
23998     *
23999     * current_time = time(NULL) + 5 * 84600;
24000     * localtime_r(&current_time, &selected_time);
24001     * elm_calendar_mark_add(cal, "holiday", selected_time,
24002     *     ELM_CALENDAR_ANNUALLY);
24003     *
24004     * current_time = time(NULL) + 1 * 84600;
24005     * localtime_r(&current_time, &selected_time);
24006     * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
24007     *
24008     * elm_calendar_marks_draw(cal);
24009     * @endcode
24010     *
24011     * @see elm_calendar_marks_draw()
24012     * @see elm_calendar_mark_del()
24013     *
24014     * @ref calendar_example_06
24015     *
24016     * @ingroup Calendar
24017     */
24018    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);
24019
24020    /**
24021     * Delete mark from the calendar.
24022     *
24023     * @param mark The mark to be deleted.
24024     *
24025     * If deleting all calendar marks is required, elm_calendar_marks_clear()
24026     * should be used instead of getting marks list and deleting each one.
24027     *
24028     * @see elm_calendar_mark_add()
24029     *
24030     * @ref calendar_example_06
24031     *
24032     * @ingroup Calendar
24033     */
24034    EAPI void               elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
24035
24036    /**
24037     * Remove all calendar's marks
24038     *
24039     * @param obj The calendar object.
24040     *
24041     * @see elm_calendar_mark_add()
24042     * @see elm_calendar_mark_del()
24043     *
24044     * @ingroup Calendar
24045     */
24046    EAPI void               elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24047
24048
24049    /**
24050     * Get a list of all the calendar marks.
24051     *
24052     * @param obj The calendar object.
24053     * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
24054     *
24055     * @see elm_calendar_mark_add()
24056     * @see elm_calendar_mark_del()
24057     * @see elm_calendar_marks_clear()
24058     *
24059     * @ingroup Calendar
24060     */
24061    EAPI const Eina_List   *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24062
24063    /**
24064     * Draw calendar marks.
24065     *
24066     * @param obj The calendar object.
24067     *
24068     * Should be used after adding, removing or clearing marks.
24069     * It will go through the entire marks list updating the calendar.
24070     * If lots of marks will be added, add all the marks and then call
24071     * this function.
24072     *
24073     * When the month is changed, i.e. user selects next or previous month,
24074     * marks will be drawed.
24075     *
24076     * @see elm_calendar_mark_add()
24077     * @see elm_calendar_mark_del()
24078     * @see elm_calendar_marks_clear()
24079     *
24080     * @ref calendar_example_06
24081     *
24082     * @ingroup Calendar
24083     */
24084    EAPI void               elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
24085
24086    /**
24087     * Set a day text color to the same that represents Saturdays.
24088     *
24089     * @param obj The calendar object.
24090     * @param pos The text position. Position is the cell counter, from left
24091     * to right, up to down. It starts on 0 and ends on 41.
24092     *
24093     * @deprecated use elm_calendar_mark_add() instead like:
24094     *
24095     * @code
24096     * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
24097     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
24098     * @endcode
24099     *
24100     * @see elm_calendar_mark_add()
24101     *
24102     * @ingroup Calendar
24103     */
24104    EINA_DEPRECATED EAPI void               elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24105
24106    /**
24107     * Set a day text color to the same that represents Sundays.
24108     *
24109     * @param obj The calendar object.
24110     * @param pos The text position. Position is the cell counter, from left
24111     * to right, up to down. It starts on 0 and ends on 41.
24112
24113     * @deprecated use elm_calendar_mark_add() instead like:
24114     *
24115     * @code
24116     * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
24117     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
24118     * @endcode
24119     *
24120     * @see elm_calendar_mark_add()
24121     *
24122     * @ingroup Calendar
24123     */
24124    EINA_DEPRECATED EAPI void               elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24125
24126    /**
24127     * Set a day text color to the same that represents Weekdays.
24128     *
24129     * @param obj The calendar object
24130     * @param pos The text position. Position is the cell counter, from left
24131     * to right, up to down. It starts on 0 and ends on 41.
24132     *
24133     * @deprecated use elm_calendar_mark_add() instead like:
24134     *
24135     * @code
24136     * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
24137     *
24138     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
24139     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
24140     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
24141     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
24142     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
24143     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
24144     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
24145     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
24146     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
24147     * @endcode
24148     *
24149     * @see elm_calendar_mark_add()
24150     *
24151     * @ingroup Calendar
24152     */
24153    EINA_DEPRECATED EAPI void               elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24154
24155    /**
24156     * Set the interval on time updates for an user mouse button hold
24157     * on calendar widgets' month selection.
24158     *
24159     * @param obj The calendar object
24160     * @param interval The (first) interval value in seconds
24161     *
24162     * This interval value is @b decreased while the user holds the
24163     * mouse pointer either selecting next or previous month.
24164     *
24165     * This helps the user to get to a given month distant from the
24166     * current one easier/faster, as it will start to change quicker and
24167     * quicker on mouse button holds.
24168     *
24169     * The calculation for the next change interval value, starting from
24170     * the one set with this call, is the previous interval divided by
24171     * 1.05, so it decreases a little bit.
24172     *
24173     * The default starting interval value for automatic changes is
24174     * @b 0.85 seconds.
24175     *
24176     * @see elm_calendar_interval_get()
24177     *
24178     * @ingroup Calendar
24179     */
24180    EAPI void               elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
24181
24182    /**
24183     * Get the interval on time updates for an user mouse button hold
24184     * on calendar widgets' month selection.
24185     *
24186     * @param obj The calendar object
24187     * @return The (first) interval value, in seconds, set on it
24188     *
24189     * @see elm_calendar_interval_set() for more details
24190     *
24191     * @ingroup Calendar
24192     */
24193    EAPI double             elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24194
24195    /**
24196     * @}
24197     */
24198
24199    /**
24200     * @defgroup Diskselector Diskselector
24201     * @ingroup Elementary
24202     *
24203     * @image html img/widget/diskselector/preview-00.png
24204     * @image latex img/widget/diskselector/preview-00.eps
24205     *
24206     * A diskselector is a kind of list widget. It scrolls horizontally,
24207     * and can contain label and icon objects. Three items are displayed
24208     * with the selected one in the middle.
24209     *
24210     * It can act like a circular list with round mode and labels can be
24211     * reduced for a defined length for side items.
24212     *
24213     * Smart callbacks one can listen to:
24214     * - "selected" - when item is selected, i.e. scroller stops.
24215     *
24216     * Available styles for it:
24217     * - @c "default"
24218     *
24219     * List of examples:
24220     * @li @ref diskselector_example_01
24221     * @li @ref diskselector_example_02
24222     */
24223
24224    /**
24225     * @addtogroup Diskselector
24226     * @{
24227     */
24228
24229    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(). */
24230
24231    /**
24232     * Add a new diskselector widget to the given parent Elementary
24233     * (container) object.
24234     *
24235     * @param parent The parent object.
24236     * @return a new diskselector widget handle or @c NULL, on errors.
24237     *
24238     * This function inserts a new diskselector widget on the canvas.
24239     *
24240     * @ingroup Diskselector
24241     */
24242    EAPI Evas_Object           *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24243
24244    /**
24245     * Enable or disable round mode.
24246     *
24247     * @param obj The diskselector object.
24248     * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
24249     * disable it.
24250     *
24251     * Disabled by default. If round mode is enabled the items list will
24252     * work like a circle list, so when the user reaches the last item,
24253     * the first one will popup.
24254     *
24255     * @see elm_diskselector_round_get()
24256     *
24257     * @ingroup Diskselector
24258     */
24259    EAPI void                   elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
24260
24261    /**
24262     * Get a value whether round mode is enabled or not.
24263     *
24264     * @see elm_diskselector_round_set() for details.
24265     *
24266     * @param obj The diskselector object.
24267     * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
24268     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24269     *
24270     * @ingroup Diskselector
24271     */
24272    EAPI Eina_Bool              elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24273
24274    /**
24275     * Get the side labels max length.
24276     *
24277     * @deprecated use elm_diskselector_side_label_length_get() instead:
24278     *
24279     * @param obj The diskselector object.
24280     * @return The max length defined for side labels, or 0 if not a valid
24281     * diskselector.
24282     *
24283     * @ingroup Diskselector
24284     */
24285    EINA_DEPRECATED EAPI int    elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24286
24287    /**
24288     * Set the side labels max length.
24289     *
24290     * @deprecated use elm_diskselector_side_label_length_set() instead:
24291     *
24292     * @param obj The diskselector object.
24293     * @param len The max length defined for side labels.
24294     *
24295     * @ingroup Diskselector
24296     */
24297    EINA_DEPRECATED EAPI void   elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
24298
24299    /**
24300     * Get the side labels max length.
24301     *
24302     * @see elm_diskselector_side_label_length_set() for details.
24303     *
24304     * @param obj The diskselector object.
24305     * @return The max length defined for side labels, or 0 if not a valid
24306     * diskselector.
24307     *
24308     * @ingroup Diskselector
24309     */
24310    EAPI int                    elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24311
24312    /**
24313     * Set the side labels max length.
24314     *
24315     * @param obj The diskselector object.
24316     * @param len The max length defined for side labels.
24317     *
24318     * Length is the number of characters of items' label that will be
24319     * visible when it's set on side positions. It will just crop
24320     * the string after defined size. E.g.:
24321     *
24322     * An item with label "January" would be displayed on side position as
24323     * "Jan" if max length is set to 3, or "Janu", if this property
24324     * is set to 4.
24325     *
24326     * When it's selected, the entire label will be displayed, except for
24327     * width restrictions. In this case label will be cropped and "..."
24328     * will be concatenated.
24329     *
24330     * Default side label max length is 3.
24331     *
24332     * This property will be applyed over all items, included before or
24333     * later this function call.
24334     *
24335     * @ingroup Diskselector
24336     */
24337    EAPI void                   elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
24338
24339    /**
24340     * Set the number of items to be displayed.
24341     *
24342     * @param obj The diskselector object.
24343     * @param num The number of items the diskselector will display.
24344     *
24345     * Default value is 3, and also it's the minimun. If @p num is less
24346     * than 3, it will be set to 3.
24347     *
24348     * Also, it can be set on theme, using data item @c display_item_num
24349     * on group "elm/diskselector/item/X", where X is style set.
24350     * E.g.:
24351     *
24352     * group { name: "elm/diskselector/item/X";
24353     * data {
24354     *     item: "display_item_num" "5";
24355     *     }
24356     *
24357     * @ingroup Diskselector
24358     */
24359    EAPI void                   elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
24360
24361    /**
24362     * Get the number of items in the diskselector object.
24363     *
24364     * @param obj The diskselector object.
24365     *
24366     * @ingroup Diskselector
24367     */
24368    EAPI int                   elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24369
24370    /**
24371     * Set bouncing behaviour when the scrolled content reaches an edge.
24372     *
24373     * Tell the internal scroller object whether it should bounce or not
24374     * when it reaches the respective edges for each axis.
24375     *
24376     * @param obj The diskselector object.
24377     * @param h_bounce Whether to bounce or not in the horizontal axis.
24378     * @param v_bounce Whether to bounce or not in the vertical axis.
24379     *
24380     * @see elm_scroller_bounce_set()
24381     *
24382     * @ingroup Diskselector
24383     */
24384    EAPI void                   elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24385
24386    /**
24387     * Get the bouncing behaviour of the internal scroller.
24388     *
24389     * Get whether the internal scroller should bounce when the edge of each
24390     * axis is reached scrolling.
24391     *
24392     * @param obj The diskselector object.
24393     * @param h_bounce Pointer where to store the bounce state of the horizontal
24394     * axis.
24395     * @param v_bounce Pointer where to store the bounce state of the vertical
24396     * axis.
24397     *
24398     * @see elm_scroller_bounce_get()
24399     * @see elm_diskselector_bounce_set()
24400     *
24401     * @ingroup Diskselector
24402     */
24403    EAPI void                   elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
24404
24405    /**
24406     * Get the scrollbar policy.
24407     *
24408     * @see elm_diskselector_scroller_policy_get() for details.
24409     *
24410     * @param obj The diskselector object.
24411     * @param policy_h Pointer where to store horizontal scrollbar policy.
24412     * @param policy_v Pointer where to store vertical scrollbar policy.
24413     *
24414     * @ingroup Diskselector
24415     */
24416    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);
24417
24418    /**
24419     * Set the scrollbar policy.
24420     *
24421     * @param obj The diskselector object.
24422     * @param policy_h Horizontal scrollbar policy.
24423     * @param policy_v Vertical scrollbar policy.
24424     *
24425     * This sets the scrollbar visibility policy for the given scroller.
24426     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
24427     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
24428     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
24429     * This applies respectively for the horizontal and vertical scrollbars.
24430     *
24431     * The both are disabled by default, i.e., are set to
24432     * #ELM_SCROLLER_POLICY_OFF.
24433     *
24434     * @ingroup Diskselector
24435     */
24436    EAPI void                   elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
24437
24438    /**
24439     * Remove all diskselector's items.
24440     *
24441     * @param obj The diskselector object.
24442     *
24443     * @see elm_diskselector_item_del()
24444     * @see elm_diskselector_item_append()
24445     *
24446     * @ingroup Diskselector
24447     */
24448    EAPI void                   elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24449
24450    /**
24451     * Get a list of all the diskselector items.
24452     *
24453     * @param obj The diskselector object.
24454     * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
24455     * or @c NULL on failure.
24456     *
24457     * @see elm_diskselector_item_append()
24458     * @see elm_diskselector_item_del()
24459     * @see elm_diskselector_clear()
24460     *
24461     * @ingroup Diskselector
24462     */
24463    EAPI const Eina_List       *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24464
24465    /**
24466     * Appends a new item to the diskselector object.
24467     *
24468     * @param obj The diskselector object.
24469     * @param label The label of the diskselector item.
24470     * @param icon The icon object to use at left side of the item. An
24471     * icon can be any Evas object, but usually it is an icon created
24472     * with elm_icon_add().
24473     * @param func The function to call when the item is selected.
24474     * @param data The data to associate with the item for related callbacks.
24475     *
24476     * @return The created item or @c NULL upon failure.
24477     *
24478     * A new item will be created and appended to the diskselector, i.e., will
24479     * be set as last item. Also, if there is no selected item, it will
24480     * be selected. This will always happens for the first appended item.
24481     *
24482     * If no icon is set, label will be centered on item position, otherwise
24483     * the icon will be placed at left of the label, that will be shifted
24484     * to the right.
24485     *
24486     * Items created with this method can be deleted with
24487     * elm_diskselector_item_del().
24488     *
24489     * Associated @p data can be properly freed when item is deleted if a
24490     * callback function is set with elm_diskselector_item_del_cb_set().
24491     *
24492     * If a function is passed as argument, it will be called everytime this item
24493     * is selected, i.e., the user stops the diskselector with this
24494     * item on center position. If such function isn't needed, just passing
24495     * @c NULL as @p func is enough. The same should be done for @p data.
24496     *
24497     * Simple example (with no function callback or data associated):
24498     * @code
24499     * disk = elm_diskselector_add(win);
24500     * ic = elm_icon_add(win);
24501     * elm_icon_file_set(ic, "path/to/image", NULL);
24502     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
24503     * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
24504     * @endcode
24505     *
24506     * @see elm_diskselector_item_del()
24507     * @see elm_diskselector_item_del_cb_set()
24508     * @see elm_diskselector_clear()
24509     * @see elm_icon_add()
24510     *
24511     * @ingroup Diskselector
24512     */
24513    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);
24514
24515
24516    /**
24517     * Delete them item from the diskselector.
24518     *
24519     * @param it The item of diskselector to be deleted.
24520     *
24521     * If deleting all diskselector items is required, elm_diskselector_clear()
24522     * should be used instead of getting items list and deleting each one.
24523     *
24524     * @see elm_diskselector_clear()
24525     * @see elm_diskselector_item_append()
24526     * @see elm_diskselector_item_del_cb_set()
24527     *
24528     * @ingroup Diskselector
24529     */
24530    EAPI void                   elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24531
24532    /**
24533     * Set the function called when a diskselector item is freed.
24534     *
24535     * @param it The item to set the callback on
24536     * @param func The function called
24537     *
24538     * If there is a @p func, then it will be called prior item's memory release.
24539     * That will be called with the following arguments:
24540     * @li item's data;
24541     * @li item's Evas object;
24542     * @li item itself;
24543     *
24544     * This way, a data associated to a diskselector item could be properly
24545     * freed.
24546     *
24547     * @ingroup Diskselector
24548     */
24549    EAPI void                   elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
24550
24551    /**
24552     * Get the data associated to the item.
24553     *
24554     * @param it The diskselector item
24555     * @return The data associated to @p it
24556     *
24557     * The return value is a pointer to data associated to @p item when it was
24558     * created, with function elm_diskselector_item_append(). If no data
24559     * was passed as argument, it will return @c NULL.
24560     *
24561     * @see elm_diskselector_item_append()
24562     *
24563     * @ingroup Diskselector
24564     */
24565    EAPI void                  *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24566
24567    /**
24568     * Set the icon associated to the item.
24569     *
24570     * @param it The diskselector item
24571     * @param icon The icon object to associate with @p it
24572     *
24573     * The icon object to use at left side of the item. An
24574     * icon can be any Evas object, but usually it is an icon created
24575     * with elm_icon_add().
24576     *
24577     * Once the icon object is set, a previously set one will be deleted.
24578     * @warning Setting the same icon for two items will cause the icon to
24579     * dissapear from the first item.
24580     *
24581     * If an icon was passed as argument on item creation, with function
24582     * elm_diskselector_item_append(), it will be already
24583     * associated to the item.
24584     *
24585     * @see elm_diskselector_item_append()
24586     * @see elm_diskselector_item_icon_get()
24587     *
24588     * @ingroup Diskselector
24589     */
24590    EAPI void                   elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
24591
24592    /**
24593     * Get the icon associated to the item.
24594     *
24595     * @param it The diskselector item
24596     * @return The icon associated to @p it
24597     *
24598     * The return value is a pointer to the icon associated to @p item when it was
24599     * created, with function elm_diskselector_item_append(), or later
24600     * with function elm_diskselector_item_icon_set. If no icon
24601     * was passed as argument, it will return @c NULL.
24602     *
24603     * @see elm_diskselector_item_append()
24604     * @see elm_diskselector_item_icon_set()
24605     *
24606     * @ingroup Diskselector
24607     */
24608    EAPI Evas_Object           *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24609
24610    /**
24611     * Set the label of item.
24612     *
24613     * @param it The item of diskselector.
24614     * @param label The label of item.
24615     *
24616     * The label to be displayed by the item.
24617     *
24618     * If no icon is set, label will be centered on item position, otherwise
24619     * the icon will be placed at left of the label, that will be shifted
24620     * to the right.
24621     *
24622     * An item with label "January" would be displayed on side position as
24623     * "Jan" if max length is set to 3 with function
24624     * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
24625     * is set to 4.
24626     *
24627     * When this @p item is selected, the entire label will be displayed,
24628     * except for width restrictions.
24629     * In this case label will be cropped and "..." will be concatenated,
24630     * but only for display purposes. It will keep the entire string, so
24631     * if diskselector is resized the remaining characters will be displayed.
24632     *
24633     * If a label was passed as argument on item creation, with function
24634     * elm_diskselector_item_append(), it will be already
24635     * displayed by the item.
24636     *
24637     * @see elm_diskselector_side_label_lenght_set()
24638     * @see elm_diskselector_item_label_get()
24639     * @see elm_diskselector_item_append()
24640     *
24641     * @ingroup Diskselector
24642     */
24643    EAPI void                   elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
24644
24645    /**
24646     * Get the label of item.
24647     *
24648     * @param it The item of diskselector.
24649     * @return The label of item.
24650     *
24651     * The return value is a pointer to the label associated to @p item when it was
24652     * created, with function elm_diskselector_item_append(), or later
24653     * with function elm_diskselector_item_label_set. If no label
24654     * was passed as argument, it will return @c NULL.
24655     *
24656     * @see elm_diskselector_item_label_set() for more details.
24657     * @see elm_diskselector_item_append()
24658     *
24659     * @ingroup Diskselector
24660     */
24661    EAPI const char            *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24662
24663    /**
24664     * Get the selected item.
24665     *
24666     * @param obj The diskselector object.
24667     * @return The selected diskselector item.
24668     *
24669     * The selected item can be unselected with function
24670     * elm_diskselector_item_selected_set(), and the first item of
24671     * diskselector will be selected.
24672     *
24673     * The selected item always will be centered on diskselector, with
24674     * full label displayed, i.e., max lenght set to side labels won't
24675     * apply on the selected item. More details on
24676     * elm_diskselector_side_label_length_set().
24677     *
24678     * @ingroup Diskselector
24679     */
24680    EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24681
24682    /**
24683     * Set the selected state of an item.
24684     *
24685     * @param it The diskselector item
24686     * @param selected The selected state
24687     *
24688     * This sets the selected state of the given item @p it.
24689     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
24690     *
24691     * If a new item is selected the previosly selected will be unselected.
24692     * Previoulsy selected item can be get with function
24693     * elm_diskselector_selected_item_get().
24694     *
24695     * If the item @p it is unselected, the first item of diskselector will
24696     * be selected.
24697     *
24698     * Selected items will be visible on center position of diskselector.
24699     * So if it was on another position before selected, or was invisible,
24700     * diskselector will animate items until the selected item reaches center
24701     * position.
24702     *
24703     * @see elm_diskselector_item_selected_get()
24704     * @see elm_diskselector_selected_item_get()
24705     *
24706     * @ingroup Diskselector
24707     */
24708    EAPI void                   elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
24709
24710    /*
24711     * Get whether the @p item is selected or not.
24712     *
24713     * @param it The diskselector item.
24714     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
24715     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
24716     *
24717     * @see elm_diskselector_selected_item_set() for details.
24718     * @see elm_diskselector_item_selected_get()
24719     *
24720     * @ingroup Diskselector
24721     */
24722    EAPI Eina_Bool              elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24723
24724    /**
24725     * Get the first item of the diskselector.
24726     *
24727     * @param obj The diskselector object.
24728     * @return The first item, or @c NULL if none.
24729     *
24730     * The list of items follows append order. So it will return the first
24731     * item appended to the widget that wasn't deleted.
24732     *
24733     * @see elm_diskselector_item_append()
24734     * @see elm_diskselector_items_get()
24735     *
24736     * @ingroup Diskselector
24737     */
24738    EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24739
24740    /**
24741     * Get the last item of the diskselector.
24742     *
24743     * @param obj The diskselector object.
24744     * @return The last item, or @c NULL if none.
24745     *
24746     * The list of items follows append order. So it will return last first
24747     * item appended to the widget that wasn't deleted.
24748     *
24749     * @see elm_diskselector_item_append()
24750     * @see elm_diskselector_items_get()
24751     *
24752     * @ingroup Diskselector
24753     */
24754    EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24755
24756    /**
24757     * Get the item before @p item in diskselector.
24758     *
24759     * @param it The diskselector item.
24760     * @return The item before @p item, or @c NULL if none or on failure.
24761     *
24762     * The list of items follows append order. So it will return item appended
24763     * just before @p item and that wasn't deleted.
24764     *
24765     * If it is the first item, @c NULL will be returned.
24766     * First item can be get by elm_diskselector_first_item_get().
24767     *
24768     * @see elm_diskselector_item_append()
24769     * @see elm_diskselector_items_get()
24770     *
24771     * @ingroup Diskselector
24772     */
24773    EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24774
24775    /**
24776     * Get the item after @p item in diskselector.
24777     *
24778     * @param it The diskselector item.
24779     * @return The item after @p item, or @c NULL if none or on failure.
24780     *
24781     * The list of items follows append order. So it will return item appended
24782     * just after @p item and that wasn't deleted.
24783     *
24784     * If it is the last item, @c NULL will be returned.
24785     * Last item can be get by elm_diskselector_last_item_get().
24786     *
24787     * @see elm_diskselector_item_append()
24788     * @see elm_diskselector_items_get()
24789     *
24790     * @ingroup Diskselector
24791     */
24792    EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24793
24794    /**
24795     * Set the text to be shown in the diskselector item.
24796     *
24797     * @param item Target item
24798     * @param text The text to set in the content
24799     *
24800     * Setup the text as tooltip to object. The item can have only one tooltip,
24801     * so any previous tooltip data is removed.
24802     *
24803     * @see elm_object_tooltip_text_set() for more details.
24804     *
24805     * @ingroup Diskselector
24806     */
24807    EAPI void                   elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
24808
24809    /**
24810     * Set the content to be shown in the tooltip item.
24811     *
24812     * Setup the tooltip to item. The item can have only one tooltip,
24813     * so any previous tooltip data is removed. @p func(with @p data) will
24814     * be called every time that need show the tooltip and it should
24815     * return a valid Evas_Object. This object is then managed fully by
24816     * tooltip system and is deleted when the tooltip is gone.
24817     *
24818     * @param item the diskselector item being attached a tooltip.
24819     * @param func the function used to create the tooltip contents.
24820     * @param data what to provide to @a func as callback data/context.
24821     * @param del_cb called when data is not needed anymore, either when
24822     *        another callback replaces @p func, the tooltip is unset with
24823     *        elm_diskselector_item_tooltip_unset() or the owner @a item
24824     *        dies. This callback receives as the first parameter the
24825     *        given @a data, and @c event_info is the item.
24826     *
24827     * @see elm_object_tooltip_content_cb_set() for more details.
24828     *
24829     * @ingroup Diskselector
24830     */
24831    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);
24832
24833    /**
24834     * Unset tooltip from item.
24835     *
24836     * @param item diskselector item to remove previously set tooltip.
24837     *
24838     * Remove tooltip from item. The callback provided as del_cb to
24839     * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
24840     * it is not used anymore.
24841     *
24842     * @see elm_object_tooltip_unset() for more details.
24843     * @see elm_diskselector_item_tooltip_content_cb_set()
24844     *
24845     * @ingroup Diskselector
24846     */
24847    EAPI void                   elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24848
24849
24850    /**
24851     * Sets a different style for this item tooltip.
24852     *
24853     * @note before you set a style you should define a tooltip with
24854     *       elm_diskselector_item_tooltip_content_cb_set() or
24855     *       elm_diskselector_item_tooltip_text_set()
24856     *
24857     * @param item diskselector item with tooltip already set.
24858     * @param style the theme style to use (default, transparent, ...)
24859     *
24860     * @see elm_object_tooltip_style_set() for more details.
24861     *
24862     * @ingroup Diskselector
24863     */
24864    EAPI void                   elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
24865
24866    /**
24867     * Get the style for this item tooltip.
24868     *
24869     * @param item diskselector item with tooltip already set.
24870     * @return style the theme style in use, defaults to "default". If the
24871     *         object does not have a tooltip set, then NULL is returned.
24872     *
24873     * @see elm_object_tooltip_style_get() for more details.
24874     * @see elm_diskselector_item_tooltip_style_set()
24875     *
24876     * @ingroup Diskselector
24877     */
24878    EAPI const char            *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24879
24880    /**
24881     * Set the cursor to be shown when mouse is over the diskselector item
24882     *
24883     * @param item Target item
24884     * @param cursor the cursor name to be used.
24885     *
24886     * @see elm_object_cursor_set() for more details.
24887     *
24888     * @ingroup Diskselector
24889     */
24890    EAPI void                   elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
24891
24892    /**
24893     * Get the cursor to be shown when mouse is over the diskselector item
24894     *
24895     * @param item diskselector item with cursor already set.
24896     * @return the cursor name.
24897     *
24898     * @see elm_object_cursor_get() for more details.
24899     * @see elm_diskselector_cursor_set()
24900     *
24901     * @ingroup Diskselector
24902     */
24903    EAPI const char            *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24904
24905
24906    /**
24907     * Unset the cursor to be shown when mouse is over the diskselector item
24908     *
24909     * @param item Target item
24910     *
24911     * @see elm_object_cursor_unset() for more details.
24912     * @see elm_diskselector_cursor_set()
24913     *
24914     * @ingroup Diskselector
24915     */
24916    EAPI void                   elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24917
24918    /**
24919     * Sets a different style for this item cursor.
24920     *
24921     * @note before you set a style you should define a cursor with
24922     *       elm_diskselector_item_cursor_set()
24923     *
24924     * @param item diskselector item with cursor already set.
24925     * @param style the theme style to use (default, transparent, ...)
24926     *
24927     * @see elm_object_cursor_style_set() for more details.
24928     *
24929     * @ingroup Diskselector
24930     */
24931    EAPI void                   elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
24932
24933
24934    /**
24935     * Get the style for this item cursor.
24936     *
24937     * @param item diskselector item with cursor already set.
24938     * @return style the theme style in use, defaults to "default". If the
24939     *         object does not have a cursor set, then @c NULL is returned.
24940     *
24941     * @see elm_object_cursor_style_get() for more details.
24942     * @see elm_diskselector_item_cursor_style_set()
24943     *
24944     * @ingroup Diskselector
24945     */
24946    EAPI const char            *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24947
24948
24949    /**
24950     * Set if the cursor set should be searched on the theme or should use
24951     * the provided by the engine, only.
24952     *
24953     * @note before you set if should look on theme you should define a cursor
24954     * with elm_diskselector_item_cursor_set().
24955     * By default it will only look for cursors provided by the engine.
24956     *
24957     * @param item widget item with cursor already set.
24958     * @param engine_only boolean to define if cursors set with
24959     * elm_diskselector_item_cursor_set() should be searched only
24960     * between cursors provided by the engine or searched on widget's
24961     * theme as well.
24962     *
24963     * @see elm_object_cursor_engine_only_set() for more details.
24964     *
24965     * @ingroup Diskselector
24966     */
24967    EAPI void                   elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
24968
24969    /**
24970     * Get the cursor engine only usage for this item cursor.
24971     *
24972     * @param item widget item with cursor already set.
24973     * @return engine_only boolean to define it cursors should be looked only
24974     * between the provided by the engine or searched on widget's theme as well.
24975     * If the item does not have a cursor set, then @c EINA_FALSE is returned.
24976     *
24977     * @see elm_object_cursor_engine_only_get() for more details.
24978     * @see elm_diskselector_item_cursor_engine_only_set()
24979     *
24980     * @ingroup Diskselector
24981     */
24982    EAPI Eina_Bool              elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24983
24984    /**
24985     * @}
24986     */
24987
24988    /**
24989     * @defgroup Colorselector Colorselector
24990     *
24991     * @{
24992     *
24993     * @image html img/widget/colorselector/preview-00.png
24994     * @image latex img/widget/colorselector/preview-00.eps
24995     *
24996     * @brief Widget for user to select a color.
24997     *
24998     * Signals that you can add callbacks for are:
24999     * "changed" - When the color value changes(event_info is NULL).
25000     *
25001     * See @ref tutorial_colorselector.
25002     */
25003    /**
25004     * @brief Add a new colorselector to the parent
25005     *
25006     * @param parent The parent object
25007     * @return The new object or NULL if it cannot be created
25008     *
25009     * @ingroup Colorselector
25010     */
25011    EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25012    /**
25013     * Set a color for the colorselector
25014     *
25015     * @param obj   Colorselector object
25016     * @param r     r-value of color
25017     * @param g     g-value of color
25018     * @param b     b-value of color
25019     * @param a     a-value of color
25020     *
25021     * @ingroup Colorselector
25022     */
25023    EAPI void         elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
25024    /**
25025     * Get a color from the colorselector
25026     *
25027     * @param obj   Colorselector object
25028     * @param r     integer pointer for r-value of color
25029     * @param g     integer pointer for g-value of color
25030     * @param b     integer pointer for b-value of color
25031     * @param a     integer pointer for a-value of color
25032     *
25033     * @ingroup Colorselector
25034     */
25035    EAPI void         elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
25036    /**
25037     * @}
25038     */
25039
25040    /**
25041     * @defgroup Ctxpopup Ctxpopup
25042     *
25043     * @image html img/widget/ctxpopup/preview-00.png
25044     * @image latex img/widget/ctxpopup/preview-00.eps
25045     *
25046     * @brief Context popup widet.
25047     *
25048     * A ctxpopup is a widget that, when shown, pops up a list of items.
25049     * It automatically chooses an area inside its parent object's view
25050     * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
25051     * optimally fit into it. In the default theme, it will also point an
25052     * arrow to it's top left position at the time one shows it. Ctxpopup
25053     * items have a label and/or an icon. It is intended for a small
25054     * number of items (hence the use of list, not genlist).
25055     *
25056     * @note Ctxpopup is a especialization of @ref Hover.
25057     *
25058     * Signals that you can add callbacks for are:
25059     * "dismissed" - the ctxpopup was dismissed
25060     *
25061     * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
25062     * @{
25063     */
25064    typedef enum _Elm_Ctxpopup_Direction
25065      {
25066         ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
25067                                           area */
25068         ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
25069                                            the clicked area */
25070         ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
25071                                           the clicked area */
25072         ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
25073                                         area */
25074         ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
25075      } Elm_Ctxpopup_Direction;
25076
25077    /**
25078     * @brief Add a new Ctxpopup object to the parent.
25079     *
25080     * @param parent Parent object
25081     * @return New object or @c NULL, if it cannot be created
25082     */
25083    EAPI Evas_Object  *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25084    /**
25085     * @brief Set the Ctxpopup's parent
25086     *
25087     * @param obj The ctxpopup object
25088     * @param area The parent to use
25089     *
25090     * Set the parent object.
25091     *
25092     * @note elm_ctxpopup_add() will automatically call this function
25093     * with its @c parent argument.
25094     *
25095     * @see elm_ctxpopup_add()
25096     * @see elm_hover_parent_set()
25097     */
25098    EAPI void          elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
25099    /**
25100     * @brief Get the Ctxpopup's parent
25101     *
25102     * @param obj The ctxpopup object
25103     *
25104     * @see elm_ctxpopup_hover_parent_set() for more information
25105     */
25106    EAPI Evas_Object  *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25107    /**
25108     * @brief Clear all items in the given ctxpopup object.
25109     *
25110     * @param obj Ctxpopup object
25111     */
25112    EAPI void          elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25113    /**
25114     * @brief Change the ctxpopup's orientation to horizontal or vertical.
25115     *
25116     * @param obj Ctxpopup object
25117     * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
25118     */
25119    EAPI void          elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
25120    /**
25121     * @brief Get the value of current ctxpopup object's orientation.
25122     *
25123     * @param obj Ctxpopup object
25124     * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
25125     *
25126     * @see elm_ctxpopup_horizontal_set()
25127     */
25128    EAPI Eina_Bool     elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25129    /**
25130     * @brief Add a new item to a ctxpopup object.
25131     *
25132     * @param obj Ctxpopup object
25133     * @param icon Icon to be set on new item
25134     * @param label The Label of the new item
25135     * @param func Convenience function called when item selected
25136     * @param data Data passed to @p func
25137     * @return A handle to the item added or @c NULL, on errors
25138     *
25139     * @warning Ctxpopup can't hold both an item list and a content at the same
25140     * time. When an item is added, any previous content will be removed.
25141     *
25142     * @see elm_ctxpopup_content_set()
25143     */
25144    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);
25145    /**
25146     * @brief Delete the given item in a ctxpopup object.
25147     *
25148     * @param it Ctxpopup item to be deleted
25149     *
25150     * @see elm_ctxpopup_item_append()
25151     */
25152    EAPI void          elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25153    /**
25154     * @brief Set the ctxpopup item's state as disabled or enabled.
25155     *
25156     * @param it Ctxpopup item to be enabled/disabled
25157     * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
25158     *
25159     * When disabled the item is greyed out to indicate it's state.
25160     */
25161    EAPI void          elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
25162    /**
25163     * @brief Get the ctxpopup item's disabled/enabled state.
25164     *
25165     * @param it Ctxpopup item to be enabled/disabled
25166     * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
25167     *
25168     * @see elm_ctxpopup_item_disabled_set()
25169     */
25170    EAPI Eina_Bool     elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25171    /**
25172     * @brief Get the icon object for the given ctxpopup item.
25173     *
25174     * @param it Ctxpopup item
25175     * @return icon object or @c NULL, if the item does not have icon or an error
25176     * occurred
25177     *
25178     * @see elm_ctxpopup_item_append()
25179     * @see elm_ctxpopup_item_icon_set()
25180     */
25181    EAPI Evas_Object  *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25182    /**
25183     * @brief Sets the side icon associated with the ctxpopup item
25184     *
25185     * @param it Ctxpopup item
25186     * @param icon Icon object to be set
25187     *
25188     * Once the icon object is set, a previously set one will be deleted.
25189     * @warning Setting the same icon for two items will cause the icon to
25190     * dissapear from the first item.
25191     *
25192     * @see elm_ctxpopup_item_append()
25193     */
25194    EAPI void          elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
25195    /**
25196     * @brief Get the label for the given ctxpopup item.
25197     *
25198     * @param it Ctxpopup item
25199     * @return label string or @c NULL, if the item does not have label or an
25200     * error occured
25201     *
25202     * @see elm_ctxpopup_item_append()
25203     * @see elm_ctxpopup_item_label_set()
25204     */
25205    EAPI const char   *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25206    /**
25207     * @brief (Re)set the label on the given ctxpopup item.
25208     *
25209     * @param it Ctxpopup item
25210     * @param label String to set as label
25211     */
25212    EAPI void          elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
25213    /**
25214     * @brief Set an elm widget as the content of the ctxpopup.
25215     *
25216     * @param obj Ctxpopup object
25217     * @param content Content to be swallowed
25218     *
25219     * If the content object is already set, a previous one will bedeleted. If
25220     * you want to keep that old content object, use the
25221     * elm_ctxpopup_content_unset() function.
25222     *
25223     * @deprecated use elm_object_content_set()
25224     *
25225     * @warning Ctxpopup can't hold both a item list and a content at the same
25226     * time. When a content is set, any previous items will be removed.
25227     */
25228    EINA_DEPRECATED EAPI void          elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
25229    /**
25230     * @brief Unset the ctxpopup content
25231     *
25232     * @param obj Ctxpopup object
25233     * @return The content that was being used
25234     *
25235     * Unparent and return the content object which was set for this widget.
25236     *
25237     * @deprecated use elm_object_content_unset()
25238     *
25239     * @see elm_ctxpopup_content_set()
25240     */
25241    EINA_DEPRECATED EAPI Evas_Object  *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25242    /**
25243     * @brief Set the direction priority of a ctxpopup.
25244     *
25245     * @param obj Ctxpopup object
25246     * @param first 1st priority of direction
25247     * @param second 2nd priority of direction
25248     * @param third 3th priority of direction
25249     * @param fourth 4th priority of direction
25250     *
25251     * This functions gives a chance to user to set the priority of ctxpopup
25252     * showing direction. This doesn't guarantee the ctxpopup will appear in the
25253     * requested direction.
25254     *
25255     * @see Elm_Ctxpopup_Direction
25256     */
25257    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);
25258    /**
25259     * @brief Get the direction priority of a ctxpopup.
25260     *
25261     * @param obj Ctxpopup object
25262     * @param first 1st priority of direction to be returned
25263     * @param second 2nd priority of direction to be returned
25264     * @param third 3th priority of direction to be returned
25265     * @param fourth 4th priority of direction to be returned
25266     *
25267     * @see elm_ctxpopup_direction_priority_set() for more information.
25268     */
25269    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);
25270
25271    /**
25272     * @brief Get the current direction of a ctxpopup.
25273     *
25274     * @param obj Ctxpopup object
25275     * @return current direction of a ctxpopup
25276     *
25277     * @warning Once the ctxpopup showed up, the direction would be determined
25278     */
25279    EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25280
25281    /**
25282     * @}
25283     */
25284
25285    /* transit */
25286    /**
25287     *
25288     * @defgroup Transit Transit
25289     * @ingroup Elementary
25290     *
25291     * Transit is designed to apply various animated transition effects to @c
25292     * Evas_Object, such like translation, rotation, etc. For using these
25293     * effects, create an @ref Elm_Transit and add the desired transition effects.
25294     *
25295     * Once the effects are added into transit, they will be automatically
25296     * managed (their callback will be called until the duration is ended, and
25297     * they will be deleted on completion).
25298     *
25299     * Example:
25300     * @code
25301     * Elm_Transit *trans = elm_transit_add();
25302     * elm_transit_object_add(trans, obj);
25303     * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
25304     * elm_transit_duration_set(transit, 1);
25305     * elm_transit_auto_reverse_set(transit, EINA_TRUE);
25306     * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
25307     * elm_transit_repeat_times_set(transit, 3);
25308     * @endcode
25309     *
25310     * Some transition effects are used to change the properties of objects. They
25311     * are:
25312     * @li @ref elm_transit_effect_translation_add
25313     * @li @ref elm_transit_effect_color_add
25314     * @li @ref elm_transit_effect_rotation_add
25315     * @li @ref elm_transit_effect_wipe_add
25316     * @li @ref elm_transit_effect_zoom_add
25317     * @li @ref elm_transit_effect_resizing_add
25318     *
25319     * Other transition effects are used to make one object disappear and another
25320     * object appear on its old place. These effects are:
25321     *
25322     * @li @ref elm_transit_effect_flip_add
25323     * @li @ref elm_transit_effect_resizable_flip_add
25324     * @li @ref elm_transit_effect_fade_add
25325     * @li @ref elm_transit_effect_blend_add
25326     *
25327     * It's also possible to make a transition chain with @ref
25328     * elm_transit_chain_transit_add.
25329     *
25330     * @warning We strongly recommend to use elm_transit just when edje can not do
25331     * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
25332     * animations can be manipulated inside the theme.
25333     *
25334     * List of examples:
25335     * @li @ref transit_example_01_explained
25336     * @li @ref transit_example_02_explained
25337     * @li @ref transit_example_03_c
25338     * @li @ref transit_example_04_c
25339     *
25340     * @{
25341     */
25342
25343    /**
25344     * @enum Elm_Transit_Tween_Mode
25345     *
25346     * The type of acceleration used in the transition.
25347     */
25348    typedef enum
25349      {
25350         ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
25351         ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
25352                                              over time, then decrease again
25353                                              and stop slowly */
25354         ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
25355                                              speed over time */
25356         ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
25357                                             over time */
25358      } Elm_Transit_Tween_Mode;
25359
25360    /**
25361     * @enum Elm_Transit_Effect_Flip_Axis
25362     *
25363     * The axis where flip effect should be applied.
25364     */
25365    typedef enum
25366      {
25367         ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
25368         ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
25369      } Elm_Transit_Effect_Flip_Axis;
25370    /**
25371     * @enum Elm_Transit_Effect_Wipe_Dir
25372     *
25373     * The direction where the wipe effect should occur.
25374     */
25375    typedef enum
25376      {
25377         ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
25378         ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
25379         ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
25380         ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
25381      } Elm_Transit_Effect_Wipe_Dir;
25382    /** @enum Elm_Transit_Effect_Wipe_Type
25383     *
25384     * Whether the wipe effect should show or hide the object.
25385     */
25386    typedef enum
25387      {
25388         ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
25389                                              animation */
25390         ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
25391                                             animation */
25392      } Elm_Transit_Effect_Wipe_Type;
25393
25394    /**
25395     * @typedef Elm_Transit
25396     *
25397     * The Transit created with elm_transit_add(). This type has the information
25398     * about the objects which the transition will be applied, and the
25399     * transition effects that will be used. It also contains info about
25400     * duration, number of repetitions, auto-reverse, etc.
25401     */
25402    typedef struct _Elm_Transit Elm_Transit;
25403    typedef void Elm_Transit_Effect;
25404    /**
25405     * @typedef Elm_Transit_Effect_Transition_Cb
25406     *
25407     * Transition callback called for this effect on each transition iteration.
25408     */
25409    typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
25410    /**
25411     * Elm_Transit_Effect_End_Cb
25412     *
25413     * Transition callback called for this effect when the transition is over.
25414     */
25415    typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
25416
25417    /**
25418     * Elm_Transit_Del_Cb
25419     *
25420     * A callback called when the transit is deleted.
25421     */
25422    typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
25423
25424    /**
25425     * Add new transit.
25426     *
25427     * @note Is not necessary to delete the transit object, it will be deleted at
25428     * the end of its operation.
25429     * @note The transit will start playing when the program enter in the main loop, is not
25430     * necessary to give a start to the transit.
25431     *
25432     * @return The transit object.
25433     *
25434     * @ingroup Transit
25435     */
25436    EAPI Elm_Transit                *elm_transit_add(void);
25437
25438    /**
25439     * Stops the animation and delete the @p transit object.
25440     *
25441     * Call this function if you wants to stop the animation before the duration
25442     * time. Make sure the @p transit object is still alive with
25443     * elm_transit_del_cb_set() function.
25444     * All added effects will be deleted, calling its repective data_free_cb
25445     * functions. The function setted by elm_transit_del_cb_set() will be called.
25446     *
25447     * @see elm_transit_del_cb_set()
25448     *
25449     * @param transit The transit object to be deleted.
25450     *
25451     * @ingroup Transit
25452     * @warning Just call this function if you are sure the transit is alive.
25453     */
25454    EAPI void                        elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
25455
25456    /**
25457     * Add a new effect to the transit.
25458     *
25459     * @note The cb function and the data are the key to the effect. If you try to
25460     * add an already added effect, nothing is done.
25461     * @note After the first addition of an effect in @p transit, if its
25462     * effect list become empty again, the @p transit will be killed by
25463     * elm_transit_del(transit) function.
25464     *
25465     * Exemple:
25466     * @code
25467     * Elm_Transit *transit = elm_transit_add();
25468     * elm_transit_effect_add(transit,
25469     *                        elm_transit_effect_blend_op,
25470     *                        elm_transit_effect_blend_context_new(),
25471     *                        elm_transit_effect_blend_context_free);
25472     * @endcode
25473     *
25474     * @param transit The transit object.
25475     * @param transition_cb The operation function. It is called when the
25476     * animation begins, it is the function that actually performs the animation.
25477     * It is called with the @p data, @p transit and the time progression of the
25478     * animation (a double value between 0.0 and 1.0).
25479     * @param effect The context data of the effect.
25480     * @param end_cb The function to free the context data, it will be called
25481     * at the end of the effect, it must finalize the animation and free the
25482     * @p data.
25483     *
25484     * @ingroup Transit
25485     * @warning The transit free the context data at the and of the transition with
25486     * the data_free_cb function, do not use the context data in another transit.
25487     */
25488    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);
25489
25490    /**
25491     * Delete an added effect.
25492     *
25493     * This function will remove the effect from the @p transit, calling the
25494     * data_free_cb to free the @p data.
25495     *
25496     * @see elm_transit_effect_add()
25497     *
25498     * @note If the effect is not found, nothing is done.
25499     * @note If the effect list become empty, this function will call
25500     * elm_transit_del(transit), that is, it will kill the @p transit.
25501     *
25502     * @param transit The transit object.
25503     * @param transition_cb The operation function.
25504     * @param effect The context data of the effect.
25505     *
25506     * @ingroup Transit
25507     */
25508    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);
25509
25510    /**
25511     * Add new object to apply the effects.
25512     *
25513     * @note After the first addition of an object in @p transit, if its
25514     * object list become empty again, the @p transit will be killed by
25515     * elm_transit_del(transit) function.
25516     * @note If the @p obj belongs to another transit, the @p obj will be
25517     * removed from it and it will only belong to the @p transit. If the old
25518     * transit stays without objects, it will die.
25519     * @note When you add an object into the @p transit, its state from
25520     * evas_object_pass_events_get(obj) is saved, and it is applied when the
25521     * transit ends, if you change this state whith evas_object_pass_events_set()
25522     * after add the object, this state will change again when @p transit stops to
25523     * run.
25524     *
25525     * @param transit The transit object.
25526     * @param obj Object to be animated.
25527     *
25528     * @ingroup Transit
25529     * @warning It is not allowed to add a new object after transit begins to go.
25530     */
25531    EAPI void                        elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
25532
25533    /**
25534     * Removes an added object from the transit.
25535     *
25536     * @note If the @p obj is not in the @p transit, nothing is done.
25537     * @note If the list become empty, this function will call
25538     * elm_transit_del(transit), that is, it will kill the @p transit.
25539     *
25540     * @param transit The transit object.
25541     * @param obj Object to be removed from @p transit.
25542     *
25543     * @ingroup Transit
25544     * @warning It is not allowed to remove objects after transit begins to go.
25545     */
25546    EAPI void                        elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
25547
25548    /**
25549     * Get the objects of the transit.
25550     *
25551     * @param transit The transit object.
25552     * @return a Eina_List with the objects from the transit.
25553     *
25554     * @ingroup Transit
25555     */
25556    EAPI const Eina_List            *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25557
25558    /**
25559     * Enable/disable keeping up the objects states.
25560     * If it is not kept, the objects states will be reset when transition ends.
25561     *
25562     * @note @p transit can not be NULL.
25563     * @note One state includes geometry, color, map data.
25564     *
25565     * @param transit The transit object.
25566     * @param state_keep Keeping or Non Keeping.
25567     *
25568     * @ingroup Transit
25569     */
25570    EAPI void                        elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
25571
25572    /**
25573     * Get a value whether the objects states will be reset or not.
25574     *
25575     * @note @p transit can not be NULL
25576     *
25577     * @see elm_transit_objects_final_state_keep_set()
25578     *
25579     * @param transit The transit object.
25580     * @return EINA_TRUE means the states of the objects will be reset.
25581     * If @p transit is NULL, EINA_FALSE is returned
25582     *
25583     * @ingroup Transit
25584     */
25585    EAPI Eina_Bool                   elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25586
25587    /**
25588     * Set the event enabled when transit is operating.
25589     *
25590     * If @p enabled is EINA_TRUE, the objects of the transit will receives
25591     * events from mouse and keyboard during the animation.
25592     * @note When you add an object with elm_transit_object_add(), its state from
25593     * evas_object_pass_events_get(obj) is saved, and it is applied when the
25594     * transit ends, if you change this state with evas_object_pass_events_set()
25595     * after adding the object, this state will change again when @p transit stops
25596     * to run.
25597     *
25598     * @param transit The transit object.
25599     * @param enabled Events are received when enabled is @c EINA_TRUE, and
25600     * ignored otherwise.
25601     *
25602     * @ingroup Transit
25603     */
25604    EAPI void                        elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25605
25606    /**
25607     * Get the value of event enabled status.
25608     *
25609     * @see elm_transit_event_enabled_set()
25610     *
25611     * @param transit The Transit object
25612     * @return EINA_TRUE, when event is enabled. If @p transit is NULL
25613     * EINA_FALSE is returned
25614     *
25615     * @ingroup Transit
25616     */
25617    EAPI Eina_Bool                   elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25618
25619    /**
25620     * Set the user-callback function when the transit is deleted.
25621     *
25622     * @note Using this function twice will overwrite the first function setted.
25623     * @note the @p transit object will be deleted after call @p cb function.
25624     *
25625     * @param transit The transit object.
25626     * @param cb Callback function pointer. This function will be called before
25627     * the deletion of the transit.
25628     * @param data Callback funtion user data. It is the @p op parameter.
25629     *
25630     * @ingroup Transit
25631     */
25632    EAPI void                        elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
25633
25634    /**
25635     * Set reverse effect automatically.
25636     *
25637     * If auto reverse is setted, after running the effects with the progress
25638     * parameter from 0 to 1, it will call the effecs again with the progress
25639     * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
25640     * where the duration was setted with the function elm_transit_add and
25641     * the repeat with the function elm_transit_repeat_times_set().
25642     *
25643     * @param transit The transit object.
25644     * @param reverse EINA_TRUE means the auto_reverse is on.
25645     *
25646     * @ingroup Transit
25647     */
25648    EAPI void                        elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
25649
25650    /**
25651     * Get if the auto reverse is on.
25652     *
25653     * @see elm_transit_auto_reverse_set()
25654     *
25655     * @param transit The transit object.
25656     * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
25657     * EINA_FALSE is returned
25658     *
25659     * @ingroup Transit
25660     */
25661    EAPI Eina_Bool                   elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25662
25663    /**
25664     * Set the transit repeat count. Effect will be repeated by repeat count.
25665     *
25666     * This function sets the number of repetition the transit will run after
25667     * the first one, that is, if @p repeat is 1, the transit will run 2 times.
25668     * If the @p repeat is a negative number, it will repeat infinite times.
25669     *
25670     * @note If this function is called during the transit execution, the transit
25671     * will run @p repeat times, ignoring the times it already performed.
25672     *
25673     * @param transit The transit object
25674     * @param repeat Repeat count
25675     *
25676     * @ingroup Transit
25677     */
25678    EAPI void                        elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
25679
25680    /**
25681     * Get the transit repeat count.
25682     *
25683     * @see elm_transit_repeat_times_set()
25684     *
25685     * @param transit The Transit object.
25686     * @return The repeat count. If @p transit is NULL
25687     * 0 is returned
25688     *
25689     * @ingroup Transit
25690     */
25691    EAPI int                         elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25692
25693    /**
25694     * Set the transit animation acceleration type.
25695     *
25696     * This function sets the tween mode of the transit that can be:
25697     * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
25698     * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
25699     * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
25700     * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
25701     *
25702     * @param transit The transit object.
25703     * @param tween_mode The tween type.
25704     *
25705     * @ingroup Transit
25706     */
25707    EAPI void                        elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
25708
25709    /**
25710     * Get the transit animation acceleration type.
25711     *
25712     * @note @p transit can not be NULL
25713     *
25714     * @param transit The transit object.
25715     * @return The tween type. If @p transit is NULL
25716     * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
25717     *
25718     * @ingroup Transit
25719     */
25720    EAPI Elm_Transit_Tween_Mode      elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25721
25722    /**
25723     * Set the transit animation time
25724     *
25725     * @note @p transit can not be NULL
25726     *
25727     * @param transit The transit object.
25728     * @param duration The animation time.
25729     *
25730     * @ingroup Transit
25731     */
25732    EAPI void                        elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
25733
25734    /**
25735     * Get the transit animation time
25736     *
25737     * @note @p transit can not be NULL
25738     *
25739     * @param transit The transit object.
25740     *
25741     * @return The transit animation time.
25742     *
25743     * @ingroup Transit
25744     */
25745    EAPI double                      elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25746
25747    /**
25748     * Starts the transition.
25749     * Once this API is called, the transit begins to measure the time.
25750     *
25751     * @note @p transit can not be NULL
25752     *
25753     * @param transit The transit object.
25754     *
25755     * @ingroup Transit
25756     */
25757    EAPI void                        elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
25758
25759    /**
25760     * Pause/Resume the transition.
25761     *
25762     * If you call elm_transit_go again, the transit will be started from the
25763     * beginning, and will be unpaused.
25764     *
25765     * @note @p transit can not be NULL
25766     *
25767     * @param transit The transit object.
25768     * @param paused Whether the transition should be paused or not.
25769     *
25770     * @ingroup Transit
25771     */
25772    EAPI void                        elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
25773
25774    /**
25775     * Get the value of paused status.
25776     *
25777     * @see elm_transit_paused_set()
25778     *
25779     * @note @p transit can not be NULL
25780     *
25781     * @param transit The transit object.
25782     * @return EINA_TRUE means transition is paused. If @p transit is NULL
25783     * EINA_FALSE is returned
25784     *
25785     * @ingroup Transit
25786     */
25787    EAPI Eina_Bool                   elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25788
25789    /**
25790     * Get the time progression of the animation (a double value between 0.0 and 1.0).
25791     *
25792     * The value returned is a fraction (current time / total time). It
25793     * represents the progression position relative to the total.
25794     *
25795     * @note @p transit can not be NULL
25796     *
25797     * @param transit The transit object.
25798     *
25799     * @return The time progression value. If @p transit is NULL
25800     * 0 is returned
25801     *
25802     * @ingroup Transit
25803     */
25804    EAPI double                      elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25805
25806    /**
25807     * Makes the chain relationship between two transits.
25808     *
25809     * @note @p transit can not be NULL. Transit would have multiple chain transits.
25810     * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
25811     *
25812     * @param transit The transit object.
25813     * @param chain_transit The chain transit object. This transit will be operated
25814     *        after transit is done.
25815     *
25816     * This function adds @p chain_transit transition to a chain after the @p
25817     * transit, and will be started as soon as @p transit ends. See @ref
25818     * transit_example_02_explained for a full example.
25819     *
25820     * @ingroup Transit
25821     */
25822    EAPI void                        elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
25823
25824    /**
25825     * Cut off the chain relationship between two transits.
25826     *
25827     * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
25828     * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
25829     *
25830     * @param transit The transit object.
25831     * @param chain_transit The chain transit object.
25832     *
25833     * This function remove the @p chain_transit transition from the @p transit.
25834     *
25835     * @ingroup Transit
25836     */
25837    EAPI void                        elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
25838
25839    /**
25840     * Get the current chain transit list.
25841     *
25842     * @note @p transit can not be NULL.
25843     *
25844     * @param transit The transit object.
25845     * @return chain transit list.
25846     *
25847     * @ingroup Transit
25848     */
25849    EAPI Eina_List                  *elm_transit_chain_transits_get(const Elm_Transit *transit);
25850
25851    /**
25852     * Add the Resizing Effect to Elm_Transit.
25853     *
25854     * @note This API is one of the facades. It creates resizing effect context
25855     * and add it's required APIs to elm_transit_effect_add.
25856     *
25857     * @see elm_transit_effect_add()
25858     *
25859     * @param transit Transit object.
25860     * @param from_w Object width size when effect begins.
25861     * @param from_h Object height size when effect begins.
25862     * @param to_w Object width size when effect ends.
25863     * @param to_h Object height size when effect ends.
25864     * @return Resizing effect context data.
25865     *
25866     * @ingroup Transit
25867     */
25868    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);
25869
25870    /**
25871     * Add the Translation Effect to Elm_Transit.
25872     *
25873     * @note This API is one of the facades. It creates translation effect context
25874     * and add it's required APIs to elm_transit_effect_add.
25875     *
25876     * @see elm_transit_effect_add()
25877     *
25878     * @param transit Transit object.
25879     * @param from_dx X Position variation when effect begins.
25880     * @param from_dy Y Position variation when effect begins.
25881     * @param to_dx X Position variation when effect ends.
25882     * @param to_dy Y Position variation when effect ends.
25883     * @return Translation effect context data.
25884     *
25885     * @ingroup Transit
25886     * @warning It is highly recommended just create a transit with this effect when
25887     * the window that the objects of the transit belongs has already been created.
25888     * This is because this effect needs the geometry information about the objects,
25889     * and if the window was not created yet, it can get a wrong information.
25890     */
25891    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);
25892
25893    /**
25894     * Add the Zoom Effect to Elm_Transit.
25895     *
25896     * @note This API is one of the facades. It creates zoom effect context
25897     * and add it's required APIs to elm_transit_effect_add.
25898     *
25899     * @see elm_transit_effect_add()
25900     *
25901     * @param transit Transit object.
25902     * @param from_rate Scale rate when effect begins (1 is current rate).
25903     * @param to_rate Scale rate when effect ends.
25904     * @return Zoom effect context data.
25905     *
25906     * @ingroup Transit
25907     * @warning It is highly recommended just create a transit with this effect when
25908     * the window that the objects of the transit belongs has already been created.
25909     * This is because this effect needs the geometry information about the objects,
25910     * and if the window was not created yet, it can get a wrong information.
25911     */
25912    EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
25913
25914    /**
25915     * Add the Flip Effect to Elm_Transit.
25916     *
25917     * @note This API is one of the facades. It creates flip effect context
25918     * and add it's required APIs to elm_transit_effect_add.
25919     * @note This effect is applied to each pair of objects in the order they are listed
25920     * in the transit list of objects. The first object in the pair will be the
25921     * "front" object and the second will be the "back" object.
25922     *
25923     * @see elm_transit_effect_add()
25924     *
25925     * @param transit Transit object.
25926     * @param axis Flipping Axis(X or Y).
25927     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
25928     * @return Flip effect context data.
25929     *
25930     * @ingroup Transit
25931     * @warning It is highly recommended just create a transit with this effect when
25932     * the window that the objects of the transit belongs has already been created.
25933     * This is because this effect needs the geometry information about the objects,
25934     * and if the window was not created yet, it can get a wrong information.
25935     */
25936    EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
25937
25938    /**
25939     * Add the Resizable Flip Effect to Elm_Transit.
25940     *
25941     * @note This API is one of the facades. It creates resizable flip effect context
25942     * and add it's required APIs to elm_transit_effect_add.
25943     * @note This effect is applied to each pair of objects in the order they are listed
25944     * in the transit list of objects. The first object in the pair will be the
25945     * "front" object and the second will be the "back" object.
25946     *
25947     * @see elm_transit_effect_add()
25948     *
25949     * @param transit Transit object.
25950     * @param axis Flipping Axis(X or Y).
25951     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
25952     * @return Resizable flip effect context data.
25953     *
25954     * @ingroup Transit
25955     * @warning It is highly recommended just create a transit with this effect when
25956     * the window that the objects of the transit belongs has already been created.
25957     * This is because this effect needs the geometry information about the objects,
25958     * and if the window was not created yet, it can get a wrong information.
25959     */
25960    EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
25961
25962    /**
25963     * Add the Wipe Effect to Elm_Transit.
25964     *
25965     * @note This API is one of the facades. It creates wipe effect context
25966     * and add it's required APIs to elm_transit_effect_add.
25967     *
25968     * @see elm_transit_effect_add()
25969     *
25970     * @param transit Transit object.
25971     * @param type Wipe type. Hide or show.
25972     * @param dir Wipe Direction.
25973     * @return Wipe effect context data.
25974     *
25975     * @ingroup Transit
25976     * @warning It is highly recommended just create a transit with this effect when
25977     * the window that the objects of the transit belongs has already been created.
25978     * This is because this effect needs the geometry information about the objects,
25979     * and if the window was not created yet, it can get a wrong information.
25980     */
25981    EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
25982
25983    /**
25984     * Add the Color Effect to Elm_Transit.
25985     *
25986     * @note This API is one of the facades. It creates color effect context
25987     * and add it's required APIs to elm_transit_effect_add.
25988     *
25989     * @see elm_transit_effect_add()
25990     *
25991     * @param transit        Transit object.
25992     * @param  from_r        RGB R when effect begins.
25993     * @param  from_g        RGB G when effect begins.
25994     * @param  from_b        RGB B when effect begins.
25995     * @param  from_a        RGB A when effect begins.
25996     * @param  to_r          RGB R when effect ends.
25997     * @param  to_g          RGB G when effect ends.
25998     * @param  to_b          RGB B when effect ends.
25999     * @param  to_a          RGB A when effect ends.
26000     * @return               Color effect context data.
26001     *
26002     * @ingroup Transit
26003     */
26004    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);
26005
26006    /**
26007     * Add the Fade Effect to Elm_Transit.
26008     *
26009     * @note This API is one of the facades. It creates fade effect context
26010     * and add it's required APIs to elm_transit_effect_add.
26011     * @note This effect is applied to each pair of objects in the order they are listed
26012     * in the transit list of objects. The first object in the pair will be the
26013     * "before" object and the second will be the "after" object.
26014     *
26015     * @see elm_transit_effect_add()
26016     *
26017     * @param transit Transit object.
26018     * @return Fade effect context data.
26019     *
26020     * @ingroup Transit
26021     * @warning It is highly recommended just create a transit with this effect when
26022     * the window that the objects of the transit belongs has already been created.
26023     * This is because this effect needs the color information about the objects,
26024     * and if the window was not created yet, it can get a wrong information.
26025     */
26026    EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
26027
26028    /**
26029     * Add the Blend Effect to Elm_Transit.
26030     *
26031     * @note This API is one of the facades. It creates blend effect context
26032     * and add it's required APIs to elm_transit_effect_add.
26033     * @note This effect is applied to each pair of objects in the order they are listed
26034     * in the transit list of objects. The first object in the pair will be the
26035     * "before" object and the second will be the "after" object.
26036     *
26037     * @see elm_transit_effect_add()
26038     *
26039     * @param transit Transit object.
26040     * @return Blend effect context data.
26041     *
26042     * @ingroup Transit
26043     * @warning It is highly recommended just create a transit with this effect when
26044     * the window that the objects of the transit belongs has already been created.
26045     * This is because this effect needs the color information about the objects,
26046     * and if the window was not created yet, it can get a wrong information.
26047     */
26048    EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
26049
26050    /**
26051     * Add the Rotation Effect to Elm_Transit.
26052     *
26053     * @note This API is one of the facades. It creates rotation effect context
26054     * and add it's required APIs to elm_transit_effect_add.
26055     *
26056     * @see elm_transit_effect_add()
26057     *
26058     * @param transit Transit object.
26059     * @param from_degree Degree when effect begins.
26060     * @param to_degree Degree when effect is ends.
26061     * @return Rotation effect context data.
26062     *
26063     * @ingroup Transit
26064     * @warning It is highly recommended just create a transit with this effect when
26065     * the window that the objects of the transit belongs has already been created.
26066     * This is because this effect needs the geometry information about the objects,
26067     * and if the window was not created yet, it can get a wrong information.
26068     */
26069    EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
26070
26071    /**
26072     * Add the ImageAnimation Effect to Elm_Transit.
26073     *
26074     * @note This API is one of the facades. It creates image animation effect context
26075     * and add it's required APIs to elm_transit_effect_add.
26076     * The @p images parameter is a list images paths. This list and
26077     * its contents will be deleted at the end of the effect by
26078     * elm_transit_effect_image_animation_context_free() function.
26079     *
26080     * Example:
26081     * @code
26082     * char buf[PATH_MAX];
26083     * Eina_List *images = NULL;
26084     * Elm_Transit *transi = elm_transit_add();
26085     *
26086     * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
26087     * images = eina_list_append(images, eina_stringshare_add(buf));
26088     *
26089     * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
26090     * images = eina_list_append(images, eina_stringshare_add(buf));
26091     * elm_transit_effect_image_animation_add(transi, images);
26092     *
26093     * @endcode
26094     *
26095     * @see elm_transit_effect_add()
26096     *
26097     * @param transit Transit object.
26098     * @param images Eina_List of images file paths. This list and
26099     * its contents will be deleted at the end of the effect by
26100     * elm_transit_effect_image_animation_context_free() function.
26101     * @return Image Animation effect context data.
26102     *
26103     * @ingroup Transit
26104     */
26105    EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
26106    /**
26107     * @}
26108     */
26109
26110   typedef struct _Elm_Store                      Elm_Store;
26111   typedef struct _Elm_Store_Filesystem           Elm_Store_Filesystem;
26112   typedef struct _Elm_Store_Item                 Elm_Store_Item;
26113   typedef struct _Elm_Store_Item_Filesystem      Elm_Store_Item_Filesystem;
26114   typedef struct _Elm_Store_Item_Info            Elm_Store_Item_Info;
26115   typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
26116   typedef struct _Elm_Store_Item_Mapping         Elm_Store_Item_Mapping;
26117   typedef struct _Elm_Store_Item_Mapping_Empty   Elm_Store_Item_Mapping_Empty;
26118   typedef struct _Elm_Store_Item_Mapping_Icon    Elm_Store_Item_Mapping_Icon;
26119   typedef struct _Elm_Store_Item_Mapping_Photo   Elm_Store_Item_Mapping_Photo;
26120   typedef struct _Elm_Store_Item_Mapping_Custom  Elm_Store_Item_Mapping_Custom;
26121
26122   typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
26123   typedef void      (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
26124   typedef void      (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
26125   typedef void     *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
26126
26127   typedef enum
26128     {
26129        ELM_STORE_ITEM_MAPPING_NONE = 0,
26130        ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
26131        ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
26132        ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
26133        ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
26134        ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
26135        // can add more here as needed by common apps
26136        ELM_STORE_ITEM_MAPPING_LAST
26137     } Elm_Store_Item_Mapping_Type;
26138
26139   struct _Elm_Store_Item_Mapping_Icon
26140     {
26141        // FIXME: allow edje file icons
26142        int                   w, h;
26143        Elm_Icon_Lookup_Order lookup_order;
26144        Eina_Bool             standard_name : 1;
26145        Eina_Bool             no_scale : 1;
26146        Eina_Bool             smooth : 1;
26147        Eina_Bool             scale_up : 1;
26148        Eina_Bool             scale_down : 1;
26149     };
26150
26151   struct _Elm_Store_Item_Mapping_Empty
26152     {
26153        Eina_Bool             dummy;
26154     };
26155
26156   struct _Elm_Store_Item_Mapping_Photo
26157     {
26158        int                   size;
26159     };
26160
26161   struct _Elm_Store_Item_Mapping_Custom
26162     {
26163        Elm_Store_Item_Mapping_Cb func;
26164     };
26165
26166   struct _Elm_Store_Item_Mapping
26167     {
26168        Elm_Store_Item_Mapping_Type     type;
26169        const char                     *part;
26170        int                             offset;
26171        union
26172          {
26173             Elm_Store_Item_Mapping_Empty  empty;
26174             Elm_Store_Item_Mapping_Icon   icon;
26175             Elm_Store_Item_Mapping_Photo  photo;
26176             Elm_Store_Item_Mapping_Custom custom;
26177             // add more types here
26178          } details;
26179     };
26180
26181   struct _Elm_Store_Item_Info
26182     {
26183       Elm_Genlist_Item_Class       *item_class;
26184       const Elm_Store_Item_Mapping *mapping;
26185       void                         *data;
26186       char                         *sort_id;
26187     };
26188
26189   struct _Elm_Store_Item_Info_Filesystem
26190     {
26191       Elm_Store_Item_Info  base;
26192       char                *path;
26193     };
26194
26195 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
26196 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
26197
26198   EAPI void                    elm_store_free(Elm_Store *st);
26199
26200   EAPI Elm_Store              *elm_store_filesystem_new(void);
26201   EAPI void                    elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
26202   EAPI const char             *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
26203   EAPI const char             *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
26204
26205   EAPI void                    elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
26206
26207   EAPI void                    elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
26208   EAPI int                     elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
26209   EAPI void                    elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
26210   EAPI void                    elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
26211   EAPI void                    elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
26212   EAPI Eina_Bool               elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
26213
26214   EAPI void                    elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
26215   EAPI void                    elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
26216   EAPI Eina_Bool               elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
26217   EAPI void                    elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
26218   EAPI void                   *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
26219   EAPI const Elm_Store        *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
26220   EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
26221
26222    /**
26223     * @defgroup SegmentControl SegmentControl
26224     * @ingroup Elementary
26225     *
26226     * @image html img/widget/segment_control/preview-00.png
26227     * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
26228     *
26229     * @image html img/segment_control.png
26230     * @image latex img/segment_control.eps width=\textwidth
26231     *
26232     * Segment control widget is a horizontal control made of multiple segment
26233     * items, each segment item functioning similar to discrete two state button.
26234     * A segment control groups the items together and provides compact
26235     * single button with multiple equal size segments.
26236     *
26237     * Segment item size is determined by base widget
26238     * size and the number of items added.
26239     * Only one segment item can be at selected state. A segment item can display
26240     * combination of Text and any Evas_Object like Images or other widget.
26241     *
26242     * Smart callbacks one can listen to:
26243     * - "changed" - When the user clicks on a segment item which is not
26244     *   previously selected and get selected. The event_info parameter is the
26245     *   segment item index.
26246     *
26247     * Available styles for it:
26248     * - @c "default"
26249     *
26250     * Here is an example on its usage:
26251     * @li @ref segment_control_example
26252     */
26253
26254    /**
26255     * @addtogroup SegmentControl
26256     * @{
26257     */
26258
26259    typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
26260
26261    /**
26262     * Add a new segment control widget to the given parent Elementary
26263     * (container) object.
26264     *
26265     * @param parent The parent object.
26266     * @return a new segment control widget handle or @c NULL, on errors.
26267     *
26268     * This function inserts a new segment control widget on the canvas.
26269     *
26270     * @ingroup SegmentControl
26271     */
26272    EAPI Evas_Object      *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26273
26274    /**
26275     * Append a new item to the segment control object.
26276     *
26277     * @param obj The segment control object.
26278     * @param icon The icon object to use for the left side of the item. An
26279     * icon can be any Evas object, but usually it is an icon created
26280     * with elm_icon_add().
26281     * @param label The label of the item.
26282     *        Note that, NULL is different from empty string "".
26283     * @return The created item or @c NULL upon failure.
26284     *
26285     * A new item will be created and appended to the segment control, i.e., will
26286     * be set as @b last item.
26287     *
26288     * If it should be inserted at another position,
26289     * elm_segment_control_item_insert_at() should be used instead.
26290     *
26291     * Items created with this function can be deleted with function
26292     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
26293     *
26294     * @note @p label set to @c NULL is different from empty string "".
26295     * If an item
26296     * only has icon, it will be displayed bigger and centered. If it has
26297     * icon and label, even that an empty string, icon will be smaller and
26298     * positioned at left.
26299     *
26300     * Simple example:
26301     * @code
26302     * sc = elm_segment_control_add(win);
26303     * ic = elm_icon_add(win);
26304     * elm_icon_file_set(ic, "path/to/image", NULL);
26305     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
26306     * elm_segment_control_item_add(sc, ic, "label");
26307     * evas_object_show(sc);
26308     * @endcode
26309     *
26310     * @see elm_segment_control_item_insert_at()
26311     * @see elm_segment_control_item_del()
26312     *
26313     * @ingroup SegmentControl
26314     */
26315    EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
26316
26317    /**
26318     * Insert a new item to the segment control object at specified position.
26319     *
26320     * @param obj The segment control object.
26321     * @param icon The icon object to use for the left side of the item. An
26322     * icon can be any Evas object, but usually it is an icon created
26323     * with elm_icon_add().
26324     * @param label The label of the item.
26325     * @param index Item position. Value should be between 0 and items count.
26326     * @return The created item or @c NULL upon failure.
26327
26328     * Index values must be between @c 0, when item will be prepended to
26329     * segment control, and items count, that can be get with
26330     * elm_segment_control_item_count_get(), case when item will be appended
26331     * to segment control, just like elm_segment_control_item_add().
26332     *
26333     * Items created with this function can be deleted with function
26334     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
26335     *
26336     * @note @p label set to @c NULL is different from empty string "".
26337     * If an item
26338     * only has icon, it will be displayed bigger and centered. If it has
26339     * icon and label, even that an empty string, icon will be smaller and
26340     * positioned at left.
26341     *
26342     * @see elm_segment_control_item_add()
26343     * @see elm_segment_control_item_count_get()
26344     * @see elm_segment_control_item_del()
26345     *
26346     * @ingroup SegmentControl
26347     */
26348    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);
26349
26350    /**
26351     * Remove a segment control item from its parent, deleting it.
26352     *
26353     * @param it The item to be removed.
26354     *
26355     * Items can be added with elm_segment_control_item_add() or
26356     * elm_segment_control_item_insert_at().
26357     *
26358     * @ingroup SegmentControl
26359     */
26360    EAPI void              elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26361
26362    /**
26363     * Remove a segment control item at given index from its parent,
26364     * deleting it.
26365     *
26366     * @param obj The segment control object.
26367     * @param index The position of the segment control item to be deleted.
26368     *
26369     * Items can be added with elm_segment_control_item_add() or
26370     * elm_segment_control_item_insert_at().
26371     *
26372     * @ingroup SegmentControl
26373     */
26374    EAPI void              elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26375
26376    /**
26377     * Get the Segment items count from segment control.
26378     *
26379     * @param obj The segment control object.
26380     * @return Segment items count.
26381     *
26382     * It will just return the number of items added to segment control @p obj.
26383     *
26384     * @ingroup SegmentControl
26385     */
26386    EAPI int               elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26387
26388    /**
26389     * Get the item placed at specified index.
26390     *
26391     * @param obj The segment control object.
26392     * @param index The index of the segment item.
26393     * @return The segment control item or @c NULL on failure.
26394     *
26395     * Index is the position of an item in segment control widget. Its
26396     * range is from @c 0 to <tt> count - 1 </tt>.
26397     * Count is the number of items, that can be get with
26398     * elm_segment_control_item_count_get().
26399     *
26400     * @ingroup SegmentControl
26401     */
26402    EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26403
26404    /**
26405     * Get the label of item.
26406     *
26407     * @param obj The segment control object.
26408     * @param index The index of the segment item.
26409     * @return The label of the item at @p index.
26410     *
26411     * The return value is a pointer to the label associated to the item when
26412     * it was created, with function elm_segment_control_item_add(), or later
26413     * with function elm_segment_control_item_label_set. If no label
26414     * was passed as argument, it will return @c NULL.
26415     *
26416     * @see elm_segment_control_item_label_set() for more details.
26417     * @see elm_segment_control_item_add()
26418     *
26419     * @ingroup SegmentControl
26420     */
26421    EAPI const char       *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26422
26423    /**
26424     * Set the label of item.
26425     *
26426     * @param it The item of segment control.
26427     * @param text The label of item.
26428     *
26429     * The label to be displayed by the item.
26430     * Label will be at right of the icon (if set).
26431     *
26432     * If a label was passed as argument on item creation, with function
26433     * elm_control_segment_item_add(), it will be already
26434     * displayed by the item.
26435     *
26436     * @see elm_segment_control_item_label_get()
26437     * @see elm_segment_control_item_add()
26438     *
26439     * @ingroup SegmentControl
26440     */
26441    EAPI void              elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
26442
26443    /**
26444     * Get the icon associated to the item.
26445     *
26446     * @param obj The segment control object.
26447     * @param index The index of the segment item.
26448     * @return The left side icon associated to the item at @p index.
26449     *
26450     * The return value is a pointer to the icon associated to the item when
26451     * it was created, with function elm_segment_control_item_add(), or later
26452     * with function elm_segment_control_item_icon_set(). If no icon
26453     * was passed as argument, it will return @c NULL.
26454     *
26455     * @see elm_segment_control_item_add()
26456     * @see elm_segment_control_item_icon_set()
26457     *
26458     * @ingroup SegmentControl
26459     */
26460    EAPI Evas_Object      *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26461
26462    /**
26463     * Set the icon associated to the item.
26464     *
26465     * @param it The segment control item.
26466     * @param icon The icon object to associate with @p it.
26467     *
26468     * The icon object to use at left side of the item. An
26469     * icon can be any Evas object, but usually it is an icon created
26470     * with elm_icon_add().
26471     *
26472     * Once the icon object is set, a previously set one will be deleted.
26473     * @warning Setting the same icon for two items will cause the icon to
26474     * dissapear from the first item.
26475     *
26476     * If an icon was passed as argument on item creation, with function
26477     * elm_segment_control_item_add(), it will be already
26478     * associated to the item.
26479     *
26480     * @see elm_segment_control_item_add()
26481     * @see elm_segment_control_item_icon_get()
26482     *
26483     * @ingroup SegmentControl
26484     */
26485    EAPI void              elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26486
26487    /**
26488     * Get the index of an item.
26489     *
26490     * @param it The segment control item.
26491     * @return The position of item in segment control widget.
26492     *
26493     * Index is the position of an item in segment control widget. Its
26494     * range is from @c 0 to <tt> count - 1 </tt>.
26495     * Count is the number of items, that can be get with
26496     * elm_segment_control_item_count_get().
26497     *
26498     * @ingroup SegmentControl
26499     */
26500    EAPI int               elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26501
26502    /**
26503     * Get the base object of the item.
26504     *
26505     * @param it The segment control item.
26506     * @return The base object associated with @p it.
26507     *
26508     * Base object is the @c Evas_Object that represents that item.
26509     *
26510     * @ingroup SegmentControl
26511     */
26512    EAPI Evas_Object      *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26513
26514    /**
26515     * Get the selected item.
26516     *
26517     * @param obj The segment control object.
26518     * @return The selected item or @c NULL if none of segment items is
26519     * selected.
26520     *
26521     * The selected item can be unselected with function
26522     * elm_segment_control_item_selected_set().
26523     *
26524     * The selected item always will be highlighted on segment control.
26525     *
26526     * @ingroup SegmentControl
26527     */
26528    EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26529
26530    /**
26531     * Set the selected state of an item.
26532     *
26533     * @param it The segment control item
26534     * @param select The selected state
26535     *
26536     * This sets the selected state of the given item @p it.
26537     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26538     *
26539     * If a new item is selected the previosly selected will be unselected.
26540     * Previoulsy selected item can be get with function
26541     * elm_segment_control_item_selected_get().
26542     *
26543     * The selected item always will be highlighted on segment control.
26544     *
26545     * @see elm_segment_control_item_selected_get()
26546     *
26547     * @ingroup SegmentControl
26548     */
26549    EAPI void              elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
26550
26551    /**
26552     * @}
26553     */
26554
26555    /**
26556     * @defgroup Grid Grid
26557     *
26558     * The grid is a grid layout widget that lays out a series of children as a
26559     * fixed "grid" of widgets using a given percentage of the grid width and
26560     * height each using the child object.
26561     *
26562     * The Grid uses a "Virtual resolution" that is stretched to fill the grid
26563     * widgets size itself. The default is 100 x 100, so that means the
26564     * position and sizes of children will effectively be percentages (0 to 100)
26565     * of the width or height of the grid widget
26566     *
26567     * @{
26568     */
26569
26570    /**
26571     * Add a new grid to the parent
26572     *
26573     * @param parent The parent object
26574     * @return The new object or NULL if it cannot be created
26575     *
26576     * @ingroup Grid
26577     */
26578    EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
26579
26580    /**
26581     * Set the virtual size of the grid
26582     *
26583     * @param obj The grid object
26584     * @param w The virtual width of the grid
26585     * @param h The virtual height of the grid
26586     *
26587     * @ingroup Grid
26588     */
26589    EAPI void         elm_grid_size_set(Evas_Object *obj, int w, int h);
26590
26591    /**
26592     * Get the virtual size of the grid
26593     *
26594     * @param obj The grid object
26595     * @param w Pointer to integer to store the virtual width of the grid
26596     * @param h Pointer to integer to store the virtual height of the grid
26597     *
26598     * @ingroup Grid
26599     */
26600    EAPI void         elm_grid_size_get(Evas_Object *obj, int *w, int *h);
26601
26602    /**
26603     * Pack child at given position and size
26604     *
26605     * @param obj The grid object
26606     * @param subobj The child to pack
26607     * @param x The virtual x coord at which to pack it
26608     * @param y The virtual y coord at which to pack it
26609     * @param w The virtual width at which to pack it
26610     * @param h The virtual height at which to pack it
26611     *
26612     * @ingroup Grid
26613     */
26614    EAPI void         elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
26615
26616    /**
26617     * Unpack a child from a grid object
26618     *
26619     * @param obj The grid object
26620     * @param subobj The child to unpack
26621     *
26622     * @ingroup Grid
26623     */
26624    EAPI void         elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
26625
26626    /**
26627     * Faster way to remove all child objects from a grid object.
26628     *
26629     * @param obj The grid object
26630     * @param clear If true, it will delete just removed children
26631     *
26632     * @ingroup Grid
26633     */
26634    EAPI void         elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
26635
26636    /**
26637     * Set packing of an existing child at to position and size
26638     *
26639     * @param subobj The child to set packing of
26640     * @param x The virtual x coord at which to pack it
26641     * @param y The virtual y coord at which to pack it
26642     * @param w The virtual width at which to pack it
26643     * @param h The virtual height at which to pack it
26644     *
26645     * @ingroup Grid
26646     */
26647    EAPI void         elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
26648
26649    /**
26650     * get packing of a child
26651     *
26652     * @param subobj The child to query
26653     * @param x Pointer to integer to store the virtual x coord
26654     * @param y Pointer to integer to store the virtual y coord
26655     * @param w Pointer to integer to store the virtual width
26656     * @param h Pointer to integer to store the virtual height
26657     *
26658     * @ingroup Grid
26659     */
26660    EAPI void         elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
26661
26662    /**
26663     * @}
26664     */
26665
26666    EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
26667    EAPI void         elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
26668    EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
26669    EAPI void         elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
26670    EAPI Eina_Bool    elm_factory_maxmin_mode_get(const Evas_Object *obj);
26671    EAPI void         elm_factory_maxmin_reset_set(Evas_Object *obj);
26672
26673    /**
26674     * @defgroup Video Video
26675     *
26676     * This object display an player that let you control an Elm_Video
26677     * object. It take care of updating it's content according to what is
26678     * going on inside the Emotion object. It does activate the remember
26679     * function on the linked Elm_Video object.
26680     *
26681     * Signals that you can add callback for are :
26682     *
26683     * "forward,clicked" - the user clicked the forward button.
26684     * "info,clicked" - the user clicked the info button.
26685     * "next,clicked" - the user clicked the next button.
26686     * "pause,clicked" - the user clicked the pause button.
26687     * "play,clicked" - the user clicked the play button.
26688     * "prev,clicked" - the user clicked the prev button.
26689     * "rewind,clicked" - the user clicked the rewind button.
26690     * "stop,clicked" - the user clicked the stop button.
26691     */
26692    EAPI Evas_Object *elm_video_add(Evas_Object *parent);
26693    EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
26694    EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
26695    EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
26696    EAPI void elm_video_play(Evas_Object *video);
26697    EAPI void elm_video_pause(Evas_Object *video);
26698    EAPI void elm_video_stop(Evas_Object *video);
26699    EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
26700    EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
26701    EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
26702    EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
26703    EAPI double elm_video_audio_level_get(Evas_Object *video);
26704    EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
26705    EAPI double elm_video_play_position_get(Evas_Object *video);
26706    EAPI void elm_video_play_position_set(Evas_Object *video, double position);
26707    EAPI double elm_video_play_length_get(Evas_Object *video);
26708    EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
26709    EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
26710    EAPI const char *elm_video_title_get(Evas_Object *video);
26711
26712    EAPI Evas_Object *elm_player_add(Evas_Object *parent);
26713    EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
26714
26715    /**
26716     * @defgroup Naviframe Naviframe
26717     *
26718     * @brief Naviframe is a kind of view manager for the applications.
26719     *
26720     * Naviframe provides functions to switch different pages with stack
26721     * mechanism. It means if one page(item) needs to be changed to the new one,
26722     * then naviframe would push the new page to it's internal stack. Of course,
26723     * it can be back to the previous page by popping the top page. Naviframe
26724     * provides some transition effect while the pages are switching (same as
26725     * pager).
26726     *
26727     * Since each item could keep the different styles, users could keep the
26728     * same look & feel for the pages or different styles for the items in it's
26729     * application.
26730     *
26731     * Signals that you can add callback for are:
26732     *
26733     * @li "transition,finished" - When the transition is finished in changing
26734     *     the item
26735     * @li "title,clicked" - User clicked title area
26736     *
26737     * Default contents parts for the naviframe items that you can use for are:
26738     *
26739     * @li "elm.swallow.content" - The main content of the page
26740     * @li "elm.swallow.prev_btn" - The button to go to the previous page
26741     * @li "elm.swallow.next_btn" - The button to go to the next page
26742     *
26743     * Default text parts of naviframe items that you can be used are:
26744     *
26745     * @li "elm.text.title" - The title label in the title area
26746     *
26747     * @ref tutorial_naviframe gives a good overview of the usage of the API.
26748     * @{
26749     */
26750    /**
26751     * @brief Add a new Naviframe object to the parent.
26752     *
26753     * @param parent Parent object
26754     * @return New object or @c NULL, if it cannot be created
26755     */
26756    EAPI Evas_Object        *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26757    /**
26758     * @brief Push a new item to the top of the naviframe stack (and show it).
26759     *
26760     * @param obj The naviframe object
26761     * @param title_label The label in the title area. The name of the title
26762     *        label part is "elm.text.title"
26763     * @param prev_btn The button to go to the previous item. If it is NULL,
26764     *        then naviframe will create a back button automatically. The name of
26765     *        the prev_btn part is "elm.swallow.prev_btn"
26766     * @param next_btn The button to go to the next item. Or It could be just an
26767     *        extra function button. The name of the next_btn part is
26768     *        "elm.swallow.next_btn"
26769     * @param content The main content object. The name of content part is
26770     *        "elm.swallow.content"
26771     * @param item_style The current item style name. @c NULL would be default.
26772     * @return The created item or @c NULL upon failure.
26773     *
26774     * The item pushed becomes one page of the naviframe, this item will be
26775     * deleted when it is popped.
26776     *
26777     * @see also elm_naviframe_item_style_set()
26778     *
26779     * The following styles are available for this item:
26780     * @li @c "default"
26781     */
26782    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);
26783    /**
26784     * @brief Pop an item that is on top of the stack
26785     *
26786     * @param obj The naviframe object
26787     * @return @c NULL or the content object(if the
26788     *         elm_naviframe_content_preserve_on_pop_get is true).
26789     *
26790     * This pops an item that is on the top(visible) of the naviframe, makes it
26791     * disappear, then deletes the item. The item that was underneath it on the
26792     * stack will become visible.
26793     *
26794     * @see also elm_naviframe_content_preserve_on_pop_get()
26795     */
26796    EAPI Evas_Object        *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
26797    /**
26798     * @brief Pop the items between the top and the above one on the given item.
26799     *
26800     * @param it The naviframe item
26801     */
26802    EAPI void                elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26803    /**
26804     * @brief preserve the content objects when items are popped.
26805     *
26806     * @param obj The naviframe object
26807     * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
26808     *
26809     * @see also elm_naviframe_content_preserve_on_pop_get()
26810     */
26811    EAPI void                elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
26812    /**
26813     * @brief Get a value whether preserve mode is enabled or not.
26814     *
26815     * @param obj The naviframe object
26816     * @return If @c EINA_TRUE, preserve mode is enabled
26817     *
26818     * @see also elm_naviframe_content_preserve_on_pop_set()
26819     */
26820    EAPI Eina_Bool           elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26821    /**
26822     * @brief Get a top item on the naviframe stack
26823     *
26824     * @param obj The naviframe object
26825     * @return The top item on the naviframe stack or @c NULL, if the stack is
26826     *         empty
26827     */
26828    EAPI Elm_Object_Item    *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26829    /**
26830     * @brief Get a bottom item on the naviframe stack
26831     *
26832     * @param obj The naviframe object
26833     * @return The bottom item on the naviframe stack or @c NULL, if the stack is
26834     *         empty
26835     */
26836    EAPI Elm_Object_Item    *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26837    /**
26838     * @brief Set an item style
26839     *
26840     * @param obj The naviframe item
26841     * @param item_style The current item style name. @c NULL would be default
26842     *
26843     * The following styles are available for this item:
26844     * @li @c "default"
26845     *
26846     * @see also elm_naviframe_item_style_get()
26847     */
26848    EAPI void                elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
26849    /**
26850     * @brief Get an item style
26851     *
26852     * @param obj The naviframe item
26853     * @return The current item style name
26854     *
26855     * @see also elm_naviframe_item_style_set()
26856     */
26857    EAPI const char         *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26858    /**
26859     * @brief Show/Hide the title area
26860     *
26861     * @param it The naviframe item
26862     * @param visible If @c EINA_TRUE, title area will be visible, hidden
26863     *        otherwise
26864     *
26865     * When the title area is invisible, then the controls would be hidden so as     * to expand the content area to full-size.
26866     *
26867     * @see also elm_naviframe_item_title_visible_get()
26868     */
26869    EAPI void                elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
26870    /**
26871     * @brief Get a value whether title area is visible or not.
26872     *
26873     * @param it The naviframe item
26874     * @return If @c EINA_TRUE, title area is visible
26875     *
26876     * @see also elm_naviframe_item_title_visible_set()
26877     */
26878    EAPI Eina_Bool           elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26879
26880    /**
26881     * @}
26882     */
26883
26884 #ifdef __cplusplus
26885 }
26886 #endif
26887
26888 #endif